]> code.delx.au - gnu-emacs/blob - lisp/progmodes/cc-engine.el
Fix spurious fontification of "for (; a * b;)" in CC Mode.
[gnu-emacs] / lisp / progmodes / cc-engine.el
1 ;;; cc-engine.el --- core syntax guessing engine for CC mode -*- coding: utf-8 -*-
2
3 ;; Copyright (C) 1985, 1987, 1992-2016 Free Software Foundation, Inc.
4
5 ;; Authors: 2001- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
8 ;; 1987 Dave Detlefs
9 ;; 1987 Stewart Clamen
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
14 ;; Package: cc-mode
15
16 ;; This file is part of GNU Emacs.
17
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.
22
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.
27
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/>.
30
31 ;;; Commentary:
32
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.
38 ;;
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.)
42
43 ;; Hidden buffer changes
44 ;;
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.
51 ;;
52 ;; Interactive functions are assumed to not do hidden buffer changes,
53 ;; except in the specific parts of them that do real changes.
54 ;;
55 ;; Lineup functions are assumed to do hidden buffer changes. They
56 ;; must not do real changes, though.
57 ;;
58 ;; All other functions that do hidden buffer changes have that noted
59 ;; in their doc string or comment.
60 ;;
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.
65 ;;
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).
70
71 ;; Use of text properties
72 ;;
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.
76 ;;
77 ;; Note: This doc is for internal use only. Other packages should not
78 ;; assume that these text properties are used as described here.
79 ;;
80 ;; 'category
81 ;; Used for "indirection". With its help, some other property can
82 ;; be cheaply and easily switched on or off everywhere it occurs.
83 ;;
84 ;; 'syntax-table
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.
88 ;;
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
93 ;; >= 21).
94 ;;
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.
99 ;;
100 ;; 'c-type
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:
108 ;;
109 ;; 'c-decl-arg-start
110 ;; Put on the last char of the token preceding each declaration
111 ;; inside a declaration style arglist (typically in a function
112 ;; prototype).
113 ;;
114 ;; 'c-decl-end
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').
120 ;;
121 ;; 'c-<>-arg-sep
122 ;; Put on the commas that separate arguments in angle bracket
123 ;; arglists like C++ template arglists.
124 ;;
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.
131 ;;
132 ;; 'c-awk-NL-prop
133 ;; Used in AWK mode to mark the various kinds of newlines. See
134 ;; cc-awk.el.
135
136 ;;; Code:
137
138 (eval-when-compile
139 (let ((load-path
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)
143 load-path)))
144 (load "cc-bytecomp" nil t)))
145
146 (cc-require 'cc-defs)
147 (cc-require-when-compile 'cc-langs)
148 (cc-require 'cc-vars)
149
150 (eval-when-compile (require 'cl))
151
152 \f
153 ;; Make declarations for all the `c-lang-defvar' variables in cc-langs.
154
155 (defmacro c-declare-lang-variables ()
156 `(progn
157 ,@(c--mapcan (lambda (init)
158 `(,(if (elt init 2)
159 `(defvar ,(car init) nil ,(elt init 2))
160 `(defvar ,(car init) nil))
161 (make-variable-buffer-local ',(car init))))
162 (cdr c-lang-variable-inits))))
163 (c-declare-lang-variables)
164
165 \f
166 ;;; Internal state variables.
167
168 ;; Internal state of hungry delete key feature
169 (defvar c-hungry-delete-key nil)
170 (make-variable-buffer-local 'c-hungry-delete-key)
171
172 ;; The electric flag (toggled by `c-toggle-electric-state').
173 ;; If t, electric actions (like automatic reindentation, and (if
174 ;; c-auto-newline is also set) auto newlining) will happen when an electric
175 ;; key like `{' is pressed (or an electric keyword like `else').
176 (defvar c-electric-flag t)
177 (make-variable-buffer-local 'c-electric-flag)
178
179 ;; Internal state of auto newline feature.
180 (defvar c-auto-newline nil)
181 (make-variable-buffer-local 'c-auto-newline)
182
183 ;; Included in the mode line to indicate the active submodes.
184 ;; (defvar c-submode-indicators nil)
185 ;; (make-variable-buffer-local 'c-submode-indicators)
186
187 (defun c-calculate-state (arg prevstate)
188 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
189 ;; arg is nil or zero, toggle the state. If arg is negative, turn
190 ;; the state off, and if arg is positive, turn the state on
191 (if (or (not arg)
192 (zerop (setq arg (prefix-numeric-value arg))))
193 (not prevstate)
194 (> arg 0)))
195
196 \f
197 ;; Basic handling of preprocessor directives.
198
199 ;; This is a dynamically bound cache used together with
200 ;; `c-query-macro-start' and `c-query-and-set-macro-start'. It only
201 ;; works as long as point doesn't cross a macro boundary.
202 (defvar c-macro-start 'unknown)
203
204 (defsubst c-query-and-set-macro-start ()
205 (if (symbolp c-macro-start)
206 (setq c-macro-start (save-excursion
207 (c-save-buffer-state ()
208 (and (c-beginning-of-macro)
209 (point)))))
210 c-macro-start))
211
212 (defsubst c-query-macro-start ()
213 (if (symbolp c-macro-start)
214 (save-excursion
215 (c-save-buffer-state ()
216 (and (c-beginning-of-macro)
217 (point))))
218 c-macro-start))
219
220 ;; One element macro cache to cope with continual movement within very large
221 ;; CPP macros.
222 (defvar c-macro-cache nil)
223 (make-variable-buffer-local 'c-macro-cache)
224 ;; Nil or cons of the bounds of the most recent CPP form probed by
225 ;; `c-beginning-of-macro', `c-end-of-macro' or `c-syntactic-end-of-macro'.
226 ;; The cdr will be nil if we know only the start of the CPP form.
227 (defvar c-macro-cache-start-pos nil)
228 (make-variable-buffer-local 'c-macro-cache-start-pos)
229 ;; The starting position from where we determined `c-macro-cache'.
230 (defvar c-macro-cache-syntactic nil)
231 (make-variable-buffer-local 'c-macro-cache-syntactic)
232 ;; non-nil iff `c-macro-cache' has both elements set AND the cdr is at a
233 ;; syntactic end of macro, not merely an apparent one.
234
235 (defun c-invalidate-macro-cache (beg end)
236 ;; Called from a before-change function. If the change region is before or
237 ;; in the macro characterized by `c-macro-cache' etc., nullify it
238 ;; appropriately. BEG and END are the standard before-change-functions
239 ;; parameters. END isn't used.
240 (cond
241 ((null c-macro-cache))
242 ((< beg (car c-macro-cache))
243 (setq c-macro-cache nil
244 c-macro-cache-start-pos nil
245 c-macro-cache-syntactic nil))
246 ((and (cdr c-macro-cache)
247 (< beg (cdr c-macro-cache)))
248 (setcdr c-macro-cache nil)
249 (setq c-macro-cache-start-pos beg
250 c-macro-cache-syntactic nil))))
251
252 (defun c-macro-is-genuine-p ()
253 ;; Check that the ostensible CPP construct at point is a real one. In
254 ;; particular, if point is on the first line of a narrowed buffer, make sure
255 ;; that the "#" isn't, say, the second character of a "##" operator. Return
256 ;; t when the macro is real, nil otherwise.
257 (let ((here (point)))
258 (beginning-of-line)
259 (prog1
260 (if (and (eq (point) (point-min))
261 (/= (point) 1))
262 (save-restriction
263 (widen)
264 (beginning-of-line)
265 (and (looking-at c-anchored-cpp-prefix)
266 (eq (match-beginning 1) here)))
267 t)
268 (goto-char here))))
269
270 (defun c-beginning-of-macro (&optional lim)
271 "Go to the beginning of a preprocessor directive.
272 Leave point at the beginning of the directive and return t if in one,
273 otherwise return nil and leave point unchanged.
274
275 Note that this function might do hidden buffer changes. See the
276 comment at the start of cc-engine.el for more info."
277 (let ((here (point)))
278 (when c-opt-cpp-prefix
279 (if (and (car c-macro-cache)
280 (>= (point) (car c-macro-cache))
281 (or (and (cdr c-macro-cache)
282 (<= (point) (cdr c-macro-cache)))
283 (<= (point) c-macro-cache-start-pos)))
284 (unless (< (car c-macro-cache) (or lim (point-min)))
285 (progn (goto-char (max (or lim (point-min)) (car c-macro-cache)))
286 (setq c-macro-cache-start-pos
287 (max c-macro-cache-start-pos here))
288 t))
289 (setq c-macro-cache nil
290 c-macro-cache-start-pos nil
291 c-macro-cache-syntactic nil)
292
293 (save-restriction
294 (if lim (narrow-to-region lim (point-max)))
295 (beginning-of-line)
296 (while (eq (char-before (1- (point))) ?\\)
297 (forward-line -1))
298 (back-to-indentation)
299 (if (and (<= (point) here)
300 (looking-at c-opt-cpp-start)
301 (c-macro-is-genuine-p))
302 (progn
303 (setq c-macro-cache (cons (point) nil)
304 c-macro-cache-start-pos here)
305 t)
306 (goto-char here)
307 nil))))))
308
309 (defun c-end-of-macro ()
310 "Go to the end of a preprocessor directive.
311 More accurately, move the point to the end of the closest following
312 line that doesn't end with a line continuation backslash - no check is
313 done that the point is inside a cpp directive to begin with.
314
315 Note that this function might do hidden buffer changes. See the
316 comment at the start of cc-engine.el for more info."
317 (if (and (cdr c-macro-cache)
318 (<= (point) (cdr c-macro-cache))
319 (>= (point) (car c-macro-cache)))
320 (goto-char (cdr c-macro-cache))
321 (unless (and (car c-macro-cache)
322 (<= (point) c-macro-cache-start-pos)
323 (>= (point) (car c-macro-cache)))
324 (setq c-macro-cache nil
325 c-macro-cache-start-pos nil
326 c-macro-cache-syntactic nil))
327 (while (progn
328 (end-of-line)
329 (when (and (eq (char-before) ?\\)
330 (not (eobp)))
331 (forward-char)
332 t)))
333 (when (car c-macro-cache)
334 (setcdr c-macro-cache (point)))))
335
336 (defun c-syntactic-end-of-macro ()
337 ;; Go to the end of a CPP directive, or a "safe" pos just before.
338 ;;
339 ;; This is normally the end of the next non-escaped line. A "safe"
340 ;; position is one not within a string or comment. (The EOL on a line
341 ;; comment is NOT "safe").
342 ;;
343 ;; This function must only be called from the beginning of a CPP construct.
344 ;;
345 ;; Note that this function might do hidden buffer changes. See the comment
346 ;; at the start of cc-engine.el for more info.
347 (let* ((here (point))
348 (there (progn (c-end-of-macro) (point)))
349 s)
350 (unless c-macro-cache-syntactic
351 (setq s (parse-partial-sexp here there))
352 (while (and (or (nth 3 s) ; in a string
353 (nth 4 s)) ; in a comment (maybe at end of line comment)
354 (> there here)) ; No infinite loops, please.
355 (setq there (1- (nth 8 s)))
356 (setq s (parse-partial-sexp here there)))
357 (setq c-macro-cache-syntactic (car c-macro-cache)))
358 (point)))
359
360 (defun c-forward-over-cpp-define-id ()
361 ;; Assuming point is at the "#" that introduces a preprocessor
362 ;; directive, it's moved forward to the end of the identifier which is
363 ;; "#define"d (or whatever c-opt-cpp-macro-define specifies). Non-nil
364 ;; is returned in this case, in all other cases nil is returned and
365 ;; point isn't moved.
366 ;;
367 ;; This function might do hidden buffer changes.
368 (when (and c-opt-cpp-macro-define-id
369 (looking-at c-opt-cpp-macro-define-id))
370 (goto-char (match-end 0))))
371
372 (defun c-forward-to-cpp-define-body ()
373 ;; Assuming point is at the "#" that introduces a preprocessor
374 ;; directive, it's moved forward to the start of the definition body
375 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
376 ;; specifies). Non-nil is returned in this case, in all other cases
377 ;; nil is returned and point isn't moved.
378 ;;
379 ;; This function might do hidden buffer changes.
380 (when (and c-opt-cpp-macro-define-start
381 (looking-at c-opt-cpp-macro-define-start)
382 (not (= (match-end 0) (c-point 'eol))))
383 (goto-char (match-end 0))))
384
385 \f
386 ;;; Basic utility functions.
387
388 (defun c-delq-from-dotted-list (elt dlist)
389 ;; If ELT is a member of the (possibly dotted) list DLIST, remove all
390 ;; occurrences of it (except for any in the last cdr of DLIST).
391 ;;
392 ;; Call this as (setq DLIST (c-delq-from-dotted-list ELT DLIST)), as
393 ;; sometimes the original structure is changed, sometimes it's not.
394 ;;
395 ;; This function is needed in Emacs < 24.5, and possibly XEmacs, because
396 ;; `delq' throws an error in these versions when given a dotted list.
397 (let ((tail dlist) prev)
398 (while (consp tail)
399 (if (eq (car tail) elt)
400 (if prev
401 (setcdr prev (cdr tail))
402 (setq dlist (cdr dlist)))
403 (setq prev tail))
404 (setq tail (cdr tail)))
405 dlist))
406
407 (defun c-syntactic-content (from to paren-level)
408 ;; Return the given region as a string where all syntactic
409 ;; whitespace is removed or, where necessary, replaced with a single
410 ;; space. If PAREN-LEVEL is given then all parens in the region are
411 ;; collapsed to "()", "[]" etc.
412 ;;
413 ;; This function might do hidden buffer changes.
414
415 (save-excursion
416 (save-restriction
417 (narrow-to-region from to)
418 (goto-char from)
419 (let* ((parts (list nil)) (tail parts) pos in-paren)
420
421 (while (re-search-forward c-syntactic-ws-start to t)
422 (goto-char (setq pos (match-beginning 0)))
423 (c-forward-syntactic-ws)
424 (if (= (point) pos)
425 (forward-char)
426
427 (when paren-level
428 (save-excursion
429 (setq in-paren (= (car (parse-partial-sexp from pos 1)) 1)
430 pos (point))))
431
432 (if (and (> pos from)
433 (< (point) to)
434 (looking-at "\\w\\|\\s_")
435 (save-excursion
436 (goto-char (1- pos))
437 (looking-at "\\w\\|\\s_")))
438 (progn
439 (setcdr tail (list (buffer-substring-no-properties from pos)
440 " "))
441 (setq tail (cddr tail)))
442 (setcdr tail (list (buffer-substring-no-properties from pos)))
443 (setq tail (cdr tail)))
444
445 (when in-paren
446 (when (= (car (parse-partial-sexp pos to -1)) -1)
447 (setcdr tail (list (buffer-substring-no-properties
448 (1- (point)) (point))))
449 (setq tail (cdr tail))))
450
451 (setq from (point))))
452
453 (setcdr tail (list (buffer-substring-no-properties from to)))
454 (apply 'concat (cdr parts))))))
455
456 (defun c-shift-line-indentation (shift-amt)
457 ;; Shift the indentation of the current line with the specified
458 ;; amount (positive inwards). The buffer is modified only if
459 ;; SHIFT-AMT isn't equal to zero.
460 (let ((pos (- (point-max) (point)))
461 (c-macro-start c-macro-start)
462 tmp-char-inserted)
463 (if (zerop shift-amt)
464 nil
465 ;; If we're on an empty line inside a macro, we take the point
466 ;; to be at the current indentation and shift it to the
467 ;; appropriate column. This way we don't treat the extra
468 ;; whitespace out to the line continuation as indentation.
469 (when (and (c-query-and-set-macro-start)
470 (looking-at "[ \t]*\\\\$")
471 (save-excursion
472 (skip-chars-backward " \t")
473 (bolp)))
474 (insert ?x)
475 (backward-char)
476 (setq tmp-char-inserted t))
477 (unwind-protect
478 (let ((col (current-indentation)))
479 (delete-region (c-point 'bol) (c-point 'boi))
480 (beginning-of-line)
481 (indent-to (+ col shift-amt)))
482 (when tmp-char-inserted
483 (delete-char 1))))
484 ;; If initial point was within line's indentation and we're not on
485 ;; a line with a line continuation in a macro, position after the
486 ;; indentation. Else stay at same point in text.
487 (if (and (< (point) (c-point 'boi))
488 (not tmp-char-inserted))
489 (back-to-indentation)
490 (if (> (- (point-max) pos) (point))
491 (goto-char (- (point-max) pos))))))
492
493 (defsubst c-keyword-sym (keyword)
494 ;; Return non-nil if the string KEYWORD is a known keyword. More
495 ;; precisely, the value is the symbol for the keyword in
496 ;; `c-keywords-obarray'.
497 (intern-soft keyword c-keywords-obarray))
498
499 (defsubst c-keyword-member (keyword-sym lang-constant)
500 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
501 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
502 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
503 ;; nil then the result is nil.
504 (get keyword-sym lang-constant))
505
506 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
507 (defconst c-string-syntax (if (memq 'gen-string-delim c-emacs-features)
508 "\"|"
509 "\""))
510
511 ;; Regexp matching string limit syntax.
512 (defconst c-string-limit-regexp (if (memq 'gen-string-delim c-emacs-features)
513 "\\s\"\\|\\s|"
514 "\\s\""))
515
516 ;; Regexp matching WS followed by string limit syntax.
517 (defconst c-ws*-string-limit-regexp
518 (concat "[ \t]*\\(" c-string-limit-regexp "\\)"))
519
520 ;; Holds formatted error strings for the few cases where parse errors
521 ;; are reported.
522 (defvar c-parsing-error nil)
523 (make-variable-buffer-local 'c-parsing-error)
524
525 (defun c-echo-parsing-error (&optional quiet)
526 (when (and c-report-syntactic-errors c-parsing-error (not quiet))
527 (c-benign-error "%s" c-parsing-error))
528 c-parsing-error)
529
530 ;; Faces given to comments and string literals. This is used in some
531 ;; situations to speed up recognition; it isn't mandatory that font
532 ;; locking is in use. This variable is extended with the face in
533 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
534 (defvar c-literal-faces
535 (append '(font-lock-comment-face font-lock-string-face)
536 (when (facep 'font-lock-comment-delimiter-face)
537 ;; New in Emacs 22.
538 '(font-lock-comment-delimiter-face))))
539
540 (defsubst c-put-c-type-property (pos value)
541 ;; Put a c-type property with the given value at POS.
542 (c-put-char-property pos 'c-type value))
543
544 (defun c-clear-c-type-property (from to value)
545 ;; Remove all occurrences of the c-type property that has the given
546 ;; value in the region between FROM and TO. VALUE is assumed to not
547 ;; be nil.
548 ;;
549 ;; Note: This assumes that c-type is put on single chars only; it's
550 ;; very inefficient if matching properties cover large regions.
551 (save-excursion
552 (goto-char from)
553 (while (progn
554 (when (eq (get-text-property (point) 'c-type) value)
555 (c-clear-char-property (point) 'c-type))
556 (goto-char (c-next-single-property-change (point) 'c-type nil to))
557 (< (point) to)))))
558
559 \f
560 ;; Some debug tools to visualize various special positions. This
561 ;; debug code isn't as portable as the rest of CC Mode.
562
563 (cc-bytecomp-defun overlays-in)
564 (cc-bytecomp-defun overlay-get)
565 (cc-bytecomp-defun overlay-start)
566 (cc-bytecomp-defun overlay-end)
567 (cc-bytecomp-defun delete-overlay)
568 (cc-bytecomp-defun overlay-put)
569 (cc-bytecomp-defun make-overlay)
570
571 (defun c-debug-add-face (beg end face)
572 (c-save-buffer-state ((overlays (overlays-in beg end)) overlay)
573 (while overlays
574 (setq overlay (car overlays)
575 overlays (cdr overlays))
576 (when (eq (overlay-get overlay 'face) face)
577 (setq beg (min beg (overlay-start overlay))
578 end (max end (overlay-end overlay)))
579 (delete-overlay overlay)))
580 (overlay-put (make-overlay beg end) 'face face)))
581
582 (defun c-debug-remove-face (beg end face)
583 (c-save-buffer-state ((overlays (overlays-in beg end)) overlay
584 (ol-beg beg) (ol-end end))
585 (while overlays
586 (setq overlay (car overlays)
587 overlays (cdr overlays))
588 (when (eq (overlay-get overlay 'face) face)
589 (setq ol-beg (min ol-beg (overlay-start overlay))
590 ol-end (max ol-end (overlay-end overlay)))
591 (delete-overlay overlay)))
592 (when (< ol-beg beg)
593 (overlay-put (make-overlay ol-beg beg) 'face face))
594 (when (> ol-end end)
595 (overlay-put (make-overlay end ol-end) 'face face))))
596
597 \f
598 ;; `c-beginning-of-statement-1' and accompanying stuff.
599
600 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
601 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
602 ;; better way should be implemented, but this will at least shut up
603 ;; the byte compiler.
604 (defvar c-maybe-labelp)
605
606 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
607
608 ;; Macros used internally in c-beginning-of-statement-1 for the
609 ;; automaton actions.
610 (defmacro c-bos-push-state ()
611 '(setq stack (cons (cons state saved-pos)
612 stack)))
613 (defmacro c-bos-pop-state (&optional do-if-done)
614 `(if (setq state (car (car stack))
615 saved-pos (cdr (car stack))
616 stack (cdr stack))
617 t
618 ,do-if-done
619 (throw 'loop nil)))
620 (defmacro c-bos-pop-state-and-retry ()
621 '(throw 'loop (setq state (car (car stack))
622 saved-pos (cdr (car stack))
623 ;; Throw nil if stack is empty, else throw non-nil.
624 stack (cdr stack))))
625 (defmacro c-bos-save-pos ()
626 '(setq saved-pos (vector pos tok ptok pptok)))
627 (defmacro c-bos-restore-pos ()
628 '(unless (eq (elt saved-pos 0) start)
629 (setq pos (elt saved-pos 0)
630 tok (elt saved-pos 1)
631 ptok (elt saved-pos 2)
632 pptok (elt saved-pos 3))
633 (goto-char pos)
634 (setq sym nil)))
635 (defmacro c-bos-save-error-info (missing got)
636 `(setq saved-pos (vector pos ,missing ,got)))
637 (defmacro c-bos-report-error ()
638 '(unless noerror
639 (setq c-parsing-error
640 (format-message
641 "No matching `%s' found for `%s' on line %d"
642 (elt saved-pos 1)
643 (elt saved-pos 2)
644 (1+ (count-lines (point-min)
645 (c-point 'bol (elt saved-pos 0))))))))
646
647 (defun c-beginning-of-statement-1 (&optional lim ignore-labels
648 noerror comma-delim)
649 "Move to the start of the current statement or declaration, or to
650 the previous one if already at the beginning of one. Only
651 statements/declarations on the same level are considered, i.e. don't
652 move into or out of sexps (not even normal expression parentheses).
653
654 If point is already at the earliest statement within braces or parens,
655 this function doesn't move back into any whitespace preceding it; it
656 returns `same' in this case.
657
658 Stop at statement continuation tokens like \"else\", \"catch\",
659 \"finally\" and the \"while\" in \"do ... while\" if the start point
660 is within the continuation. If starting at such a token, move to the
661 corresponding statement start. If at the beginning of a statement,
662 move to the closest containing statement if there is any. This might
663 also stop at a continuation clause.
664
665 Labels are treated as part of the following statements if
666 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
667 statement start keyword.) Otherwise, each label is treated as a
668 separate statement.
669
670 Macros are ignored \(i.e. skipped over) unless point is within one, in
671 which case the content of the macro is treated as normal code. Aside
672 from any normal statement starts found in it, stop at the first token
673 of the content in the macro, i.e. the expression of an \"#if\" or the
674 start of the definition in a \"#define\". Also stop at start of
675 macros before leaving them.
676
677 Return:
678 `label' if stopped at a label or \"case...:\" or \"default:\";
679 `same' if stopped at the beginning of the current statement;
680 `up' if stepped to a containing statement;
681 `previous' if stepped to a preceding statement;
682 `beginning' if stepped from a statement continuation clause to
683 its start clause; or
684 `macro' if stepped to a macro start.
685 Note that `same' and not `label' is returned if stopped at the same
686 label without crossing the colon character.
687
688 LIM may be given to limit the search. If the search hits the limit,
689 point will be left at the closest following token, or at the start
690 position if that is less (`same' is returned in this case).
691
692 NOERROR turns off error logging to `c-parsing-error'.
693
694 Normally only `;' and virtual semicolons are considered to delimit
695 statements, but if COMMA-DELIM is non-nil then `,' is treated
696 as a delimiter too.
697
698 Note that this function might do hidden buffer changes. See the
699 comment at the start of cc-engine.el for more info."
700
701 ;; The bulk of this function is a pushdown automaton that looks at statement
702 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
703 ;; purpose is to keep track of nested statements, ensuring that such
704 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
705 ;; does with nested braces/brackets/parentheses).
706 ;;
707 ;; Note: The position of a boundary is the following token.
708 ;;
709 ;; Beginning with the current token (the one following point), move back one
710 ;; sexp at a time (where a sexp is, more or less, either a token or the
711 ;; entire contents of a brace/bracket/paren pair). Each time a statement
712 ;; boundary is crossed or a "while"-like token is found, update the state of
713 ;; the PDA. Stop at the beginning of a statement when the stack (holding
714 ;; nested statement info) is empty and the position has been moved.
715 ;;
716 ;; The following variables constitute the PDA:
717 ;;
718 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
719 ;; scanned back over, 'boundary if we've just gone back over a
720 ;; statement boundary, or nil otherwise.
721 ;; state: takes one of the values (nil else else-boundary while
722 ;; while-boundary catch catch-boundary).
723 ;; nil means "no "while"-like token yet scanned".
724 ;; 'else, for example, means "just gone back over an else".
725 ;; 'else-boundary means "just gone back over a statement boundary
726 ;; immediately after having gone back over an else".
727 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
728 ;; of error reporting information.
729 ;; stack: The stack onto which the PDA pushes its state. Each entry
730 ;; consists of a saved value of state and saved-pos. An entry is
731 ;; pushed when we move back over a "continuation" token (e.g. else)
732 ;; and popped when we encounter the corresponding opening token
733 ;; (e.g. if).
734 ;;
735 ;;
736 ;; The following diagram briefly outlines the PDA.
737 ;;
738 ;; Common state:
739 ;; "else": Push state, goto state `else'.
740 ;; "while": Push state, goto state `while'.
741 ;; "catch" or "finally": Push state, goto state `catch'.
742 ;; boundary: Pop state.
743 ;; other: Do nothing special.
744 ;;
745 ;; State `else':
746 ;; boundary: Goto state `else-boundary'.
747 ;; other: Error, pop state, retry token.
748 ;;
749 ;; State `else-boundary':
750 ;; "if": Pop state.
751 ;; boundary: Error, pop state.
752 ;; other: See common state.
753 ;;
754 ;; State `while':
755 ;; boundary: Save position, goto state `while-boundary'.
756 ;; other: Pop state, retry token.
757 ;;
758 ;; State `while-boundary':
759 ;; "do": Pop state.
760 ;; boundary: Restore position if it's not at start, pop state. [*see below]
761 ;; other: See common state.
762 ;;
763 ;; State `catch':
764 ;; boundary: Goto state `catch-boundary'.
765 ;; other: Error, pop state, retry token.
766 ;;
767 ;; State `catch-boundary':
768 ;; "try": Pop state.
769 ;; "catch": Goto state `catch'.
770 ;; boundary: Error, pop state.
771 ;; other: See common state.
772 ;;
773 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
774 ;; searching for a "do" which would have opened a do-while. If we didn't
775 ;; find it, we discard the analysis done since the "while", go back to this
776 ;; token in the buffer and restart the scanning there, this time WITHOUT
777 ;; pushing the 'while state onto the stack.
778 ;;
779 ;; In addition to the above there is some special handling of labels
780 ;; and macros.
781
782 (let ((case-fold-search nil)
783 (start (point))
784 macro-start
785 (delims (if comma-delim '(?\; ?,) '(?\;)))
786 (c-stmt-delim-chars (if comma-delim
787 c-stmt-delim-chars-with-comma
788 c-stmt-delim-chars))
789 c-in-literal-cache c-maybe-labelp after-case:-pos saved
790 ;; Current position.
791 pos
792 ;; Position of last stmt boundary character (e.g. ;).
793 boundary-pos
794 ;; The position of the last sexp or bound that follows the
795 ;; first found colon, i.e. the start of the nonlabel part of
796 ;; the statement. It's `start' if a colon is found just after
797 ;; the start.
798 after-labels-pos
799 ;; Like `after-labels-pos', but the first such position inside
800 ;; a label, i.e. the start of the last label before the start
801 ;; of the nonlabel part of the statement.
802 last-label-pos
803 ;; The last position where a label is possible provided the
804 ;; statement started there. It's nil as long as no invalid
805 ;; label content has been found (according to
806 ;; `c-nonlabel-token-key'). It's `start' if no valid label
807 ;; content was found in the label. Note that we might still
808 ;; regard it a label if it starts with `c-label-kwds'.
809 label-good-pos
810 ;; Putative positions of the components of a bitfield declaration,
811 ;; e.g. "int foo : NUM_FOO_BITS ;"
812 bitfield-type-pos bitfield-id-pos bitfield-size-pos
813 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
814 ;; See above.
815 sym
816 ;; Current state in the automaton. See above.
817 state
818 ;; Current saved positions. See above.
819 saved-pos
820 ;; Stack of conses (state . saved-pos).
821 stack
822 ;; Regexp which matches "for", "if", etc.
823 (cond-key (or c-opt-block-stmt-key
824 "\\<\\>")) ; Matches nothing.
825 ;; Return value.
826 (ret 'same)
827 ;; Positions of the last three sexps or bounds we've stopped at.
828 tok ptok pptok)
829
830 (save-restriction
831 (if lim (narrow-to-region lim (point-max)))
832
833 (if (save-excursion
834 (and (c-beginning-of-macro)
835 (/= (point) start)))
836 (setq macro-start (point)))
837
838 ;; Try to skip back over unary operator characters, to register
839 ;; that we've moved.
840 (while (progn
841 (setq pos (point))
842 (c-backward-syntactic-ws)
843 ;; Protect post-++/-- operators just before a virtual semicolon.
844 (and (not (c-at-vsemi-p))
845 (/= (skip-chars-backward "-+!*&~@`#") 0))))
846
847 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
848 ;; done. Later on we ignore the boundaries for statements that don't
849 ;; contain any sexp. The only thing that is affected is that the error
850 ;; checking is a little less strict, and we really don't bother.
851 (if (and (memq (char-before) delims)
852 (progn (forward-char -1)
853 (setq saved (point))
854 (c-backward-syntactic-ws)
855 (or (memq (char-before) delims)
856 (memq (char-before) '(?: nil))
857 (eq (char-syntax (char-before)) ?\()
858 (c-at-vsemi-p))))
859 (setq ret 'previous
860 pos saved)
861
862 ;; Begin at start and not pos to detect macros if we stand
863 ;; directly after the #.
864 (goto-char start)
865 (if (looking-at "\\<\\|\\W")
866 ;; Record this as the first token if not starting inside it.
867 (setq tok start))
868
869 ;; The following while loop goes back one sexp (balanced parens,
870 ;; etc. with contents, or symbol or suchlike) each iteration. This
871 ;; movement is accomplished with a call to c-backward-sexp approx 170
872 ;; lines below.
873 ;;
874 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
875 ;; 1. On reaching the start of a macro;
876 ;; 2. On having passed a stmt boundary with the PDA stack empty;
877 ;; 3. On reaching the start of an Objective C method def;
878 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
879 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
880 (while
881 (catch 'loop ;; Throw nil to break, non-nil to continue.
882 (cond
883 ;; Are we in a macro, just after the opening #?
884 ((save-excursion
885 (and macro-start ; Always NIL for AWK.
886 (progn (skip-chars-backward " \t")
887 (eq (char-before) ?#))
888 (progn (setq saved (1- (point)))
889 (beginning-of-line)
890 (not (eq (char-before (1- (point))) ?\\)))
891 (looking-at c-opt-cpp-start)
892 (progn (skip-chars-forward " \t")
893 (eq (point) saved))))
894 (goto-char saved)
895 (if (and (c-forward-to-cpp-define-body)
896 (progn (c-forward-syntactic-ws start)
897 (< (point) start)))
898 ;; Stop at the first token in the content of the macro.
899 (setq pos (point)
900 ignore-labels t) ; Avoid the label check on exit.
901 (setq pos saved
902 ret 'macro
903 ignore-labels t))
904 (throw 'loop nil)) ; 1. Start of macro.
905
906 ;; Do a round through the automaton if we've just passed a
907 ;; statement boundary or passed a "while"-like token.
908 ((or sym
909 (and (looking-at cond-key)
910 (setq sym (intern (match-string 1)))))
911
912 (when (and (< pos start) (null stack))
913 (throw 'loop nil)) ; 2. Statement boundary.
914
915 ;; The PDA state handling.
916 ;;
917 ;; Refer to the description of the PDA in the opening
918 ;; comments. In the following OR form, the first leaf
919 ;; attempts to handles one of the specific actions detailed
920 ;; (e.g., finding token "if" whilst in state `else-boundary').
921 ;; We drop through to the second leaf (which handles common
922 ;; state) if no specific handler is found in the first cond.
923 ;; If a parsing error is detected (e.g. an "else" with no
924 ;; preceding "if"), we throw to the enclosing catch.
925 ;;
926 ;; Note that the (eq state 'else) means
927 ;; "we've just passed an else", NOT "we're looking for an
928 ;; else".
929 (or (cond
930 ((eq state 'else)
931 (if (eq sym 'boundary)
932 (setq state 'else-boundary)
933 (c-bos-report-error)
934 (c-bos-pop-state-and-retry)))
935
936 ((eq state 'else-boundary)
937 (cond ((eq sym 'if)
938 (c-bos-pop-state (setq ret 'beginning)))
939 ((eq sym 'boundary)
940 (c-bos-report-error)
941 (c-bos-pop-state))))
942
943 ((eq state 'while)
944 (if (and (eq sym 'boundary)
945 ;; Since this can cause backtracking we do a
946 ;; little more careful analysis to avoid it:
947 ;; If there's a label in front of the while
948 ;; it can't be part of a do-while.
949 (not after-labels-pos))
950 (progn (c-bos-save-pos)
951 (setq state 'while-boundary))
952 (c-bos-pop-state-and-retry))) ; Can't be a do-while
953
954 ((eq state 'while-boundary)
955 (cond ((eq sym 'do)
956 (c-bos-pop-state (setq ret 'beginning)))
957 ((eq sym 'boundary) ; isn't a do-while
958 (c-bos-restore-pos) ; the position of the while
959 (c-bos-pop-state)))) ; no longer searching for do.
960
961 ((eq state 'catch)
962 (if (eq sym 'boundary)
963 (setq state 'catch-boundary)
964 (c-bos-report-error)
965 (c-bos-pop-state-and-retry)))
966
967 ((eq state 'catch-boundary)
968 (cond
969 ((eq sym 'try)
970 (c-bos-pop-state (setq ret 'beginning)))
971 ((eq sym 'catch)
972 (setq state 'catch))
973 ((eq sym 'boundary)
974 (c-bos-report-error)
975 (c-bos-pop-state)))))
976
977 ;; This is state common. We get here when the previous
978 ;; cond statement found no particular state handler.
979 (cond ((eq sym 'boundary)
980 ;; If we have a boundary at the start
981 ;; position we push a frame to go to the
982 ;; previous statement.
983 (if (>= pos start)
984 (c-bos-push-state)
985 (c-bos-pop-state)))
986 ((eq sym 'else)
987 (c-bos-push-state)
988 (c-bos-save-error-info 'if 'else)
989 (setq state 'else))
990 ((eq sym 'while)
991 ;; Is this a real while, or a do-while?
992 ;; The next `when' triggers unless we are SURE that
993 ;; the `while' is not the tail end of a `do-while'.
994 (when (or (not pptok)
995 (memq (char-after pptok) delims)
996 ;; The following kludge is to prevent
997 ;; infinite recursion when called from
998 ;; c-awk-after-if-for-while-condition-p,
999 ;; or the like.
1000 (and (eq (point) start)
1001 (c-vsemi-status-unknown-p))
1002 (c-at-vsemi-p pptok))
1003 ;; Since this can cause backtracking we do a
1004 ;; little more careful analysis to avoid it: If
1005 ;; the while isn't followed by a (possibly
1006 ;; virtual) semicolon it can't be a do-while.
1007 (c-bos-push-state)
1008 (setq state 'while)))
1009 ((memq sym '(catch finally))
1010 (c-bos-push-state)
1011 (c-bos-save-error-info 'try sym)
1012 (setq state 'catch))))
1013
1014 (when c-maybe-labelp
1015 ;; We're either past a statement boundary or at the
1016 ;; start of a statement, so throw away any label data
1017 ;; for the previous one.
1018 (setq after-labels-pos nil
1019 last-label-pos nil
1020 c-maybe-labelp nil))))
1021
1022 ;; Step to the previous sexp, but not if we crossed a
1023 ;; boundary, since that doesn't consume an sexp.
1024 (if (eq sym 'boundary)
1025 (setq ret 'previous)
1026
1027 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
1028 ;; BACKWARDS THROUGH THE SOURCE.
1029
1030 (c-backward-syntactic-ws)
1031 (let ((before-sws-pos (point))
1032 ;; The end position of the area to search for statement
1033 ;; barriers in this round.
1034 (maybe-after-boundary-pos pos))
1035
1036 ;; Go back over exactly one logical sexp, taking proper
1037 ;; account of macros and escaped EOLs.
1038 (while
1039 (progn
1040 (unless (c-safe (c-backward-sexp) t)
1041 ;; Give up if we hit an unbalanced block. Since the
1042 ;; stack won't be empty the code below will report a
1043 ;; suitable error.
1044 (throw 'loop nil))
1045 (cond
1046 ;; Have we moved into a macro?
1047 ((and (not macro-start)
1048 (c-beginning-of-macro))
1049 ;; Have we crossed a statement boundary? If not,
1050 ;; keep going back until we find one or a "real" sexp.
1051 (and
1052 (save-excursion
1053 (c-end-of-macro)
1054 (not (c-crosses-statement-barrier-p
1055 (point) maybe-after-boundary-pos)))
1056 (setq maybe-after-boundary-pos (point))))
1057 ;; Have we just gone back over an escaped NL? This
1058 ;; doesn't count as a sexp.
1059 ((looking-at "\\\\$")))))
1060
1061 ;; Have we crossed a statement boundary?
1062 (setq boundary-pos
1063 (cond
1064 ;; Are we at a macro beginning?
1065 ((and (not macro-start)
1066 c-opt-cpp-prefix
1067 (looking-at c-opt-cpp-prefix))
1068 (save-excursion
1069 (c-end-of-macro)
1070 (c-crosses-statement-barrier-p
1071 (point) maybe-after-boundary-pos)))
1072 ;; Just gone back over a brace block?
1073 ((and
1074 (eq (char-after) ?{)
1075 (not (c-looking-at-inexpr-block lim nil t))
1076 (save-excursion
1077 (c-backward-token-2 1 t nil)
1078 (not (looking-at "=\\([^=]\\|$\\)"))))
1079 (save-excursion
1080 (c-forward-sexp) (point)))
1081 ;; Just gone back over some paren block?
1082 ((looking-at "\\s(")
1083 (save-excursion
1084 (goto-char (1+ (c-down-list-backward
1085 before-sws-pos)))
1086 (c-crosses-statement-barrier-p
1087 (point) maybe-after-boundary-pos)))
1088 ;; Just gone back over an ordinary symbol of some sort?
1089 (t (c-crosses-statement-barrier-p
1090 (point) maybe-after-boundary-pos))))
1091
1092 (when boundary-pos
1093 (setq pptok ptok
1094 ptok tok
1095 tok boundary-pos
1096 sym 'boundary)
1097 ;; Like a C "continue". Analyze the next sexp.
1098 (throw 'loop t))))
1099
1100 ;; ObjC method def?
1101 (when (and c-opt-method-key
1102 (setq saved (c-in-method-def-p)))
1103 (setq pos saved
1104 ignore-labels t) ; Avoid the label check on exit.
1105 (throw 'loop nil)) ; 3. ObjC method def.
1106
1107 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1108 (if c-has-bitfields
1109 (cond
1110 ;; The : <size> and <id> fields?
1111 ((and (numberp c-maybe-labelp)
1112 (not bitfield-size-pos)
1113 (save-excursion
1114 (goto-char (or tok start))
1115 (not (looking-at c-keywords-regexp)))
1116 (not (looking-at c-keywords-regexp))
1117 (not (c-punctuation-in (point) c-maybe-labelp)))
1118 (setq bitfield-size-pos (or tok start)
1119 bitfield-id-pos (point)))
1120 ;; The <type> field?
1121 ((and bitfield-id-pos
1122 (not bitfield-type-pos))
1123 (if (and (looking-at c-symbol-key) ; Can only be an integer type. :-)
1124 (not (looking-at c-not-primitive-type-keywords-regexp))
1125 (not (c-punctuation-in (point) tok)))
1126 (setq bitfield-type-pos (point))
1127 (setq bitfield-size-pos nil
1128 bitfield-id-pos nil)))))
1129
1130 ;; Handle labels.
1131 (unless (eq ignore-labels t)
1132 (when (numberp c-maybe-labelp)
1133 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1134 ;; might be in a label now. Have we got a real label
1135 ;; (including a case label) or something like C++'s "public:"?
1136 ;; A case label might use an expression rather than a token.
1137 (setq after-case:-pos (or tok start))
1138 (if (or (looking-at c-nonlabel-token-key) ; e.g. "while" or "'a'"
1139 ;; Catch C++'s inheritance construct "class foo : bar".
1140 (save-excursion
1141 (and
1142 (c-safe (c-backward-sexp) t)
1143 (looking-at c-nonlabel-token-2-key))))
1144 (setq c-maybe-labelp nil)
1145 (if after-labels-pos ; Have we already encountered a label?
1146 (if (not last-label-pos)
1147 (setq last-label-pos (or tok start)))
1148 (setq after-labels-pos (or tok start)))
1149 (setq c-maybe-labelp t
1150 label-good-pos nil))) ; bogus "label"
1151
1152 (when (and (not label-good-pos) ; i.e. no invalid "label"'s yet
1153 ; been found.
1154 (looking-at c-nonlabel-token-key)) ; e.g. "while :"
1155 ;; We're in a potential label and it's the first
1156 ;; time we've found something that isn't allowed in
1157 ;; one.
1158 (setq label-good-pos (or tok start))))
1159
1160 ;; We've moved back by a sexp, so update the token positions.
1161 (setq sym nil
1162 pptok ptok
1163 ptok tok
1164 tok (point)
1165 pos tok) ; always non-nil
1166 ) ; end of (catch loop ....)
1167 ) ; end of sexp-at-a-time (while ....)
1168
1169 ;; If the stack isn't empty there might be errors to report.
1170 (while stack
1171 (if (and (vectorp saved-pos) (eq (length saved-pos) 3))
1172 (c-bos-report-error))
1173 (setq saved-pos (cdr (car stack))
1174 stack (cdr stack)))
1175
1176 (when (and (eq ret 'same)
1177 (not (memq sym '(boundary ignore nil))))
1178 ;; Need to investigate closer whether we've crossed
1179 ;; between a substatement and its containing statement.
1180 (if (setq saved
1181 (cond ((and (looking-at c-block-stmt-1-2-key)
1182 (eq (char-after ptok) ?\())
1183 pptok)
1184 ((looking-at c-block-stmt-1-key)
1185 ptok)
1186 (t pptok)))
1187 (cond ((> start saved) (setq pos saved))
1188 ((= start saved) (setq ret 'up)))))
1189
1190 (when (and (not ignore-labels)
1191 (eq c-maybe-labelp t)
1192 (not (eq ret 'beginning))
1193 after-labels-pos
1194 (not bitfield-type-pos) ; Bitfields take precedence over labels.
1195 (or (not label-good-pos)
1196 (<= label-good-pos pos)
1197 (progn
1198 (goto-char (if (and last-label-pos
1199 (< last-label-pos start))
1200 last-label-pos
1201 pos))
1202 (looking-at c-label-kwds-regexp))))
1203 ;; We're in a label. Maybe we should step to the statement
1204 ;; after it.
1205 (if (< after-labels-pos start)
1206 (setq pos after-labels-pos)
1207 (setq ret 'label)
1208 (if (and last-label-pos (< last-label-pos start))
1209 ;; Might have jumped over several labels. Go to the last one.
1210 (setq pos last-label-pos)))))
1211
1212 ;; Have we got "case <expression>:"?
1213 (goto-char pos)
1214 (when (and after-case:-pos
1215 (not (eq ret 'beginning))
1216 (looking-at c-case-kwds-regexp))
1217 (if (< after-case:-pos start)
1218 (setq pos after-case:-pos))
1219 (if (eq ret 'same)
1220 (setq ret 'label)))
1221
1222 ;; Skip over the unary operators that can start the statement.
1223 (while (progn
1224 (c-backward-syntactic-ws)
1225 ;; protect AWK post-inc/decrement operators, etc.
1226 (and (not (c-at-vsemi-p (point)))
1227 (/= (skip-chars-backward "-+!*&~@`#") 0)))
1228 (setq pos (point)))
1229 (goto-char pos)
1230 ret)))
1231
1232 (defun c-punctuation-in (from to)
1233 "Return non-nil if there is a non-comment non-macro punctuation character
1234 between FROM and TO. FROM must not be in a string or comment. The returned
1235 value is the position of the first such character."
1236 (save-excursion
1237 (goto-char from)
1238 (let ((pos (point)))
1239 (while (progn (skip-chars-forward c-symbol-chars to)
1240 (c-forward-syntactic-ws to)
1241 (> (point) pos))
1242 (setq pos (point))))
1243 (and (< (point) to) (point))))
1244
1245 (defun c-crosses-statement-barrier-p (from to)
1246 "Return non-nil if buffer positions FROM to TO cross one or more
1247 statement or declaration boundaries. The returned value is actually
1248 the position of the earliest boundary char. FROM must not be within
1249 a string or comment.
1250
1251 The variable `c-maybe-labelp' is set to the position of the first `:' that
1252 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1253 single `?' is found, then `c-maybe-labelp' is cleared.
1254
1255 For AWK, a statement which is terminated by an EOL (not a ; or a }) is
1256 regarded as having a \"virtual semicolon\" immediately after the last token on
1257 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1258
1259 Note that this function might do hidden buffer changes. See the
1260 comment at the start of cc-engine.el for more info."
1261 (let* ((skip-chars
1262 ;; If the current language has CPP macros, insert # into skip-chars.
1263 (if c-opt-cpp-symbol
1264 (concat (substring c-stmt-delim-chars 0 1) ; "^"
1265 c-opt-cpp-symbol ; usually "#"
1266 (substring c-stmt-delim-chars 1)) ; e.g. ";{}?:"
1267 c-stmt-delim-chars))
1268 (non-skip-list
1269 (append (substring skip-chars 1) nil)) ; e.g. (?# ?\; ?{ ?} ?? ?:)
1270 lit-range vsemi-pos)
1271 (save-restriction
1272 (widen)
1273 (save-excursion
1274 (catch 'done
1275 (goto-char from)
1276 (while (progn (skip-chars-forward
1277 skip-chars
1278 (min to (c-point 'bonl)))
1279 (< (point) to))
1280 (cond
1281 ;; Virtual semicolon?
1282 ((and (bolp)
1283 (save-excursion
1284 (progn
1285 (if (setq lit-range (c-literal-limits from)) ; Have we landed in a string/comment?
1286 (goto-char (car lit-range)))
1287 (c-backward-syntactic-ws) ; ? put a limit here, maybe?
1288 (setq vsemi-pos (point))
1289 (c-at-vsemi-p))))
1290 (throw 'done vsemi-pos))
1291 ;; In a string/comment?
1292 ((setq lit-range (c-literal-limits from))
1293 (goto-char (cdr lit-range)))
1294 ((eq (char-after) ?:)
1295 (forward-char)
1296 (if (and (eq (char-after) ?:)
1297 (< (point) to))
1298 ;; Ignore scope operators.
1299 (forward-char)
1300 (setq c-maybe-labelp (1- (point)))))
1301 ((eq (char-after) ??)
1302 ;; A question mark. Can't be a label, so stop
1303 ;; looking for more : and ?.
1304 (setq c-maybe-labelp nil
1305 skip-chars (substring c-stmt-delim-chars 0 -2)))
1306 ;; At a CPP construct or a "#" or "##" operator?
1307 ((and c-opt-cpp-symbol (looking-at c-opt-cpp-symbol))
1308 (if (save-excursion
1309 (skip-chars-backward " \t")
1310 (and (bolp)
1311 (or (bobp)
1312 (not (eq (char-before (1- (point))) ?\\)))))
1313 (c-end-of-macro)
1314 (skip-chars-forward c-opt-cpp-symbol)))
1315 ((memq (char-after) non-skip-list)
1316 (throw 'done (point)))))
1317 ;; In trailing space after an as yet undetected virtual semicolon?
1318 (c-backward-syntactic-ws from)
1319 (when (and (bolp) (not (bobp))) ; Can happen in AWK Mode with an
1320 ; unterminated string/regexp.
1321 (backward-char))
1322 (if (and (< (point) to)
1323 (c-at-vsemi-p))
1324 (point)
1325 nil))))))
1326
1327 (defun c-at-statement-start-p ()
1328 "Return non-nil if the point is at the first token in a statement
1329 or somewhere in the syntactic whitespace before it.
1330
1331 A \"statement\" here is not restricted to those inside code blocks.
1332 Any kind of declaration-like construct that occur outside function
1333 bodies is also considered a \"statement\".
1334
1335 Note that this function might do hidden buffer changes. See the
1336 comment at the start of cc-engine.el for more info."
1337
1338 (save-excursion
1339 (let ((end (point))
1340 c-maybe-labelp)
1341 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1342 (or (bobp)
1343 (eq (char-before) ?})
1344 (and (eq (char-before) ?{)
1345 (not (and c-special-brace-lists
1346 (progn (backward-char)
1347 (c-looking-at-special-brace-list)))))
1348 (c-crosses-statement-barrier-p (point) end)))))
1349
1350 (defun c-at-expression-start-p ()
1351 "Return non-nil if the point is at the first token in an expression or
1352 statement, or somewhere in the syntactic whitespace before it.
1353
1354 An \"expression\" here is a bit different from the normal language
1355 grammar sense: It's any sequence of expression tokens except commas,
1356 unless they are enclosed inside parentheses of some kind. Also, an
1357 expression never continues past an enclosing parenthesis, but it might
1358 contain parenthesis pairs of any sort except braces.
1359
1360 Since expressions never cross statement boundaries, this function also
1361 recognizes statement beginnings, just like `c-at-statement-start-p'.
1362
1363 Note that this function might do hidden buffer changes. See the
1364 comment at the start of cc-engine.el for more info."
1365
1366 (save-excursion
1367 (let ((end (point))
1368 (c-stmt-delim-chars c-stmt-delim-chars-with-comma)
1369 c-maybe-labelp)
1370 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1371 (or (bobp)
1372 (memq (char-before) '(?{ ?}))
1373 (save-excursion (backward-char)
1374 (looking-at "\\s("))
1375 (c-crosses-statement-barrier-p (point) end)))))
1376
1377 \f
1378 ;; A set of functions that covers various idiosyncrasies in
1379 ;; implementations of `forward-comment'.
1380
1381 ;; Note: Some emacsen considers incorrectly that any line comment
1382 ;; ending with a backslash continues to the next line. I can't think
1383 ;; of any way to work around that in a reliable way without changing
1384 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1385 ;; changing the syntax for backslash doesn't work since we must treat
1386 ;; escapes in string literals correctly.)
1387
1388 (defun c-forward-single-comment ()
1389 "Move forward past whitespace and the closest following comment, if any.
1390 Return t if a comment was found, nil otherwise. In either case, the
1391 point is moved past the following whitespace. Line continuations,
1392 i.e. a backslashes followed by line breaks, are treated as whitespace.
1393 The line breaks that end line comments are considered to be the
1394 comment enders, so the point will be put on the beginning of the next
1395 line if it moved past a line comment.
1396
1397 This function does not do any hidden buffer changes."
1398
1399 (let ((start (point)))
1400 (when (looking-at "\\([ \t\n\r\f\v]\\|\\\\[\n\r]\\)+")
1401 (goto-char (match-end 0)))
1402
1403 (when (forward-comment 1)
1404 (if (eobp)
1405 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1406 ;; forwards at eob.
1407 nil
1408
1409 ;; Emacs includes the ending newline in a b-style (c++)
1410 ;; comment, but XEmacs doesn't. We depend on the Emacs
1411 ;; behavior (which also is symmetric).
1412 (if (and (eolp) (elt (parse-partial-sexp start (point)) 7))
1413 (condition-case nil (forward-char 1)))
1414
1415 t))))
1416
1417 (defsubst c-forward-comments ()
1418 "Move forward past all following whitespace and comments.
1419 Line continuations, i.e. a backslashes followed by line breaks, are
1420 treated as whitespace.
1421
1422 Note that this function might do hidden buffer changes. See the
1423 comment at the start of cc-engine.el for more info."
1424
1425 (while (or
1426 ;; If forward-comment in at least XEmacs 21 is given a large
1427 ;; positive value, it'll loop all the way through if it hits
1428 ;; eob.
1429 (and (forward-comment 5)
1430 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1431 ;; forwards at eob.
1432 (not (eobp)))
1433
1434 (when (looking-at "\\\\[\n\r]")
1435 (forward-char 2)
1436 t))))
1437
1438 (defun c-backward-single-comment ()
1439 "Move backward past whitespace and the closest preceding comment, if any.
1440 Return t if a comment was found, nil otherwise. In either case, the
1441 point is moved past the preceding whitespace. Line continuations,
1442 i.e. a backslashes followed by line breaks, are treated as whitespace.
1443 The line breaks that end line comments are considered to be the
1444 comment enders, so the point cannot be at the end of the same line to
1445 move over a line comment.
1446
1447 This function does not do any hidden buffer changes."
1448
1449 (let ((start (point)))
1450 ;; When we got newline terminated comments, forward-comment in all
1451 ;; supported emacsen so far will stop at eol of each line not
1452 ;; ending with a comment when moving backwards. This corrects for
1453 ;; that, and at the same time handles line continuations.
1454 (while (progn
1455 (skip-chars-backward " \t\n\r\f\v")
1456 (and (looking-at "[\n\r]")
1457 (eq (char-before) ?\\)))
1458 (backward-char))
1459
1460 (if (bobp)
1461 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1462 ;; backwards at bob.
1463 nil
1464
1465 ;; Leave point after the closest following newline if we've
1466 ;; backed up over any above, since forward-comment won't move
1467 ;; backward over a line comment if point is at the end of the
1468 ;; same line.
1469 (re-search-forward "\\=\\s *[\n\r]" start t)
1470
1471 (if (if (forward-comment -1)
1472 (if (eolp)
1473 ;; If forward-comment above succeeded and we're at eol
1474 ;; then the newline we moved over above didn't end a
1475 ;; line comment, so we give it another go.
1476 (forward-comment -1)
1477 t))
1478
1479 ;; Emacs <= 20 and XEmacs move back over the closer of a
1480 ;; block comment that lacks an opener.
1481 (if (looking-at "\\*/")
1482 (progn (forward-char 2) nil)
1483 t)))))
1484
1485 (defsubst c-backward-comments ()
1486 "Move backward past all preceding whitespace and comments.
1487 Line continuations, i.e. a backslashes followed by line breaks, are
1488 treated as whitespace. The line breaks that end line comments are
1489 considered to be the comment enders, so the point cannot be at the end
1490 of the same line to move over a line comment. Unlike
1491 c-backward-syntactic-ws, this function doesn't move back over
1492 preprocessor directives.
1493
1494 Note that this function might do hidden buffer changes. See the
1495 comment at the start of cc-engine.el for more info."
1496
1497 (let ((start (point)))
1498 (while (and
1499 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1500 ;; return t when moving backwards at bob.
1501 (not (bobp))
1502
1503 (if (let (moved-comment)
1504 (while
1505 (and (not (setq moved-comment (forward-comment -1)))
1506 ;; Cope specifically with ^M^J here -
1507 ;; forward-comment sometimes gets stuck after ^Ms,
1508 ;; sometimes after ^M^J.
1509 (or
1510 (when (eq (char-before) ?\r)
1511 (backward-char)
1512 t)
1513 (when (and (eq (char-before) ?\n)
1514 (eq (char-before (1- (point))) ?\r))
1515 (backward-char 2)
1516 t))))
1517 moved-comment)
1518 (if (looking-at "\\*/")
1519 ;; Emacs <= 20 and XEmacs move back over the
1520 ;; closer of a block comment that lacks an opener.
1521 (progn (forward-char 2) nil)
1522 t)
1523
1524 ;; XEmacs treats line continuations as whitespace but
1525 ;; only in the backward direction, which seems a bit
1526 ;; odd. Anyway, this is necessary for Emacs.
1527 (when (and (looking-at "[\n\r]")
1528 (eq (char-before) ?\\)
1529 (< (point) start))
1530 (backward-char)
1531 t))))))
1532
1533 \f
1534 ;; Tools for skipping over syntactic whitespace.
1535
1536 ;; The following functions use text properties to cache searches over
1537 ;; large regions of syntactic whitespace. It works as follows:
1538 ;;
1539 ;; o If a syntactic whitespace region contains anything but simple
1540 ;; whitespace (i.e. space, tab and line breaks), the text property
1541 ;; `c-in-sws' is put over it. At places where we have stopped
1542 ;; within that region there's also a `c-is-sws' text property.
1543 ;; That since there typically are nested whitespace inside that
1544 ;; must be handled separately, e.g. whitespace inside a comment or
1545 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1546 ;; to jump to another point with that property within the same
1547 ;; `c-in-sws' region. It can be likened to a ladder where
1548 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1549 ;;
1550 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1551 ;; a "rung position" and also maybe on the first following char.
1552 ;; As many characters as can be conveniently found in this range
1553 ;; are marked, but no assumption can be made that the whole range
1554 ;; is marked (it could be clobbered by later changes, for
1555 ;; instance).
1556 ;;
1557 ;; Note that some part of the beginning of a sequence of simple
1558 ;; whitespace might be part of the end of a preceding line comment
1559 ;; or cpp directive and must not be considered part of the "rung".
1560 ;; Such whitespace is some amount of horizontal whitespace followed
1561 ;; by a newline. In the case of cpp directives it could also be
1562 ;; two newlines with horizontal whitespace between them.
1563 ;;
1564 ;; The reason to include the first following char is to cope with
1565 ;; "rung positions" that don't have any ordinary whitespace. If
1566 ;; `c-is-sws' is put on a token character it does not have
1567 ;; `c-in-sws' set simultaneously. That's the only case when that
1568 ;; can occur, and the reason for not extending the `c-in-sws'
1569 ;; region to cover it is that the `c-in-sws' region could then be
1570 ;; accidentally merged with a following one if the token is only
1571 ;; one character long.
1572 ;;
1573 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1574 ;; removed in the changed region. If the change was inside
1575 ;; syntactic whitespace that means that the "ladder" is broken, but
1576 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1577 ;; parts on either side and use an ordinary search only to "repair"
1578 ;; the gap.
1579 ;;
1580 ;; Special care needs to be taken if a region is removed: If there
1581 ;; are `c-in-sws' on both sides of it which do not connect inside
1582 ;; the region then they can't be joined. If e.g. a marked macro is
1583 ;; broken, syntactic whitespace inside the new text might be
1584 ;; marked. If those marks would become connected with the old
1585 ;; `c-in-sws' range around the macro then we could get a ladder
1586 ;; with one end outside the macro and the other at some whitespace
1587 ;; within it.
1588 ;;
1589 ;; The main motivation for this system is to increase the speed in
1590 ;; skipping over the large whitespace regions that can occur at the
1591 ;; top level in e.g. header files that contain a lot of comments and
1592 ;; cpp directives. For small comments inside code it's probably
1593 ;; slower than using `forward-comment' straightforwardly, but speed is
1594 ;; not a significant factor there anyway.
1595
1596 ; (defface c-debug-is-sws-face
1597 ; '((t (:background "GreenYellow")))
1598 ; "Debug face to mark the `c-is-sws' property.")
1599 ; (defface c-debug-in-sws-face
1600 ; '((t (:underline t)))
1601 ; "Debug face to mark the `c-in-sws' property.")
1602
1603 ; (defun c-debug-put-sws-faces ()
1604 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1605 ; ;; properties in the buffer.
1606 ; (interactive)
1607 ; (save-excursion
1608 ; (c-save-buffer-state (in-face)
1609 ; (goto-char (point-min))
1610 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1611 ; (point)))
1612 ; (while (progn
1613 ; (goto-char (next-single-property-change
1614 ; (point) 'c-is-sws nil (point-max)))
1615 ; (if in-face
1616 ; (progn
1617 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1618 ; (setq in-face nil))
1619 ; (setq in-face (point)))
1620 ; (not (eobp))))
1621 ; (goto-char (point-min))
1622 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1623 ; (point)))
1624 ; (while (progn
1625 ; (goto-char (next-single-property-change
1626 ; (point) 'c-in-sws nil (point-max)))
1627 ; (if in-face
1628 ; (progn
1629 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1630 ; (setq in-face nil))
1631 ; (setq in-face (point)))
1632 ; (not (eobp)))))))
1633
1634 (defmacro c-debug-sws-msg (&rest args)
1635 ;;`(message ,@args)
1636 )
1637
1638 (defmacro c-put-is-sws (beg end)
1639 ;; This macro does a hidden buffer change.
1640 `(let ((beg ,beg) (end ,end))
1641 (put-text-property beg end 'c-is-sws t)
1642 ,@(when (facep 'c-debug-is-sws-face)
1643 `((c-debug-add-face beg end 'c-debug-is-sws-face)))))
1644
1645 (defmacro c-put-in-sws (beg end)
1646 ;; This macro does a hidden buffer change.
1647 `(let ((beg ,beg) (end ,end))
1648 (put-text-property beg end 'c-in-sws t)
1649 ,@(when (facep 'c-debug-is-sws-face)
1650 `((c-debug-add-face beg end 'c-debug-in-sws-face)))))
1651
1652 (defmacro c-remove-is-sws (beg end)
1653 ;; This macro does a hidden buffer change.
1654 `(let ((beg ,beg) (end ,end))
1655 (remove-text-properties beg end '(c-is-sws nil))
1656 ,@(when (facep 'c-debug-is-sws-face)
1657 `((c-debug-remove-face beg end 'c-debug-is-sws-face)))))
1658
1659 (defmacro c-remove-in-sws (beg end)
1660 ;; This macro does a hidden buffer change.
1661 `(let ((beg ,beg) (end ,end))
1662 (remove-text-properties beg end '(c-in-sws nil))
1663 ,@(when (facep 'c-debug-is-sws-face)
1664 `((c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1665
1666 (defmacro c-remove-is-and-in-sws (beg end)
1667 ;; This macro does a hidden buffer change.
1668 `(let ((beg ,beg) (end ,end))
1669 (remove-text-properties beg end '(c-is-sws nil c-in-sws nil))
1670 ,@(when (facep 'c-debug-is-sws-face)
1671 `((c-debug-remove-face beg end 'c-debug-is-sws-face)
1672 (c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1673
1674 (defsubst c-invalidate-sws-region-after (beg end)
1675 ;; Called from `after-change-functions'. Note that if
1676 ;; `c-forward-sws' or `c-backward-sws' are used outside
1677 ;; `c-save-buffer-state' or similar then this will remove the cache
1678 ;; properties right after they're added.
1679 ;;
1680 ;; This function does hidden buffer changes.
1681
1682 (save-excursion
1683 ;; Adjust the end to remove the properties in any following simple
1684 ;; ws up to and including the next line break, if there is any
1685 ;; after the changed region. This is necessary e.g. when a rung
1686 ;; marked empty line is converted to a line comment by inserting
1687 ;; "//" before the line break. In that case the line break would
1688 ;; keep the rung mark which could make a later `c-backward-sws'
1689 ;; move into the line comment instead of over it.
1690 (goto-char end)
1691 (skip-chars-forward " \t\f\v")
1692 (when (and (eolp) (not (eobp)))
1693 (setq end (1+ (point)))))
1694
1695 (when (and (= beg end)
1696 (get-text-property beg 'c-in-sws)
1697 (> beg (point-min))
1698 (get-text-property (1- beg) 'c-in-sws))
1699 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1700 ;; safe to keep a range that was continuous before the change. E.g:
1701 ;;
1702 ;; #define foo
1703 ;; \
1704 ;; bar
1705 ;;
1706 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1707 ;; after "foo" is removed then "bar" will become part of the cpp
1708 ;; directive instead of a syntactically relevant token. In that
1709 ;; case there's no longer syntactic ws from "#" to "b".
1710 (setq beg (1- beg)))
1711
1712 (c-debug-sws-msg "c-invalidate-sws-region-after [%s..%s]" beg end)
1713 (c-remove-is-and-in-sws beg end))
1714
1715 (defun c-forward-sws ()
1716 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1717 ;;
1718 ;; This function might do hidden buffer changes.
1719
1720 (let (;; `rung-pos' is set to a position as early as possible in the
1721 ;; unmarked part of the simple ws region.
1722 (rung-pos (point)) next-rung-pos rung-end-pos last-put-in-sws-pos
1723 rung-is-marked next-rung-is-marked simple-ws-end
1724 ;; `safe-start' is set when it's safe to cache the start position.
1725 ;; It's not set if we've initially skipped over comments and line
1726 ;; continuations since we might have gone out through the end of a
1727 ;; macro then. This provision makes `c-forward-sws' not populate the
1728 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1729 ;; more common.
1730 safe-start)
1731
1732 ;; Skip simple ws and do a quick check on the following character to see
1733 ;; if it's anything that can't start syntactic ws, so we can bail out
1734 ;; early in the majority of cases when there just are a few ws chars.
1735 (skip-chars-forward " \t\n\r\f\v")
1736 (when (or (looking-at c-syntactic-ws-start)
1737 (and c-opt-cpp-prefix
1738 (looking-at c-noise-macro-name-re)))
1739
1740 (setq rung-end-pos (min (1+ (point)) (point-max)))
1741 (if (setq rung-is-marked (text-property-any rung-pos rung-end-pos
1742 'c-is-sws t))
1743 ;; Find the last rung position to avoid setting properties in all
1744 ;; the cases when the marked rung is complete.
1745 ;; (`next-single-property-change' is certain to move at least one
1746 ;; step forward.)
1747 (setq rung-pos (1- (c-next-single-property-change
1748 rung-is-marked 'c-is-sws nil rung-end-pos)))
1749 ;; Got no marked rung here. Since the simple ws might have started
1750 ;; inside a line comment or cpp directive we must set `rung-pos' as
1751 ;; high as possible.
1752 (setq rung-pos (point)))
1753
1754 (with-silent-modifications
1755 (while
1756 (progn
1757 ;; In the following while form, we move over a "ladder" and
1758 ;; following simple WS each time round the loop, appending the WS
1759 ;; onto the ladder, joining adjacent ladders, and terminating when
1760 ;; there is no more WS or we reach EOB.
1761 (while
1762 (when (and rung-is-marked
1763 (get-text-property (point) 'c-in-sws))
1764
1765 ;; The following search is the main reason that `c-in-sws'
1766 ;; and `c-is-sws' aren't combined to one property.
1767 (goto-char (c-next-single-property-change
1768 (point) 'c-in-sws nil (point-max)))
1769 (unless (get-text-property (point) 'c-is-sws)
1770 ;; If the `c-in-sws' region extended past the last
1771 ;; `c-is-sws' char we have to go back a bit.
1772 (or (get-text-property (1- (point)) 'c-is-sws)
1773 (goto-char (previous-single-property-change
1774 (point) 'c-is-sws)))
1775 (backward-char))
1776
1777 (c-debug-sws-msg
1778 "c-forward-sws cached move %s -> %s (max %s)"
1779 rung-pos (point) (point-max))
1780
1781 (setq rung-pos (point))
1782 (and (> (skip-chars-forward " \t\n\r\f\v") 0)
1783 (not (eobp))))
1784
1785 ;; We'll loop here if there is simple ws after the last rung.
1786 ;; That means that there's been some change in it and it's
1787 ;; possible that we've stepped into another ladder, so extend
1788 ;; the previous one to join with it if there is one, and try to
1789 ;; use the cache again.
1790 (c-debug-sws-msg
1791 "c-forward-sws extending rung with [%s..%s] (max %s)"
1792 (1+ rung-pos) (1+ (point)) (point-max))
1793 (unless (get-text-property (point) 'c-is-sws)
1794 ;; Remove any `c-in-sws' property from the last char of
1795 ;; the rung before we mark it with `c-is-sws', so that we
1796 ;; won't connect with the remains of a broken "ladder".
1797 (c-remove-in-sws (point) (1+ (point))))
1798 (c-put-is-sws (1+ rung-pos)
1799 (1+ (point)))
1800 (c-put-in-sws rung-pos
1801 (setq rung-pos (point)
1802 last-put-in-sws-pos rung-pos)))
1803
1804 ;; Now move over any comments (x)or a CPP construct.
1805 (setq simple-ws-end (point))
1806 (c-forward-comments)
1807
1808 (cond
1809 ((/= (point) simple-ws-end)
1810 ;; Skipped over comments. Don't cache at eob in case the buffer
1811 ;; is narrowed.
1812 (not (eobp)))
1813
1814 ((save-excursion
1815 (and c-opt-cpp-prefix
1816 (looking-at c-opt-cpp-start)
1817 (progn (skip-chars-backward " \t")
1818 (bolp))
1819 (or (bobp)
1820 (progn (backward-char)
1821 (not (eq (char-before) ?\\))))))
1822 ;; Skip a preprocessor directive.
1823 (end-of-line)
1824 (while (and (eq (char-before) ?\\)
1825 (= (forward-line 1) 0))
1826 (end-of-line))
1827 (forward-line 1)
1828 (setq safe-start t)
1829 ;; Don't cache at eob in case the buffer is narrowed.
1830 (not (eobp)))
1831
1832 ((and c-opt-cpp-prefix
1833 (looking-at c-noise-macro-name-re))
1834 ;; Skip over a noise macro.
1835 (goto-char (match-end 1))
1836 (setq safe-start t)
1837 (not (eobp)))))
1838
1839 ;; We've searched over a piece of non-white syntactic ws. See if this
1840 ;; can be cached.
1841 (setq next-rung-pos (point))
1842 (skip-chars-forward " \t\n\r\f\v")
1843 (setq rung-end-pos (min (1+ (point)) (point-max)))
1844
1845 (if (or
1846 ;; Cache if we haven't skipped comments only, and if we started
1847 ;; either from a marked rung or from a completely uncached
1848 ;; position.
1849 (and safe-start
1850 (or rung-is-marked
1851 (not (get-text-property simple-ws-end 'c-in-sws))))
1852
1853 ;; See if there's a marked rung in the encountered simple ws. If
1854 ;; so then we can cache, unless `safe-start' is nil. Even then
1855 ;; we need to do this to check if the cache can be used for the
1856 ;; next step.
1857 (and (setq next-rung-is-marked
1858 (text-property-any next-rung-pos rung-end-pos
1859 'c-is-sws t))
1860 safe-start))
1861
1862 (progn
1863 (c-debug-sws-msg
1864 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1865 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1866 (point-max))
1867
1868 ;; Remove the properties for any nested ws that might be cached.
1869 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1870 ;; anyway.
1871 (c-remove-is-sws (1+ simple-ws-end) next-rung-pos)
1872 (unless (and rung-is-marked (= rung-pos simple-ws-end))
1873 (c-put-is-sws rung-pos
1874 (1+ simple-ws-end))
1875 (setq rung-is-marked t))
1876 (c-put-in-sws rung-pos
1877 (setq rung-pos (point)
1878 last-put-in-sws-pos rung-pos))
1879 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
1880 ;; Remove any `c-in-sws' property from the last char of
1881 ;; the rung before we mark it with `c-is-sws', so that we
1882 ;; won't connect with the remains of a broken "ladder".
1883 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
1884 (c-put-is-sws next-rung-pos
1885 rung-end-pos))
1886
1887 (c-debug-sws-msg
1888 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1889 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1890 (point-max))
1891
1892 ;; Set `rung-pos' for the next rung. It's the same thing here as
1893 ;; initially, except that the rung position is set as early as
1894 ;; possible since we can't be in the ending ws of a line comment or
1895 ;; cpp directive now.
1896 (if (setq rung-is-marked next-rung-is-marked)
1897 (setq rung-pos (1- (c-next-single-property-change
1898 rung-is-marked 'c-is-sws nil rung-end-pos)))
1899 (setq rung-pos next-rung-pos))
1900 (setq safe-start t)))
1901
1902 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1903 ;; another one after the point (which might occur when editing inside a
1904 ;; comment or macro).
1905 (when (eq last-put-in-sws-pos (point))
1906 (cond ((< last-put-in-sws-pos (point-max))
1907 (c-debug-sws-msg
1908 "c-forward-sws clearing at %s for cache separation"
1909 last-put-in-sws-pos)
1910 (c-remove-in-sws last-put-in-sws-pos
1911 (1+ last-put-in-sws-pos)))
1912 (t
1913 ;; If at eob we have to clear the last character before the end
1914 ;; instead since the buffer might be narrowed and there might
1915 ;; be a `c-in-sws' after (point-max). In this case it's
1916 ;; necessary to clear both properties.
1917 (c-debug-sws-msg
1918 "c-forward-sws clearing thoroughly at %s for cache separation"
1919 (1- last-put-in-sws-pos))
1920 (c-remove-is-and-in-sws (1- last-put-in-sws-pos)
1921 last-put-in-sws-pos))))
1922 ))))
1923
1924 (defun c-backward-sws ()
1925 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1926 ;;
1927 ;; This function might do hidden buffer changes.
1928
1929 (let (;; `rung-pos' is set to a position as late as possible in the unmarked
1930 ;; part of the simple ws region.
1931 (rung-pos (point)) next-rung-pos last-put-in-sws-pos
1932 rung-is-marked simple-ws-beg cmt-skip-pos)
1933
1934 ;; Skip simple horizontal ws and do a quick check on the preceding
1935 ;; character to see if it's anything that can't end syntactic ws, so we can
1936 ;; bail out early in the majority of cases when there just are a few ws
1937 ;; chars. Newlines are complicated in the backward direction, so we can't
1938 ;; skip over them.
1939 (skip-chars-backward " \t\f")
1940 (when (and (not (bobp))
1941 (save-excursion
1942 (backward-char)
1943 (or (looking-at c-syntactic-ws-end)
1944 (and c-opt-cpp-prefix
1945 (looking-at c-symbol-char-key)
1946 (progn (c-beginning-of-current-token)
1947 (looking-at c-noise-macro-name-re))))))
1948 ;; Try to find a rung position in the simple ws preceding point, so that
1949 ;; we can get a cache hit even if the last bit of the simple ws has
1950 ;; changed recently.
1951 (setq simple-ws-beg (point))
1952 (skip-chars-backward " \t\n\r\f\v")
1953 (if (setq rung-is-marked (text-property-any
1954 (point) (min (1+ rung-pos) (point-max))
1955 'c-is-sws t))
1956 ;; `rung-pos' will be the earliest marked position, which means that
1957 ;; there might be later unmarked parts in the simple ws region.
1958 ;; It's not worth the effort to fix that; the last part of the
1959 ;; simple ws is also typically edited often, so it could be wasted.
1960 (goto-char (setq rung-pos rung-is-marked))
1961 (goto-char simple-ws-beg))
1962
1963 (with-silent-modifications
1964 (while
1965 (progn
1966 ;; Each time round the next while form, we move back over a ladder
1967 ;; and append any simple WS preceding it, if possible joining with
1968 ;; the previous ladder.
1969 (while
1970 (when (and rung-is-marked
1971 (not (bobp))
1972 (get-text-property (1- (point)) 'c-in-sws))
1973
1974 ;; The following search is the main reason that `c-in-sws'
1975 ;; and `c-is-sws' aren't combined to one property.
1976 (goto-char (previous-single-property-change
1977 (point) 'c-in-sws nil (point-min)))
1978 (unless (get-text-property (point) 'c-is-sws)
1979 ;; If the `c-in-sws' region extended past the first
1980 ;; `c-is-sws' char we have to go forward a bit.
1981 (goto-char (c-next-single-property-change
1982 (point) 'c-is-sws)))
1983
1984 (c-debug-sws-msg
1985 "c-backward-sws cached move %s <- %s (min %s)"
1986 (point) rung-pos (point-min))
1987
1988 (setq rung-pos (point))
1989 (if (and (< (min (skip-chars-backward " \t\f\v")
1990 (progn
1991 (setq simple-ws-beg (point))
1992 (skip-chars-backward " \t\n\r\f\v")))
1993 0)
1994 (setq rung-is-marked
1995 (text-property-any (point) rung-pos
1996 'c-is-sws t)))
1997 t
1998 (goto-char simple-ws-beg)
1999 nil))
2000
2001 ;; We'll loop here if there is simple ws before the first rung.
2002 ;; That means that there's been some change in it and it's
2003 ;; possible that we've stepped into another ladder, so extend
2004 ;; the previous one to join with it if there is one, and try to
2005 ;; use the cache again.
2006 (c-debug-sws-msg
2007 "c-backward-sws extending rung with [%s..%s] (min %s)"
2008 rung-is-marked rung-pos (point-min))
2009 (unless (get-text-property (1- rung-pos) 'c-is-sws)
2010 ;; Remove any `c-in-sws' property from the last char of
2011 ;; the rung before we mark it with `c-is-sws', so that we
2012 ;; won't connect with the remains of a broken "ladder".
2013 (c-remove-in-sws (1- rung-pos) rung-pos))
2014 (c-put-is-sws rung-is-marked
2015 rung-pos)
2016 (c-put-in-sws rung-is-marked
2017 (1- rung-pos))
2018 (setq rung-pos rung-is-marked
2019 last-put-in-sws-pos rung-pos))
2020
2021 (c-backward-comments)
2022 (setq cmt-skip-pos (point))
2023
2024 (cond
2025 ((and c-opt-cpp-prefix
2026 (/= cmt-skip-pos simple-ws-beg)
2027 (c-beginning-of-macro))
2028 ;; Inside a cpp directive. See if it should be skipped over.
2029 (let ((cpp-beg (point)))
2030
2031 ;; Move back over all line continuations in the region skipped
2032 ;; over by `c-backward-comments'. If we go past it then we
2033 ;; started inside the cpp directive.
2034 (goto-char simple-ws-beg)
2035 (beginning-of-line)
2036 (while (and (> (point) cmt-skip-pos)
2037 (progn (backward-char)
2038 (eq (char-before) ?\\)))
2039 (beginning-of-line))
2040
2041 (if (< (point) cmt-skip-pos)
2042 ;; Don't move past the cpp directive if we began inside
2043 ;; it. Note that the position at the end of the last line
2044 ;; of the macro is also considered to be within it.
2045 (progn (goto-char cmt-skip-pos)
2046 nil)
2047
2048 ;; It's worthwhile to spend a little bit of effort on finding
2049 ;; the end of the macro, to get a good `simple-ws-beg'
2050 ;; position for the cache. Note that `c-backward-comments'
2051 ;; could have stepped over some comments before going into
2052 ;; the macro, and then `simple-ws-beg' must be kept on the
2053 ;; same side of those comments.
2054 (goto-char simple-ws-beg)
2055 (skip-chars-backward " \t\n\r\f\v")
2056 (if (eq (char-before) ?\\)
2057 (forward-char))
2058 (forward-line 1)
2059 (if (< (point) simple-ws-beg)
2060 ;; Might happen if comments after the macro were skipped
2061 ;; over.
2062 (setq simple-ws-beg (point)))
2063
2064 (goto-char cpp-beg)
2065 t)))
2066
2067 ((/= (save-excursion
2068 (skip-chars-forward " \t\n\r\f\v" simple-ws-beg)
2069 (setq next-rung-pos (point)))
2070 simple-ws-beg)
2071 ;; Skipped over comments. Must put point at the end of
2072 ;; the simple ws at point since we might be after a line
2073 ;; comment or cpp directive that's been partially
2074 ;; narrowed out, and we can't risk marking the simple ws
2075 ;; at the end of it.
2076 (goto-char next-rung-pos)
2077 t)
2078
2079 ((and c-opt-cpp-prefix
2080 (save-excursion
2081 (and (< (skip-syntax-backward "w_") 0)
2082 (progn (setq next-rung-pos (point))
2083 (looking-at c-noise-macro-name-re)))))
2084 ;; Skipped over a noise macro
2085 (goto-char next-rung-pos)
2086 t)))
2087
2088 ;; We've searched over a piece of non-white syntactic ws. See if this
2089 ;; can be cached.
2090 (setq next-rung-pos (point))
2091 (skip-chars-backward " \t\f\v")
2092
2093 (if (or
2094 ;; Cache if we started either from a marked rung or from a
2095 ;; completely uncached position.
2096 rung-is-marked
2097 (not (get-text-property (1- simple-ws-beg) 'c-in-sws))
2098
2099 ;; Cache if there's a marked rung in the encountered simple ws.
2100 (save-excursion
2101 (skip-chars-backward " \t\n\r\f\v")
2102 (text-property-any (point) (min (1+ next-rung-pos) (point-max))
2103 'c-is-sws t)))
2104
2105 (progn
2106 (c-debug-sws-msg
2107 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2108 (point) (1+ next-rung-pos)
2109 simple-ws-beg (min (1+ rung-pos) (point-max))
2110 (point-min))
2111
2112 ;; Remove the properties for any nested ws that might be cached.
2113 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2114 ;; anyway.
2115 (c-remove-is-sws (1+ next-rung-pos) simple-ws-beg)
2116 (unless (and rung-is-marked (= simple-ws-beg rung-pos))
2117 (let ((rung-end-pos (min (1+ rung-pos) (point-max))))
2118 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
2119 ;; Remove any `c-in-sws' property from the last char of
2120 ;; the rung before we mark it with `c-is-sws', so that we
2121 ;; won't connect with the remains of a broken "ladder".
2122 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
2123 (c-put-is-sws simple-ws-beg
2124 rung-end-pos)
2125 (setq rung-is-marked t)))
2126 (c-put-in-sws (setq simple-ws-beg (point)
2127 last-put-in-sws-pos simple-ws-beg)
2128 rung-pos)
2129 (c-put-is-sws (setq rung-pos simple-ws-beg)
2130 (1+ next-rung-pos)))
2131
2132 (c-debug-sws-msg
2133 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2134 (point) (1+ next-rung-pos)
2135 simple-ws-beg (min (1+ rung-pos) (point-max))
2136 (point-min))
2137 (setq rung-pos next-rung-pos
2138 simple-ws-beg (point))
2139 ))
2140
2141 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2142 ;; another one before the point (which might occur when editing inside a
2143 ;; comment or macro).
2144 (when (eq last-put-in-sws-pos (point))
2145 (cond ((< (point-min) last-put-in-sws-pos)
2146 (c-debug-sws-msg
2147 "c-backward-sws clearing at %s for cache separation"
2148 (1- last-put-in-sws-pos))
2149 (c-remove-in-sws (1- last-put-in-sws-pos)
2150 last-put-in-sws-pos))
2151 ((> (point-min) 1)
2152 ;; If at bob and the buffer is narrowed, we have to clear the
2153 ;; character we're standing on instead since there might be a
2154 ;; `c-in-sws' before (point-min). In this case it's necessary
2155 ;; to clear both properties.
2156 (c-debug-sws-msg
2157 "c-backward-sws clearing thoroughly at %s for cache separation"
2158 last-put-in-sws-pos)
2159 (c-remove-is-and-in-sws last-put-in-sws-pos
2160 (1+ last-put-in-sws-pos)))))
2161 ))))
2162
2163 \f
2164 ;; Other whitespace tools
2165 (defun c-partial-ws-p (beg end)
2166 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2167 ;; region? This is a "heuristic" function. .....
2168 ;;
2169 ;; The motivation for the second bit is to check whether removing this
2170 ;; region would coalesce two symbols.
2171 ;;
2172 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2173 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2174 (save-excursion
2175 (let ((end+1 (min (1+ end) (point-max))))
2176 (or (progn (goto-char (max (point-min) (1- beg)))
2177 (c-skip-ws-forward end)
2178 (eq (point) end))
2179 (progn (goto-char beg)
2180 (c-skip-ws-forward end+1)
2181 (eq (point) end+1))))))
2182 \f
2183 ;; A system for finding noteworthy parens before the point.
2184
2185 (defconst c-state-cache-too-far 5000)
2186 ;; A maximum comfortable scanning distance, e.g. between
2187 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2188 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2189 ;; the cache and starting again from point-min or a beginning of defun. This
2190 ;; value can be tuned for efficiency or set to a lower value for testing.
2191
2192 (defvar c-state-cache nil)
2193 (make-variable-buffer-local 'c-state-cache)
2194 ;; The state cache used by `c-parse-state' to cut down the amount of
2195 ;; searching. It's the result from some earlier `c-parse-state' call. See
2196 ;; `c-parse-state''s doc string for details of its structure.
2197 ;;
2198 ;; The use of the cached info is more effective if the next
2199 ;; `c-parse-state' call is on a line close by the one the cached state
2200 ;; was made at; the cache can actually slow down a little if the
2201 ;; cached state was made very far back in the buffer. The cache is
2202 ;; most effective if `c-parse-state' is used on each line while moving
2203 ;; forward.
2204
2205 (defvar c-state-cache-good-pos 1)
2206 (make-variable-buffer-local 'c-state-cache-good-pos)
2207 ;; This is a position where `c-state-cache' is known to be correct, or
2208 ;; nil (see below). It's a position inside one of the recorded unclosed
2209 ;; parens or the top level, but not further nested inside any literal or
2210 ;; subparen that is closed before the last recorded position.
2211 ;;
2212 ;; The exact position is chosen to try to be close to yet earlier than
2213 ;; the position where `c-state-cache' will be called next. Right now
2214 ;; the heuristic is to set it to the position after the last found
2215 ;; closing paren (of any type) before the line on which
2216 ;; `c-parse-state' was called. That is chosen primarily to work well
2217 ;; with refontification of the current line.
2218 ;;
2219 ;; 2009-07-28: When `c-state-point-min' and the last position where
2220 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2221 ;; both in the same literal, there is no such "good position", and
2222 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2223 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2224 ;;
2225 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2226 ;; the middle of the desert, as long as it is not within a brace pair
2227 ;; recorded in `c-state-cache' or a paren/bracket pair.
2228
2229 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2230 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2231 ;; speed up testing for non-literality.
2232 (defconst c-state-nonlit-pos-interval 3000)
2233 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2234
2235 (defvar c-state-nonlit-pos-cache nil)
2236 (make-variable-buffer-local 'c-state-nonlit-pos-cache)
2237 ;; A list of buffer positions which are known not to be in a literal or a cpp
2238 ;; construct. This is ordered with higher positions at the front of the list.
2239 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2240
2241 (defvar c-state-nonlit-pos-cache-limit 1)
2242 (make-variable-buffer-local 'c-state-nonlit-pos-cache-limit)
2243 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2244 ;; reduced by buffer changes, and increased by invocations of
2245 ;; `c-state-literal-at'.
2246
2247 (defvar c-state-semi-nonlit-pos-cache nil)
2248 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache)
2249 ;; A list of buffer positions which are known not to be in a literal. This is
2250 ;; ordered with higher positions at the front of the list. Only those which
2251 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2252
2253 (defvar c-state-semi-nonlit-pos-cache-limit 1)
2254 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache-limit)
2255 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2256 ;; reduced by buffer changes, and increased by invocations of
2257 ;; `c-state-literal-at'. FIXME!!!
2258
2259 (defsubst c-state-pp-to-literal (from to &optional not-in-delimiter)
2260 ;; Do a parse-partial-sexp from FROM to TO, returning either
2261 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2262 ;; (STATE) otherwise,
2263 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2264 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2265 ;;
2266 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2267 ;; comment opener, this is recognized as being in a comment literal.
2268 ;;
2269 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2270 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2271 ;; STATE are valid.
2272 (save-excursion
2273 (let ((s (parse-partial-sexp from to))
2274 ty co-st)
2275 (cond
2276 ((or (nth 3 s) (nth 4 s)) ; in a string or comment
2277 (setq ty (cond
2278 ((nth 3 s) 'string)
2279 ((nth 7 s) 'c++)
2280 (t 'c)))
2281 (parse-partial-sexp (point) (point-max)
2282 nil ; TARGETDEPTH
2283 nil ; STOPBEFORE
2284 s ; OLDSTATE
2285 'syntax-table) ; stop at end of literal
2286 `(,s ,ty (,(nth 8 s) . ,(point))))
2287
2288 ((and (not not-in-delimiter) ; inside a comment starter
2289 (not (bobp))
2290 (progn (backward-char)
2291 (and (not (looking-at "\\s!"))
2292 (looking-at c-comment-start-regexp))))
2293 (setq ty (if (looking-at c-block-comment-start-regexp) 'c 'c++)
2294 co-st (point))
2295 (forward-comment 1)
2296 `(,s ,ty (,co-st . ,(point))))
2297
2298 (t `(,s))))))
2299
2300 (defun c-state-safe-place (here)
2301 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2302 ;; string, comment, or macro.
2303 ;;
2304 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2305 ;; MAY NOT contain any positions within macros, since macros are frequently
2306 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2307 ;; We cannot rely on this mechanism whilst determining a cache pos since
2308 ;; this function is also called from outwith `c-parse-state'.
2309 (save-restriction
2310 (widen)
2311 (save-excursion
2312 (let ((c c-state-nonlit-pos-cache)
2313 pos npos high-pos lit macro-beg macro-end)
2314 ;; Trim the cache to take account of buffer changes.
2315 (while (and c (> (car c) c-state-nonlit-pos-cache-limit))
2316 (setq c (cdr c)))
2317 (setq c-state-nonlit-pos-cache c)
2318
2319 (while (and c (> (car c) here))
2320 (setq high-pos (car c))
2321 (setq c (cdr c)))
2322 (setq pos (or (car c) (point-min)))
2323
2324 (unless high-pos
2325 (while
2326 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2327 (and
2328 (setq npos
2329 (when (<= (+ pos c-state-nonlit-pos-interval) here)
2330 (+ pos c-state-nonlit-pos-interval)))
2331
2332 ;; Test for being in a literal. If so, go to after it.
2333 (progn
2334 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2335 (or (null lit)
2336 (prog1 (<= (cdr lit) here)
2337 (setq npos (cdr lit)))))
2338
2339 ;; Test for being in a macro. If so, go to after it.
2340 (progn
2341 (goto-char npos)
2342 (setq macro-beg
2343 (and (c-beginning-of-macro) (/= (point) npos) (point)))
2344 (when macro-beg
2345 (c-syntactic-end-of-macro)
2346 (or (eobp) (forward-char))
2347 (setq macro-end (point)))
2348 (or (null macro-beg)
2349 (prog1 (<= macro-end here)
2350 (setq npos macro-end)))))
2351
2352 (setq pos npos)
2353 (setq c-state-nonlit-pos-cache (cons pos c-state-nonlit-pos-cache)))
2354 ;; Add one extra element above HERE so as to to avoid the previous
2355 ;; expensive calculation when the next call is close to the current
2356 ;; one. This is especially useful when inside a large macro.
2357 (when npos
2358 (setq c-state-nonlit-pos-cache
2359 (cons npos c-state-nonlit-pos-cache))))
2360
2361 (if (> pos c-state-nonlit-pos-cache-limit)
2362 (setq c-state-nonlit-pos-cache-limit pos))
2363 pos))))
2364
2365 (defun c-state-semi-safe-place (here)
2366 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2367 ;; string or comment. It may be in a macro.
2368 (save-restriction
2369 (widen)
2370 (save-excursion
2371 (let ((c c-state-semi-nonlit-pos-cache)
2372 pos npos high-pos lit macro-beg macro-end)
2373 ;; Trim the cache to take account of buffer changes.
2374 (while (and c (> (car c) c-state-semi-nonlit-pos-cache-limit))
2375 (setq c (cdr c)))
2376 (setq c-state-semi-nonlit-pos-cache c)
2377
2378 (while (and c (> (car c) here))
2379 (setq high-pos (car c))
2380 (setq c (cdr c)))
2381 (setq pos (or (car c) (point-min)))
2382
2383 (unless high-pos
2384 (while
2385 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2386 (and
2387 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2388
2389 ;; Test for being in a literal. If so, go to after it.
2390 (progn
2391 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2392 (or (null lit)
2393 (prog1 (<= (cdr lit) here)
2394 (setq npos (cdr lit))))))
2395
2396 (setq pos npos)
2397 (setq c-state-semi-nonlit-pos-cache
2398 (cons pos c-state-semi-nonlit-pos-cache))))
2399
2400 (if (> pos c-state-semi-nonlit-pos-cache-limit)
2401 (setq c-state-semi-nonlit-pos-cache-limit pos))
2402 pos))))
2403
2404 (defun c-state-literal-at (here)
2405 ;; If position HERE is inside a literal, return (START . END), the
2406 ;; boundaries of the literal (which may be outside the accessible bit of the
2407 ;; buffer). Otherwise, return nil.
2408 ;;
2409 ;; This function is almost the same as `c-literal-limits'. Previously, it
2410 ;; differed in that it was a lower level function, and that it rigorously
2411 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2412 ;; virtually identical to this function.
2413 (save-restriction
2414 (widen)
2415 (save-excursion
2416 (let ((pos (c-state-safe-place here)))
2417 (car (cddr (c-state-pp-to-literal pos here)))))))
2418
2419 (defsubst c-state-lit-beg (pos)
2420 ;; Return the start of the literal containing POS, or POS itself.
2421 (or (car (c-state-literal-at pos))
2422 pos))
2423
2424 (defsubst c-state-cache-non-literal-place (pos state)
2425 ;; Return a position outside of a string/comment/macro at or before POS.
2426 ;; STATE is the parse-partial-sexp state at POS.
2427 (let ((res (if (or (nth 3 state) ; in a string?
2428 (nth 4 state)) ; in a comment?
2429 (nth 8 state)
2430 pos)))
2431 (save-excursion
2432 (goto-char res)
2433 (if (c-beginning-of-macro)
2434 (point)
2435 res))))
2436
2437 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2438 ;; Stuff to do with point-min, and coping with any literal there.
2439 (defvar c-state-point-min 1)
2440 (make-variable-buffer-local 'c-state-point-min)
2441 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2442 ;; narrowing is likely to affect the parens that are visible before the point.
2443
2444 (defvar c-state-point-min-lit-type nil)
2445 (make-variable-buffer-local 'c-state-point-min-lit-type)
2446 (defvar c-state-point-min-lit-start nil)
2447 (make-variable-buffer-local 'c-state-point-min-lit-start)
2448 ;; These two variables define the literal, if any, containing point-min.
2449 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2450 ;; literal. If there's no literal there, they're both nil.
2451
2452 (defvar c-state-min-scan-pos 1)
2453 (make-variable-buffer-local 'c-state-min-scan-pos)
2454 ;; This is the earliest buffer-pos from which scanning can be done. It is
2455 ;; either the end of the literal containing point-min, or point-min itself.
2456 ;; It becomes nil if the buffer is changed earlier than this point.
2457 (defun c-state-get-min-scan-pos ()
2458 ;; Return the lowest valid scanning pos. This will be the end of the
2459 ;; literal enclosing point-min, or point-min itself.
2460 (or c-state-min-scan-pos
2461 (save-restriction
2462 (save-excursion
2463 (widen)
2464 (goto-char c-state-point-min-lit-start)
2465 (if (eq c-state-point-min-lit-type 'string)
2466 (forward-sexp)
2467 (forward-comment 1))
2468 (setq c-state-min-scan-pos (point))))))
2469
2470 (defun c-state-mark-point-min-literal ()
2471 ;; Determine the properties of any literal containing POINT-MIN, setting the
2472 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2473 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2474 (let ((p-min (point-min))
2475 lit)
2476 (save-restriction
2477 (widen)
2478 (setq lit (c-state-literal-at p-min))
2479 (if lit
2480 (setq c-state-point-min-lit-type
2481 (save-excursion
2482 (goto-char (car lit))
2483 (cond
2484 ((looking-at c-block-comment-start-regexp) 'c)
2485 ((looking-at c-line-comment-starter) 'c++)
2486 (t 'string)))
2487 c-state-point-min-lit-start (car lit)
2488 c-state-min-scan-pos (cdr lit))
2489 (setq c-state-point-min-lit-type nil
2490 c-state-point-min-lit-start nil
2491 c-state-min-scan-pos p-min)))))
2492
2493
2494 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2495 ;; A variable which signals a brace dessert - helpful for reducing the number
2496 ;; of fruitless backward scans.
2497 (defvar c-state-brace-pair-desert nil)
2498 (make-variable-buffer-local 'c-state-brace-pair-desert)
2499 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2500 ;; that defun has searched backwards for a brace pair and not found one. Its
2501 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2502 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2503 ;; nil when at top level) and FROM is where the backward search started. It
2504 ;; is reset to nil in `c-invalidate-state-cache'.
2505
2506
2507 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2508 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2509 ;; list of like structure.
2510 (defmacro c-state-cache-top-lparen (&optional cache)
2511 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2512 ;; (default `c-state-cache') (or nil).
2513 (let ((cash (or cache 'c-state-cache)))
2514 `(if (consp (car ,cash))
2515 (caar ,cash)
2516 (car ,cash))))
2517
2518 (defmacro c-state-cache-top-paren (&optional cache)
2519 ;; Return the address of the latest brace/bracket/paren (whether left or
2520 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2521 (let ((cash (or cache 'c-state-cache)))
2522 `(if (consp (car ,cash))
2523 (cdar ,cash)
2524 (car ,cash))))
2525
2526 (defmacro c-state-cache-after-top-paren (&optional cache)
2527 ;; Return the position just after the latest brace/bracket/paren (whether
2528 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2529 (let ((cash (or cache 'c-state-cache)))
2530 `(if (consp (car ,cash))
2531 (cdar ,cash)
2532 (and (car ,cash)
2533 (1+ (car ,cash))))))
2534
2535 (defun c-get-cache-scan-pos (here)
2536 ;; From the state-cache, determine the buffer position from which we might
2537 ;; scan forward to HERE to update this cache. This position will be just
2538 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2539 ;; return the earliest position in the accessible region which isn't within
2540 ;; a literal. If the visible portion of the buffer is entirely within a
2541 ;; literal, return NIL.
2542 (let ((c c-state-cache) elt)
2543 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2544 (while (and c
2545 (>= (c-state-cache-top-lparen c) here))
2546 (setq c (cdr c)))
2547
2548 (setq elt (car c))
2549 (cond
2550 ((consp elt)
2551 (if (> (cdr elt) here)
2552 (1+ (car elt))
2553 (cdr elt)))
2554 (elt (1+ elt))
2555 ((<= (c-state-get-min-scan-pos) here)
2556 (c-state-get-min-scan-pos))
2557 (t nil))))
2558
2559 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2560 ;; Variables which keep track of preprocessor constructs.
2561 (defvar c-state-old-cpp-beg-marker nil)
2562 (make-variable-buffer-local 'c-state-old-cpp-beg-marker)
2563 (defvar c-state-old-cpp-beg nil)
2564 (make-variable-buffer-local 'c-state-old-cpp-beg)
2565 (defvar c-state-old-cpp-end-marker nil)
2566 (make-variable-buffer-local 'c-state-old-cpp-end-marker)
2567 (defvar c-state-old-cpp-end nil)
2568 (make-variable-buffer-local 'c-state-old-cpp-end)
2569 ;; These are the limits of the macro containing point at the previous call of
2570 ;; `c-parse-state', or nil.
2571
2572 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2573 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2574 (defun c-get-fallback-scan-pos (here)
2575 ;; Return a start position for building `c-state-cache' from
2576 ;; scratch. This will be at the top level, 2 defuns back.
2577 (save-excursion
2578 ;; Go back 2 bods, but ignore any bogus positions returned by
2579 ;; beginning-of-defun (i.e. open paren in column zero).
2580 (goto-char here)
2581 (let ((cnt 2))
2582 (while (not (or (bobp) (zerop cnt)))
2583 (c-beginning-of-defun-1) ; Pure elisp BOD.
2584 (if (eq (char-after) ?\{)
2585 (setq cnt (1- cnt)))))
2586 (point)))
2587
2588 (defun c-state-balance-parens-backwards (here- here+ top)
2589 ;; Return the position of the opening paren/brace/bracket before HERE- which
2590 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2591 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2592 ;;
2593 ;; ............................................
2594 ;; | |
2595 ;; ( [ ( .........#macro.. ) ( ) ] )
2596 ;; ^ ^ ^ ^
2597 ;; | | | |
2598 ;; return HERE- HERE+ TOP
2599 ;;
2600 ;; If there aren't enough opening paren/brace/brackets, return the position
2601 ;; of the outermost one found, or HERE- if there are none. If there are no
2602 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2603 ;; must not be inside literals. Only the accessible portion of the buffer
2604 ;; will be scanned.
2605
2606 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2607 ;; `here'. Go round the next loop each time we pass over such a ")". These
2608 ;; probably match "("s before `here-'.
2609 (let (pos pa ren+1 lonely-rens)
2610 (save-excursion
2611 (save-restriction
2612 (narrow-to-region (point-min) top) ; This can move point, sometimes.
2613 (setq pos here+)
2614 (c-safe
2615 (while
2616 (setq ren+1 (c-sc-scan-lists pos 1 1)) ; might signal
2617 (setq lonely-rens (cons ren+1 lonely-rens)
2618 pos ren+1)))))
2619
2620 ;; PART 2: Scan back before `here-' searching for the "("s
2621 ;; matching/mismatching the ")"s found above. We only need to direct the
2622 ;; caller to scan when we've encountered unmatched right parens.
2623 (setq pos here-)
2624 (when lonely-rens
2625 (c-safe
2626 (while
2627 (and lonely-rens ; actual values aren't used.
2628 (setq pa (c-sc-scan-lists pos -1 1)))
2629 (setq pos pa)
2630 (setq lonely-rens (cdr lonely-rens)))))
2631 pos))
2632
2633 (defun c-parse-state-get-strategy (here good-pos)
2634 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2635 ;; to minimize the amount of scanning. HERE is the pertinent position in
2636 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2637 ;; its head trimmed) is known to be good, or nil if there is no such
2638 ;; position.
2639 ;;
2640 ;; The return value is a list, one of the following:
2641 ;;
2642 ;; o - ('forward START-POINT) - scan forward from START-POINT,
2643 ;; which is not less than the highest position in `c-state-cache' below HERE,
2644 ;; which is after GOOD-POS.
2645 ;; o - ('backward nil) - scan backwards (from HERE).
2646 ;; o - ('back-and-forward START-POINT) - like 'forward, but when HERE is earlier
2647 ;; than GOOD-POS.
2648 ;; o - ('BOD START-POINT) - scan forwards from START-POINT, which is at the
2649 ;; top level.
2650 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
2651 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
2652 BOD-pos ; position of 2nd BOD before HERE.
2653 strategy ; 'forward, 'backward, 'BOD, or 'IN-LIT.
2654 start-point
2655 how-far) ; putative scanning distance.
2656 (setq good-pos (or good-pos (c-state-get-min-scan-pos)))
2657 (cond
2658 ((< here (c-state-get-min-scan-pos))
2659 (setq strategy 'IN-LIT
2660 start-point nil
2661 cache-pos nil
2662 how-far 0))
2663 ((<= good-pos here)
2664 (setq strategy 'forward
2665 start-point (max good-pos cache-pos)
2666 how-far (- here start-point)))
2667 ((< (- good-pos here) (- here cache-pos)) ; FIXME!!! ; apply some sort of weighting.
2668 (setq strategy 'backward
2669 how-far (- good-pos here)))
2670 (t
2671 (setq strategy 'back-and-forward
2672 start-point cache-pos
2673 how-far (- here start-point))))
2674
2675 ;; Might we be better off starting from the top level, two defuns back,
2676 ;; instead? This heuristic no longer works well in C++, where
2677 ;; declarations inside namespace brace blocks are frequently placed at
2678 ;; column zero. (2015-11-10): Remove the condition on C++ Mode.
2679 (when (and (or (not (memq 'col-0-paren c-emacs-features))
2680 open-paren-in-column-0-is-defun-start)
2681 ;; (not (c-major-mode-is 'c++-mode))
2682 (> how-far c-state-cache-too-far))
2683 (setq BOD-pos (c-get-fallback-scan-pos here)) ; somewhat EXPENSIVE!!!
2684 (if (< (- here BOD-pos) how-far)
2685 (setq strategy 'BOD
2686 start-point BOD-pos)))
2687
2688 (list strategy start-point)))
2689
2690
2691 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2692 ;; Routines which change `c-state-cache' and associated values.
2693 (defun c-renarrow-state-cache ()
2694 ;; The region (more precisely, point-min) has changed since we
2695 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2696 (if (< (point-min) c-state-point-min)
2697 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2698 ;; It would be possible to do a better job here and recalculate the top
2699 ;; only.
2700 (progn
2701 (c-state-mark-point-min-literal)
2702 (setq c-state-cache nil
2703 c-state-cache-good-pos c-state-min-scan-pos
2704 c-state-brace-pair-desert nil))
2705
2706 ;; point-min has MOVED FORWARD.
2707
2708 ;; Is the new point-min inside a (different) literal?
2709 (unless (and c-state-point-min-lit-start ; at prev. point-min
2710 (< (point-min) (c-state-get-min-scan-pos)))
2711 (c-state-mark-point-min-literal))
2712
2713 ;; Cut off a bit of the tail from `c-state-cache'.
2714 (let ((ptr (cons nil c-state-cache))
2715 pa)
2716 (while (and (setq pa (c-state-cache-top-lparen (cdr ptr)))
2717 (>= pa (point-min)))
2718 (setq ptr (cdr ptr)))
2719
2720 (when (consp ptr)
2721 (if (eq (cdr ptr) c-state-cache)
2722 (setq c-state-cache nil
2723 c-state-cache-good-pos c-state-min-scan-pos)
2724 (setcdr ptr nil)
2725 (setq c-state-cache-good-pos (1+ (c-state-cache-top-lparen))))
2726 )))
2727
2728 (setq c-state-point-min (point-min)))
2729
2730 (defun c-append-lower-brace-pair-to-state-cache (from here &optional upper-lim)
2731 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2732 ;; of nesting (not necessarily immediately preceding), push a cons onto
2733 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2734 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2735 ;; UPPER-LIM.
2736 ;;
2737 ;; Return non-nil when this has been done.
2738 ;;
2739 ;; The situation it copes with is this transformation:
2740 ;;
2741 ;; OLD: { (.) {...........}
2742 ;; ^ ^
2743 ;; FROM HERE
2744 ;;
2745 ;; NEW: { {....} (.) {.........
2746 ;; ^ ^ ^
2747 ;; LOWER BRACE PAIR HERE or HERE
2748 ;;
2749 ;; This routine should be fast. Since it can get called a LOT, we maintain
2750 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2751 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2752 (save-excursion
2753 (save-restriction
2754 (let* (new-cons
2755 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2756 (macro-start-or-from
2757 (progn (goto-char from)
2758 (c-beginning-of-macro)
2759 (point)))
2760 (bra ; Position of "{".
2761 ;; Don't start scanning in the middle of a CPP construct unless
2762 ;; it contains HERE - these constructs, in Emacs, are "commented
2763 ;; out" with category properties.
2764 (if (eq (c-get-char-property macro-start-or-from 'category)
2765 'c-cpp-delimiter)
2766 macro-start-or-from
2767 from))
2768 ce) ; Position of "}"
2769 (or upper-lim (setq upper-lim from))
2770
2771 ;; If we're essentially repeating a fruitless search, just give up.
2772 (unless (and c-state-brace-pair-desert
2773 (eq cache-pos (car c-state-brace-pair-desert))
2774 (or (null (car c-state-brace-pair-desert))
2775 (> from (car c-state-brace-pair-desert)))
2776 (<= from (cdr c-state-brace-pair-desert)))
2777 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2778 (let ((desert-lim
2779 (and c-state-brace-pair-desert
2780 (eq cache-pos (car c-state-brace-pair-desert))
2781 (>= from (cdr c-state-brace-pair-desert))
2782 (cdr c-state-brace-pair-desert)))
2783 ;; CACHE-LIM. This limit will be necessary when an opening
2784 ;; paren at `cache-pos' has just had its matching close paren
2785 ;; inserted into the buffer. `cache-pos' continues to be a
2786 ;; search bound, even though the algorithm below would skip
2787 ;; over the new paren pair.
2788 (cache-lim (and cache-pos (< cache-pos from) cache-pos)))
2789 (narrow-to-region
2790 (cond
2791 ((and desert-lim cache-lim)
2792 (max desert-lim cache-lim))
2793 (desert-lim)
2794 (cache-lim)
2795 ((point-min)))
2796 ;; The top limit is EOB to ensure that `bra' is inside the
2797 ;; accessible part of the buffer at the next scan operation.
2798 (1+ (buffer-size))))
2799
2800 ;; In the next pair of nested loops, the inner one moves back past a
2801 ;; pair of (mis-)matching parens or brackets; the outer one moves
2802 ;; back over a sequence of unmatched close brace/paren/bracket each
2803 ;; time round.
2804 (while
2805 (progn
2806 (c-safe
2807 (while
2808 (and (setq ce (c-sc-scan-lists bra -1 -1)) ; back past )/]/}; might signal
2809 (setq bra (c-sc-scan-lists ce -1 1)) ; back past (/[/{; might signal
2810 (or (> bra here) ;(> ce here)
2811 (and
2812 (< ce here)
2813 (or (not (eq (char-after bra) ?\{))
2814 (and (goto-char bra)
2815 (c-beginning-of-macro)
2816 (< (point) macro-start-or-from))))))))
2817 (and ce (< ce bra)))
2818 (setq bra ce)) ; If we just backed over an unbalanced closing
2819 ; brace, ignore it.
2820
2821 (if (and ce (< ce here) (< bra ce) (eq (char-after bra) ?\{))
2822 ;; We've found the desired brace-pair.
2823 (progn
2824 (setq new-cons (cons bra (1+ ce)))
2825 (cond
2826 ((consp (car c-state-cache))
2827 (setcar c-state-cache new-cons))
2828 ((and (numberp (car c-state-cache)) ; probably never happens
2829 (< ce (car c-state-cache)))
2830 (setcdr c-state-cache
2831 (cons new-cons (cdr c-state-cache))))
2832 (t (setq c-state-cache (cons new-cons c-state-cache)))))
2833
2834 ;; We haven't found a brace pair. Record this in the cache.
2835 (setq c-state-brace-pair-desert
2836 (cons (if (and ce (< bra ce) (> ce here)) ; {..} straddling HERE?
2837 bra
2838 (point-min))
2839 (min here from)))))))))
2840
2841 (defsubst c-state-push-any-brace-pair (bra+1 macro-start-or-here)
2842 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2843 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2844 ;; "push" "a" brace pair onto `c-state-cache'.
2845 ;;
2846 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2847 ;; otherwise push it normally.
2848 ;;
2849 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2850 ;; latter is inside a macro, not being a macro containing
2851 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2852 ;; base pair. This latter case is assumed to be rare.
2853 ;;
2854 ;; Note: POINT is not preserved in this routine.
2855 (if bra+1
2856 (if (or (> bra+1 macro-start-or-here)
2857 (progn (goto-char bra+1)
2858 (not (c-beginning-of-macro))))
2859 (setq c-state-cache
2860 (cons (cons (1- bra+1)
2861 (c-sc-scan-lists bra+1 1 1))
2862 (if (consp (car c-state-cache))
2863 (cdr c-state-cache)
2864 c-state-cache)))
2865 ;; N.B. This defsubst codes one method for the simple, normal case,
2866 ;; and a more sophisticated, slower way for the general case. Don't
2867 ;; eliminate this defsubst - it's a speed optimization.
2868 (c-append-lower-brace-pair-to-state-cache (1- bra+1) (point-max)))))
2869
2870 (defun c-append-to-state-cache (from here)
2871 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
2872 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
2873 ;;
2874 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2875 ;; any. Typically, it is immediately after it. It must not be inside a
2876 ;; literal.
2877 (let ((here-bol (c-point 'bol here))
2878 (macro-start-or-here
2879 (save-excursion (goto-char here)
2880 (if (c-beginning-of-macro)
2881 (point)
2882 here)))
2883 pa+1 ; pos just after an opening PAren (or brace).
2884 (ren+1 from) ; usually a pos just after an closing paREN etc.
2885 ; Is actually the pos. to scan for a (/{/[ from,
2886 ; which sometimes is after a silly )/}/].
2887 paren+1 ; Pos after some opening or closing paren.
2888 paren+1s ; A list of `paren+1's; used to determine a
2889 ; good-pos.
2890 bra+1 ; just after L bra-ce.
2891 bra+1s ; list of OLD values of bra+1.
2892 mstart) ; start of a macro.
2893
2894 (save-excursion
2895 (save-restriction
2896 (narrow-to-region (point-min) here)
2897 ;; Each time round the following loop, we enter a successively deeper
2898 ;; level of brace/paren nesting. (Except sometimes we "continue at
2899 ;; the existing level".) `pa+1' is a pos inside an opening
2900 ;; brace/paren/bracket, usually just after it.
2901 (while
2902 (progn
2903 ;; Each time round the next loop moves forward over an opening then
2904 ;; a closing brace/bracket/paren. This loop is white hot, so it
2905 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2906 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2907 ;; call of `scan-lists' signals an error, which happens when there
2908 ;; are no more b/b/p's to scan.
2909 (c-safe
2910 (while t
2911 (setq pa+1 (c-sc-scan-lists ren+1 1 -1) ; Into (/{/[; might signal
2912 paren+1s (cons pa+1 paren+1s))
2913 (setq ren+1 (c-sc-scan-lists pa+1 1 1)) ; Out of )/}/]; might signal
2914 (if (and (eq (char-before pa+1) ?{)) ; Check for a macro later.
2915 (setq bra+1 pa+1))
2916 (setcar paren+1s ren+1)))
2917
2918 (if (and pa+1 (> pa+1 ren+1))
2919 ;; We've just entered a deeper nesting level.
2920 (progn
2921 ;; Insert the brace pair (if present) and the single open
2922 ;; paren/brace/bracket into `c-state-cache' It cannot be
2923 ;; inside a macro, except one around point, because of what
2924 ;; `c-neutralize-syntax-in-CPP' has done.
2925 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2926 ;; Insert the opening brace/bracket/paren position.
2927 (setq c-state-cache (cons (1- pa+1) c-state-cache))
2928 ;; Clear admin stuff for the next more nested part of the scan.
2929 (setq ren+1 pa+1 pa+1 nil bra+1 nil bra+1s nil)
2930 t) ; Carry on the loop
2931
2932 ;; All open p/b/b's at this nesting level, if any, have probably
2933 ;; been closed by matching/mismatching ones. We're probably
2934 ;; finished - we just need to check for having found an
2935 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2936 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2937 (c-safe (setq ren+1 (c-sc-scan-lists ren+1 1 1)))))) ; acts as loop control.
2938
2939 ;; Record the final, innermost, brace-pair if there is one.
2940 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2941
2942 ;; Determine a good pos
2943 (while (and (setq paren+1 (car paren+1s))
2944 (> (if (> paren+1 macro-start-or-here)
2945 paren+1
2946 (goto-char paren+1)
2947 (setq mstart (and (c-beginning-of-macro)
2948 (point)))
2949 (or mstart paren+1))
2950 here-bol))
2951 (setq paren+1s (cdr paren+1s)))
2952 (cond
2953 ((and paren+1 mstart)
2954 (min paren+1 mstart))
2955 (paren+1)
2956 (t from))))))
2957
2958 (defun c-remove-stale-state-cache (start-point here pps-point)
2959 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2960 ;; not be in it when it is amended for position HERE. This may involve
2961 ;; replacing a CONS element for a brace pair containing HERE with its car.
2962 ;; Additionally, the "outermost" open-brace entry before HERE will be
2963 ;; converted to a cons if the matching close-brace is below HERE.
2964 ;;
2965 ;; START-POINT is a "maximal" "safe position" - there must be no open
2966 ;; parens/braces/brackets between START-POINT and HERE.
2967 ;;
2968 ;; As a second thing, calculate the result of parse-partial-sexp at
2969 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
2970 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2971 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2972 ;; needs to be FAST).
2973 ;;
2974 ;; Return a list (GOOD-POS SCAN-BACK-POS CONS-SEPARATED PPS-STATE), where
2975 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2976 ;; to be good (we aim for this to be as high as possible);
2977 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2978 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2979 ;; position to scan backwards from. It is the position of the "{" of the
2980 ;; last element to be removed from `c-state-cache', when that elt is a
2981 ;; cons, otherwise nil.
2982 ;; o - CONS-SEPARATED is t when a cons element in `c-state-cache' has been
2983 ;; replaced by its car because HERE lies inside the brace pair represented
2984 ;; by the cons.
2985 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2986 (save-excursion
2987 (save-restriction
2988 (narrow-to-region 1 (point-max))
2989 (let* ((in-macro-start ; start of macro containing HERE or nil.
2990 (save-excursion
2991 (goto-char here)
2992 (and (c-beginning-of-macro)
2993 (point))))
2994 (start-point-actual-macro-start ; Start of macro containing
2995 ; start-point or nil
2996 (and (< start-point here)
2997 (save-excursion
2998 (goto-char start-point)
2999 (and (c-beginning-of-macro)
3000 (point)))))
3001 (start-point-actual-macro-end ; End of this macro, (maybe
3002 ; HERE), or nil.
3003 (and start-point-actual-macro-start
3004 (save-excursion
3005 (goto-char start-point-actual-macro-start)
3006 (c-end-of-macro)
3007 (point))))
3008 pps-state ; Will be 9 or 10 elements long.
3009 pos
3010 upper-lim ; ,beyond which `c-state-cache' entries are removed
3011 scan-back-pos
3012 cons-separated
3013 pair-beg pps-point-state target-depth)
3014
3015 ;; Remove entries beyond HERE. Also remove any entries inside
3016 ;; a macro, unless HERE is in the same macro.
3017 (setq upper-lim
3018 (if (or (null c-state-old-cpp-beg)
3019 (and (> here c-state-old-cpp-beg)
3020 (< here c-state-old-cpp-end)))
3021 here
3022 (min here c-state-old-cpp-beg)))
3023 (while (and c-state-cache (>= (c-state-cache-top-lparen) upper-lim))
3024 (setq scan-back-pos (car-safe (car c-state-cache)))
3025 (setq c-state-cache (cdr c-state-cache)))
3026
3027 ;; If `upper-lim' is inside the last recorded brace pair, remove its
3028 ;; RBrace and indicate we'll need to search backwards for a previous
3029 ;; brace pair.
3030 (when (and c-state-cache
3031 (consp (car c-state-cache))
3032 (> (cdar c-state-cache) upper-lim))
3033 (setcar c-state-cache (caar c-state-cache))
3034 (setq scan-back-pos (car c-state-cache)
3035 cons-separated t))
3036
3037 ;; The next loop jumps forward out of a nested level of parens each
3038 ;; time round; the corresponding elements in `c-state-cache' are
3039 ;; removed. `pos' is just after the brace-pair or the open paren at
3040 ;; (car c-state-cache). There can be no open parens/braces/brackets
3041 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
3042 ;; due to the interface spec to this function.
3043 (setq pos (if (and start-point-actual-macro-end
3044 (not (eq start-point-actual-macro-start
3045 in-macro-start)))
3046 (1+ start-point-actual-macro-end) ; get outside the macro as
3047 ; marked by a `category' text property.
3048 start-point))
3049 (goto-char pos)
3050 (while (and c-state-cache
3051 (or (numberp (car c-state-cache)) ; Have we a { at all?
3052 (cdr c-state-cache))
3053 (< (point) here))
3054 (cond
3055 ((null pps-state) ; first time through
3056 (setq target-depth -1))
3057 ((eq (car pps-state) target-depth) ; found closing ),},]
3058 (setq target-depth (1- (car pps-state))))
3059 ;; Do nothing when we've merely reached pps-point.
3060 )
3061
3062 ;; Scan!
3063 (setq pps-state
3064 (c-sc-parse-partial-sexp
3065 (point) (if (< (point) pps-point) pps-point here)
3066 target-depth
3067 nil pps-state))
3068
3069 (if (= (point) pps-point)
3070 (setq pps-point-state pps-state))
3071
3072 (when (eq (car pps-state) target-depth)
3073 (setq pos (point)) ; POS is now just after an R-paren/brace.
3074 (cond
3075 ((and (consp (car c-state-cache))
3076 (eq (point) (cdar c-state-cache)))
3077 ;; We've just moved out of the paren pair containing the brace-pair
3078 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
3079 ;; and is potentially where the open brace of a cons in
3080 ;; c-state-cache will be.
3081 (setq pair-beg (car-safe (cdr c-state-cache))
3082 c-state-cache (cdr-safe (cdr c-state-cache)))) ; remove {}pair + containing Lparen.
3083 ((numberp (car c-state-cache))
3084 (setq pair-beg (car c-state-cache)
3085 c-state-cache (cdr c-state-cache))) ; remove this
3086 ; containing Lparen
3087 ((numberp (cadr c-state-cache))
3088 (setq pair-beg (cadr c-state-cache)
3089 c-state-cache (cddr c-state-cache))) ; Remove a paren pair
3090 ; together with enclosed brace pair.
3091 ;; (t nil) ; Ignore an unmated Rparen.
3092 )))
3093
3094 (if (< (point) pps-point)
3095 (setq pps-state (c-sc-parse-partial-sexp
3096 (point) pps-point
3097 nil nil ; TARGETDEPTH, STOPBEFORE
3098 pps-state)))
3099
3100 ;; If the last paren pair we moved out of was actually a brace pair,
3101 ;; insert it into `c-state-cache'.
3102 (when (and pair-beg (eq (char-after pair-beg) ?{))
3103 (if (consp (car-safe c-state-cache))
3104 (setq c-state-cache (cdr c-state-cache)))
3105 (setq c-state-cache (cons (cons pair-beg pos)
3106 c-state-cache)))
3107
3108 (list pos scan-back-pos cons-separated pps-state)))))
3109
3110 (defun c-remove-stale-state-cache-backwards (here)
3111 ;; Strip stale elements of `c-state-cache' by moving backwards through the
3112 ;; buffer, and inform the caller of the scenario detected.
3113 ;;
3114 ;; HERE is the position we're setting `c-state-cache' for.
3115 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
3116 ;; position in `c-state-cache' before HERE, or a position at or near
3117 ;; point-min which isn't in a literal.
3118 ;;
3119 ;; This function must only be called only when (> `c-state-cache-good-pos'
3120 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
3121 ;; optimized to eliminate (or minimize) scanning between these two
3122 ;; positions.
3123 ;;
3124 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3125 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3126 ;; could become so after missing elements are inserted into
3127 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3128 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3129 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3130 ;; before `here''s line, or the start of the literal containing it.
3131 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3132 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3133 ;; to scan backwards from.
3134 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3135 ;; POS and HERE which aren't recorded in `c-state-cache'.
3136 ;;
3137 ;; The comments in this defun use "paren" to mean parenthesis or square
3138 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3139 ;;
3140 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3141 ;; | | | | | |
3142 ;; CP E here D C good
3143 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
3144 (pos c-state-cache-good-pos)
3145 pa ren ; positions of "(" and ")"
3146 dropped-cons ; whether the last element dropped from `c-state-cache'
3147 ; was a cons (representing a brace-pair)
3148 good-pos ; see above.
3149 lit ; (START . END) of a literal containing some point.
3150 here-lit-start here-lit-end ; bounds of literal containing `here'
3151 ; or `here' itself.
3152 here- here+ ; start/end of macro around HERE, or HERE
3153 (here-bol (c-point 'bol here))
3154 (too-far-back (max (- here c-state-cache-too-far) (point-min))))
3155
3156 ;; Remove completely irrelevant entries from `c-state-cache'.
3157 (while (and c-state-cache
3158 (>= (setq pa (c-state-cache-top-lparen)) here))
3159 (setq dropped-cons (consp (car c-state-cache)))
3160 (setq c-state-cache (cdr c-state-cache))
3161 (setq pos pa))
3162 ;; At this stage, (>= pos here);
3163 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3164
3165 (cond
3166 ((and (consp (car c-state-cache))
3167 (> (cdar c-state-cache) here))
3168 ;; CASE 1: The top of the cache is a brace pair which now encloses
3169 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3170 ;; knowledge of what's inside these braces, we have no alternative but
3171 ;; to direct the caller to scan the buffer from the opening brace.
3172 (setq pos (caar c-state-cache))
3173 (setcar c-state-cache pos)
3174 (list (1+ pos) pos t)) ; return value. We've just converted a brace pair
3175 ; entry into a { entry, so the caller needs to
3176 ; search for a brace pair before the {.
3177
3178 ;; `here' might be inside a literal. Check for this.
3179 ((progn
3180 (setq lit (c-state-literal-at here)
3181 here-lit-start (or (car lit) here)
3182 here-lit-end (or (cdr lit) here))
3183 ;; Has `here' just "newly entered" a macro?
3184 (save-excursion
3185 (goto-char here-lit-start)
3186 (if (and (c-beginning-of-macro)
3187 (or (null c-state-old-cpp-beg)
3188 (not (= (point) c-state-old-cpp-beg))))
3189 (progn
3190 (setq here- (point))
3191 (c-end-of-macro)
3192 (setq here+ (point)))
3193 (setq here- here-lit-start
3194 here+ here-lit-end)))
3195
3196 ;; `here' might be nested inside any depth of parens (or brackets but
3197 ;; not braces). Scan backwards to find the outermost such opening
3198 ;; paren, if there is one. This will be the scan position to return.
3199 (save-restriction
3200 (narrow-to-region cache-pos (point-max))
3201 (setq pos (c-state-balance-parens-backwards here- here+ pos)))
3202 nil)) ; for the cond
3203
3204 ((< pos here-lit-start)
3205 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3206 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3207 ;; a brace pair preceding this, it will already be in `c-state-cache',
3208 ;; unless there was a brace pair after it, i.e. there'll only be one to
3209 ;; scan for if we've just deleted one.
3210 (list pos (and dropped-cons pos) t)) ; Return value.
3211
3212 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3213 ;; Further forward scanning isn't needed, but we still need to find a
3214 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3215 ((progn
3216 (save-restriction
3217 (narrow-to-region here-bol (point-max))
3218 (setq pos here-lit-start)
3219 (c-safe (while (setq pa (c-sc-scan-lists pos -1 1))
3220 (setq pos pa)))) ; might signal
3221 nil)) ; for the cond
3222
3223 ((save-restriction
3224 (narrow-to-region too-far-back (point-max))
3225 (setq ren (c-safe (c-sc-scan-lists pos -1 -1))))
3226 ;; CASE 3: After a }/)/] before `here''s BOL.
3227 (list (1+ ren) (and dropped-cons pos) nil)) ; Return value
3228
3229 ((progn (setq good-pos (c-state-lit-beg (c-point 'bopl here-bol)))
3230 (>= cache-pos good-pos))
3231 ;; CASE 3.5: Just after an existing entry in `c-state-cache' on `here''s
3232 ;; line or the previous line.
3233 (list cache-pos nil nil))
3234
3235 (t
3236 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3237 ;; literal containing it.
3238 (list good-pos (and dropped-cons good-pos) nil)))))
3239
3240
3241 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3242 ;; Externally visible routines.
3243
3244 (defun c-state-cache-init ()
3245 (setq c-state-cache nil
3246 c-state-cache-good-pos 1
3247 c-state-nonlit-pos-cache nil
3248 c-state-nonlit-pos-cache-limit 1
3249 c-state-semi-nonlit-pos-cache nil
3250 c-state-semi-nonlit-pos-cache-limit 1
3251 c-state-brace-pair-desert nil
3252 c-state-point-min 1
3253 c-state-point-min-lit-type nil
3254 c-state-point-min-lit-start nil
3255 c-state-min-scan-pos 1
3256 c-state-old-cpp-beg nil
3257 c-state-old-cpp-end nil)
3258 (c-state-mark-point-min-literal))
3259
3260 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3261 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3262 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3263 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3264 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3265 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3266 ;; (defun c-state-dump ()
3267 ;; ;; For debugging.
3268 ;; ;(message
3269 ;; (concat
3270 ;; (c-sc-qde c-state-cache)
3271 ;; (c-sc-de c-state-cache-good-pos)
3272 ;; (c-sc-qde c-state-nonlit-pos-cache)
3273 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3274 ;; (c-sc-qde c-state-brace-pair-desert)
3275 ;; (c-sc-de c-state-point-min)
3276 ;; (c-sc-de c-state-point-min-lit-type)
3277 ;; (c-sc-de c-state-point-min-lit-start)
3278 ;; (c-sc-de c-state-min-scan-pos)
3279 ;; (c-sc-de c-state-old-cpp-beg)
3280 ;; (c-sc-de c-state-old-cpp-end)))
3281 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3282
3283 (defun c-invalidate-state-cache-1 (here)
3284 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3285 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3286 ;; left in a consistent state.
3287 ;;
3288 ;; This is much like `c-whack-state-after', but it never changes a paren
3289 ;; pair element into an open paren element. Doing that would mean that the
3290 ;; new open paren wouldn't have the required preceding paren pair element.
3291 ;;
3292 ;; This function is called from c-before-change.
3293
3294 ;; The caches of non-literals:
3295 ;; Note that we use "<=" for the possibility of the second char of a two-char
3296 ;; comment opener being typed; this would invalidate any cache position at
3297 ;; HERE.
3298 (if (<= here c-state-nonlit-pos-cache-limit)
3299 (setq c-state-nonlit-pos-cache-limit (1- here)))
3300 (if (<= here c-state-semi-nonlit-pos-cache-limit)
3301 (setq c-state-semi-nonlit-pos-cache-limit (1- here)))
3302
3303 ;; `c-state-cache':
3304 ;; Case 1: if `here' is in a literal containing point-min, everything
3305 ;; becomes (or is already) nil.
3306 (if (or (null c-state-cache-good-pos)
3307 (< here (c-state-get-min-scan-pos)))
3308 (setq c-state-cache nil
3309 c-state-cache-good-pos nil
3310 c-state-min-scan-pos nil)
3311
3312 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3313 ;; below `here'. To maintain its consistency, we may need to insert a new
3314 ;; brace pair.
3315 (let ((here-bol (c-point 'bol here))
3316 too-high-pa ; recorded {/(/[ next above or just below here, or nil.
3317 dropped-cons ; was the last removed element a brace pair?
3318 pa)
3319 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3320 (while (and c-state-cache
3321 (>= (setq pa (c-state-cache-top-paren)) here))
3322 (setq dropped-cons (consp (car c-state-cache))
3323 too-high-pa (c-state-cache-top-lparen)
3324 c-state-cache (cdr c-state-cache)))
3325
3326 ;; Do we need to add in an earlier brace pair, having lopped one off?
3327 (if (and dropped-cons
3328 (<= too-high-pa here))
3329 (c-append-lower-brace-pair-to-state-cache too-high-pa here here-bol))
3330 (setq c-state-cache-good-pos (or (c-state-cache-after-top-paren)
3331 (c-state-get-min-scan-pos)))))
3332
3333 ;; The brace-pair desert marker:
3334 (when (car c-state-brace-pair-desert)
3335 (if (< here (car c-state-brace-pair-desert))
3336 (setq c-state-brace-pair-desert nil)
3337 (if (< here (cdr c-state-brace-pair-desert))
3338 (setcdr c-state-brace-pair-desert here)))))
3339
3340 (defun c-parse-state-1 ()
3341 ;; Find and record all noteworthy parens between some good point earlier in
3342 ;; the file and point. That good point is at least the beginning of the
3343 ;; top-level construct we are in, or the beginning of the preceding
3344 ;; top-level construct if we aren't in one.
3345 ;;
3346 ;; The returned value is a list of the noteworthy parens with the last one
3347 ;; first. If an element in the list is an integer, it's the position of an
3348 ;; open paren (of any type) which has not been closed before the point. If
3349 ;; an element is a cons, it gives the position of a closed BRACE paren
3350 ;; pair[*]; the car is the start brace position and the cdr is the position
3351 ;; following the closing brace. Only the last closed brace paren pair
3352 ;; before each open paren and before the point is recorded, and thus the
3353 ;; state never contains two cons elements in succession. When a close brace
3354 ;; has no matching open brace (e.g., the matching brace is outside the
3355 ;; visible region), it is not represented in the returned value.
3356 ;;
3357 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3358 ;; This defun explicitly treats mismatching parens/braces/brackets as
3359 ;; matching. It is the open brace which makes it a "brace" pair.
3360 ;;
3361 ;; If POINT is within a macro, open parens and brace pairs within
3362 ;; THIS macro MIGHT be recorded. This depends on whether their
3363 ;; syntactic properties have been suppressed by
3364 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3365 ;;
3366 ;; Currently no characters which are given paren syntax with the
3367 ;; syntax-table property are recorded, i.e. angle bracket arglist
3368 ;; parens are never present here. Note that this might change.
3369 ;;
3370 ;; BUG: This function doesn't cope entirely well with unbalanced
3371 ;; parens in macros. (2008-12-11: this has probably been resolved
3372 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3373 ;; following case the brace before the macro isn't balanced with the
3374 ;; one after it:
3375 ;;
3376 ;; {
3377 ;; #define X {
3378 ;; }
3379 ;;
3380 ;; Note to maintainers: this function DOES get called with point
3381 ;; within comments and strings, so don't assume it doesn't!
3382 ;;
3383 ;; This function might do hidden buffer changes.
3384 (let* ((here (point))
3385 (here-bopl (c-point 'bopl))
3386 strategy ; 'forward, 'backward etc..
3387 ;; Candidate positions to start scanning from:
3388 cache-pos ; highest position below HERE already existing in
3389 ; cache (or 1).
3390 good-pos
3391 start-point ; (when scanning forward) a place below HERE where there
3392 ; are no open parens/braces between it and HERE.
3393 bopl-state
3394 res
3395 cons-separated
3396 scan-backward-pos scan-forward-p) ; used for 'backward.
3397 ;; If POINT-MIN has changed, adjust the cache
3398 (unless (= (point-min) c-state-point-min)
3399 (c-renarrow-state-cache))
3400
3401 ;; Strategy?
3402 (setq res (c-parse-state-get-strategy here c-state-cache-good-pos)
3403 strategy (car res)
3404 start-point (cadr res))
3405
3406 (when (eq strategy 'BOD)
3407 (setq c-state-cache nil
3408 c-state-cache-good-pos start-point))
3409
3410 ;; SCAN!
3411 (cond
3412 ((memq strategy '(forward back-and-forward BOD))
3413 (setq res (c-remove-stale-state-cache start-point here here-bopl))
3414 (setq cache-pos (car res)
3415 scan-backward-pos (cadr res)
3416 cons-separated (car (cddr res))
3417 bopl-state (cadr (cddr res))) ; will be nil if (< here-bopl
3418 ; start-point)
3419 (if (and scan-backward-pos
3420 (or cons-separated (eq strategy 'forward))) ;scan-backward-pos
3421 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3422 (setq good-pos
3423 (c-append-to-state-cache cache-pos here))
3424 (setq c-state-cache-good-pos
3425 (if (and bopl-state
3426 (< good-pos (- here c-state-cache-too-far)))
3427 (c-state-cache-non-literal-place here-bopl bopl-state)
3428 good-pos)))
3429
3430 ((eq strategy 'backward)
3431 (setq res (c-remove-stale-state-cache-backwards here)
3432 good-pos (car res)
3433 scan-backward-pos (cadr res)
3434 scan-forward-p (car (cddr res)))
3435 (if scan-backward-pos
3436 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3437 (setq c-state-cache-good-pos
3438 (if scan-forward-p
3439 (c-append-to-state-cache good-pos here)
3440 good-pos)))
3441
3442 (t ; (eq strategy 'IN-LIT)
3443 (setq c-state-cache nil
3444 c-state-cache-good-pos nil))))
3445
3446 c-state-cache)
3447
3448 (defun c-invalidate-state-cache (here)
3449 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3450 ;;
3451 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3452 ;; of all parens in preprocessor constructs, except for any such construct
3453 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3454 ;; worrying further about macros and template delimiters.
3455 (if (eval-when-compile (memq 'category-properties c-emacs-features))
3456 ;; Emacs
3457 (c-with-<->-as-parens-suppressed
3458 (if (and c-state-old-cpp-beg
3459 (< c-state-old-cpp-beg here))
3460 (c-with-all-but-one-cpps-commented-out
3461 c-state-old-cpp-beg
3462 c-state-old-cpp-end
3463 (c-invalidate-state-cache-1 here))
3464 (c-with-cpps-commented-out
3465 (c-invalidate-state-cache-1 here))))
3466 ;; XEmacs
3467 (c-invalidate-state-cache-1 here)))
3468
3469 (defmacro c-state-maybe-marker (place marker)
3470 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3471 ;; We (re)use MARKER.
3472 `(and ,place
3473 (or ,marker (setq ,marker (make-marker)))
3474 (set-marker ,marker ,place)))
3475
3476 (defun c-parse-state ()
3477 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3478 ;; description of the functionality and return value.
3479 ;;
3480 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3481 ;; of all parens in preprocessor constructs, except for any such construct
3482 ;; containing point. We can then call `c-parse-state-1' without worrying
3483 ;; further about macros and template delimiters.
3484 (let (here-cpp-beg here-cpp-end)
3485 (save-excursion
3486 (when (c-beginning-of-macro)
3487 (setq here-cpp-beg (point))
3488 (unless
3489 (> (setq here-cpp-end (c-syntactic-end-of-macro))
3490 here-cpp-beg)
3491 (setq here-cpp-beg nil here-cpp-end nil))))
3492 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3493 ;; subsystem.
3494 (prog1
3495 (if (eval-when-compile (memq 'category-properties c-emacs-features))
3496 ;; Emacs
3497 (c-with-<->-as-parens-suppressed
3498 (if (and here-cpp-beg (> here-cpp-end here-cpp-beg))
3499 (c-with-all-but-one-cpps-commented-out
3500 here-cpp-beg here-cpp-end
3501 (c-parse-state-1))
3502 (c-with-cpps-commented-out
3503 (c-parse-state-1))))
3504 ;; XEmacs
3505 (c-parse-state-1))
3506 (setq c-state-old-cpp-beg
3507 (c-state-maybe-marker here-cpp-beg c-state-old-cpp-beg-marker)
3508 c-state-old-cpp-end
3509 (c-state-maybe-marker here-cpp-end c-state-old-cpp-end-marker)))))
3510
3511 ;; Debug tool to catch cache inconsistencies. This is called from
3512 ;; 000tests.el.
3513 (defvar c-debug-parse-state nil)
3514 (unless (fboundp 'c-real-parse-state)
3515 (fset 'c-real-parse-state (symbol-function 'c-parse-state)))
3516 (cc-bytecomp-defun c-real-parse-state)
3517
3518 (defvar c-parse-state-point nil)
3519 (defvar c-parse-state-state nil)
3520 (make-variable-buffer-local 'c-parse-state-state)
3521 (defun c-record-parse-state-state ()
3522 (setq c-parse-state-point (point))
3523 (when (markerp (cdr (assq 'c-state-old-cpp-beg c-parse-state-state)))
3524 (move-marker (cdr (assq 'c-state-old-cpp-beg c-parse-state-state)) nil)
3525 (move-marker (cdr (assq 'c-state-old-cpp-end c-parse-state-state)) nil))
3526 (setq c-parse-state-state
3527 (mapcar
3528 (lambda (arg)
3529 (let ((val (symbol-value arg)))
3530 (cons arg
3531 (cond ((consp val) (copy-tree val))
3532 ((markerp val) (copy-marker val))
3533 (t val)))))
3534 '(c-state-cache
3535 c-state-cache-good-pos
3536 c-state-nonlit-pos-cache
3537 c-state-nonlit-pos-cache-limit
3538 c-state-semi-nonlit-pos-cache
3539 c-state-semi-nonlit-pos-cache-limit
3540 c-state-brace-pair-desert
3541 c-state-point-min
3542 c-state-point-min-lit-type
3543 c-state-point-min-lit-start
3544 c-state-min-scan-pos
3545 c-state-old-cpp-beg
3546 c-state-old-cpp-end
3547 c-parse-state-point))))
3548 (defun c-replay-parse-state-state ()
3549 (message "%s"
3550 (concat "(setq "
3551 (mapconcat
3552 (lambda (arg)
3553 (format "%s %s%s" (car arg)
3554 (if (atom (cdr arg)) "" "'")
3555 (if (markerp (cdr arg))
3556 (format "(copy-marker %s)" (marker-position (cdr arg)))
3557 (cdr arg))))
3558 c-parse-state-state " ")
3559 ")")))
3560
3561 (defun c-debug-parse-state-double-cons (state)
3562 (let (state-car conses-not-ok)
3563 (while state
3564 (setq state-car (car state)
3565 state (cdr state))
3566 (if (and (consp state-car)
3567 (consp (car state)))
3568 (setq conses-not-ok t)))
3569 conses-not-ok))
3570
3571 (defun c-debug-parse-state ()
3572 (let ((here (point)) (res1 (c-real-parse-state)) res2)
3573 (let ((c-state-cache nil)
3574 (c-state-cache-good-pos 1)
3575 (c-state-nonlit-pos-cache nil)
3576 (c-state-nonlit-pos-cache-limit 1)
3577 (c-state-brace-pair-desert nil)
3578 (c-state-point-min 1)
3579 (c-state-point-min-lit-type nil)
3580 (c-state-point-min-lit-start nil)
3581 (c-state-min-scan-pos 1)
3582 (c-state-old-cpp-beg nil)
3583 (c-state-old-cpp-end nil))
3584 (setq res2 (c-real-parse-state)))
3585 (unless (equal res1 res2)
3586 ;; The cache can actually go further back due to the ad-hoc way
3587 ;; the first paren is found, so try to whack off a bit of its
3588 ;; start before complaining.
3589 ;; (save-excursion
3590 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3591 ;; (c-beginning-of-defun-1)
3592 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3593 ;; (c-beginning-of-defun-1))
3594 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3595 ;; (message (concat "c-parse-state inconsistency at %s: "
3596 ;; "using cache: %s, from scratch: %s")
3597 ;; here res1 res2)))
3598 (message (concat "c-parse-state inconsistency at %s: "
3599 "using cache: %s, from scratch: %s")
3600 here res1 res2)
3601 (message "Old state:")
3602 (c-replay-parse-state-state))
3603
3604 (when (c-debug-parse-state-double-cons res1)
3605 (message "c-parse-state INVALIDITY at %s: %s"
3606 here res1)
3607 (message "Old state:")
3608 (c-replay-parse-state-state))
3609
3610 (c-record-parse-state-state)
3611 res2 ; res1 correct a cascading series of errors ASAP
3612 ))
3613
3614 (defun c-toggle-parse-state-debug (&optional arg)
3615 (interactive "P")
3616 (setq c-debug-parse-state (c-calculate-state arg c-debug-parse-state))
3617 (fset 'c-parse-state (symbol-function (if c-debug-parse-state
3618 'c-debug-parse-state
3619 'c-real-parse-state)))
3620 (c-keep-region-active)
3621 (message "c-debug-parse-state %sabled"
3622 (if c-debug-parse-state "en" "dis")))
3623 (when c-debug-parse-state
3624 (c-toggle-parse-state-debug 1))
3625
3626 \f
3627 (defun c-whack-state-before (bufpos paren-state)
3628 ;; Whack off any state information from PAREN-STATE which lies
3629 ;; before BUFPOS. Not destructive on PAREN-STATE.
3630 (let* ((newstate (list nil))
3631 (ptr newstate)
3632 car)
3633 (while paren-state
3634 (setq car (car paren-state)
3635 paren-state (cdr paren-state))
3636 (if (< (if (consp car) (car car) car) bufpos)
3637 (setq paren-state nil)
3638 (setcdr ptr (list car))
3639 (setq ptr (cdr ptr))))
3640 (cdr newstate)))
3641
3642 (defun c-whack-state-after (bufpos paren-state)
3643 ;; Whack off any state information from PAREN-STATE which lies at or
3644 ;; after BUFPOS. Not destructive on PAREN-STATE.
3645 (catch 'done
3646 (while paren-state
3647 (let ((car (car paren-state)))
3648 (if (consp car)
3649 ;; just check the car, because in a balanced brace
3650 ;; expression, it must be impossible for the corresponding
3651 ;; close brace to be before point, but the open brace to
3652 ;; be after.
3653 (if (<= bufpos (car car))
3654 nil ; whack it off
3655 (if (< bufpos (cdr car))
3656 ;; its possible that the open brace is before
3657 ;; bufpos, but the close brace is after. In that
3658 ;; case, convert this to a non-cons element. The
3659 ;; rest of the state is before bufpos, so we're
3660 ;; done.
3661 (throw 'done (cons (car car) (cdr paren-state)))
3662 ;; we know that both the open and close braces are
3663 ;; before bufpos, so we also know that everything else
3664 ;; on state is before bufpos.
3665 (throw 'done paren-state)))
3666 (if (<= bufpos car)
3667 nil ; whack it off
3668 ;; it's before bufpos, so everything else should too.
3669 (throw 'done paren-state)))
3670 (setq paren-state (cdr paren-state)))
3671 nil)))
3672
3673 (defun c-most-enclosing-brace (paren-state &optional bufpos)
3674 ;; Return the bufpos of the innermost enclosing open paren before
3675 ;; bufpos, or nil if none was found.
3676 (let (enclosingp)
3677 (or bufpos (setq bufpos 134217727))
3678 (while paren-state
3679 (setq enclosingp (car paren-state)
3680 paren-state (cdr paren-state))
3681 (if (or (consp enclosingp)
3682 (>= enclosingp bufpos))
3683 (setq enclosingp nil)
3684 (setq paren-state nil)))
3685 enclosingp))
3686
3687 (defun c-least-enclosing-brace (paren-state)
3688 ;; Return the bufpos of the outermost enclosing open paren, or nil
3689 ;; if none was found.
3690 (let (pos elem)
3691 (while paren-state
3692 (setq elem (car paren-state)
3693 paren-state (cdr paren-state))
3694 (if (integerp elem)
3695 (setq pos elem)))
3696 pos))
3697
3698 (defun c-safe-position (bufpos paren-state)
3699 ;; Return the closest "safe" position recorded on PAREN-STATE that
3700 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3701 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3702 ;; find the closest limit before a given limit that might be nil.
3703 ;;
3704 ;; A "safe" position is a position at or after a recorded open
3705 ;; paren, or after a recorded close paren. The returned position is
3706 ;; thus either the first position after a close brace, or the first
3707 ;; position after an enclosing paren, or at the enclosing paren in
3708 ;; case BUFPOS is immediately after it.
3709 (when bufpos
3710 (let (elem)
3711 (catch 'done
3712 (while paren-state
3713 (setq elem (car paren-state))
3714 (if (consp elem)
3715 (cond ((< (cdr elem) bufpos)
3716 (throw 'done (cdr elem)))
3717 ((< (car elem) bufpos)
3718 ;; See below.
3719 (throw 'done (min (1+ (car elem)) bufpos))))
3720 (if (< elem bufpos)
3721 ;; elem is the position at and not after the opening paren, so
3722 ;; we can go forward one more step unless it's equal to
3723 ;; bufpos. This is useful in some cases avoid an extra paren
3724 ;; level between the safe position and bufpos.
3725 (throw 'done (min (1+ elem) bufpos))))
3726 (setq paren-state (cdr paren-state)))))))
3727
3728 (defun c-beginning-of-syntax ()
3729 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3730 ;; goes to the closest previous point that is known to be outside
3731 ;; any string literal or comment. `c-state-cache' is used if it has
3732 ;; a position in the vicinity.
3733 (let* ((paren-state c-state-cache)
3734 elem
3735
3736 (pos (catch 'done
3737 ;; Note: Similar code in `c-safe-position'. The
3738 ;; difference is that we accept a safe position at
3739 ;; the point and don't bother to go forward past open
3740 ;; parens.
3741 (while paren-state
3742 (setq elem (car paren-state))
3743 (if (consp elem)
3744 (cond ((<= (cdr elem) (point))
3745 (throw 'done (cdr elem)))
3746 ((<= (car elem) (point))
3747 (throw 'done (car elem))))
3748 (if (<= elem (point))
3749 (throw 'done elem)))
3750 (setq paren-state (cdr paren-state)))
3751 (point-min))))
3752
3753 (if (> pos (- (point) 4000))
3754 (goto-char pos)
3755 ;; The position is far back. Try `c-beginning-of-defun-1'
3756 ;; (although we can't be entirely sure it will go to a position
3757 ;; outside a comment or string in current emacsen). FIXME:
3758 ;; Consult `syntax-ppss' here.
3759 (c-beginning-of-defun-1)
3760 (if (< (point) pos)
3761 (goto-char pos)))))
3762
3763 \f
3764 ;; Tools for scanning identifiers and other tokens.
3765
3766 (defun c-on-identifier ()
3767 "Return non-nil if the point is on or directly after an identifier.
3768 Keywords are recognized and not considered identifiers. If an
3769 identifier is detected, the returned value is its starting position.
3770 If an identifier ends at the point and another begins at it \(can only
3771 happen in Pike) then the point for the preceding one is returned.
3772
3773 Note that this function might do hidden buffer changes. See the
3774 comment at the start of cc-engine.el for more info."
3775
3776 ;; FIXME: Shouldn't this function handle "operator" in C++?
3777
3778 (save-excursion
3779 (skip-syntax-backward "w_")
3780
3781 (or
3782
3783 ;; Check for a normal (non-keyword) identifier.
3784 (and (looking-at c-symbol-start)
3785 (not (looking-at c-keywords-regexp))
3786 (point))
3787
3788 (when (c-major-mode-is 'pike-mode)
3789 ;; Handle the `<operator> syntax in Pike.
3790 (let ((pos (point)))
3791 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3792 (and (if (< (skip-chars-backward "`") 0)
3793 t
3794 (goto-char pos)
3795 (eq (char-after) ?\`))
3796 (looking-at c-symbol-key)
3797 (>= (match-end 0) pos)
3798 (point))))
3799
3800 ;; Handle the "operator +" syntax in C++.
3801 (when (and c-overloadable-operators-regexp
3802 (= (c-backward-token-2 0) 0))
3803
3804 (cond ((and (looking-at c-overloadable-operators-regexp)
3805 (or (not c-opt-op-identifier-prefix)
3806 (and (= (c-backward-token-2 1) 0)
3807 (looking-at c-opt-op-identifier-prefix))))
3808 (point))
3809
3810 ((save-excursion
3811 (and c-opt-op-identifier-prefix
3812 (looking-at c-opt-op-identifier-prefix)
3813 (= (c-forward-token-2 1) 0)
3814 (looking-at c-overloadable-operators-regexp)))
3815 (point))))
3816
3817 )))
3818
3819 (defsubst c-simple-skip-symbol-backward ()
3820 ;; If the point is at the end of a symbol then skip backward to the
3821 ;; beginning of it. Don't move otherwise. Return non-nil if point
3822 ;; moved.
3823 ;;
3824 ;; This function might do hidden buffer changes.
3825 (or (< (skip-syntax-backward "w_") 0)
3826 (and (c-major-mode-is 'pike-mode)
3827 ;; Handle the `<operator> syntax in Pike.
3828 (let ((pos (point)))
3829 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3830 (< (skip-chars-backward "`") 0)
3831 (looking-at c-symbol-key)
3832 (>= (match-end 0) pos))
3833 t
3834 (goto-char pos)
3835 nil)))))
3836
3837 (defun c-beginning-of-current-token (&optional back-limit)
3838 ;; Move to the beginning of the current token. Do not move if not
3839 ;; in the middle of one. BACK-LIMIT may be used to bound the
3840 ;; backward search; if given it's assumed to be at the boundary
3841 ;; between two tokens. Return non-nil if the point is moved, nil
3842 ;; otherwise.
3843 ;;
3844 ;; This function might do hidden buffer changes.
3845 (let ((start (point)))
3846 (if (looking-at "\\w\\|\\s_")
3847 (skip-syntax-backward "w_" back-limit)
3848 (when (< (skip-syntax-backward ".()" back-limit) 0)
3849 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp)
3850 (match-end 0))
3851 ;; `c-nonsymbol-token-regexp' should always match
3852 ;; since we've skipped backward over punctuation
3853 ;; or paren syntax, but consume one char in case
3854 ;; it doesn't so that we don't leave point before
3855 ;; some earlier incorrect token.
3856 (1+ (point)))))
3857 (if (<= pos start)
3858 (goto-char pos))))))
3859 (< (point) start)))
3860
3861 (defun c-end-of-current-token (&optional back-limit)
3862 ;; Move to the end of the current token. Do not move if not in the
3863 ;; middle of one. BACK-LIMIT may be used to bound the backward
3864 ;; search; if given it's assumed to be at the boundary between two
3865 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3866 ;;
3867 ;; This function might do hidden buffer changes.
3868 (let ((start (point)))
3869 (cond ((< (skip-syntax-backward "w_" (1- start)) 0)
3870 (skip-syntax-forward "w_"))
3871 ((< (skip-syntax-backward ".()" back-limit) 0)
3872 (while (progn
3873 (if (looking-at c-nonsymbol-token-regexp)
3874 (goto-char (match-end 0))
3875 ;; `c-nonsymbol-token-regexp' should always match since
3876 ;; we've skipped backward over punctuation or paren
3877 ;; syntax, but move forward in case it doesn't so that
3878 ;; we don't leave point earlier than we started with.
3879 (forward-char))
3880 (< (point) start)))))
3881 (> (point) start)))
3882
3883 (defconst c-jump-syntax-balanced
3884 (if (memq 'gen-string-delim c-emacs-features)
3885 "\\w\\|\\s_\\|\\s(\\|\\s)\\|\\s\"\\|\\s|"
3886 "\\w\\|\\s_\\|\\s(\\|\\s)\\|\\s\""))
3887
3888 (defconst c-jump-syntax-unbalanced
3889 (if (memq 'gen-string-delim c-emacs-features)
3890 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3891 "\\w\\|\\s_\\|\\s\""))
3892
3893 (defun c-forward-token-2 (&optional count balanced limit)
3894 "Move forward by tokens.
3895 A token is defined as all symbols and identifiers which aren't
3896 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3897 treated properly). Point is always either left at the beginning of a
3898 token or not moved at all. COUNT specifies the number of tokens to
3899 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3900 moves to the next token beginning only if not already at one. If
3901 BALANCED is true, move over balanced parens, otherwise move into them.
3902 Also, if BALANCED is true, never move out of an enclosing paren.
3903
3904 LIMIT sets the limit for the movement and defaults to the point limit.
3905 The case when LIMIT is set in the middle of a token, comment or macro
3906 is handled correctly, i.e. the point won't be left there.
3907
3908 Return the number of tokens left to move \(positive or negative). If
3909 BALANCED is true, a move over a balanced paren counts as one. Note
3910 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3911 be returned. Thus, a return value of 0 guarantees that point is at
3912 the requested position and a return value less \(without signs) than
3913 COUNT guarantees that point is at the beginning of some token.
3914
3915 Note that this function might do hidden buffer changes. See the
3916 comment at the start of cc-engine.el for more info."
3917
3918 (or count (setq count 1))
3919 (if (< count 0)
3920 (- (c-backward-token-2 (- count) balanced limit))
3921
3922 (let ((jump-syntax (if balanced
3923 c-jump-syntax-balanced
3924 c-jump-syntax-unbalanced))
3925 (last (point))
3926 (prev (point)))
3927
3928 (if (zerop count)
3929 ;; If count is zero we should jump if in the middle of a token.
3930 (c-end-of-current-token))
3931
3932 (save-restriction
3933 (if limit (narrow-to-region (point-min) limit))
3934 (if (/= (point)
3935 (progn (c-forward-syntactic-ws) (point)))
3936 ;; Skip whitespace. Count this as a move if we did in
3937 ;; fact move.
3938 (setq count (max (1- count) 0)))
3939
3940 (if (eobp)
3941 ;; Moved out of bounds. Make sure the returned count isn't zero.
3942 (progn
3943 (if (zerop count) (setq count 1))
3944 (goto-char last))
3945
3946 ;; Use `condition-case' to avoid having the limit tests
3947 ;; inside the loop.
3948 (condition-case nil
3949 (while (and
3950 (> count 0)
3951 (progn
3952 (setq last (point))
3953 (cond ((looking-at jump-syntax)
3954 (goto-char (scan-sexps (point) 1))
3955 t)
3956 ((looking-at c-nonsymbol-token-regexp)
3957 (goto-char (match-end 0))
3958 t)
3959 ;; `c-nonsymbol-token-regexp' above should always
3960 ;; match if there are correct tokens. Try to
3961 ;; widen to see if the limit was set in the
3962 ;; middle of one, else fall back to treating
3963 ;; the offending thing as a one character token.
3964 ((and limit
3965 (save-restriction
3966 (widen)
3967 (looking-at c-nonsymbol-token-regexp)))
3968 nil)
3969 (t
3970 (forward-char)
3971 t))))
3972 (c-forward-syntactic-ws)
3973 (setq prev last
3974 count (1- count)))
3975 (error (goto-char last)))
3976
3977 (when (eobp)
3978 (goto-char prev)
3979 (setq count (1+ count)))))
3980
3981 count)))
3982
3983 (defun c-backward-token-2 (&optional count balanced limit)
3984 "Move backward by tokens.
3985 See `c-forward-token-2' for details."
3986
3987 (or count (setq count 1))
3988 (if (< count 0)
3989 (- (c-forward-token-2 (- count) balanced limit))
3990
3991 (or limit (setq limit (point-min)))
3992 (let ((jump-syntax (if balanced
3993 c-jump-syntax-balanced
3994 c-jump-syntax-unbalanced))
3995 (last (point)))
3996
3997 (if (zerop count)
3998 ;; The count is zero so try to skip to the beginning of the
3999 ;; current token.
4000 (if (> (point)
4001 (progn (c-beginning-of-current-token) (point)))
4002 (if (< (point) limit)
4003 ;; The limit is inside the same token, so return 1.
4004 (setq count 1))
4005
4006 ;; We're not in the middle of a token. If there's
4007 ;; whitespace after the point then we must move backward,
4008 ;; so set count to 1 in that case.
4009 (and (looking-at c-syntactic-ws-start)
4010 ;; If we're looking at a '#' that might start a cpp
4011 ;; directive then we have to do a more elaborate check.
4012 (or (/= (char-after) ?#)
4013 (not c-opt-cpp-prefix)
4014 (save-excursion
4015 (and (= (point)
4016 (progn (beginning-of-line)
4017 (looking-at "[ \t]*")
4018 (match-end 0)))
4019 (or (bobp)
4020 (progn (backward-char)
4021 (not (eq (char-before) ?\\)))))))
4022 (setq count 1))))
4023
4024 ;; Use `condition-case' to avoid having to check for buffer
4025 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
4026 (condition-case nil
4027 (while (and
4028 (> count 0)
4029 (progn
4030 (c-backward-syntactic-ws)
4031 (backward-char)
4032 (if (looking-at jump-syntax)
4033 (goto-char (scan-sexps (1+ (point)) -1))
4034 ;; This can be very inefficient if there's a long
4035 ;; sequence of operator tokens without any separation.
4036 ;; That doesn't happen in practice, anyway.
4037 (c-beginning-of-current-token))
4038 (>= (point) limit)))
4039 (setq last (point)
4040 count (1- count)))
4041 (error (goto-char last)))
4042
4043 (if (< (point) limit)
4044 (goto-char last))
4045
4046 count)))
4047
4048 (defun c-forward-token-1 (&optional count balanced limit)
4049 "Like `c-forward-token-2' but doesn't treat multicharacter operator
4050 tokens like \"==\" as single tokens, i.e. all sequences of symbol
4051 characters are jumped over character by character. This function is
4052 for compatibility only; it's only a wrapper over `c-forward-token-2'."
4053 (let ((c-nonsymbol-token-regexp "\\s."))
4054 (c-forward-token-2 count balanced limit)))
4055
4056 (defun c-backward-token-1 (&optional count balanced limit)
4057 "Like `c-backward-token-2' but doesn't treat multicharacter operator
4058 tokens like \"==\" as single tokens, i.e. all sequences of symbol
4059 characters are jumped over character by character. This function is
4060 for compatibility only; it's only a wrapper over `c-backward-token-2'."
4061 (let ((c-nonsymbol-token-regexp "\\s."))
4062 (c-backward-token-2 count balanced limit)))
4063
4064 \f
4065 ;; Tools for doing searches restricted to syntactically relevant text.
4066
4067 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
4068 paren-level not-inside-token
4069 lookbehind-submatch)
4070 "Like `re-search-forward', but only report matches that are found
4071 in syntactically significant text. I.e. matches in comments, macros
4072 or string literals are ignored. The start point is assumed to be
4073 outside any comment, macro or string literal, or else the content of
4074 that region is taken as syntactically significant text.
4075
4076 If PAREN-LEVEL is non-nil, an additional restriction is added to
4077 ignore matches in nested paren sexps. The search will also not go
4078 outside the current list sexp, which has the effect that if the point
4079 should be moved to BOUND when no match is found \(i.e. NOERROR is
4080 neither nil nor t), then it will be at the closing paren if the end of
4081 the current list sexp is encountered first.
4082
4083 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
4084 ignored. Things like multicharacter operators and special symbols
4085 \(e.g. \"`()\" in Pike) are handled but currently not floating point
4086 constants.
4087
4088 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
4089 subexpression in REGEXP. The end of that submatch is used as the
4090 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
4091 isn't used or if that subexpression didn't match then the start
4092 position of the whole match is used instead. The \"look behind\"
4093 subexpression is never tested before the starting position, so it
4094 might be a good idea to include \\=\\= as a match alternative in it.
4095
4096 Optimization note: Matches might be missed if the \"look behind\"
4097 subexpression can match the end of nonwhite syntactic whitespace,
4098 i.e. the end of comments or cpp directives. This since the function
4099 skips over such things before resuming the search. It's on the other
4100 hand not safe to assume that the \"look behind\" subexpression never
4101 matches syntactic whitespace.
4102
4103 Bug: Unbalanced parens inside cpp directives are currently not handled
4104 correctly \(i.e. they don't get ignored as they should) when
4105 PAREN-LEVEL is set.
4106
4107 Note that this function might do hidden buffer changes. See the
4108 comment at the start of cc-engine.el for more info."
4109
4110 (or bound (setq bound (point-max)))
4111 (if paren-level (setq paren-level -1))
4112
4113 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
4114
4115 (let ((start (point))
4116 tmp
4117 ;; Start position for the last search.
4118 search-pos
4119 ;; The `parse-partial-sexp' state between the start position
4120 ;; and the point.
4121 state
4122 ;; The current position after the last state update. The next
4123 ;; `parse-partial-sexp' continues from here.
4124 (state-pos (point))
4125 ;; The position at which to check the state and the state
4126 ;; there. This is separate from `state-pos' since we might
4127 ;; need to back up before doing the next search round.
4128 check-pos check-state
4129 ;; Last position known to end a token.
4130 (last-token-end-pos (point-min))
4131 ;; Set when a valid match is found.
4132 found)
4133
4134 (condition-case err
4135 (while
4136 (and
4137 (progn
4138 (setq search-pos (point))
4139 (re-search-forward regexp bound noerror))
4140
4141 (progn
4142 (setq state (parse-partial-sexp
4143 state-pos (match-beginning 0) paren-level nil state)
4144 state-pos (point))
4145 (if (setq check-pos (and lookbehind-submatch
4146 (or (not paren-level)
4147 (>= (car state) 0))
4148 (match-end lookbehind-submatch)))
4149 (setq check-state (parse-partial-sexp
4150 state-pos check-pos paren-level nil state))
4151 (setq check-pos state-pos
4152 check-state state))
4153
4154 ;; NOTE: If we got a look behind subexpression and get
4155 ;; an insignificant match in something that isn't
4156 ;; syntactic whitespace (i.e. strings or in nested
4157 ;; parentheses), then we can never skip more than a
4158 ;; single character from the match start position
4159 ;; (i.e. `state-pos' here) before continuing the
4160 ;; search. That since the look behind subexpression
4161 ;; might match the end of the insignificant region in
4162 ;; the next search.
4163
4164 (cond
4165 ((elt check-state 7)
4166 ;; Match inside a line comment. Skip to eol. Use
4167 ;; `re-search-forward' instead of `skip-chars-forward' to get
4168 ;; the right bound behavior.
4169 (re-search-forward "[\n\r]" bound noerror))
4170
4171 ((elt check-state 4)
4172 ;; Match inside a block comment. Skip to the '*/'.
4173 (search-forward "*/" bound noerror))
4174
4175 ((and (not (elt check-state 5))
4176 (eq (char-before check-pos) ?/)
4177 (not (c-get-char-property (1- check-pos) 'syntax-table))
4178 (memq (char-after check-pos) '(?/ ?*)))
4179 ;; Match in the middle of the opener of a block or line
4180 ;; comment.
4181 (if (= (char-after check-pos) ?/)
4182 (re-search-forward "[\n\r]" bound noerror)
4183 (search-forward "*/" bound noerror)))
4184
4185 ;; The last `parse-partial-sexp' above might have
4186 ;; stopped short of the real check position if the end
4187 ;; of the current sexp was encountered in paren-level
4188 ;; mode. The checks above are always false in that
4189 ;; case, and since they can do better skipping in
4190 ;; lookbehind-submatch mode, we do them before
4191 ;; checking the paren level.
4192
4193 ((and paren-level
4194 (/= (setq tmp (car check-state)) 0))
4195 ;; Check the paren level first since we're short of the
4196 ;; syntactic checking position if the end of the
4197 ;; current sexp was encountered by `parse-partial-sexp'.
4198 (if (> tmp 0)
4199
4200 ;; Inside a nested paren sexp.
4201 (if lookbehind-submatch
4202 ;; See the NOTE above.
4203 (progn (goto-char state-pos) t)
4204 ;; Skip out of the paren quickly.
4205 (setq state (parse-partial-sexp state-pos bound 0 nil state)
4206 state-pos (point)))
4207
4208 ;; Have exited the current paren sexp.
4209 (if noerror
4210 (progn
4211 ;; The last `parse-partial-sexp' call above
4212 ;; has left us just after the closing paren
4213 ;; in this case, so we can modify the bound
4214 ;; to leave the point at the right position
4215 ;; upon return.
4216 (setq bound (1- (point)))
4217 nil)
4218 (signal 'search-failed (list regexp)))))
4219
4220 ((setq tmp (elt check-state 3))
4221 ;; Match inside a string.
4222 (if (or lookbehind-submatch
4223 (not (integerp tmp)))
4224 ;; See the NOTE above.
4225 (progn (goto-char state-pos) t)
4226 ;; Skip to the end of the string before continuing.
4227 (let ((ender (make-string 1 tmp)) (continue t))
4228 (while (if (search-forward ender bound noerror)
4229 (progn
4230 (setq state (parse-partial-sexp
4231 state-pos (point) nil nil state)
4232 state-pos (point))
4233 (elt state 3))
4234 (setq continue nil)))
4235 continue)))
4236
4237 ((save-excursion
4238 (save-match-data
4239 (c-beginning-of-macro start)))
4240 ;; Match inside a macro. Skip to the end of it.
4241 (c-end-of-macro)
4242 (cond ((<= (point) bound) t)
4243 (noerror nil)
4244 (t (signal 'search-failed (list regexp)))))
4245
4246 ((and not-inside-token
4247 (or (< check-pos last-token-end-pos)
4248 (< check-pos
4249 (save-excursion
4250 (goto-char check-pos)
4251 (save-match-data
4252 (c-end-of-current-token last-token-end-pos))
4253 (setq last-token-end-pos (point))))))
4254 ;; Inside a token.
4255 (if lookbehind-submatch
4256 ;; See the NOTE above.
4257 (goto-char state-pos)
4258 (goto-char (min last-token-end-pos bound))))
4259
4260 (t
4261 ;; A real match.
4262 (setq found t)
4263 nil)))
4264
4265 ;; Should loop to search again, but take care to avoid
4266 ;; looping on the same spot.
4267 (or (/= search-pos (point))
4268 (if (= (point) bound)
4269 (if noerror
4270 nil
4271 (signal 'search-failed (list regexp)))
4272 (forward-char)
4273 t))))
4274
4275 (error
4276 (goto-char start)
4277 (signal (car err) (cdr err))))
4278
4279 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4280
4281 (if found
4282 (progn
4283 (goto-char (match-end 0))
4284 (match-end 0))
4285
4286 ;; Search failed. Set point as appropriate.
4287 (if (eq noerror t)
4288 (goto-char start)
4289 (goto-char bound))
4290 nil)))
4291
4292 (defvar safe-pos-list) ; bound in c-syntactic-skip-backward
4293
4294 (defsubst c-ssb-lit-begin ()
4295 ;; Return the start of the literal point is in, or nil.
4296 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4297 ;; bound in the caller.
4298
4299 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4300 ;; if it's outside comments and strings.
4301 (save-excursion
4302 (let ((pos (point)) safe-pos state)
4303 ;; Pick a safe position as close to the point as possible.
4304 ;;
4305 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4306 ;; position.
4307
4308 (while (and safe-pos-list
4309 (> (car safe-pos-list) (point)))
4310 (setq safe-pos-list (cdr safe-pos-list)))
4311 (unless (setq safe-pos (car-safe safe-pos-list))
4312 (setq safe-pos (max (or (c-safe-position
4313 (point) (c-parse-state))
4314 0)
4315 (point-min))
4316 safe-pos-list (list safe-pos)))
4317
4318 ;; Cache positions along the way to use if we have to back up more. We
4319 ;; cache every closing paren on the same level. If the paren cache is
4320 ;; relevant in this region then we're typically already on the same
4321 ;; level as the target position. Note that we might cache positions
4322 ;; after opening parens in case safe-pos is in a nested list. That's
4323 ;; both uncommon and harmless.
4324 (while (progn
4325 (setq state (parse-partial-sexp
4326 safe-pos pos 0))
4327 (< (point) pos))
4328 (setq safe-pos (point)
4329 safe-pos-list (cons safe-pos safe-pos-list)))
4330
4331 ;; If the state contains the start of the containing sexp we cache that
4332 ;; position too, so that parse-partial-sexp in the next run has a bigger
4333 ;; chance of starting at the same level as the target position and thus
4334 ;; will get more good safe positions into the list.
4335 (if (elt state 1)
4336 (setq safe-pos (1+ (elt state 1))
4337 safe-pos-list (cons safe-pos safe-pos-list)))
4338
4339 (if (or (elt state 3) (elt state 4))
4340 ;; Inside string or comment. Continue search at the
4341 ;; beginning of it.
4342 (elt state 8)))))
4343
4344 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4345 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4346 i.e. don't stop at positions inside syntactic whitespace or string
4347 literals. Preprocessor directives are also ignored, with the exception
4348 of the one that the point starts within, if any. If LIMIT is given,
4349 it's assumed to be at a syntactically relevant position.
4350
4351 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4352 sexps, and the search will also not go outside the current paren sexp.
4353 However, if LIMIT or the buffer limit is reached inside a nested paren
4354 then the point will be left at the limit.
4355
4356 Non-nil is returned if the point moved, nil otherwise.
4357
4358 Note that this function might do hidden buffer changes. See the
4359 comment at the start of cc-engine.el for more info."
4360
4361 (c-self-bind-state-cache
4362 (let ((start (point))
4363 state-2
4364 ;; A list of syntactically relevant positions in descending
4365 ;; order. It's used to avoid scanning repeatedly over
4366 ;; potentially large regions with `parse-partial-sexp' to verify
4367 ;; each position. Used in `c-ssb-lit-begin'
4368 safe-pos-list
4369 ;; The result from `c-beginning-of-macro' at the start position or the
4370 ;; start position itself if it isn't within a macro. Evaluated on
4371 ;; demand.
4372 start-macro-beg
4373 ;; The earliest position after the current one with the same paren
4374 ;; level. Used only when `paren-level' is set.
4375 lit-beg
4376 (paren-level-pos (point)))
4377
4378 (while
4379 (progn
4380 ;; The next loop "tries" to find the end point each time round,
4381 ;; loops when it hasn't succeeded.
4382 (while
4383 (and
4384 (let ((pos (point)))
4385 (while (and
4386 (< (skip-chars-backward skip-chars limit) 0)
4387 ;; Don't stop inside a literal.
4388 (when (setq lit-beg (c-ssb-lit-begin))
4389 (goto-char lit-beg)
4390 t)))
4391 (< (point) pos))
4392
4393 (let ((pos (point)) state-2 pps-end-pos)
4394
4395 (cond
4396 ((and paren-level
4397 (save-excursion
4398 (setq state-2 (parse-partial-sexp
4399 pos paren-level-pos -1)
4400 pps-end-pos (point))
4401 (/= (car state-2) 0)))
4402 ;; Not at the right level.
4403
4404 (if (and (< (car state-2) 0)
4405 ;; We stop above if we go out of a paren.
4406 ;; Now check whether it precedes or is
4407 ;; nested in the starting sexp.
4408 (save-excursion
4409 (setq state-2
4410 (parse-partial-sexp
4411 pps-end-pos paren-level-pos
4412 nil nil state-2))
4413 (< (car state-2) 0)))
4414
4415 ;; We've stopped short of the starting position
4416 ;; so the hit was inside a nested list. Go up
4417 ;; until we are at the right level.
4418 (condition-case nil
4419 (progn
4420 (goto-char (scan-lists pos -1
4421 (- (car state-2))))
4422 (setq paren-level-pos (point))
4423 (if (and limit (>= limit paren-level-pos))
4424 (progn
4425 (goto-char limit)
4426 nil)
4427 t))
4428 (error
4429 (goto-char (or limit (point-min)))
4430 nil))
4431
4432 ;; The hit was outside the list at the start
4433 ;; position. Go to the start of the list and exit.
4434 (goto-char (1+ (elt state-2 1)))
4435 nil))
4436
4437 ((c-beginning-of-macro limit)
4438 ;; Inside a macro.
4439 (if (< (point)
4440 (or start-macro-beg
4441 (setq start-macro-beg
4442 (save-excursion
4443 (goto-char start)
4444 (c-beginning-of-macro limit)
4445 (point)))))
4446 t
4447
4448 ;; It's inside the same macro we started in so it's
4449 ;; a relevant match.
4450 (goto-char pos)
4451 nil))))))
4452
4453 (> (point)
4454 (progn
4455 ;; Skip syntactic ws afterwards so that we don't stop at the
4456 ;; end of a comment if `skip-chars' is something like "^/".
4457 (c-backward-syntactic-ws)
4458 (point)))))
4459
4460 ;; We might want to extend this with more useful return values in
4461 ;; the future.
4462 (/= (point) start))))
4463
4464 ;; The following is an alternative implementation of
4465 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4466 ;; track of the syntactic context. It turned out to be generally
4467 ;; slower than the one above which uses forward checks from earlier
4468 ;; safe positions.
4469 ;;
4470 ;;(defconst c-ssb-stop-re
4471 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4472 ;; ;; stop at to avoid going into comments and literals.
4473 ;; (concat
4474 ;; ;; Match comment end syntax and string literal syntax. Also match
4475 ;; ;; '/' for block comment endings (not covered by comment end
4476 ;; ;; syntax).
4477 ;; "\\s>\\|/\\|\\s\""
4478 ;; (if (memq 'gen-string-delim c-emacs-features)
4479 ;; "\\|\\s|"
4480 ;; "")
4481 ;; (if (memq 'gen-comment-delim c-emacs-features)
4482 ;; "\\|\\s!"
4483 ;; "")))
4484 ;;
4485 ;;(defconst c-ssb-stop-paren-re
4486 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4487 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4488 ;;
4489 ;;(defconst c-ssb-sexp-end-re
4490 ;; ;; Regexp matching the ending syntax of a complex sexp.
4491 ;; (concat c-string-limit-regexp "\\|\\s)"))
4492 ;;
4493 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4494 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4495 ;;i.e. don't stop at positions inside syntactic whitespace or string
4496 ;;literals. Preprocessor directives are also ignored. However, if the
4497 ;;point is within a comment, string literal or preprocessor directory to
4498 ;;begin with, its contents is treated as syntactically relevant chars.
4499 ;;If LIMIT is given, it limits the backward search and the point will be
4500 ;;left there if no earlier position is found.
4501 ;;
4502 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4503 ;;sexps, and the search will also not go outside the current paren sexp.
4504 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4505 ;;then the point will be left at the limit.
4506 ;;
4507 ;;Non-nil is returned if the point moved, nil otherwise.
4508 ;;
4509 ;;Note that this function might do hidden buffer changes. See the
4510 ;;comment at the start of cc-engine.el for more info."
4511 ;;
4512 ;; (save-restriction
4513 ;; (when limit
4514 ;; (narrow-to-region limit (point-max)))
4515 ;;
4516 ;; (let ((start (point)))
4517 ;; (catch 'done
4518 ;; (while (let ((last-pos (point))
4519 ;; (stop-pos (progn
4520 ;; (skip-chars-backward skip-chars)
4521 ;; (point))))
4522 ;;
4523 ;; ;; Skip back over the same region as
4524 ;; ;; `skip-chars-backward' above, but keep to
4525 ;; ;; syntactically relevant positions.
4526 ;; (goto-char last-pos)
4527 ;; (while (and
4528 ;; ;; `re-search-backward' with a single char regexp
4529 ;; ;; should be fast.
4530 ;; (re-search-backward
4531 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4532 ;; stop-pos 'move)
4533 ;;
4534 ;; (progn
4535 ;; (cond
4536 ;; ((looking-at "\\s(")
4537 ;; ;; `paren-level' is set and we've found the
4538 ;; ;; start of the containing paren.
4539 ;; (forward-char)
4540 ;; (throw 'done t))
4541 ;;
4542 ;; ((looking-at c-ssb-sexp-end-re)
4543 ;; ;; We're at the end of a string literal or paren
4544 ;; ;; sexp (if `paren-level' is set).
4545 ;; (forward-char)
4546 ;; (condition-case nil
4547 ;; (c-backward-sexp)
4548 ;; (error
4549 ;; (goto-char limit)
4550 ;; (throw 'done t))))
4551 ;;
4552 ;; (t
4553 ;; (forward-char)
4554 ;; ;; At the end of some syntactic ws or possibly
4555 ;; ;; after a plain '/' operator.
4556 ;; (let ((pos (point)))
4557 ;; (c-backward-syntactic-ws)
4558 ;; (if (= pos (point))
4559 ;; ;; Was a plain '/' operator. Go past it.
4560 ;; (backward-char)))))
4561 ;;
4562 ;; (> (point) stop-pos))))
4563 ;;
4564 ;; ;; Now the point is either at `stop-pos' or at some
4565 ;; ;; position further back if `stop-pos' was at a
4566 ;; ;; syntactically irrelevant place.
4567 ;;
4568 ;; ;; Skip additional syntactic ws so that we don't stop
4569 ;; ;; at the end of a comment if `skip-chars' is
4570 ;; ;; something like "^/".
4571 ;; (c-backward-syntactic-ws)
4572 ;;
4573 ;; (< (point) stop-pos))))
4574 ;;
4575 ;; ;; We might want to extend this with more useful return values
4576 ;; ;; in the future.
4577 ;; (/= (point) start))))
4578
4579 \f
4580 ;; Tools for handling comments and string literals.
4581
4582 (defun c-in-literal (&optional lim detect-cpp)
4583 "Return the type of literal point is in, if any.
4584 The return value is `c' if in a C-style comment, `c++' if in a C++
4585 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4586 is non-nil and in a preprocessor line, or nil if somewhere else.
4587 Optional LIM is used as the backward limit of the search. If omitted,
4588 or nil, `c-beginning-of-defun' is used.
4589
4590 The last point calculated is cached if the cache is enabled, i.e. if
4591 `c-in-literal-cache' is bound to a two element vector.
4592
4593 Note that this function might do hidden buffer changes. See the
4594 comment at the start of cc-engine.el for more info."
4595 (save-restriction
4596 (widen)
4597 (let* ((safe-place (c-state-semi-safe-place (point)))
4598 (lit (c-state-pp-to-literal safe-place (point))))
4599 (or (cadr lit)
4600 (and detect-cpp
4601 (save-excursion (c-beginning-of-macro))
4602 'pound)))))
4603
4604 (defun c-literal-limits (&optional lim near not-in-delimiter)
4605 "Return a cons of the beginning and end positions of the comment or
4606 string surrounding point (including both delimiters), or nil if point
4607 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4608 to start parsing from. If NEAR is non-nil, then the limits of any
4609 literal next to point is returned. \"Next to\" means there's only
4610 spaces and tabs between point and the literal. The search for such a
4611 literal is done first in forward direction. If NOT-IN-DELIMITER is
4612 non-nil, the case when point is inside a starting delimiter won't be
4613 recognized. This only has effect for comments which have starting
4614 delimiters with more than one character.
4615
4616 Note that this function might do hidden buffer changes. See the
4617 comment at the start of cc-engine.el for more info."
4618
4619 (save-excursion
4620 (let* ((pos (point))
4621 (lim (or lim (c-state-semi-safe-place pos)))
4622 (pp-to-lit (save-restriction
4623 (widen)
4624 (c-state-pp-to-literal lim pos not-in-delimiter)))
4625 (state (car pp-to-lit))
4626 (lit-limits (car (cddr pp-to-lit))))
4627
4628 (cond
4629 (lit-limits)
4630
4631 (near
4632 (goto-char pos)
4633 ;; Search forward for a literal.
4634 (skip-chars-forward " \t")
4635 (cond
4636 ((looking-at c-string-limit-regexp) ; String.
4637 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4638 (point-max))))
4639
4640 ((looking-at c-comment-start-regexp) ; Line or block comment.
4641 (cons (point) (progn (c-forward-single-comment) (point))))
4642
4643 (t
4644 ;; Search backward.
4645 (skip-chars-backward " \t")
4646
4647 (let ((end (point)) beg)
4648 (cond
4649 ((save-excursion
4650 (< (skip-syntax-backward c-string-syntax) 0)) ; String.
4651 (setq beg (c-safe (c-backward-sexp 1) (point))))
4652
4653 ((and (c-safe (forward-char -2) t)
4654 (looking-at "*/"))
4655 ;; Block comment. Due to the nature of line
4656 ;; comments, they will always be covered by the
4657 ;; normal case above.
4658 (goto-char end)
4659 (c-backward-single-comment)
4660 ;; If LIM is bogus, beg will be bogus.
4661 (setq beg (point))))
4662
4663 (if beg (cons beg end))))))
4664 ))))
4665
4666 ;; In case external callers use this; it did have a docstring.
4667 (defalias 'c-literal-limits-fast 'c-literal-limits)
4668
4669 (defun c-collect-line-comments (range)
4670 "If the argument is a cons of two buffer positions (such as returned by
4671 `c-literal-limits'), and that range contains a C++ style line comment,
4672 then an extended range is returned that contains all adjacent line
4673 comments (i.e. all comments that starts in the same column with no
4674 empty lines or non-whitespace characters between them). Otherwise the
4675 argument is returned.
4676
4677 Note that this function might do hidden buffer changes. See the
4678 comment at the start of cc-engine.el for more info."
4679
4680 (save-excursion
4681 (condition-case nil
4682 (if (and (consp range) (progn
4683 (goto-char (car range))
4684 (looking-at c-line-comment-starter)))
4685 (let ((col (current-column))
4686 (beg (point))
4687 (bopl (c-point 'bopl))
4688 (end (cdr range)))
4689 ;; Got to take care in the backward direction to handle
4690 ;; comments which are preceded by code.
4691 (while (and (c-backward-single-comment)
4692 (>= (point) bopl)
4693 (looking-at c-line-comment-starter)
4694 (= col (current-column)))
4695 (setq beg (point)
4696 bopl (c-point 'bopl)))
4697 (goto-char end)
4698 (while (and (progn (skip-chars-forward " \t")
4699 (looking-at c-line-comment-starter))
4700 (= col (current-column))
4701 (prog1 (zerop (forward-line 1))
4702 (setq end (point)))))
4703 (cons beg end))
4704 range)
4705 (error range))))
4706
4707 (defun c-literal-type (range)
4708 "Convenience function that given the result of `c-literal-limits',
4709 returns nil or the type of literal that the range surrounds, one
4710 of the symbols `c', `c++' or `string'. It's much faster than using
4711 `c-in-literal' and is intended to be used when you need both the
4712 type of a literal and its limits.
4713
4714 Note that this function might do hidden buffer changes. See the
4715 comment at the start of cc-engine.el for more info."
4716
4717 (if (consp range)
4718 (save-excursion
4719 (goto-char (car range))
4720 (cond ((looking-at c-string-limit-regexp) 'string)
4721 ((or (looking-at "//") ; c++ line comment
4722 (and (looking-at "\\s<") ; comment starter
4723 (looking-at "#"))) ; awk comment.
4724 'c++)
4725 (t 'c))) ; Assuming the range is valid.
4726 range))
4727
4728 (defsubst c-determine-limit-get-base (start try-size)
4729 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4730 ;; This doesn't preserve point.
4731 (let* ((pos (max (- start try-size) (point-min)))
4732 (base (c-state-semi-safe-place pos))
4733 (s (parse-partial-sexp base pos)))
4734 (if (or (nth 4 s) (nth 3 s)) ; comment or string
4735 (nth 8 s)
4736 (point))))
4737
4738 (defun c-determine-limit (how-far-back &optional start try-size)
4739 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4740 ;; (default point). This is done by going back further in the buffer then
4741 ;; searching forward for literals. The position found won't be in a
4742 ;; literal. We start searching for the sought position TRY-SIZE (default
4743 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4744 ;; :-)
4745 (save-excursion
4746 (let* ((start (or start (point)))
4747 (try-size (or try-size (* 2 how-far-back)))
4748 (base (c-determine-limit-get-base start try-size))
4749 (pos base)
4750
4751 (s (parse-partial-sexp pos pos)) ; null state.
4752 stack elt size
4753 (count 0))
4754 (while (< pos start)
4755 ;; Move forward one literal each time round this loop.
4756 ;; Move forward to the start of a comment or string.
4757 (setq s (parse-partial-sexp
4758 pos
4759 start
4760 nil ; target-depth
4761 nil ; stop-before
4762 s ; state
4763 'syntax-table)) ; stop-comment
4764
4765 ;; Gather details of the non-literal-bit - starting pos and size.
4766 (setq size (- (if (or (nth 4 s) (nth 3 s))
4767 (nth 8 s)
4768 (point))
4769 pos))
4770 (if (> size 0)
4771 (setq stack (cons (cons pos size) stack)))
4772
4773 ;; Move forward to the end of the comment/string.
4774 (if (or (nth 4 s) (nth 3 s))
4775 (setq s (parse-partial-sexp
4776 (point)
4777 start
4778 nil ; target-depth
4779 nil ; stop-before
4780 s ; state
4781 'syntax-table))) ; stop-comment
4782 (setq pos (point)))
4783
4784 ;; Now try and find enough non-literal characters recorded on the stack.
4785 ;; Go back one recorded literal each time round this loop.
4786 (while (and (< count how-far-back)
4787 stack)
4788 (setq elt (car stack)
4789 stack (cdr stack))
4790 (setq count (+ count (cdr elt))))
4791
4792 ;; Have we found enough yet?
4793 (cond
4794 ((>= count how-far-back)
4795 (+ (car elt) (- count how-far-back)))
4796 ((eq base (point-min))
4797 (point-min))
4798 (t
4799 (c-determine-limit (- how-far-back count) base try-size))))))
4800
4801 (defun c-determine-+ve-limit (how-far &optional start-pos)
4802 ;; Return a buffer position about HOW-FAR non-literal characters forward
4803 ;; from START-POS (default point), which must not be inside a literal.
4804 (save-excursion
4805 (let ((pos (or start-pos (point)))
4806 (count how-far)
4807 (s (parse-partial-sexp (point) (point)))) ; null state
4808 (while (and (not (eobp))
4809 (> count 0))
4810 ;; Scan over counted characters.
4811 (setq s (parse-partial-sexp
4812 pos
4813 (min (+ pos count) (point-max))
4814 nil ; target-depth
4815 nil ; stop-before
4816 s ; state
4817 'syntax-table)) ; stop-comment
4818 (setq count (- count (- (point) pos) 1)
4819 pos (point))
4820 ;; Scan over literal characters.
4821 (if (nth 8 s)
4822 (setq s (parse-partial-sexp
4823 pos
4824 (point-max)
4825 nil ; target-depth
4826 nil ; stop-before
4827 s ; state
4828 'syntax-table) ; stop-comment
4829 pos (point))))
4830 (point))))
4831
4832 \f
4833 ;; `c-find-decl-spots' and accompanying stuff.
4834
4835 ;; Variables used in `c-find-decl-spots' to cache the search done for
4836 ;; the first declaration in the last call. When that function starts,
4837 ;; it needs to back up over syntactic whitespace to look at the last
4838 ;; token before the region being searched. That can sometimes cause
4839 ;; moves back and forth over a quite large region of comments and
4840 ;; macros, which would be repeated for each changed character when
4841 ;; we're called during fontification, since font-lock refontifies the
4842 ;; current line for each change. Thus it's worthwhile to cache the
4843 ;; first match.
4844 ;;
4845 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4846 ;; the syntactic whitespace less or equal to some start position.
4847 ;; There's no cached value if it's nil.
4848 ;;
4849 ;; `c-find-decl-match-pos' is the match position if
4850 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4851 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4852 (defvar c-find-decl-syntactic-pos nil)
4853 (make-variable-buffer-local 'c-find-decl-syntactic-pos)
4854 (defvar c-find-decl-match-pos nil)
4855 (make-variable-buffer-local 'c-find-decl-match-pos)
4856
4857 (defsubst c-invalidate-find-decl-cache (change-min-pos)
4858 (and c-find-decl-syntactic-pos
4859 (< change-min-pos c-find-decl-syntactic-pos)
4860 (setq c-find-decl-syntactic-pos nil)))
4861
4862 ; (defface c-debug-decl-spot-face
4863 ; '((t (:background "Turquoise")))
4864 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4865 ; (defface c-debug-decl-sws-face
4866 ; '((t (:background "Khaki")))
4867 ; "Debug face to mark the syntactic whitespace between the declaration
4868 ; spots and the preceding token end.")
4869
4870 (defmacro c-debug-put-decl-spot-faces (match-pos decl-pos)
4871 (when (facep 'c-debug-decl-spot-face)
4872 `(c-save-buffer-state ((match-pos ,match-pos) (decl-pos ,decl-pos))
4873 (c-debug-add-face (max match-pos (point-min)) decl-pos
4874 'c-debug-decl-sws-face)
4875 (c-debug-add-face decl-pos (min (1+ decl-pos) (point-max))
4876 'c-debug-decl-spot-face))))
4877 (defmacro c-debug-remove-decl-spot-faces (beg end)
4878 (when (facep 'c-debug-decl-spot-face)
4879 `(c-save-buffer-state ()
4880 (c-debug-remove-face ,beg ,end 'c-debug-decl-spot-face)
4881 (c-debug-remove-face ,beg ,end 'c-debug-decl-sws-face))))
4882
4883 (defmacro c-find-decl-prefix-search ()
4884 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4885 ;; but it contains lots of free variables that refer to things
4886 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4887 ;; if there is a match, otherwise at `cfd-limit'.
4888 ;;
4889 ;; The macro moves point forward to the next putative start of a declaration
4890 ;; or cfd-limit. This decl start is the next token after a "declaration
4891 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
4892 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
4893 ;;
4894 ;; This macro might do hidden buffer changes.
4895
4896 '(progn
4897 ;; Find the next property match position if we haven't got one already.
4898 (unless cfd-prop-match
4899 (save-excursion
4900 (while (progn
4901 (goto-char (c-next-single-property-change
4902 (point) 'c-type nil cfd-limit))
4903 (and (< (point) cfd-limit)
4904 (not (eq (c-get-char-property (1- (point)) 'c-type)
4905 'c-decl-end)))))
4906 (setq cfd-prop-match (point))))
4907
4908 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4909 ;; got one already.
4910 (unless cfd-re-match
4911
4912 (if (> cfd-re-match-end (point))
4913 (goto-char cfd-re-match-end))
4914
4915 ;; Each time round, the next `while' moves forward over a pseudo match
4916 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
4917 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
4918 ;; `cfd-re-match-end' get set.
4919 (while
4920 (progn
4921 (setq cfd-re-match-end (re-search-forward c-decl-prefix-or-start-re
4922 cfd-limit 'move))
4923 (cond
4924 ((null cfd-re-match-end)
4925 ;; No match. Finish up and exit the loop.
4926 (setq cfd-re-match cfd-limit)
4927 nil)
4928 ((c-got-face-at
4929 (if (setq cfd-re-match (match-end 1))
4930 ;; Matched the end of a token preceding a decl spot.
4931 (progn
4932 (goto-char cfd-re-match)
4933 (1- cfd-re-match))
4934 ;; Matched a token that start a decl spot.
4935 (goto-char (match-beginning 0))
4936 (point))
4937 c-literal-faces)
4938 ;; Pseudo match inside a comment or string literal. Skip out
4939 ;; of comments and string literals.
4940 (while (progn
4941 (goto-char (c-next-single-property-change
4942 (point) 'face nil cfd-limit))
4943 (and (< (point) cfd-limit)
4944 (c-got-face-at (point) c-literal-faces))))
4945 t) ; Continue the loop over pseudo matches.
4946 ((and (match-string 1)
4947 (string= (match-string 1) ":")
4948 (save-excursion
4949 (or (/= (c-backward-token-2 2) 0) ; no search limit. :-(
4950 (not (looking-at c-decl-start-colon-kwd-re)))))
4951 ;; Found a ":" which isn't part of "public:", etc.
4952 t)
4953 (t nil)))) ;; Found a real match. Exit the pseudo-match loop.
4954
4955 ;; If our match was at the decl start, we have to back up over the
4956 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4957 ;; any decl spots in the syntactic ws.
4958 (unless cfd-re-match
4959 (c-backward-syntactic-ws)
4960 (setq cfd-re-match (point))))
4961
4962 ;; Choose whichever match is closer to the start.
4963 (if (< cfd-re-match cfd-prop-match)
4964 (setq cfd-match-pos cfd-re-match
4965 cfd-re-match nil)
4966 (setq cfd-match-pos cfd-prop-match
4967 cfd-prop-match nil))
4968
4969 (goto-char cfd-match-pos)
4970
4971 (when (< cfd-match-pos cfd-limit)
4972 ;; Skip forward past comments only so we don't skip macros.
4973 (c-forward-comments)
4974 ;; Set the position to continue at. We can avoid going over
4975 ;; the comments skipped above a second time, but it's possible
4976 ;; that the comment skipping has taken us past `cfd-prop-match'
4977 ;; since the property might be used inside comments.
4978 (setq cfd-continue-pos (if cfd-prop-match
4979 (min cfd-prop-match (point))
4980 (point))))))
4981
4982 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun)
4983 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4984 ;; label from the point to CFD-LIMIT.
4985 ;;
4986 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4987 ;; arguments: The first is the end position of the token preceding the spot,
4988 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4989 ;; the match is inside a macro. Point should be moved forward by at least
4990 ;; one token.
4991 ;;
4992 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4993 ;; it should return non-nil to ensure that the next search will find them.
4994 ;;
4995 ;; Such a spot is:
4996 ;; o The first token after bob.
4997 ;; o The first token after the end of submatch 1 in
4998 ;; `c-decl-prefix-or-start-re' when that submatch matches. This
4999 ;; submatch is typically a (L or R) brace or paren, a ;, or a ,.
5000 ;; o The start of each `c-decl-prefix-or-start-re' match when
5001 ;; submatch 1 doesn't match. This is, for example, the keyword
5002 ;; "class" in Pike.
5003 ;; o The start of a previously recognized declaration; "recognized"
5004 ;; means that the last char of the previous token has a `c-type'
5005 ;; text property with the value `c-decl-end'; this only holds
5006 ;; when `c-type-decl-end-used' is set.
5007 ;;
5008 ;; Only a spot that match CFD-DECL-RE and whose face is in the
5009 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
5010 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
5011 ;;
5012 ;; If the match is inside a macro then the buffer is narrowed to the
5013 ;; end of it, so that CFD-FUN can investigate the following tokens
5014 ;; without matching something that begins inside a macro and ends
5015 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
5016 ;; CFD-FACE-CHECKLIST checks exist.
5017 ;;
5018 ;; The spots are visited approximately in order from top to bottom.
5019 ;; It's however the positions where `c-decl-prefix-or-start-re'
5020 ;; matches and where `c-decl-end' properties are found that are in
5021 ;; order. Since the spots often are at the following token, they
5022 ;; might be visited out of order insofar as more spots are reported
5023 ;; later on within the syntactic whitespace between the match
5024 ;; positions and their spots.
5025 ;;
5026 ;; It's assumed that comments and strings are fontified in the
5027 ;; searched range.
5028 ;;
5029 ;; This is mainly used in fontification, and so has an elaborate
5030 ;; cache to handle repeated calls from the same start position; see
5031 ;; the variables above.
5032 ;;
5033 ;; All variables in this function begin with `cfd-' to avoid name
5034 ;; collision with the (dynamically bound) variables used in CFD-FUN.
5035 ;;
5036 ;; This function might do hidden buffer changes.
5037
5038 (let ((cfd-start-pos (point)) ; never changed
5039 (cfd-buffer-end (point-max))
5040 ;; The end of the token preceding the decl spot last found
5041 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
5042 ;; no match.
5043 cfd-re-match
5044 ;; The end position of the last `c-decl-prefix-or-start-re'
5045 ;; match. If this is greater than `cfd-continue-pos', the
5046 ;; next regexp search is started here instead.
5047 (cfd-re-match-end (point-min))
5048 ;; The end of the last `c-decl-end' found by
5049 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
5050 ;; match. If searching for the property isn't needed then we
5051 ;; disable it by setting it to `cfd-limit' directly.
5052 (cfd-prop-match (unless c-type-decl-end-used cfd-limit))
5053 ;; The end of the token preceding the decl spot last found by
5054 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
5055 ;; bob. `cfd-limit' if there's no match. In other words,
5056 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
5057 (cfd-match-pos cfd-limit)
5058 ;; The position to continue searching at.
5059 cfd-continue-pos
5060 ;; The position of the last "real" token we've stopped at.
5061 ;; This can be greater than `cfd-continue-pos' when we get
5062 ;; hits inside macros or at `c-decl-end' positions inside
5063 ;; comments.
5064 (cfd-token-pos 0)
5065 ;; The end position of the last entered macro.
5066 (cfd-macro-end 0))
5067
5068 ;; Initialize by finding a syntactically relevant start position
5069 ;; before the point, and do the first `c-decl-prefix-or-start-re'
5070 ;; search unless we're at bob.
5071
5072 (let (start-in-literal start-in-macro syntactic-pos)
5073 ;; Must back up a bit since we look for the end of the previous
5074 ;; statement or declaration, which is earlier than the first
5075 ;; returned match.
5076
5077 ;; This `cond' moves back over any literals or macros. It has special
5078 ;; handling for when the region being searched is entirely within a
5079 ;; macro. It sets `cfd-continue-pos' (unless we've reached
5080 ;; `cfd-limit').
5081 (cond
5082 ;; First we need to move to a syntactically relevant position.
5083 ;; Begin by backing out of comment or string literals.
5084 ;;
5085 ;; This arm of the cond actually triggers if we're in a literal,
5086 ;; and cfd-limit is at most at BONL.
5087 ((and
5088 ;; This arm of the `and' moves backwards out of a literal when
5089 ;; the face at point is a literal face. In this case, its value
5090 ;; is always non-nil.
5091 (when (c-got-face-at (point) c-literal-faces)
5092 ;; Try to use the faces to back up to the start of the
5093 ;; literal. FIXME: What if the point is on a declaration
5094 ;; inside a comment?
5095 (while (and (not (bobp))
5096 (c-got-face-at (1- (point)) c-literal-faces))
5097 (goto-char (previous-single-property-change
5098 (point) 'face nil (point-min))))
5099
5100 ;; XEmacs doesn't fontify the quotes surrounding string
5101 ;; literals.
5102 (and (featurep 'xemacs)
5103 (eq (get-text-property (point) 'face)
5104 'font-lock-string-face)
5105 (not (bobp))
5106 (progn (backward-char)
5107 (not (looking-at c-string-limit-regexp)))
5108 (forward-char))
5109
5110 ;; Don't trust the literal to contain only literal faces
5111 ;; (the font lock package might not have fontified the
5112 ;; start of it at all, for instance) so check that we have
5113 ;; arrived at something that looks like a start or else
5114 ;; resort to `c-literal-limits'.
5115 (unless (looking-at c-literal-start-regexp)
5116 (let ((range (c-literal-limits)))
5117 (if range (goto-char (car range)))))
5118
5119 (setq start-in-literal (point))) ; end of `and' arm.
5120
5121 ;; The start is in a literal. If the limit is in the same
5122 ;; one we don't have to find a syntactic position etc. We
5123 ;; only check that if the limit is at or before bonl to save
5124 ;; time; it covers the by far most common case when font-lock
5125 ;; refontifies the current line only.
5126 (<= cfd-limit (c-point 'bonl cfd-start-pos))
5127 (save-excursion
5128 (goto-char cfd-start-pos)
5129 (while (progn
5130 (goto-char (c-next-single-property-change
5131 (point) 'face nil cfd-limit))
5132 (and (< (point) cfd-limit)
5133 (c-got-face-at (point) c-literal-faces))))
5134 (= (point) cfd-limit))) ; end of `cond' arm condition
5135
5136 ;; Completely inside a literal. Set up variables to trig the
5137 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5138 ;; find a suitable start position.
5139 (setq cfd-continue-pos start-in-literal)) ; end of `cond' arm
5140
5141 ;; Check if the region might be completely inside a macro, to
5142 ;; optimize that like the completely-inside-literal above.
5143 ((save-excursion
5144 (and (= (forward-line 1) 0)
5145 (bolp) ; forward-line has funny behavior at eob.
5146 (>= (point) cfd-limit)
5147 (progn (backward-char)
5148 (eq (char-before) ?\\))))
5149 ;; (Maybe) completely inside a macro. Only need to trig the
5150 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5151 ;; set things up.
5152 (setq cfd-continue-pos (1- cfd-start-pos)
5153 start-in-macro t))
5154
5155 ;; The default arm of the `cond' moves back over any macro we're in
5156 ;; and over any syntactic WS. It sets `c-find-decl-syntactic-pos'.
5157 (t
5158 ;; Back out of any macro so we don't miss any declaration
5159 ;; that could follow after it.
5160 (when (c-beginning-of-macro)
5161 (setq start-in-macro t))
5162
5163 ;; Now we're at a proper syntactically relevant position so we
5164 ;; can use the cache. But first clear it if it applied
5165 ;; further down.
5166 (c-invalidate-find-decl-cache cfd-start-pos)
5167
5168 (setq syntactic-pos (point))
5169 (unless (eq syntactic-pos c-find-decl-syntactic-pos)
5170 ;; Don't have to do this if the cache is relevant here,
5171 ;; typically if the same line is refontified again. If
5172 ;; we're just some syntactic whitespace further down we can
5173 ;; still use the cache to limit the skipping.
5174 (c-backward-syntactic-ws c-find-decl-syntactic-pos))
5175
5176 ;; If we hit `c-find-decl-syntactic-pos' and
5177 ;; `c-find-decl-match-pos' is set then we install the cached
5178 ;; values. If we hit `c-find-decl-syntactic-pos' and
5179 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5180 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5181 ;; and so we can continue the search from this point. If we
5182 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5183 ;; the right spot to begin searching anyway.
5184 (if (and (eq (point) c-find-decl-syntactic-pos)
5185 c-find-decl-match-pos)
5186 (setq cfd-match-pos c-find-decl-match-pos
5187 cfd-continue-pos syntactic-pos)
5188
5189 (setq c-find-decl-syntactic-pos syntactic-pos)
5190
5191 (when (if (bobp)
5192 ;; Always consider bob a match to get the first
5193 ;; declaration in the file. Do this separately instead of
5194 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5195 ;; regexp always can consume at least one character to
5196 ;; ensure that we won't get stuck in an infinite loop.
5197 (setq cfd-re-match 0)
5198 (backward-char)
5199 (c-beginning-of-current-token)
5200 (< (point) cfd-limit))
5201 ;; Do an initial search now. In the bob case above it's
5202 ;; only done to search for a `c-decl-end' spot.
5203 (c-find-decl-prefix-search)) ; sets cfd-continue-pos
5204
5205 (setq c-find-decl-match-pos (and (< cfd-match-pos cfd-start-pos)
5206 cfd-match-pos))))) ; end of `cond'
5207
5208 ;; Advance `cfd-continue-pos' if it's before the start position.
5209 ;; The closest continue position that might have effect at or
5210 ;; after the start depends on what we started in. This also
5211 ;; finds a suitable start position in the special cases when the
5212 ;; region is completely within a literal or macro.
5213 (when (and cfd-continue-pos (< cfd-continue-pos cfd-start-pos))
5214
5215 (cond
5216 (start-in-macro
5217 ;; If we're in a macro then it's the closest preceding token
5218 ;; in the macro. Check this before `start-in-literal',
5219 ;; since if we're inside a literal in a macro, the preceding
5220 ;; token is earlier than any `c-decl-end' spot inside the
5221 ;; literal (comment).
5222 (goto-char (or start-in-literal cfd-start-pos))
5223 ;; The only syntactic ws in macros are comments.
5224 (c-backward-comments)
5225 (backward-char)
5226 (c-beginning-of-current-token))
5227
5228 (start-in-literal
5229 ;; If we're in a comment it can only be the closest
5230 ;; preceding `c-decl-end' position within that comment, if
5231 ;; any. Go back to the beginning of such a property so that
5232 ;; `c-find-decl-prefix-search' will find the end of it.
5233 ;; (Can't stop at the end and install it directly on
5234 ;; `cfd-prop-match' since that variable might be cleared
5235 ;; after `cfd-fun' below.)
5236 ;;
5237 ;; Note that if the literal is a string then the property
5238 ;; search will simply skip to the beginning of it right
5239 ;; away.
5240 (if (not c-type-decl-end-used)
5241 (goto-char start-in-literal)
5242 (goto-char cfd-start-pos)
5243 (while (progn
5244 (goto-char (previous-single-property-change
5245 (point) 'c-type nil start-in-literal))
5246 (and (> (point) start-in-literal)
5247 (not (eq (c-get-char-property (point) 'c-type)
5248 'c-decl-end))))))
5249
5250 (when (= (point) start-in-literal)
5251 ;; Didn't find any property inside the comment, so we can
5252 ;; skip it entirely. (This won't skip past a string, but
5253 ;; that'll be handled quickly by the next
5254 ;; `c-find-decl-prefix-search' anyway.)
5255 (c-forward-single-comment)
5256 (if (> (point) cfd-limit)
5257 (goto-char cfd-limit))))
5258
5259 (t
5260 ;; If we started in normal code, the only match that might
5261 ;; apply before the start is what we already got in
5262 ;; `cfd-match-pos' so we can continue at the start position.
5263 ;; (Note that we don't get here if the first match is below
5264 ;; it.)
5265 (goto-char cfd-start-pos))) ; end of `cond'
5266
5267 ;; Delete found matches if they are before our new continue
5268 ;; position, so that `c-find-decl-prefix-search' won't back up
5269 ;; to them later on.
5270 (setq cfd-continue-pos (point))
5271 (when (and cfd-re-match (< cfd-re-match cfd-continue-pos))
5272 (setq cfd-re-match nil))
5273 (when (and cfd-prop-match (< cfd-prop-match cfd-continue-pos))
5274 (setq cfd-prop-match nil))) ; end of `when'
5275
5276 (if syntactic-pos
5277 ;; This is the normal case and we got a proper syntactic
5278 ;; position. If there's a match then it's always outside
5279 ;; macros and comments, so advance to the next token and set
5280 ;; `cfd-token-pos'. The loop below will later go back using
5281 ;; `cfd-continue-pos' to fix declarations inside the
5282 ;; syntactic ws.
5283 (when (and cfd-match-pos (< cfd-match-pos syntactic-pos))
5284 (goto-char syntactic-pos)
5285 (c-forward-syntactic-ws)
5286 (and cfd-continue-pos
5287 (< cfd-continue-pos (point))
5288 (setq cfd-token-pos (point))))
5289
5290 ;; Have one of the special cases when the region is completely
5291 ;; within a literal or macro. `cfd-continue-pos' is set to a
5292 ;; good start position for the search, so do it.
5293 (c-find-decl-prefix-search)))
5294
5295 ;; Now loop, one decl spot per iteration. We already have the first
5296 ;; match in `cfd-match-pos'.
5297 (while (progn
5298 ;; Go forward over "false matches", one per iteration.
5299 (while (and
5300 (< cfd-match-pos cfd-limit)
5301
5302 (or
5303 ;; Kludge to filter out matches on the "<" that
5304 ;; aren't open parens, for the sake of languages
5305 ;; that got `c-recognize-<>-arglists' set.
5306 (and (eq (char-before cfd-match-pos) ?<)
5307 (not (c-get-char-property (1- cfd-match-pos)
5308 'syntax-table)))
5309
5310 ;; If `cfd-continue-pos' is less or equal to
5311 ;; `cfd-token-pos', we've got a hit inside a macro
5312 ;; that's in the syntactic whitespace before the last
5313 ;; "real" declaration we've checked. If they're equal
5314 ;; we've arrived at the declaration a second time, so
5315 ;; there's nothing to do.
5316 (= cfd-continue-pos cfd-token-pos)
5317
5318 (progn
5319 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5320 ;; we're still searching for declarations embedded in
5321 ;; the syntactic whitespace. In that case we need
5322 ;; only to skip comments and not macros, since they
5323 ;; can't be nested, and that's already been done in
5324 ;; `c-find-decl-prefix-search'.
5325 (when (> cfd-continue-pos cfd-token-pos)
5326 (c-forward-syntactic-ws)
5327 (setq cfd-token-pos (point)))
5328
5329 ;; Continue if the following token fails the
5330 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5331 (when (or (>= (point) cfd-limit)
5332 (not (looking-at cfd-decl-re))
5333 (and cfd-face-checklist
5334 (not (c-got-face-at
5335 (point) cfd-face-checklist))))
5336 (goto-char cfd-continue-pos)
5337 t)))
5338
5339 (< (point) cfd-limit)) ; end of "false matches" condition
5340 (c-find-decl-prefix-search)) ; end of "false matches" loop
5341
5342 (< (point) cfd-limit)) ; end of condition for "decl-spot" while
5343
5344 (when (and
5345 (>= (point) cfd-start-pos)
5346
5347 (progn
5348 ;; Narrow to the end of the macro if we got a hit inside
5349 ;; one, to avoid recognizing things that start inside the
5350 ;; macro and end outside it.
5351 (when (> cfd-match-pos cfd-macro-end)
5352 ;; Not in the same macro as in the previous round.
5353 (save-excursion
5354 (goto-char cfd-match-pos)
5355 (setq cfd-macro-end
5356 (if (save-excursion (and (c-beginning-of-macro)
5357 (< (point) cfd-match-pos)))
5358 (progn (c-end-of-macro)
5359 (point))
5360 0))))
5361
5362 (if (zerop cfd-macro-end)
5363 t
5364 (if (> cfd-macro-end (point))
5365 (progn (narrow-to-region (point-min) cfd-macro-end)
5366 t)
5367 ;; The matched token was the last thing in the macro,
5368 ;; so the whole match is bogus.
5369 (setq cfd-macro-end 0)
5370 nil)))) ; end of when condition
5371
5372 (c-debug-put-decl-spot-faces cfd-match-pos (point))
5373 (if (funcall cfd-fun cfd-match-pos (/= cfd-macro-end 0))
5374 (setq cfd-prop-match nil))
5375
5376 (when (/= cfd-macro-end 0)
5377 ;; Restore limits if we did macro narrowing above.
5378 (narrow-to-region (point-min) cfd-buffer-end)))
5379
5380 (goto-char cfd-continue-pos)
5381 (if (= cfd-continue-pos cfd-limit)
5382 (setq cfd-match-pos cfd-limit)
5383 (c-find-decl-prefix-search))))) ; Moves point, sets cfd-continue-pos,
5384 ; cfd-match-pos, etc.
5385
5386 \f
5387 ;; A cache for found types.
5388
5389 ;; Buffer local variable that contains an obarray with the types we've
5390 ;; found. If a declaration is recognized somewhere we record the
5391 ;; fully qualified identifier in it to recognize it as a type
5392 ;; elsewhere in the file too. This is not accurate since we do not
5393 ;; bother with the scoping rules of the languages, but in practice the
5394 ;; same name is seldom used as both a type and something else in a
5395 ;; file, and we only use this as a last resort in ambiguous cases (see
5396 ;; `c-forward-decl-or-cast-1').
5397 ;;
5398 ;; Not every type need be in this cache. However, things which have
5399 ;; ceased to be types must be removed from it.
5400 ;;
5401 ;; Template types in C++ are added here too but with the template
5402 ;; arglist replaced with "<>" in references or "<" for the one in the
5403 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5404 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5405 ;; template specs can be fairly sized programs in themselves) and
5406 ;; improves the hit ratio (it's a type regardless of the template
5407 ;; args; it's just not the same type, but we're only interested in
5408 ;; recognizing types, not telling distinct types apart). Note that
5409 ;; template types in references are added here too; from the example
5410 ;; above there will also be an entry "Foo<".
5411 (defvar c-found-types nil)
5412 (make-variable-buffer-local 'c-found-types)
5413
5414 (defsubst c-clear-found-types ()
5415 ;; Clears `c-found-types'.
5416 (setq c-found-types (make-vector 53 0)))
5417
5418 (defun c-add-type (from to)
5419 ;; Add the given region as a type in `c-found-types'. If the region
5420 ;; doesn't match an existing type but there is a type which is equal
5421 ;; to the given one except that the last character is missing, then
5422 ;; the shorter type is removed. That's done to avoid adding all
5423 ;; prefixes of a type as it's being entered and font locked. This
5424 ;; doesn't cover cases like when characters are removed from a type
5425 ;; or added in the middle. We'd need the position of point when the
5426 ;; font locking is invoked to solve this well.
5427 ;;
5428 ;; This function might do hidden buffer changes.
5429 (let ((type (c-syntactic-content from to c-recognize-<>-arglists)))
5430 (unless (intern-soft type c-found-types)
5431 (unintern (substring type 0 -1) c-found-types)
5432 (intern type c-found-types))))
5433
5434 (defun c-unfind-type (name)
5435 ;; Remove the "NAME" from c-found-types, if present.
5436 (unintern name c-found-types))
5437
5438 (defsubst c-check-type (from to)
5439 ;; Return non-nil if the given region contains a type in
5440 ;; `c-found-types'.
5441 ;;
5442 ;; This function might do hidden buffer changes.
5443 (intern-soft (c-syntactic-content from to c-recognize-<>-arglists)
5444 c-found-types))
5445
5446 (defun c-list-found-types ()
5447 ;; Return all the types in `c-found-types' as a sorted list of
5448 ;; strings.
5449 (let (type-list)
5450 (mapatoms (lambda (type)
5451 (setq type-list (cons (symbol-name type)
5452 type-list)))
5453 c-found-types)
5454 (sort type-list 'string-lessp)))
5455
5456 ;; Shut up the byte compiler.
5457 (defvar c-maybe-stale-found-type)
5458
5459 (defun c-trim-found-types (beg end old-len)
5460 ;; An after change function which, in conjunction with the info in
5461 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5462 ;; from `c-found-types', should this type have become stale. For
5463 ;; example, this happens to "foo" when "foo \n bar();" becomes
5464 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5465 ;; the fontification.
5466 ;;
5467 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5468 ;; type?
5469 (when (> end beg)
5470 (save-excursion
5471 (when (< end (point-max))
5472 (goto-char end)
5473 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
5474 (progn (goto-char end)
5475 (c-end-of-current-token)))
5476 (c-unfind-type (buffer-substring-no-properties
5477 end (point)))))
5478 (when (> beg (point-min))
5479 (goto-char beg)
5480 (if (and (c-end-of-current-token) ; only moves when we started in the middle
5481 (progn (goto-char beg)
5482 (c-beginning-of-current-token)))
5483 (c-unfind-type (buffer-substring-no-properties
5484 (point) beg))))))
5485
5486 (if c-maybe-stale-found-type ; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
5487 (cond
5488 ;; Changing the amount of (already existing) whitespace - don't do anything.
5489 ((and (c-partial-ws-p beg end)
5490 (or (= beg end) ; removal of WS
5491 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type)))))
5492
5493 ;; The syntactic relationship which defined a "found type" has been
5494 ;; destroyed.
5495 ((eq (car c-maybe-stale-found-type) 'c-decl-id-start)
5496 (c-unfind-type (cadr c-maybe-stale-found-type)))
5497 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5498 )))
5499
5500 \f
5501 ;; Setting and removing syntax properties on < and > in languages (C++
5502 ;; and Java) where they can be template/generic delimiters as well as
5503 ;; their normal meaning of "less/greater than".
5504
5505 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5506 ;; be delimiters, they are marked as such with the category properties
5507 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5508
5509 ;; STRATEGY:
5510 ;;
5511 ;; It is impossible to determine with certainty whether a <..> pair in
5512 ;; C++ is two comparison operators or is template delimiters, unless
5513 ;; one duplicates a lot of a C++ compiler. For example, the following
5514 ;; code fragment:
5515 ;;
5516 ;; foo (a < b, c > d) ;
5517 ;;
5518 ;; could be a function call with two integer parameters (each a
5519 ;; relational expression), or it could be a constructor for class foo
5520 ;; taking one parameter d of templated type "a < b, c >". They are
5521 ;; somewhat easier to distinguish in Java.
5522 ;;
5523 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5524 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5525 ;; individually when their context so indicated. This gave rise to
5526 ;; intractable problems when one of a matching pair was deleted, or
5527 ;; pulled into a literal.]
5528 ;;
5529 ;; At each buffer change, the syntax-table properties are removed in a
5530 ;; before-change function and reapplied, when needed, in an
5531 ;; after-change function. It is far more important that the
5532 ;; properties get removed when they they are spurious than that they
5533 ;; be present when wanted.
5534 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5535 (defun c-clear-<-pair-props (&optional pos)
5536 ;; POS (default point) is at a < character. If it is marked with
5537 ;; open paren syntax-table text property, remove the property,
5538 ;; together with the close paren property on the matching > (if
5539 ;; any).
5540 (save-excursion
5541 (if pos
5542 (goto-char pos)
5543 (setq pos (point)))
5544 (when (equal (c-get-char-property (point) 'syntax-table)
5545 c-<-as-paren-syntax)
5546 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5547 (c-go-list-forward))
5548 (when (equal (c-get-char-property (1- (point)) 'syntax-table)
5549 c->-as-paren-syntax) ; should always be true.
5550 (c-unmark-<->-as-paren (1- (point))))
5551 (c-unmark-<->-as-paren pos))))
5552
5553 (defun c-clear->-pair-props (&optional pos)
5554 ;; POS (default point) is at a > character. If it is marked with
5555 ;; close paren syntax-table property, remove the property, together
5556 ;; with the open paren property on the matching < (if any).
5557 (save-excursion
5558 (if pos
5559 (goto-char pos)
5560 (setq pos (point)))
5561 (when (equal (c-get-char-property (point) 'syntax-table)
5562 c->-as-paren-syntax)
5563 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5564 (c-go-up-list-backward))
5565 (when (equal (c-get-char-property (point) 'syntax-table)
5566 c-<-as-paren-syntax) ; should always be true.
5567 (c-unmark-<->-as-paren (point)))
5568 (c-unmark-<->-as-paren pos))))
5569
5570 (defun c-clear-<>-pair-props (&optional pos)
5571 ;; POS (default point) is at a < or > character. If it has an
5572 ;; open/close paren syntax-table property, remove this property both
5573 ;; from the current character and its partner (which will also be
5574 ;; thusly marked).
5575 (cond
5576 ((eq (char-after) ?\<)
5577 (c-clear-<-pair-props pos))
5578 ((eq (char-after) ?\>)
5579 (c-clear->-pair-props pos))
5580 (t (c-benign-error
5581 "c-clear-<>-pair-props called from wrong position"))))
5582
5583 (defun c-clear-<-pair-props-if-match-after (lim &optional pos)
5584 ;; POS (default point) is at a < character. If it is both marked
5585 ;; with open/close paren syntax-table property, and has a matching >
5586 ;; (also marked) which is after LIM, remove the property both from
5587 ;; the current > and its partner. Return t when this happens, nil
5588 ;; when it doesn't.
5589 (save-excursion
5590 (if pos
5591 (goto-char pos)
5592 (setq pos (point)))
5593 (when (equal (c-get-char-property (point) 'syntax-table)
5594 c-<-as-paren-syntax)
5595 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5596 (c-go-list-forward))
5597 (when (and (>= (point) lim)
5598 (equal (c-get-char-property (1- (point)) 'syntax-table)
5599 c->-as-paren-syntax)) ; should always be true.
5600 (c-unmark-<->-as-paren (1- (point)))
5601 (c-unmark-<->-as-paren pos))
5602 t)))
5603
5604 (defun c-clear->-pair-props-if-match-before (lim &optional pos)
5605 ;; POS (default point) is at a > character. If it is both marked
5606 ;; with open/close paren syntax-table property, and has a matching <
5607 ;; (also marked) which is before LIM, remove the property both from
5608 ;; the current < and its partner. Return t when this happens, nil
5609 ;; when it doesn't.
5610 (save-excursion
5611 (if pos
5612 (goto-char pos)
5613 (setq pos (point)))
5614 (when (equal (c-get-char-property (point) 'syntax-table)
5615 c->-as-paren-syntax)
5616 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5617 (c-go-up-list-backward))
5618 (when (and (<= (point) lim)
5619 (equal (c-get-char-property (point) 'syntax-table)
5620 c-<-as-paren-syntax)) ; should always be true.
5621 (c-unmark-<->-as-paren (point))
5622 (c-unmark-<->-as-paren pos))
5623 t)))
5624
5625 ;; Set by c-common-init in cc-mode.el.
5626 (defvar c-new-BEG)
5627 (defvar c-new-END)
5628
5629 (defun c-before-change-check-<>-operators (beg end)
5630 ;; Unmark certain pairs of "< .... >" which are currently marked as
5631 ;; template/generic delimiters. (This marking is via syntax-table text
5632 ;; properties), and expand the (c-new-BEG c-new-END) region to include all
5633 ;; unmarked < and > operators within the certain bounds (see below).
5634 ;;
5635 ;; These pairs are those which are in the current "statement" (i.e.,
5636 ;; the region between the {, }, or ; before BEG and the one after
5637 ;; END), and which enclose any part of the interval (BEG END).
5638 ;;
5639 ;; Note that in C++ (?and Java), template/generic parens cannot
5640 ;; enclose a brace or semicolon, so we use these as bounds on the
5641 ;; region we must work on.
5642 ;;
5643 ;; This function is called from before-change-functions (via
5644 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5645 ;; and point is undefined, both at entry and exit.
5646 ;;
5647 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5648 ;; 2010-01-29.
5649 (save-excursion
5650 (c-save-buffer-state
5651 ((beg-lit-limits (progn (goto-char beg) (c-literal-limits)))
5652 (end-lit-limits (progn (goto-char end) (c-literal-limits)))
5653 new-beg new-end beg-limit end-limit)
5654 ;; Locate the earliest < after the barrier before the changed region,
5655 ;; which isn't already marked as a paren.
5656 (goto-char (if beg-lit-limits (car beg-lit-limits) beg))
5657 (setq beg-limit (c-determine-limit 512))
5658
5659 ;; Remove the syntax-table/category properties from each pertinent <...>
5660 ;; pair. Firstly, the ones with the < before beg and > after beg....
5661 (while (progn (c-syntactic-skip-backward "^;{}<" beg-limit)
5662 (eq (char-before) ?<))
5663 (c-backward-token-2)
5664 (when (eq (char-after) ?<)
5665 (c-clear-<-pair-props-if-match-after beg)))
5666 (c-forward-syntactic-ws)
5667 (setq new-beg (point))
5668
5669 ;; ...Then the ones with < before end and > after end.
5670 (goto-char (if end-lit-limits (cdr end-lit-limits) end))
5671 (setq end-limit (c-determine-+ve-limit 512))
5672 (while (and (c-syntactic-re-search-forward "[;{}>]" end-limit 'end)
5673 (eq (char-before) ?>))
5674 (c-end-of-current-token)
5675 (when (eq (char-before) ?>)
5676 (c-clear->-pair-props-if-match-before end (1- (point)))))
5677 (c-backward-syntactic-ws)
5678 (setq new-end (point))
5679
5680 ;; Extend the fontification region, if needed.
5681 (and new-beg
5682 (< new-beg c-new-BEG)
5683 (setq c-new-BEG new-beg))
5684 (and new-end
5685 (> new-end c-new-END)
5686 (setq c-new-END new-end)))))
5687
5688 (defun c-after-change-check-<>-operators (beg end)
5689 ;; This is called from `after-change-functions' when
5690 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5691 ;; chars with paren syntax become part of another operator like "<<"
5692 ;; or ">=".
5693 ;;
5694 ;; This function might do hidden buffer changes.
5695
5696 (save-excursion
5697 (goto-char beg)
5698 (when (or (looking-at "[<>]")
5699 (< (skip-chars-backward "<>") 0))
5700
5701 (goto-char beg)
5702 (c-beginning-of-current-token)
5703 (when (and (< (point) beg)
5704 (looking-at c-<>-multichar-token-regexp)
5705 (< beg (setq beg (match-end 0))))
5706 (while (progn (skip-chars-forward "^<>" beg)
5707 (< (point) beg))
5708 (c-clear-<>-pair-props)
5709 (forward-char))))
5710
5711 (when (< beg end)
5712 (goto-char end)
5713 (when (or (looking-at "[<>]")
5714 (< (skip-chars-backward "<>") 0))
5715
5716 (goto-char end)
5717 (c-beginning-of-current-token)
5718 (when (and (< (point) end)
5719 (looking-at c-<>-multichar-token-regexp)
5720 (< end (setq end (match-end 0))))
5721 (while (progn (skip-chars-forward "^<>" end)
5722 (< (point) end))
5723 (c-clear-<>-pair-props)
5724 (forward-char)))))))
5725
5726 (defun c-restore-<>-properties (_beg _end _old-len)
5727 ;; This function is called as an after-change function. It restores the
5728 ;; category/syntax-table properties on template/generic <..> pairs between
5729 ;; c-new-BEG and c-new-END. It may do hidden buffer changes.
5730 (c-save-buffer-state ((c-parse-and-markup-<>-arglists t)
5731 c-restricted-<>-arglists lit-limits)
5732 (goto-char c-new-BEG)
5733 (if (setq lit-limits (c-literal-limits))
5734 (goto-char (cdr lit-limits)))
5735 (while (and (< (point) c-new-END)
5736 (c-syntactic-re-search-forward "<" c-new-END 'bound))
5737 (backward-char)
5738 (save-excursion
5739 (c-backward-token-2)
5740 (setq c-restricted-<>-arglists
5741 (and (not (looking-at c-opt-<>-sexp-key))
5742 (progn (c-backward-syntactic-ws) ; to ( or ,
5743 (and (memq (char-before) '(?\( ?,)) ; what about <?
5744 (not (eq (c-get-char-property (point) 'c-type)
5745 'c-decl-arg-start)))))))
5746 (or (c-forward-<>-arglist nil)
5747 (forward-char)))))
5748 \f
5749 ;; Handling of small scale constructs like types and names.
5750
5751 ;; Dynamically bound variable that instructs `c-forward-type' to also
5752 ;; treat possible types (i.e. those that it normally returns 'maybe or
5753 ;; 'found for) as actual types (and always return 'found for them).
5754 ;; This means that it records them in `c-record-type-identifiers' if
5755 ;; that is set, and that it adds them to `c-found-types'.
5756 (defvar c-promote-possible-types nil)
5757
5758 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5759 ;; mark up successfully parsed arglists with paren syntax properties on
5760 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5761 ;; `c-type' property of each argument separating comma.
5762 ;;
5763 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5764 ;; all arglists for side effects (i.e. recording types), otherwise it
5765 ;; exploits any existing paren syntax properties to quickly jump to the
5766 ;; end of already parsed arglists.
5767 ;;
5768 ;; Marking up the arglists is not the default since doing that correctly
5769 ;; depends on a proper value for `c-restricted-<>-arglists'.
5770 (defvar c-parse-and-markup-<>-arglists nil)
5771
5772 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5773 ;; not accept arglists that contain binary operators.
5774 ;;
5775 ;; This is primarily used to handle C++ template arglists. C++
5776 ;; disambiguates them by checking whether the preceding name is a
5777 ;; template or not. We can't do that, so we assume it is a template
5778 ;; if it can be parsed as one. That usually works well since
5779 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5780 ;; in almost all cases would be pointless.
5781 ;;
5782 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5783 ;; should let the comma separate the function arguments instead. And
5784 ;; in a context where the value of the expression is taken, e.g. in
5785 ;; "if (a < b || c > d)", it's probably not a template.
5786 (defvar c-restricted-<>-arglists nil)
5787
5788 ;; Dynamically bound variables that instructs
5789 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5790 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5791 ;; `c-forward-label' to record the ranges of all the type and
5792 ;; reference identifiers they encounter. They will build lists on
5793 ;; these variables where each element is a cons of the buffer
5794 ;; positions surrounding each identifier. This recording is only
5795 ;; activated when `c-record-type-identifiers' is non-nil.
5796 ;;
5797 ;; All known types that can't be identifiers are recorded, and also
5798 ;; other possible types if `c-promote-possible-types' is set.
5799 ;; Recording is however disabled inside angle bracket arglists that
5800 ;; are encountered inside names and other angle bracket arglists.
5801 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5802 ;; instead.
5803 ;;
5804 ;; Only the names in C++ template style references (e.g. "tmpl" in
5805 ;; "tmpl<a,b>::foo") are recorded as references, other references
5806 ;; aren't handled here.
5807 ;;
5808 ;; `c-forward-label' records the label identifier(s) on
5809 ;; `c-record-ref-identifiers'.
5810 (defvar c-record-type-identifiers nil)
5811 (defvar c-record-ref-identifiers nil)
5812
5813 ;; This variable will receive a cons cell of the range of the last
5814 ;; single identifier symbol stepped over by `c-forward-name' if it's
5815 ;; successful. This is the range that should be put on one of the
5816 ;; record lists above by the caller. It's assigned nil if there's no
5817 ;; such symbol in the name.
5818 (defvar c-last-identifier-range nil)
5819
5820 (defmacro c-record-type-id (range)
5821 (if (eq (car-safe range) 'cons)
5822 ;; Always true.
5823 `(setq c-record-type-identifiers
5824 (cons ,range c-record-type-identifiers))
5825 `(let ((range ,range))
5826 (if range
5827 (setq c-record-type-identifiers
5828 (cons range c-record-type-identifiers))))))
5829
5830 (defmacro c-record-ref-id (range)
5831 (if (eq (car-safe range) 'cons)
5832 ;; Always true.
5833 `(setq c-record-ref-identifiers
5834 (cons ,range c-record-ref-identifiers))
5835 `(let ((range ,range))
5836 (if range
5837 (setq c-record-ref-identifiers
5838 (cons range c-record-ref-identifiers))))))
5839
5840 ;; Dynamically bound variable that instructs `c-forward-type' to
5841 ;; record the ranges of types that only are found. Behaves otherwise
5842 ;; like `c-record-type-identifiers'.
5843 (defvar c-record-found-types nil)
5844
5845 (defmacro c-forward-keyword-prefixed-id (type)
5846 ;; Used internally in `c-forward-keyword-clause' to move forward
5847 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5848 ;; possibly is prefixed by keywords and their associated clauses.
5849 ;; Try with a type/name first to not trip up on those that begin
5850 ;; with a keyword. Return t if a known or found type is moved
5851 ;; over. The point is clobbered if nil is returned. If range
5852 ;; recording is enabled, the identifier is recorded on as a type
5853 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5854 ;;
5855 ;; This macro might do hidden buffer changes.
5856 `(let (res)
5857 (setq c-last-identifier-range nil)
5858 (while (if (setq res ,(if (eq type 'type)
5859 `(c-forward-type)
5860 `(c-forward-name)))
5861 nil
5862 (cond ((looking-at c-keywords-regexp)
5863 (c-forward-keyword-clause 1))
5864 ((and c-opt-cpp-prefix
5865 (looking-at c-noise-macro-with-parens-name-re))
5866 (c-forward-noise-clause)))))
5867 (when (memq res '(t known found prefix maybe))
5868 (when c-record-type-identifiers
5869 ,(if (eq type 'type)
5870 `(c-record-type-id c-last-identifier-range)
5871 `(c-record-ref-id c-last-identifier-range)))
5872 t)))
5873
5874 (defmacro c-forward-id-comma-list (type update-safe-pos)
5875 ;; Used internally in `c-forward-keyword-clause' to move forward
5876 ;; over a comma separated list of types or names using
5877 ;; `c-forward-keyword-prefixed-id'.
5878 ;;
5879 ;; This macro might do hidden buffer changes.
5880 `(while (and (progn
5881 ,(when update-safe-pos
5882 `(setq safe-pos (point)))
5883 (eq (char-after) ?,))
5884 (progn
5885 (forward-char)
5886 (c-forward-syntactic-ws)
5887 (c-forward-keyword-prefixed-id ,type)))))
5888
5889 (defun c-forward-noise-clause ()
5890 ;; Point is at a c-noise-macro-with-parens-names macro identifier. Go
5891 ;; forward over this name, any parenthesis expression which follows it, and
5892 ;; any syntactic WS, ending up at the next token. If there is an unbalanced
5893 ;; paren expression, leave point at it. Always Return t.
5894 (c-forward-token-2)
5895 (if (and (eq (char-after) ?\()
5896 (c-go-list-forward))
5897 (c-forward-syntactic-ws))
5898 t)
5899
5900 (defun c-forward-keyword-clause (match)
5901 ;; Submatch MATCH in the current match data is assumed to surround a
5902 ;; token. If it's a keyword, move over it and any immediately
5903 ;; following clauses associated with it, stopping at the start of
5904 ;; the next token. t is returned in that case, otherwise the point
5905 ;; stays and nil is returned. The kind of clauses that are
5906 ;; recognized are those specified by `c-type-list-kwds',
5907 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5908 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5909 ;; and `c-<>-arglist-kwds'.
5910 ;;
5911 ;; This function records identifier ranges on
5912 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5913 ;; `c-record-type-identifiers' is non-nil.
5914 ;;
5915 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5916 ;; apply directly after the keyword, the type list is moved over
5917 ;; only when there is no unaccounted token before it (i.e. a token
5918 ;; that isn't moved over due to some other keyword list). The
5919 ;; identifier ranges in the list are still recorded if that should
5920 ;; be done, though.
5921 ;;
5922 ;; This function might do hidden buffer changes.
5923
5924 (let ((kwd-sym (c-keyword-sym (match-string match))) safe-pos pos
5925 ;; The call to `c-forward-<>-arglist' below is made after
5926 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5927 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5928 ;; should therefore be nil.
5929 (c-parse-and-markup-<>-arglists t)
5930 c-restricted-<>-arglists)
5931
5932 (when kwd-sym
5933 (goto-char (match-end match))
5934 (c-forward-syntactic-ws)
5935 (setq safe-pos (point))
5936
5937 (cond
5938 ((and (c-keyword-member kwd-sym 'c-type-list-kwds)
5939 (c-forward-keyword-prefixed-id type))
5940 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5941 (c-forward-id-comma-list type t))
5942
5943 ((and (c-keyword-member kwd-sym 'c-ref-list-kwds)
5944 (c-forward-keyword-prefixed-id ref))
5945 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5946 (c-forward-id-comma-list ref t))
5947
5948 ((and (c-keyword-member kwd-sym 'c-paren-any-kwds)
5949 (eq (char-after) ?\())
5950 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5951
5952 (forward-char)
5953 (when (and (setq pos (c-up-list-forward))
5954 (eq (char-before pos) ?\)))
5955 (when (and c-record-type-identifiers
5956 (c-keyword-member kwd-sym 'c-paren-type-kwds))
5957 ;; Use `c-forward-type' on every identifier we can find
5958 ;; inside the paren, to record the types.
5959 (while (c-syntactic-re-search-forward c-symbol-start pos t)
5960 (goto-char (match-beginning 0))
5961 (unless (c-forward-type)
5962 (looking-at c-symbol-key) ; Always matches.
5963 (goto-char (match-end 0)))))
5964
5965 (goto-char pos)
5966 (c-forward-syntactic-ws)
5967 (setq safe-pos (point))))
5968
5969 ((and (c-keyword-member kwd-sym 'c-<>-sexp-kwds)
5970 (eq (char-after) ?<)
5971 (c-forward-<>-arglist (c-keyword-member kwd-sym 'c-<>-type-kwds)))
5972 (c-forward-syntactic-ws)
5973 (setq safe-pos (point)))
5974
5975 ((and (c-keyword-member kwd-sym 'c-nonsymbol-sexp-kwds)
5976 (not (looking-at c-symbol-start))
5977 (c-safe (c-forward-sexp) t))
5978 (c-forward-syntactic-ws)
5979 (setq safe-pos (point))))
5980
5981 (when (c-keyword-member kwd-sym 'c-colon-type-list-kwds)
5982 (if (eq (char-after) ?:)
5983 ;; If we are at the colon already, we move over the type
5984 ;; list after it.
5985 (progn
5986 (forward-char)
5987 (c-forward-syntactic-ws)
5988 (when (c-forward-keyword-prefixed-id type)
5989 (c-forward-id-comma-list type t)))
5990 ;; Not at the colon, so stop here. But the identifier
5991 ;; ranges in the type list later on should still be
5992 ;; recorded.
5993 (and c-record-type-identifiers
5994 (progn
5995 ;; If a keyword matched both one of the types above and
5996 ;; this one, we match `c-colon-type-list-re' after the
5997 ;; clause matched above.
5998 (goto-char safe-pos)
5999 (looking-at c-colon-type-list-re))
6000 (progn
6001 (goto-char (match-end 0))
6002 (c-forward-syntactic-ws)
6003 (c-forward-keyword-prefixed-id type))
6004 ;; There's a type after the `c-colon-type-list-re' match
6005 ;; after a keyword in `c-colon-type-list-kwds'.
6006 (c-forward-id-comma-list type nil))))
6007
6008 (goto-char safe-pos)
6009 t)))
6010
6011 ;; cc-mode requires cc-fonts.
6012 (declare-function c-fontify-recorded-types-and-refs "cc-fonts" ())
6013
6014 (defun c-forward-<>-arglist (all-types)
6015 ;; The point is assumed to be at a "<". Try to treat it as the open
6016 ;; paren of an angle bracket arglist and move forward to the
6017 ;; corresponding ">". If successful, the point is left after the
6018 ;; ">" and t is returned, otherwise the point isn't moved and nil is
6019 ;; returned. If ALL-TYPES is t then all encountered arguments in
6020 ;; the arglist that might be types are treated as found types.
6021 ;;
6022 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
6023 ;; function handles text properties on the angle brackets and argument
6024 ;; separating commas.
6025 ;;
6026 ;; `c-restricted-<>-arglists' controls how lenient the template
6027 ;; arglist recognition should be.
6028 ;;
6029 ;; This function records identifier ranges on
6030 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6031 ;; `c-record-type-identifiers' is non-nil.
6032 ;;
6033 ;; This function might do hidden buffer changes.
6034
6035 (let ((start (point))
6036 ;; If `c-record-type-identifiers' is set then activate
6037 ;; recording of any found types that constitute an argument in
6038 ;; the arglist.
6039 (c-record-found-types (if c-record-type-identifiers t)))
6040 (if (catch 'angle-bracket-arglist-escape
6041 (setq c-record-found-types
6042 (c-forward-<>-arglist-recur all-types)))
6043 (progn
6044 (when (consp c-record-found-types)
6045 (setq c-record-type-identifiers
6046 ;; `nconc' doesn't mind that the tail of
6047 ;; `c-record-found-types' is t.
6048 (nconc c-record-found-types c-record-type-identifiers)))
6049 t)
6050
6051 (goto-char start)
6052 nil)))
6053
6054 (defun c-forward-<>-arglist-recur (all-types)
6055 ;; Recursive part of `c-forward-<>-arglist'.
6056 ;;
6057 ;; This function might do hidden buffer changes.
6058 (let ((start (point)) res pos
6059 ;; Cover this so that any recorded found type ranges are
6060 ;; automatically lost if it turns out to not be an angle
6061 ;; bracket arglist. It's propagated through the return value
6062 ;; on successful completion.
6063 (c-record-found-types c-record-found-types)
6064 ;; List that collects the positions after the argument
6065 ;; separating ',' in the arglist.
6066 arg-start-pos)
6067 ;; If the '<' has paren open syntax then we've marked it as an angle
6068 ;; bracket arglist before, so skip to the end.
6069 (if (and (not c-parse-and-markup-<>-arglists)
6070 (c-get-char-property (point) 'syntax-table))
6071
6072 (progn
6073 (forward-char)
6074 (if (and (c-go-up-list-forward)
6075 (eq (char-before) ?>))
6076 t
6077 ;; Got unmatched paren angle brackets. We don't clear the paren
6078 ;; syntax properties and retry, on the basis that it's very
6079 ;; unlikely that paren angle brackets become operators by code
6080 ;; manipulation. It's far more likely that it doesn't match due
6081 ;; to narrowing or some temporary change.
6082 (goto-char start)
6083 nil))
6084
6085 (forward-char) ; Forward over the opening '<'.
6086
6087 (unless (looking-at c-<-op-cont-regexp)
6088 ;; go forward one non-alphanumeric character (group) per iteration of
6089 ;; this loop.
6090 (while (and
6091 (progn
6092 (c-forward-syntactic-ws)
6093 (when (or (and c-record-type-identifiers all-types)
6094 (not (equal c-inside-<>-type-key "\\(\\<\\>\\)")))
6095 (c-forward-syntactic-ws)
6096 (cond
6097 ((eq (char-after) ??)
6098 (forward-char))
6099 ((and (looking-at c-identifier-start)
6100 (not (looking-at c-keywords-regexp)))
6101 (if (or (and all-types c-record-type-identifiers)
6102 (c-major-mode-is 'java-mode))
6103 ;; All encountered identifiers are types, so set the
6104 ;; promote flag and parse the type.
6105 (let ((c-promote-possible-types t)
6106 (c-record-found-types t))
6107 (c-forward-type))
6108 (c-forward-token-2))))
6109
6110 (c-forward-syntactic-ws)
6111
6112 (when (looking-at c-inside-<>-type-key)
6113 (goto-char (match-end 1))
6114 (c-forward-syntactic-ws)
6115 (let ((c-promote-possible-types t)
6116 (c-record-found-types t))
6117 (c-forward-type))
6118 (c-forward-syntactic-ws)))
6119
6120 (setq pos (point)) ; e.g. first token inside the '<'
6121
6122 ;; Note: These regexps exploit the match order in \| so
6123 ;; that "<>" is matched by "<" rather than "[^>:-]>".
6124 (c-syntactic-re-search-forward
6125 ;; Stop on ',', '|', '&', '+' and '-' to catch
6126 ;; common binary operators that could be between
6127 ;; two comparison expressions "a<b" and "c>d".
6128 ;; 2016-02-11: C++11 templates can now contain arithmetic
6129 ;; expressions, so template detection in C++ is now less
6130 ;; robust than it was.
6131 c-<>-notable-chars-re
6132 nil t t))
6133
6134 (cond
6135 ((eq (char-before) ?>)
6136 ;; Either an operator starting with '>' or the end of
6137 ;; the angle bracket arglist.
6138
6139 (if (save-excursion
6140 (c-backward-token-2)
6141 (looking-at c-multichar->-op-not->>-regexp))
6142 (progn
6143 (goto-char (match-end 0))
6144 t) ; Continue the loop.
6145
6146 ;; The angle bracket arglist is finished.
6147 (when c-parse-and-markup-<>-arglists
6148 (while arg-start-pos
6149 (c-put-c-type-property (1- (car arg-start-pos))
6150 'c-<>-arg-sep)
6151 (setq arg-start-pos (cdr arg-start-pos)))
6152 (c-mark-<-as-paren start)
6153 (c-mark->-as-paren (1- (point))))
6154 (setq res t)
6155 nil)) ; Exit the loop.
6156
6157 ((eq (char-before) ?<)
6158 ;; Either an operator starting with '<' or a nested arglist.
6159 (setq pos (point))
6160 (let (id-start id-end subres keyword-match)
6161 (cond
6162 ;; The '<' begins a multi-char operator.
6163 ((looking-at c-<-op-cont-regexp)
6164 (goto-char (match-end 0)))
6165 ;; We're at a nested <.....>
6166 ((progn
6167 (backward-char) ; to the '<'
6168 (and
6169 (save-excursion
6170 ;; There's always an identifier before an angle
6171 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
6172 ;; or `c-<>-arglist-kwds'.
6173 (c-backward-syntactic-ws)
6174 (setq id-end (point))
6175 (c-simple-skip-symbol-backward)
6176 (when (or (setq keyword-match
6177 (looking-at c-opt-<>-sexp-key))
6178 (not (looking-at c-keywords-regexp)))
6179 (setq id-start (point))))
6180 (setq subres
6181 (let ((c-promote-possible-types t)
6182 (c-record-found-types t))
6183 (c-forward-<>-arglist-recur
6184 (and keyword-match
6185 (c-keyword-member
6186 (c-keyword-sym (match-string 1))
6187 'c-<>-type-kwds))))))
6188 (or subres (goto-char pos))
6189 subres)
6190 ;; It was an angle bracket arglist.
6191 (setq c-record-found-types subres)
6192
6193 ;; Record the identifier before the template as a type
6194 ;; or reference depending on whether the arglist is last
6195 ;; in a qualified identifier.
6196 (when (and c-record-type-identifiers
6197 (not keyword-match))
6198 (if (and c-opt-identifier-concat-key
6199 (progn
6200 (c-forward-syntactic-ws)
6201 (looking-at c-opt-identifier-concat-key)))
6202 (c-record-ref-id (cons id-start id-end))
6203 (c-record-type-id (cons id-start id-end)))))
6204
6205 ;; At a "less than" operator.
6206 (t
6207 ;; (forward-char) ; NO! We've already gone over the <.
6208 )))
6209 t) ; carry on looping.
6210
6211 ((and
6212 (eq (char-before) ?\()
6213 (c-go-up-list-forward)
6214 (eq (char-before) ?\))))
6215
6216 ((and (not c-restricted-<>-arglists)
6217 (or (and (eq (char-before) ?&)
6218 (not (eq (char-after) ?&)))
6219 (eq (char-before) ?,)))
6220 ;; Just another argument. Record the position. The
6221 ;; type check stuff that made us stop at it is at
6222 ;; the top of the loop.
6223 (setq arg-start-pos (cons (point) arg-start-pos)))
6224
6225 (t
6226 ;; Got a character that can't be in an angle bracket
6227 ;; arglist argument. Abort using `throw', since
6228 ;; it's useless to try to find a surrounding arglist
6229 ;; if we're nested.
6230 (throw 'angle-bracket-arglist-escape nil))))))
6231 (if res
6232 (or c-record-found-types t)))))
6233
6234 (defun c-backward-<>-arglist (all-types &optional limit)
6235 ;; The point is assumed to be directly after a ">". Try to treat it
6236 ;; as the close paren of an angle bracket arglist and move back to
6237 ;; the corresponding "<". If successful, the point is left at
6238 ;; the "<" and t is returned, otherwise the point isn't moved and
6239 ;; nil is returned. ALL-TYPES is passed on to
6240 ;; `c-forward-<>-arglist'.
6241 ;;
6242 ;; If the optional LIMIT is given, it bounds the backward search.
6243 ;; It's then assumed to be at a syntactically relevant position.
6244 ;;
6245 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6246 ;; function for more details.
6247
6248 (let ((start (point)))
6249 (backward-char)
6250 (if (and (not c-parse-and-markup-<>-arglists)
6251 (c-get-char-property (point) 'syntax-table))
6252
6253 (if (and (c-go-up-list-backward)
6254 (eq (char-after) ?<))
6255 t
6256 ;; See corresponding note in `c-forward-<>-arglist'.
6257 (goto-char start)
6258 nil)
6259
6260 (while (progn
6261 (c-syntactic-skip-backward "^<;{}" limit t)
6262
6263 (and
6264 (if (eq (char-before) ?<)
6265 t
6266 ;; Stopped at bob or a char that isn't allowed in an
6267 ;; arglist, so we've failed.
6268 (goto-char start)
6269 nil)
6270
6271 (if (> (point)
6272 (progn (c-beginning-of-current-token)
6273 (point)))
6274 ;; If we moved then the "<" was part of some
6275 ;; multicharacter token.
6276 t
6277
6278 (backward-char)
6279 (let ((beg-pos (point)))
6280 (if (c-forward-<>-arglist all-types)
6281 (cond ((= (point) start)
6282 ;; Matched the arglist. Break the while.
6283 (goto-char beg-pos)
6284 nil)
6285 ((> (point) start)
6286 ;; We started from a non-paren ">" inside an
6287 ;; arglist.
6288 (goto-char start)
6289 nil)
6290 (t
6291 ;; Matched a shorter arglist. Can be a nested
6292 ;; one so continue looking.
6293 (goto-char beg-pos)
6294 t))
6295 t))))))
6296
6297 (/= (point) start))))
6298
6299 (defun c-forward-name ()
6300 ;; Move forward over a complete name if at the beginning of one,
6301 ;; stopping at the next following token. A keyword, as such,
6302 ;; doesn't count as a name. If the point is not at something that
6303 ;; is recognized as a name then it stays put.
6304 ;;
6305 ;; A name could be something as simple as "foo" in C or something as
6306 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6307 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6308 ;; int>::*volatile const" in C++ (this function is actually little
6309 ;; more than a `looking-at' call in all modes except those that,
6310 ;; like C++, have `c-recognize-<>-arglists' set).
6311 ;;
6312 ;; Return
6313 ;; o - nil if no name is found;
6314 ;; o - 'template if it's an identifier ending with an angle bracket
6315 ;; arglist;
6316 ;; o - 'operator of it's an operator identifier;
6317 ;; o - t if it's some other kind of name.
6318 ;;
6319 ;; This function records identifier ranges on
6320 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6321 ;; `c-record-type-identifiers' is non-nil.
6322 ;;
6323 ;; This function might do hidden buffer changes.
6324
6325 (let ((pos (point)) (start (point)) res id-start id-end
6326 ;; Turn off `c-promote-possible-types' here since we might
6327 ;; call `c-forward-<>-arglist' and we don't want it to promote
6328 ;; every suspect thing in the arglist to a type. We're
6329 ;; typically called from `c-forward-type' in this case, and
6330 ;; the caller only wants the top level type that it finds to
6331 ;; be promoted.
6332 c-promote-possible-types)
6333 (while
6334 (and
6335 (looking-at c-identifier-key)
6336
6337 (progn
6338 ;; Check for keyword. We go to the last symbol in
6339 ;; `c-identifier-key' first.
6340 (goto-char (setq id-end (match-end 0)))
6341 (c-simple-skip-symbol-backward)
6342 (setq id-start (point))
6343
6344 (if (looking-at c-keywords-regexp)
6345 (when (and (c-major-mode-is 'c++-mode)
6346 (looking-at
6347 (cc-eval-when-compile
6348 (concat "\\(operator\\|\\(template\\)\\)"
6349 "\\(" (c-lang-const c-nonsymbol-key c++)
6350 "\\|$\\)")))
6351 (if (match-beginning 2)
6352 ;; "template" is only valid inside an
6353 ;; identifier if preceded by "::".
6354 (save-excursion
6355 (c-backward-syntactic-ws)
6356 (and (c-safe (backward-char 2) t)
6357 (looking-at "::")))
6358 t))
6359
6360 ;; Handle a C++ operator or template identifier.
6361 (goto-char id-end)
6362 (c-forward-syntactic-ws)
6363 (cond ((eq (char-before id-end) ?e)
6364 ;; Got "... ::template".
6365 (let ((subres (c-forward-name)))
6366 (when subres
6367 (setq pos (point)
6368 res subres))))
6369
6370 ((looking-at c-identifier-start)
6371 ;; Got a cast operator.
6372 (when (c-forward-type)
6373 (setq pos (point)
6374 res 'operator)
6375 ;; Now we should match a sequence of either
6376 ;; '*', '&' or a name followed by ":: *",
6377 ;; where each can be followed by a sequence
6378 ;; of `c-opt-type-modifier-key'.
6379 (while (cond ((looking-at "[*&]")
6380 (goto-char (match-end 0))
6381 t)
6382 ((looking-at c-identifier-start)
6383 (and (c-forward-name)
6384 (looking-at "::")
6385 (progn
6386 (goto-char (match-end 0))
6387 (c-forward-syntactic-ws)
6388 (eq (char-after) ?*))
6389 (progn
6390 (forward-char)
6391 t))))
6392 (while (progn
6393 (c-forward-syntactic-ws)
6394 (setq pos (point))
6395 (looking-at c-opt-type-modifier-key))
6396 (goto-char (match-end 1))))))
6397
6398 ((looking-at c-overloadable-operators-regexp)
6399 ;; Got some other operator.
6400 (setq c-last-identifier-range
6401 (cons (point) (match-end 0)))
6402 (goto-char (match-end 0))
6403 (c-forward-syntactic-ws)
6404 (setq pos (point)
6405 res 'operator)))
6406
6407 nil)
6408
6409 ;; `id-start' is equal to `id-end' if we've jumped over
6410 ;; an identifier that doesn't end with a symbol token.
6411 ;; That can occur e.g. for Java import directives on the
6412 ;; form "foo.bar.*".
6413 (when (and id-start (/= id-start id-end))
6414 (setq c-last-identifier-range
6415 (cons id-start id-end)))
6416 (goto-char id-end)
6417 (c-forward-syntactic-ws)
6418 (setq pos (point)
6419 res t)))
6420
6421 (progn
6422 (goto-char pos)
6423 (when (or c-opt-identifier-concat-key
6424 c-recognize-<>-arglists)
6425
6426 (cond
6427 ((and c-opt-identifier-concat-key
6428 (looking-at c-opt-identifier-concat-key))
6429 ;; Got a concatenated identifier. This handles the
6430 ;; cases with tricky syntactic whitespace that aren't
6431 ;; covered in `c-identifier-key'.
6432 (goto-char (match-end 0))
6433 (c-forward-syntactic-ws)
6434 t)
6435
6436 ((and c-recognize-<>-arglists
6437 (eq (char-after) ?<))
6438 ;; Maybe an angle bracket arglist.
6439 (when (let (c-last-identifier-range)
6440 (c-forward-<>-arglist nil))
6441
6442 (c-forward-syntactic-ws)
6443 (unless (eq (char-after) ?\()
6444 (setq c-last-identifier-range nil)
6445 (c-add-type start (1+ pos)))
6446 (setq pos (point))
6447
6448 (if (and c-opt-identifier-concat-key
6449 (looking-at c-opt-identifier-concat-key))
6450
6451 ;; Continue if there's an identifier concatenation
6452 ;; operator after the template argument.
6453 (progn
6454 (when (and c-record-type-identifiers id-start)
6455 (c-record-ref-id (cons id-start id-end)))
6456 (forward-char 2)
6457 (c-forward-syntactic-ws)
6458 t)
6459
6460 (when (and c-record-type-identifiers id-start
6461 (not (eq (char-after) ?\()))
6462 (c-record-type-id (cons id-start id-end)))
6463 (setq res 'template)
6464 nil)))
6465 )))))
6466
6467 (goto-char pos)
6468 res))
6469
6470 (defun c-forward-type (&optional brace-block-too)
6471 ;; Move forward over a type spec if at the beginning of one,
6472 ;; stopping at the next following token. The keyword "typedef"
6473 ;; isn't part of a type spec here.
6474 ;;
6475 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6476 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6477 ;; The current (2009-03-10) intention is to convert all uses of
6478 ;; `c-forward-type' to call with this parameter set, then to
6479 ;; eliminate it.
6480 ;;
6481 ;; Return
6482 ;; o - t if it's a known type that can't be a name or other
6483 ;; expression;
6484 ;; o - 'known if it's an otherwise known type (according to
6485 ;; `*-font-lock-extra-types');
6486 ;; o - 'prefix if it's a known prefix of a type;
6487 ;; o - 'found if it's a type that matches one in `c-found-types';
6488 ;; o - 'maybe if it's an identifier that might be a type;
6489 ;; o - 'decltype if it's a decltype(variable) declaration; - or
6490 ;; o - nil if it can't be a type (the point isn't moved then).
6491 ;;
6492 ;; The point is assumed to be at the beginning of a token.
6493 ;;
6494 ;; Note that this function doesn't skip past the brace definition
6495 ;; that might be considered part of the type, e.g.
6496 ;; "enum {a, b, c} foo".
6497 ;;
6498 ;; This function records identifier ranges on
6499 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6500 ;; `c-record-type-identifiers' is non-nil.
6501 ;;
6502 ;; This function might do hidden buffer changes.
6503 (when (and c-recognize-<>-arglists
6504 (looking-at "<"))
6505 (c-forward-<>-arglist t)
6506 (c-forward-syntactic-ws))
6507
6508 (let ((start (point)) pos res name-res id-start id-end id-range)
6509
6510 ;; Skip leading type modifiers. If any are found we know it's a
6511 ;; prefix of a type.
6512 (when c-opt-type-modifier-key ; e.g. "const" "volatile", but NOT "typedef"
6513 (while (looking-at c-opt-type-modifier-key)
6514 (goto-char (match-end 1))
6515 (c-forward-syntactic-ws)
6516 (setq res 'prefix)))
6517
6518 (cond
6519 ((looking-at c-typeof-key) ; e.g. C++'s "decltype".
6520 (goto-char (match-end 1))
6521 (c-forward-syntactic-ws)
6522 (setq res (and (eq (char-after) ?\()
6523 (c-safe (c-forward-sexp))
6524 'decltype))
6525 (if res
6526 (c-forward-syntactic-ws)
6527 (goto-char start)))
6528
6529 ((looking-at c-type-prefix-key) ; e.g. "struct", "class", but NOT
6530 ; "typedef".
6531 (goto-char (match-end 1))
6532 (c-forward-syntactic-ws)
6533
6534 (while (cond
6535 ((looking-at c-decl-hangon-key)
6536 (c-forward-keyword-clause 1))
6537 ((and c-opt-cpp-prefix
6538 (looking-at c-noise-macro-with-parens-name-re))
6539 (c-forward-noise-clause))))
6540
6541 (setq pos (point))
6542
6543 (setq name-res (c-forward-name))
6544 (setq res (not (null name-res)))
6545 (when (eq name-res t)
6546 ;; In many languages the name can be used without the
6547 ;; prefix, so we add it to `c-found-types'.
6548 (c-add-type pos (point))
6549 (when (and c-record-type-identifiers
6550 c-last-identifier-range)
6551 (c-record-type-id c-last-identifier-range)))
6552 (when (and brace-block-too
6553 (memq res '(t nil))
6554 (eq (char-after) ?\{)
6555 (save-excursion
6556 (c-safe
6557 (progn (c-forward-sexp)
6558 (c-forward-syntactic-ws)
6559 (setq pos (point))))))
6560 (goto-char pos)
6561 (setq res t))
6562 (unless res (goto-char start))) ; invalid syntax
6563
6564 ((progn
6565 (setq pos nil)
6566 (if (looking-at c-identifier-start)
6567 (save-excursion
6568 (setq id-start (point)
6569 name-res (c-forward-name))
6570 (when name-res
6571 (setq id-end (point)
6572 id-range c-last-identifier-range))))
6573 (and (cond ((looking-at c-primitive-type-key)
6574 (setq res t))
6575 ((c-with-syntax-table c-identifier-syntax-table
6576 (looking-at c-known-type-key))
6577 (setq res 'known)))
6578 (or (not id-end)
6579 (>= (save-excursion
6580 (save-match-data
6581 (goto-char (match-end 1))
6582 (c-forward-syntactic-ws)
6583 (setq pos (point))))
6584 id-end)
6585 (setq res nil))))
6586 ;; Looking at a primitive or known type identifier. We've
6587 ;; checked for a name first so that we don't go here if the
6588 ;; known type match only is a prefix of another name.
6589
6590 (setq id-end (match-end 1))
6591
6592 (when (and c-record-type-identifiers
6593 (or c-promote-possible-types (eq res t)))
6594 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
6595
6596 (if (and c-opt-type-component-key
6597 (save-match-data
6598 (looking-at c-opt-type-component-key)))
6599 ;; There might be more keywords for the type.
6600 (let (safe-pos)
6601 (c-forward-keyword-clause 1)
6602 (while (progn
6603 (setq safe-pos (point))
6604 (looking-at c-opt-type-component-key))
6605 (when (and c-record-type-identifiers
6606 (looking-at c-primitive-type-key))
6607 (c-record-type-id (cons (match-beginning 1)
6608 (match-end 1))))
6609 (c-forward-keyword-clause 1))
6610 (if (looking-at c-primitive-type-key)
6611 (progn
6612 (when c-record-type-identifiers
6613 (c-record-type-id (cons (match-beginning 1)
6614 (match-end 1))))
6615 (c-forward-keyword-clause 1)
6616 (setq res t))
6617 (goto-char safe-pos)
6618 (setq res 'prefix)))
6619 (unless (save-match-data (c-forward-keyword-clause 1))
6620 (if pos
6621 (goto-char pos)
6622 (goto-char (match-end 1))
6623 (c-forward-syntactic-ws)))))
6624
6625 (name-res
6626 (cond ((eq name-res t)
6627 ;; A normal identifier.
6628 (goto-char id-end)
6629 (if (or res c-promote-possible-types)
6630 (progn
6631 (c-add-type id-start id-end)
6632 (when (and c-record-type-identifiers id-range)
6633 (c-record-type-id id-range))
6634 (unless res
6635 (setq res 'found)))
6636 (setq res (if (c-check-type id-start id-end)
6637 ;; It's an identifier that has been used as
6638 ;; a type somewhere else.
6639 'found
6640 ;; It's an identifier that might be a type.
6641 'maybe))))
6642 ((eq name-res 'template)
6643 ;; A template is sometimes a type.
6644 (goto-char id-end)
6645 (c-forward-syntactic-ws)
6646 (setq res
6647 (if (eq (char-after) ?\()
6648 (if (c-check-type id-start id-end)
6649 ;; It's an identifier that has been used as
6650 ;; a type somewhere else.
6651 'found
6652 ;; It's an identifier that might be a type.
6653 'maybe)
6654 t)))
6655 (t
6656 ;; Otherwise it's an operator identifier, which is not a type.
6657 (goto-char start)
6658 (setq res nil)))))
6659
6660 (when res
6661 ;; Skip trailing type modifiers. If any are found we know it's
6662 ;; a type.
6663 (when c-opt-type-modifier-key
6664 (while (looking-at c-opt-type-modifier-key) ; e.g. "const", "volatile"
6665 (goto-char (match-end 1))
6666 (c-forward-syntactic-ws)
6667 (setq res t)))
6668
6669 ;; Step over any type suffix operator. Do not let the existence
6670 ;; of these alter the classification of the found type, since
6671 ;; these operators typically are allowed in normal expressions
6672 ;; too.
6673 (when c-opt-type-suffix-key ; e.g. "..."
6674 (while (looking-at c-opt-type-suffix-key)
6675 (goto-char (match-end 1))
6676 (c-forward-syntactic-ws)))
6677
6678 (when c-opt-type-concat-key ; Only/mainly for pike.
6679 ;; Look for a trailing operator that concatenates the type
6680 ;; with a following one, and if so step past that one through
6681 ;; a recursive call. Note that we don't record concatenated
6682 ;; types in `c-found-types' - it's the component types that
6683 ;; are recorded when appropriate.
6684 (setq pos (point))
6685 (let* ((c-promote-possible-types (or (memq res '(t known))
6686 c-promote-possible-types))
6687 ;; If we can't promote then set `c-record-found-types' so that
6688 ;; we can merge in the types from the second part afterwards if
6689 ;; it turns out to be a known type there.
6690 (c-record-found-types (and c-record-type-identifiers
6691 (not c-promote-possible-types)))
6692 subres)
6693 (if (and (looking-at c-opt-type-concat-key)
6694
6695 (progn
6696 (goto-char (match-end 1))
6697 (c-forward-syntactic-ws)
6698 (setq subres (c-forward-type))))
6699
6700 (progn
6701 ;; If either operand certainly is a type then both are, but we
6702 ;; don't let the existence of the operator itself promote two
6703 ;; uncertain types to a certain one.
6704 (cond ((eq res t))
6705 ((eq subres t)
6706 (unless (eq name-res 'template)
6707 (c-add-type id-start id-end))
6708 (when (and c-record-type-identifiers id-range)
6709 (c-record-type-id id-range))
6710 (setq res t))
6711 ((eq res 'known))
6712 ((eq subres 'known)
6713 (setq res 'known))
6714 ((eq res 'found))
6715 ((eq subres 'found)
6716 (setq res 'found))
6717 (t
6718 (setq res 'maybe)))
6719
6720 (when (and (eq res t)
6721 (consp c-record-found-types))
6722 ;; Merge in the ranges of any types found by the second
6723 ;; `c-forward-type'.
6724 (setq c-record-type-identifiers
6725 ;; `nconc' doesn't mind that the tail of
6726 ;; `c-record-found-types' is t.
6727 (nconc c-record-found-types
6728 c-record-type-identifiers))))
6729
6730 (goto-char pos))))
6731
6732 (when (and c-record-found-types (memq res '(known found)) id-range)
6733 (setq c-record-found-types
6734 (cons id-range c-record-found-types))))
6735
6736 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6737
6738 res))
6739
6740 (defun c-forward-annotation ()
6741 ;; Used for Java code only at the moment. Assumes point is on the @, moves
6742 ;; forward an annotation and returns t. Leaves point unmoved and returns
6743 ;; nil if there is no annotation at point.
6744 (let ((pos (point)))
6745 (or
6746 (and (looking-at "@")
6747 (not (looking-at c-keywords-regexp))
6748 (progn (forward-char) t)
6749 (looking-at c-symbol-key)
6750 (progn (goto-char (match-end 0))
6751 (c-forward-syntactic-ws)
6752 t)
6753 (if (looking-at "(")
6754 (c-go-list-forward)
6755 t))
6756 (progn (goto-char pos) nil))))
6757
6758 (defmacro c-pull-open-brace (ps)
6759 ;; Pull the next open brace from PS (which has the form of paren-state),
6760 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
6761 `(progn
6762 (while (consp (car ,ps))
6763 (setq ,ps (cdr ,ps)))
6764 (prog1 (car ,ps)
6765 (setq ,ps (cdr ,ps)))))
6766
6767 (defun c-back-over-member-initializer-braces ()
6768 ;; Point is just after a closing brace/parenthesis. Try to parse this as a
6769 ;; C++ member initializer list, going back to just after the introducing ":"
6770 ;; and returning t. Otherwise return nil, leaving point unchanged.
6771 (let ((here (point)) res)
6772 (setq res
6773 (catch 'done
6774 (when (not (c-go-list-backward))
6775 (throw 'done nil))
6776 (c-backward-syntactic-ws)
6777 (when (not (c-simple-skip-symbol-backward))
6778 (throw 'done nil))
6779 (c-backward-syntactic-ws)
6780
6781 (while (eq (char-before) ?,)
6782 (backward-char)
6783 (c-backward-syntactic-ws)
6784 (when (not (memq (char-before) '(?\) ?})))
6785 (throw 'done nil))
6786 (when (not (c-go-list-backward))
6787 (throw 'done nil))
6788 (c-backward-syntactic-ws)
6789 (when (not (c-simple-skip-symbol-backward))
6790 (throw 'done nil))
6791 (c-backward-syntactic-ws))
6792
6793 (eq (char-before) ?:)))
6794 (or res (goto-char here))
6795 res))
6796
6797 (defmacro c-back-over-list-of-member-inits ()
6798 ;; Go back over a list of elements, each looking like:
6799 ;; <symbol> (<expression>) ,
6800 ;; or <symbol> {<expression>} ,
6801 ;; when we are putatively immediately after a comma. Stop when we don't see
6802 ;; a comma. If either of <symbol> or bracketed <expression> is missing,
6803 ;; throw nil to 'level. If the terminating } or ) is unmatched, throw nil
6804 ;; to 'done. This is not a general purpose macro!
6805 `(while (eq (char-before) ?,)
6806 (backward-char)
6807 (c-backward-syntactic-ws)
6808 (when (not (memq (char-before) '(?\) ?})))
6809 (throw 'level nil))
6810 (when (not (c-go-list-backward))
6811 (throw 'done nil))
6812 (c-backward-syntactic-ws)
6813 (when (not (c-simple-skip-symbol-backward))
6814 (throw 'level nil))
6815 (c-backward-syntactic-ws)))
6816
6817 (defun c-back-over-member-initializers ()
6818 ;; Test whether we are in a C++ member initializer list, and if so, go back
6819 ;; to the introducing ":", returning the position of the opening paren of
6820 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6821 (let ((here (point))
6822 (paren-state (c-parse-state))
6823 pos level-plausible at-top-level res)
6824 ;; Assume tentatively that we're at the top level. Try to go back to the
6825 ;; colon we seek.
6826 (setq res
6827 (catch 'done
6828 (setq level-plausible
6829 (catch 'level
6830 (c-backward-syntactic-ws)
6831 (when (memq (char-before) '(?\) ?}))
6832 (when (not (c-go-list-backward))
6833 (throw 'done nil))
6834 (c-backward-syntactic-ws))
6835 (when (c-simple-skip-symbol-backward)
6836 (c-backward-syntactic-ws))
6837 (c-back-over-list-of-member-inits)
6838 (and (eq (char-before) ?:)
6839 (save-excursion
6840 (c-backward-token-2)
6841 (not (looking-at c-:$-multichar-token-regexp)))
6842 (c-just-after-func-arglist-p))))
6843
6844 (while (and (not (and level-plausible
6845 (setq at-top-level (c-at-toplevel-p))))
6846 (setq pos (c-pull-open-brace paren-state))) ; might be a paren.
6847 (setq level-plausible
6848 (catch 'level
6849 (goto-char pos)
6850 (c-backward-syntactic-ws)
6851 (when (not (c-simple-skip-symbol-backward))
6852 (throw 'level nil))
6853 (c-backward-syntactic-ws)
6854 (c-back-over-list-of-member-inits)
6855 (and (eq (char-before) ?:)
6856 (save-excursion
6857 (c-backward-token-2)
6858 (not (looking-at c-:$-multichar-token-regexp)))
6859 (c-just-after-func-arglist-p)))))
6860
6861 (and at-top-level level-plausible)))
6862 (or res (goto-char here))
6863 res))
6864
6865 \f
6866 ;; Handling of large scale constructs like statements and declarations.
6867
6868 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6869 ;; defsubst or perhaps even a defun, but it contains lots of free
6870 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6871 (defmacro c-fdoc-shift-type-backward (&optional short)
6872 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6873 ;; of types when parsing a declaration, which means that it
6874 ;; sometimes consumes the identifier in the declaration as a type.
6875 ;; This is used to "backtrack" and make the last type be treated as
6876 ;; an identifier instead.
6877 `(progn
6878 ,(unless short
6879 ;; These identifiers are bound only in the inner let.
6880 '(setq identifier-type at-type
6881 identifier-start type-start
6882 got-parens nil
6883 got-identifier t
6884 got-suffix t
6885 got-suffix-after-parens id-start
6886 paren-depth 0))
6887
6888 (if (setq at-type (if (eq backup-at-type 'prefix)
6889 t
6890 backup-at-type))
6891 (setq type-start backup-type-start
6892 id-start backup-id-start)
6893 (setq type-start start-pos
6894 id-start start-pos))
6895
6896 ;; When these flags already are set we've found specifiers that
6897 ;; unconditionally signal these attributes - backtracking doesn't
6898 ;; change that. So keep them set in that case.
6899 (or at-type-decl
6900 (setq at-type-decl backup-at-type-decl))
6901 (or maybe-typeless
6902 (setq maybe-typeless backup-maybe-typeless))
6903
6904 ,(unless short
6905 ;; This identifier is bound only in the inner let.
6906 '(setq start id-start))))
6907
6908 (defun c-forward-declarator (&optional limit accept-anon)
6909 ;; Assuming point is at the start of a declarator, move forward over it,
6910 ;; leaving point at the next token after it (e.g. a ) or a ; or a ,).
6911 ;;
6912 ;; Return a list (ID-START ID-END BRACKETS-AFTER-ID GOT-INIT), where ID-START and
6913 ;; ID-END are the bounds of the declarator's identifier, and
6914 ;; BRACKETS-AFTER-ID is non-nil if a [...] pair is present after the id.
6915 ;; GOT-INIT is non-nil when the declarator is followed by "=" or "(".
6916 ;;
6917 ;; If ACCEPT-ANON is non-nil, move forward over any "anonymous declarator",
6918 ;; i.e. something like the (*) in int (*), such as might be found in a
6919 ;; declaration. In such a case ID-START and ID-END in the return value are
6920 ;; both set to nil. A "null" "anonymous declarator" gives a non-nil result.
6921 ;;
6922 ;; If no declarator is found, leave point unmoved and return nil. LIMIT is
6923 ;; an optional limit for forward searching.
6924 ;;
6925 ;; Note that the global variable `c-last-identifier-range' is written to, so
6926 ;; the caller should bind it if necessary.
6927
6928 ;; Inside the following "condition form", we move forward over the
6929 ;; declarator's identifier up as far as any opening bracket (for array
6930 ;; size) or paren (for parameters of function-type) or brace (for
6931 ;; array/struct initialization) or "=" or terminating delimiter
6932 ;; (e.g. "," or ";" or "}").
6933 (let ((here (point))
6934 id-start id-end brackets-after-id paren-depth)
6935 (or limit (setq limit (point-max)))
6936 (if (and
6937 (< (point) limit)
6938
6939 ;; The following form moves forward over the declarator's
6940 ;; identifier (and what precedes it), returning t. If there
6941 ;; wasn't one, it returns nil.
6942 (let (got-identifier)
6943 (setq paren-depth 0)
6944 ;; Skip over type decl prefix operators, one for each iteration
6945 ;; of the while. These are, e.g. "*" in "int *foo" or "(" and
6946 ;; "*" in "int (*foo) (void)" (Note similar code in
6947 ;; `c-forward-decl-or-cast-1'.)
6948 (while
6949 (cond
6950 ((looking-at c-decl-hangon-key)
6951 (c-forward-keyword-clause 1))
6952 ((and c-opt-cpp-prefix
6953 (looking-at c-noise-macro-with-parens-name-re))
6954 (c-forward-noise-clause))
6955 ((and (looking-at c-type-decl-prefix-key)
6956 (if (and (c-major-mode-is 'c++-mode)
6957 (match-beginning 3))
6958 ;; If the third submatch matches in C++ then
6959 ;; we're looking at an identifier that's a
6960 ;; prefix only if it specifies a member pointer.
6961 (progn
6962 (setq id-start (point))
6963 (c-forward-name)
6964 (if (looking-at "\\(::\\)")
6965 ;; We only check for a trailing "::" and
6966 ;; let the "*" that should follow be
6967 ;; matched in the next round.
6968 t
6969 ;; It turned out to be the real identifier,
6970 ;; so flag that and stop.
6971 (setq got-identifier t)
6972 nil))
6973 t))
6974 (if (eq (char-after) ?\()
6975 (progn
6976 (setq paren-depth (1+ paren-depth))
6977 (forward-char))
6978 (goto-char (match-end 1)))
6979 (c-forward-syntactic-ws)
6980 t)))
6981
6982 ;; If we haven't passed the identifier already, do it now.
6983 (unless got-identifier
6984 (setq id-start (point)))
6985 (cond
6986 ((or got-identifier
6987 (c-forward-name))
6988 (save-excursion
6989 (c-backward-syntactic-ws)
6990 (setq id-end (point))))
6991 (accept-anon
6992 (setq id-start nil id-end nil)
6993 t)
6994 (t (/= (point) here))))
6995
6996 ;; Skip out of the parens surrounding the identifier. If closing
6997 ;; parens are missing, this form returns nil.
6998 (or (= paren-depth 0)
6999 (c-safe (goto-char (scan-lists (point) 1 paren-depth))))
7000
7001 (<= (point) limit)
7002
7003 ;; Skip over any trailing bit, such as "__attribute__".
7004 (progn
7005 (while (cond
7006 ((looking-at c-decl-hangon-key)
7007 (c-forward-keyword-clause 1))
7008 ((and c-opt-cpp-prefix
7009 (looking-at c-noise-macro-with-parens-name-re))
7010 (c-forward-noise-clause))))
7011 (<= (point) limit))
7012
7013 ;; Search syntactically to the end of the declarator (";",
7014 ;; ",", a closing paren, eob etc) or to the beginning of an
7015 ;; initializer or function prototype ("=" or "\\s\(").
7016 ;; Note that square brackets are now not also treated as
7017 ;; initializers, since this broke when there were also
7018 ;; initializing brace lists.
7019 (let (found)
7020 (while
7021 (and (setq found (c-syntactic-re-search-forward
7022 "[;,]\\|\\s)\\|\\'\\|\\(=\\|\\s(\\)" limit t t))
7023 (eq (char-before) ?\[)
7024 (c-go-up-list-forward))
7025 (setq brackets-after-id t))
7026 (backward-char)
7027 found))
7028 (list id-start id-end brackets-after-id (match-beginning 1))
7029
7030 (goto-char here)
7031 nil)))
7032
7033 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end)
7034 ;; Move forward over a declaration or a cast if at the start of one.
7035 ;; The point is assumed to be at the start of some token. Nil is
7036 ;; returned if no declaration or cast is recognized, and the point
7037 ;; is clobbered in that case.
7038 ;;
7039 ;; If a declaration is parsed:
7040 ;;
7041 ;; The point is left at the first token after the first complete
7042 ;; declarator, if there is one. The return value is a list of 4 elements,
7043 ;; where the first is the position of the first token in the declarator.
7044 ;; (See below for the other three.)
7045 ;; Some examples:
7046 ;;
7047 ;; void foo (int a, char *b) stuff ...
7048 ;; car ^ ^ point
7049 ;; float (*a)[], b;
7050 ;; car ^ ^ point
7051 ;; unsigned int a = c_style_initializer, b;
7052 ;; car ^ ^ point
7053 ;; unsigned int a (cplusplus_style_initializer), b;
7054 ;; car ^ ^ point (might change)
7055 ;; class Foo : public Bar {}
7056 ;; car ^ ^ point
7057 ;; class PikeClass (int a, string b) stuff ...
7058 ;; car ^ ^ point
7059 ;; enum bool;
7060 ;; car ^ ^ point
7061 ;; enum bool flag;
7062 ;; car ^ ^ point
7063 ;; void cplusplus_function (int x) throw (Bad);
7064 ;; car ^ ^ point
7065 ;; Foo::Foo (int b) : Base (b) {}
7066 ;; car ^ ^ point
7067 ;;
7068 ;; auto foo = 5;
7069 ;; car ^ ^ point
7070 ;; auto cplusplus_11 (int a, char *b) -> decltype (bar):
7071 ;; car ^ ^ point
7072 ;;
7073 ;;
7074 ;;
7075 ;; The second element of the return value is non-nil when a
7076 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
7077 ;; Specifically it is a dotted pair (A . B) where B is t when a
7078 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
7079 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
7080 ;; specifier is present. I.e., (some of) the declared
7081 ;; identifier(s) are types.
7082 ;;
7083 ;; The third element of the return value is non-nil when the declaration
7084 ;; parsed might be an expression. The fourth element is the position of
7085 ;; the start of the type identifier.
7086 ;;
7087 ;; If a cast is parsed:
7088 ;;
7089 ;; The point is left at the first token after the closing paren of
7090 ;; the cast. The return value is `cast'. Note that the start
7091 ;; position must be at the first token inside the cast parenthesis
7092 ;; to recognize it.
7093 ;;
7094 ;; PRECEDING-TOKEN-END is the first position after the preceding
7095 ;; token, i.e. on the other side of the syntactic ws from the point.
7096 ;; Use a value less than or equal to (point-min) if the point is at
7097 ;; the first token in (the visible part of) the buffer.
7098 ;;
7099 ;; CONTEXT is a symbol that describes the context at the point:
7100 ;; 'decl In a comma-separated declaration context (typically
7101 ;; inside a function declaration arglist).
7102 ;; '<> In an angle bracket arglist.
7103 ;; 'arglist Some other type of arglist.
7104 ;; nil Some other context or unknown context. Includes
7105 ;; within the parens of an if, for, ... construct.
7106 ;;
7107 ;; LAST-CAST-END is the first token after the closing paren of a
7108 ;; preceding cast, or nil if none is known. If
7109 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
7110 ;; the position after the closest preceding call where a cast was
7111 ;; matched. In that case it's used to discover chains of casts like
7112 ;; "(a) (b) c".
7113 ;;
7114 ;; This function records identifier ranges on
7115 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7116 ;; `c-record-type-identifiers' is non-nil.
7117 ;;
7118 ;; This function might do hidden buffer changes.
7119
7120 (let (;; `start-pos' is used below to point to the start of the
7121 ;; first type, i.e. after any leading specifiers. It might
7122 ;; also point at the beginning of the preceding syntactic
7123 ;; whitespace.
7124 (start-pos (point))
7125 ;; Set to the result of `c-forward-type'.
7126 at-type
7127 ;; The position of the first token in what we currently
7128 ;; believe is the type in the declaration or cast, after any
7129 ;; specifiers and their associated clauses.
7130 type-start
7131 ;; The position of the first token in what we currently
7132 ;; believe is the declarator for the first identifier. Set
7133 ;; when the type is found, and moved forward over any
7134 ;; `c-decl-hangon-kwds' and their associated clauses that
7135 ;; occurs after the type.
7136 id-start
7137 ;; These store `at-type', `type-start' and `id-start' of the
7138 ;; identifier before the one in those variables. The previous
7139 ;; identifier might turn out to be the real type in a
7140 ;; declaration if the last one has to be the declarator in it.
7141 ;; If `backup-at-type' is nil then the other variables have
7142 ;; undefined values.
7143 backup-at-type backup-type-start backup-id-start
7144 ;; This stores `kwd-sym' of the symbol before the current one.
7145 ;; This is needed to distinguish the C++11 version of "auto" from
7146 ;; the pre C++11 meaning.
7147 backup-kwd-sym
7148 ;; Set if we've found a specifier (apart from "typedef") that makes
7149 ;; the defined identifier(s) types.
7150 at-type-decl
7151 ;; Set if we've a "typedef" keyword.
7152 at-typedef
7153 ;; Set if we've found a specifier that can start a declaration
7154 ;; where there's no type.
7155 maybe-typeless
7156 ;; Save the value of kwd-sym between loops of the "Check for a
7157 ;; type" loop. Needed to distinguish a C++11 "auto" from a pre
7158 ;; C++11 one.
7159 prev-kwd-sym
7160 ;; If a specifier is found that also can be a type prefix,
7161 ;; these flags are set instead of those above. If we need to
7162 ;; back up an identifier, they are copied to the real flag
7163 ;; variables. Thus they only take effect if we fail to
7164 ;; interpret it as a type.
7165 backup-at-type-decl backup-maybe-typeless
7166 ;; Whether we've found a declaration or a cast. We might know
7167 ;; this before we've found the type in it. It's 'ids if we've
7168 ;; found two consecutive identifiers (usually a sure sign, but
7169 ;; we should allow that in labels too), and t if we've found a
7170 ;; specifier keyword (a 100% sure sign).
7171 at-decl-or-cast
7172 ;; Set when we need to back up to parse this as a declaration
7173 ;; but not as a cast.
7174 backup-if-not-cast
7175 ;; For casts, the return position.
7176 cast-end
7177 ;; Have we got a new-style C++11 "auto"?
7178 new-style-auto
7179 ;; Set when the symbol before `preceding-token-end' is known to
7180 ;; terminate the previous construct, or when we're at point-min.
7181 at-decl-start
7182 ;; Save `c-record-type-identifiers' and
7183 ;; `c-record-ref-identifiers' since ranges are recorded
7184 ;; speculatively and should be thrown away if it turns out
7185 ;; that it isn't a declaration or cast.
7186 (save-rec-type-ids c-record-type-identifiers)
7187 (save-rec-ref-ids c-record-ref-identifiers)
7188 ;; Set when we parse a declaration which might also be an expression,
7189 ;; such as "a *b". See CASE 16 and CASE 17.
7190 maybe-expression)
7191
7192 (save-excursion
7193 (goto-char preceding-token-end)
7194 (setq at-decl-start
7195 (or (bobp)
7196 (let ((tok-end (point)))
7197 (c-backward-token-2)
7198 (member (buffer-substring-no-properties (point) tok-end)
7199 c-pre-start-tokens)))))
7200
7201 (while (c-forward-annotation)
7202 (c-forward-syntactic-ws))
7203
7204 ;; Check for a type. Unknown symbols are treated as possible
7205 ;; types, but they could also be specifiers disguised through
7206 ;; macros like __INLINE__, so we recognize both types and known
7207 ;; specifiers after them too.
7208 (while
7209 (let* ((start (point)) kwd-sym kwd-clause-end found-type noise-start)
7210
7211 (cond
7212 ;; Look for a specifier keyword clause.
7213 ((or (looking-at c-prefix-spec-kwds-re)
7214 (and (c-major-mode-is 'java-mode)
7215 (looking-at "@[A-Za-z0-9]+")))
7216 (save-match-data
7217 (if (looking-at c-typedef-key)
7218 (setq at-typedef t)))
7219 (setq kwd-sym (c-keyword-sym (match-string 1)))
7220 (save-excursion
7221 (c-forward-keyword-clause 1)
7222 (setq kwd-clause-end (point))))
7223 ((and c-opt-cpp-prefix
7224 (looking-at c-noise-macro-with-parens-name-re))
7225 (setq noise-start (point))
7226 (c-forward-noise-clause)
7227 (setq kwd-clause-end (point))))
7228
7229 (when (setq found-type (c-forward-type t)) ; brace-block-too
7230 ;; Found a known or possible type or a prefix of a known type.
7231 (when (and (c-major-mode-is 'c++-mode) ; C++11 style "auto"?
7232 (eq prev-kwd-sym (c-keyword-sym "auto"))
7233 (looking-at "[=(]")) ; FIXME!!! proper regexp.
7234 (setq new-style-auto t)
7235 (setq found-type nil)
7236 (goto-char start)) ; position of foo in "auto foo"
7237
7238 (when at-type
7239 ;; Got two identifiers with nothing but whitespace
7240 ;; between them. That can only happen in declarations.
7241 (setq at-decl-or-cast 'ids)
7242
7243 (when (eq at-type 'found)
7244 ;; If the previous identifier is a found type we
7245 ;; record it as a real one; it might be some sort of
7246 ;; alias for a prefix like "unsigned".
7247 (save-excursion
7248 (goto-char type-start)
7249 (let ((c-promote-possible-types t))
7250 (c-forward-type)))))
7251
7252 (setq backup-at-type at-type
7253 backup-type-start type-start
7254 backup-id-start id-start
7255 backup-kwd-sym kwd-sym
7256 at-type found-type
7257 type-start start
7258 id-start (point)
7259 ;; The previous ambiguous specifier/type turned out
7260 ;; to be a type since we've parsed another one after
7261 ;; it, so clear these backup flags.
7262 backup-at-type-decl nil
7263 backup-maybe-typeless nil))
7264
7265 (if (or kwd-sym noise-start)
7266 (progn
7267 ;; Handle known specifier keywords and
7268 ;; `c-decl-hangon-kwds' which can occur after known
7269 ;; types.
7270
7271 (if (or (c-keyword-member kwd-sym 'c-decl-hangon-kwds)
7272 noise-start)
7273 ;; It's a hang-on keyword or noise clause that can occur
7274 ;; anywhere.
7275 (progn
7276 (if at-type
7277 ;; Move the identifier start position if
7278 ;; we've passed a type.
7279 (setq id-start kwd-clause-end)
7280 ;; Otherwise treat this as a specifier and
7281 ;; move the fallback position.
7282 (setq start-pos kwd-clause-end))
7283 (goto-char kwd-clause-end))
7284
7285 ;; It's an ordinary specifier so we know that
7286 ;; anything before this can't be the type.
7287 (setq backup-at-type nil
7288 start-pos kwd-clause-end)
7289
7290 (if found-type
7291 ;; It's ambiguous whether this keyword is a
7292 ;; specifier or a type prefix, so set the backup
7293 ;; flags. (It's assumed that `c-forward-type'
7294 ;; moved further than `c-forward-keyword-clause'.)
7295 (progn
7296 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
7297 (setq backup-at-type-decl t))
7298 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
7299 (setq backup-maybe-typeless t)))
7300
7301 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
7302 ;; This test only happens after we've scanned a type.
7303 ;; So, with valid syntax, kwd-sym can't be 'typedef.
7304 (setq at-type-decl t))
7305 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
7306 (setq maybe-typeless t))
7307
7308 ;; Haven't matched a type so it's an unambiguous
7309 ;; specifier keyword and we know we're in a
7310 ;; declaration.
7311 (setq at-decl-or-cast t)
7312 (setq prev-kwd-sym kwd-sym)
7313
7314 (goto-char kwd-clause-end))))
7315
7316 ;; If the type isn't known we continue so that we'll jump
7317 ;; over all specifiers and type identifiers. The reason
7318 ;; to do this for a known type prefix is to make things
7319 ;; like "unsigned INT16" work.
7320 (and found-type (not (eq found-type t))))))
7321
7322 (cond
7323 ((eq at-type t)
7324 ;; If a known type was found, we still need to skip over any
7325 ;; hangon keyword clauses after it. Otherwise it has already
7326 ;; been done in the loop above.
7327 (while
7328 (cond ((looking-at c-decl-hangon-key)
7329 (c-forward-keyword-clause 1))
7330 ((and c-opt-cpp-prefix
7331 (looking-at c-noise-macro-with-parens-name-re))
7332 (c-forward-noise-clause))))
7333 (setq id-start (point)))
7334
7335 ((eq at-type 'prefix)
7336 ;; A prefix type is itself a primitive type when it's not
7337 ;; followed by another type.
7338 (setq at-type t))
7339
7340 ((not at-type)
7341 ;; Got no type but set things up to continue anyway to handle
7342 ;; the various cases when a declaration doesn't start with a
7343 ;; type.
7344 (setq id-start start-pos))
7345
7346 ((and (eq at-type 'maybe)
7347 (c-major-mode-is 'c++-mode))
7348 ;; If it's C++ then check if the last "type" ends on the form
7349 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
7350 ;; (con|de)structor.
7351 (save-excursion
7352 (let (name end-2 end-1)
7353 (goto-char id-start)
7354 (c-backward-syntactic-ws)
7355 (setq end-2 (point))
7356 (when (and
7357 (c-simple-skip-symbol-backward)
7358 (progn
7359 (setq name
7360 (buffer-substring-no-properties (point) end-2))
7361 ;; Cheating in the handling of syntactic ws below.
7362 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
7363 (progn
7364 (setq end-1 (point))
7365 (c-simple-skip-symbol-backward))
7366 (>= (point) type-start)
7367 (equal (buffer-substring-no-properties (point) end-1)
7368 name))
7369 ;; It is a (con|de)structor name. In that case the
7370 ;; declaration is typeless so zap out any preceding
7371 ;; identifier(s) that we might have taken as types.
7372 (goto-char type-start)
7373 (setq at-type nil
7374 backup-at-type nil
7375 id-start type-start))))))
7376
7377 ;; Check for and step over a type decl expression after the thing
7378 ;; that is or might be a type. This can't be skipped since we
7379 ;; need the correct end position of the declarator for
7380 ;; `max-type-decl-end-*'.
7381 (let ((start (point)) (paren-depth 0) pos
7382 ;; True if there's a non-open-paren match of
7383 ;; `c-type-decl-prefix-key'.
7384 got-prefix
7385 ;; True if the declarator is surrounded by a parenthesis pair.
7386 got-parens
7387 ;; True if there is an identifier in the declarator.
7388 got-identifier
7389 ;; True if there's a non-close-paren match of
7390 ;; `c-type-decl-suffix-key'.
7391 got-suffix
7392 ;; True if there's a prefix match outside the outermost
7393 ;; paren pair that surrounds the declarator.
7394 got-prefix-before-parens
7395 ;; True if there's a suffix match outside the outermost
7396 ;; paren pair that surrounds the declarator. The value is
7397 ;; the position of the first suffix match.
7398 got-suffix-after-parens
7399 ;; True if we've parsed the type decl to a token that is
7400 ;; known to end declarations in this context.
7401 at-decl-end
7402 ;; The earlier values of `at-type' and `type-start' if we've
7403 ;; shifted the type backwards.
7404 identifier-type identifier-start
7405 ;; If `c-parse-and-markup-<>-arglists' is set we need to
7406 ;; turn it off during the name skipping below to avoid
7407 ;; getting `c-type' properties that might be bogus. That
7408 ;; can happen since we don't know if
7409 ;; `c-restricted-<>-arglists' will be correct inside the
7410 ;; arglist paren that gets entered.
7411 c-parse-and-markup-<>-arglists
7412 ;; Start of the identifier for which `got-identifier' was set.
7413 name-start)
7414
7415 (goto-char id-start)
7416
7417 ;; Skip over type decl prefix operators. (Note similar code in
7418 ;; `c-forward-declarator'.)
7419 (if (and c-recognize-typeless-decls
7420 (equal c-type-decl-prefix-key "\\<\\>"))
7421 (when (eq (char-after) ?\()
7422 (progn
7423 (setq paren-depth (1+ paren-depth))
7424 (forward-char)))
7425 (while (and (looking-at c-type-decl-prefix-key)
7426 (if (and (c-major-mode-is 'c++-mode)
7427 (match-beginning 3))
7428 ;; If the third submatch matches in C++ then
7429 ;; we're looking at an identifier that's a
7430 ;; prefix only if it specifies a member pointer.
7431 (when (progn (setq pos (point))
7432 (setq got-identifier (c-forward-name)))
7433 (setq name-start pos)
7434 (if (looking-at "\\(::\\)")
7435 ;; We only check for a trailing "::" and
7436 ;; let the "*" that should follow be
7437 ;; matched in the next round.
7438 (progn (setq got-identifier nil) t)
7439 ;; It turned out to be the real identifier,
7440 ;; so stop.
7441 nil))
7442 t))
7443
7444 (if (eq (char-after) ?\()
7445 (progn
7446 (setq paren-depth (1+ paren-depth))
7447 (forward-char))
7448 (unless got-prefix-before-parens
7449 (setq got-prefix-before-parens (= paren-depth 0)))
7450 (setq got-prefix t)
7451 (goto-char (match-end 1)))
7452 (c-forward-syntactic-ws)))
7453
7454 (setq got-parens (> paren-depth 0))
7455
7456 ;; Skip over an identifier.
7457 (or got-identifier
7458 (and (looking-at c-identifier-start)
7459 (setq pos (point))
7460 (setq got-identifier (c-forward-name))
7461 (setq name-start pos)))
7462
7463 ;; Skip over type decl suffix operators and trailing noise macros.
7464 (while
7465 (cond
7466 ((and c-opt-cpp-prefix
7467 (looking-at c-noise-macro-with-parens-name-re))
7468 (c-forward-noise-clause))
7469
7470 ((looking-at c-type-decl-suffix-key)
7471 (if (eq (char-after) ?\))
7472 (when (> paren-depth 0)
7473 (setq paren-depth (1- paren-depth))
7474 (forward-char)
7475 t)
7476 (when (if (save-match-data (looking-at "\\s("))
7477 (c-safe (c-forward-sexp 1) t)
7478 (goto-char (match-end 1))
7479 t)
7480 (when (and (not got-suffix-after-parens)
7481 (= paren-depth 0))
7482 (setq got-suffix-after-parens (match-beginning 0)))
7483 (setq got-suffix t))))
7484
7485 (t
7486 ;; No suffix matched. We might have matched the
7487 ;; identifier as a type and the open paren of a
7488 ;; function arglist as a type decl prefix. In that
7489 ;; case we should "backtrack": Reinterpret the last
7490 ;; type as the identifier, move out of the arglist and
7491 ;; continue searching for suffix operators.
7492 ;;
7493 ;; Do this even if there's no preceding type, to cope
7494 ;; with old style function declarations in K&R C,
7495 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
7496 ;; style declarations. That isn't applicable in an
7497 ;; arglist context, though.
7498 (when (and (= paren-depth 1)
7499 (not got-prefix-before-parens)
7500 (not (eq at-type t))
7501 (or backup-at-type
7502 maybe-typeless
7503 backup-maybe-typeless
7504 (when c-recognize-typeless-decls
7505 (not context)))
7506 (setq pos (c-up-list-forward (point)))
7507 (eq (char-before pos) ?\)))
7508 (c-fdoc-shift-type-backward)
7509 (goto-char pos)
7510 t)))
7511
7512 (c-forward-syntactic-ws))
7513
7514 (when (or (and new-style-auto
7515 (looking-at c-auto-ops-re))
7516 (and (or maybe-typeless backup-maybe-typeless)
7517 (not got-identifier)
7518 (not got-prefix)
7519 at-type))
7520 ;; Have found no identifier but `c-typeless-decl-kwds' has
7521 ;; matched so we know we're inside a declaration. The
7522 ;; preceding type must be the identifier instead.
7523 (c-fdoc-shift-type-backward))
7524
7525 ;; Prepare the "-> type;" for fontification later on.
7526 (when (and new-style-auto
7527 (looking-at c-haskell-op-re))
7528 (save-excursion
7529 (goto-char (match-end 0))
7530 (c-forward-syntactic-ws)
7531 (setq type-start (point))
7532 (setq at-type (c-forward-type))))
7533
7534 (setq
7535 at-decl-or-cast
7536 (catch 'at-decl-or-cast
7537
7538 ;; CASE 1
7539 (when (> paren-depth 0)
7540 ;; Encountered something inside parens that isn't matched by
7541 ;; the `c-type-decl-*' regexps, so it's not a type decl
7542 ;; expression. Try to skip out to the same paren depth to
7543 ;; not confuse the cast check below.
7544 (c-safe (goto-char (scan-lists (point) 1 paren-depth)))
7545 ;; If we've found a specifier keyword then it's a
7546 ;; declaration regardless.
7547 (throw 'at-decl-or-cast (eq at-decl-or-cast t)))
7548
7549 (setq at-decl-end
7550 (looking-at (cond ((eq context '<>) "[,>]")
7551 (context "[,)]")
7552 (t "[,;]"))))
7553
7554 ;; Now we've collected info about various characteristics of
7555 ;; the construct we're looking at. Below follows a decision
7556 ;; tree based on that. It's ordered to check more certain
7557 ;; signs before less certain ones.
7558
7559 (if got-identifier
7560 (progn
7561
7562 ;; CASE 2
7563 (when (and (or at-type maybe-typeless)
7564 (not (or got-prefix got-parens)))
7565 ;; Got another identifier directly after the type, so it's a
7566 ;; declaration.
7567 (throw 'at-decl-or-cast t))
7568
7569 (when (and got-parens
7570 (not got-prefix)
7571 ;; (not got-suffix-after-parens)
7572 (or backup-at-type
7573 maybe-typeless
7574 backup-maybe-typeless
7575 (eq at-decl-or-cast t)
7576 (save-excursion
7577 (goto-char name-start)
7578 (not (memq (c-forward-type) '(nil maybe))))))
7579 ;; Got a declaration of the form "foo bar (gnu);" or "bar
7580 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
7581 ;; as the declarator. In this case it's however more likely
7582 ;; that "bar" is the declarator and "gnu" a function argument
7583 ;; or initializer (if `c-recognize-paren-inits' is set),
7584 ;; since the parens around "gnu" would be superfluous if it's
7585 ;; a declarator. Shift the type one step backward.
7586 (c-fdoc-shift-type-backward)))
7587
7588 ;; Found no identifier.
7589
7590 (if backup-at-type
7591 (progn
7592
7593 ;; CASE 3
7594 (when (= (point) start)
7595 ;; Got a plain list of identifiers. If a colon follows it's
7596 ;; a valid label, or maybe a bitfield. Otherwise the last
7597 ;; one probably is the declared identifier and we should
7598 ;; back up to the previous type, providing it isn't a cast.
7599 (if (and (eq (char-after) ?:)
7600 (not (c-major-mode-is 'java-mode)))
7601 (cond
7602 ;; If we've found a specifier keyword then it's a
7603 ;; declaration regardless.
7604 ((eq at-decl-or-cast t)
7605 (throw 'at-decl-or-cast t))
7606 ((and c-has-bitfields
7607 (eq at-decl-or-cast 'ids)) ; bitfield.
7608 (setq backup-if-not-cast t)
7609 (throw 'at-decl-or-cast t)))
7610
7611 (setq backup-if-not-cast t)
7612 (throw 'at-decl-or-cast t)))
7613
7614 ;; CASE 4
7615 (when (and got-suffix
7616 (not got-prefix)
7617 (not got-parens))
7618 ;; Got a plain list of identifiers followed by some suffix.
7619 ;; If this isn't a cast then the last identifier probably is
7620 ;; the declared one and we should back up to the previous
7621 ;; type.
7622 (setq backup-if-not-cast t)
7623 (throw 'at-decl-or-cast t)))
7624
7625 ;; CASE 5
7626 (when (eq at-type t)
7627 ;; If the type is known we know that there can't be any
7628 ;; identifier somewhere else, and it's only in declarations in
7629 ;; e.g. function prototypes and in casts that the identifier may
7630 ;; be left out.
7631 (throw 'at-decl-or-cast t))
7632
7633 (when (= (point) start)
7634 ;; Only got a single identifier (parsed as a type so far).
7635 ;; CASE 6
7636 (if (and
7637 ;; Check that the identifier isn't at the start of an
7638 ;; expression.
7639 at-decl-end
7640 (cond
7641 ((eq context 'decl)
7642 ;; Inside an arglist that contains declarations. If K&R
7643 ;; style declarations and parenthesis style initializers
7644 ;; aren't allowed then the single identifier must be a
7645 ;; type, else we require that it's known or found
7646 ;; (primitive types are handled above).
7647 (or (and (not c-recognize-knr-p)
7648 (not c-recognize-paren-inits))
7649 (memq at-type '(known found))))
7650 ((eq context '<>)
7651 ;; Inside a template arglist. Accept known and found
7652 ;; types; other identifiers could just as well be
7653 ;; constants in C++.
7654 (memq at-type '(known found)))))
7655 (throw 'at-decl-or-cast t)
7656 ;; CASE 7
7657 ;; Can't be a valid declaration or cast, but if we've found a
7658 ;; specifier it can't be anything else either, so treat it as
7659 ;; an invalid/unfinished declaration or cast.
7660 (throw 'at-decl-or-cast at-decl-or-cast))))
7661
7662 (if (and got-parens
7663 (not got-prefix)
7664 (not context)
7665 (not (eq at-type t))
7666 (or backup-at-type
7667 maybe-typeless
7668 backup-maybe-typeless
7669 (when c-recognize-typeless-decls
7670 (or (not got-suffix)
7671 (not (looking-at
7672 c-after-suffixed-type-maybe-decl-key))))))
7673 ;; Got an empty paren pair and a preceding type that probably
7674 ;; really is the identifier. Shift the type backwards to make
7675 ;; the last one the identifier. This is analogous to the
7676 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7677 ;; above.
7678 ;;
7679 ;; Exception: In addition to the conditions in that
7680 ;; "backtracking" code, do not shift backward if we're not
7681 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7682 ;; Since there's no preceding type, the shift would mean that
7683 ;; the declaration is typeless. But if the regexp doesn't match
7684 ;; then we will simply fall through in the tests below and not
7685 ;; recognize it at all, so it's better to try it as an abstract
7686 ;; declarator instead.
7687 (c-fdoc-shift-type-backward)
7688
7689 ;; Still no identifier.
7690 ;; CASE 8
7691 (when (and got-prefix (or got-parens got-suffix))
7692 ;; Require `got-prefix' together with either `got-parens' or
7693 ;; `got-suffix' to recognize it as an abstract declarator:
7694 ;; `got-parens' only is probably an empty function call.
7695 ;; `got-suffix' only can build an ordinary expression together
7696 ;; with the preceding identifier which we've taken as a type.
7697 ;; We could actually accept on `got-prefix' only, but that can
7698 ;; easily occur temporarily while writing an expression so we
7699 ;; avoid that case anyway. We could do a better job if we knew
7700 ;; the point when the fontification was invoked.
7701 (throw 'at-decl-or-cast t))
7702
7703 ;; CASE 9
7704 (when (and at-type
7705 (not got-prefix)
7706 (not got-parens)
7707 got-suffix-after-parens
7708 (eq (char-after got-suffix-after-parens) ?\())
7709 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7710 ;; normal function call after all (or perhaps a C++ style object
7711 ;; instantiation expression).
7712 (throw 'at-decl-or-cast nil))))
7713
7714 ;; CASE 10
7715 (when at-decl-or-cast
7716 ;; By now we've located the type in the declaration that we know
7717 ;; we're in.
7718 (throw 'at-decl-or-cast t))
7719
7720 ;; CASE 11
7721 (when (and got-identifier
7722 (not context)
7723 (looking-at c-after-suffixed-type-decl-key)
7724 (if (and got-parens
7725 (not got-prefix)
7726 (not got-suffix)
7727 (not (eq at-type t)))
7728 ;; Shift the type backward in the case that there's a
7729 ;; single identifier inside parens. That can only
7730 ;; occur in K&R style function declarations so it's
7731 ;; more likely that it really is a function call.
7732 ;; Therefore we only do this after
7733 ;; `c-after-suffixed-type-decl-key' has matched.
7734 (progn (c-fdoc-shift-type-backward) t)
7735 got-suffix-after-parens))
7736 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7737 (throw 'at-decl-or-cast t))
7738
7739 ;; CASE 12
7740 (when (and (or got-prefix (not got-parens))
7741 (memq at-type '(t known)))
7742 ;; It's a declaration if a known type precedes it and it can't be a
7743 ;; function call.
7744 (throw 'at-decl-or-cast t))
7745
7746 ;; If we get here we can't tell if this is a type decl or a normal
7747 ;; expression by looking at it alone. (That's under the assumption
7748 ;; that normal expressions always can look like type decl expressions,
7749 ;; which isn't really true but the cases where it doesn't hold are so
7750 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7751 ;; the effort to look for them.)
7752
7753 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
7754 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
7755 ;;; as a(n almost complete) declaration, enabling it to be fontified.
7756 ;; CASE 13
7757 ;; (unless (or at-decl-end (looking-at "=[^=]"))
7758 ;; If this is a declaration it should end here or its initializer(*)
7759 ;; should start here, so check for allowed separation tokens. Note
7760 ;; that this rule doesn't work e.g. with a K&R arglist after a
7761 ;; function header.
7762 ;;
7763 ;; *) Don't check for C++ style initializers using parens
7764 ;; since those already have been matched as suffixes.
7765 ;;
7766 ;; If `at-decl-or-cast' is then we've found some other sign that
7767 ;; it's a declaration or cast, so then it's probably an
7768 ;; invalid/unfinished one.
7769 ;; (throw 'at-decl-or-cast at-decl-or-cast))
7770
7771 ;; Below are tests that only should be applied when we're certain to
7772 ;; not have parsed halfway through an expression.
7773
7774 ;; CASE 14
7775 (when (memq at-type '(t known))
7776 ;; The expression starts with a known type so treat it as a
7777 ;; declaration.
7778 (throw 'at-decl-or-cast t))
7779
7780 ;; CASE 15
7781 (when (and (c-major-mode-is 'c++-mode)
7782 ;; In C++ we check if the identifier is a known type, since
7783 ;; (con|de)structors use the class name as identifier.
7784 ;; We've always shifted over the identifier as a type and
7785 ;; then backed up again in this case.
7786 identifier-type
7787 (or (memq identifier-type '(found known))
7788 (and (eq (char-after identifier-start) ?~)
7789 ;; `at-type' probably won't be 'found for
7790 ;; destructors since the "~" is then part of the
7791 ;; type name being checked against the list of
7792 ;; known types, so do a check without that
7793 ;; operator.
7794 (or (save-excursion
7795 (goto-char (1+ identifier-start))
7796 (c-forward-syntactic-ws)
7797 (c-with-syntax-table
7798 c-identifier-syntax-table
7799 (looking-at c-known-type-key)))
7800 (save-excursion
7801 (goto-char (1+ identifier-start))
7802 ;; We have already parsed the type earlier,
7803 ;; so it'd be possible to cache the end
7804 ;; position instead of redoing it here, but
7805 ;; then we'd need to keep track of another
7806 ;; position everywhere.
7807 (c-check-type (point)
7808 (progn (c-forward-type)
7809 (point))))))))
7810 (throw 'at-decl-or-cast t))
7811
7812 (if got-identifier
7813 (progn
7814 ;; CASE 16
7815 (when (and got-prefix-before-parens
7816 at-type
7817 (or at-decl-end (looking-at "=[^=]"))
7818 (not context)
7819 (or (not got-suffix)
7820 at-decl-start))
7821 ;; Got something like "foo * bar;". Since we're not inside
7822 ;; an arglist it would be a meaningless expression because
7823 ;; the result isn't used. We therefore choose to recognize
7824 ;; it as a declaration. We only allow a suffix (which makes
7825 ;; the construct look like a function call) when
7826 ;; `at-decl-start' provides additional evidence that we do
7827 ;; have a declaration.
7828 (setq maybe-expression t)
7829 (throw 'at-decl-or-cast t))
7830
7831 ;; CASE 17
7832 (when (and (or got-suffix-after-parens
7833 (looking-at "=[^=]"))
7834 (eq at-type 'found)
7835 (not (eq context 'arglist)))
7836 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7837 ;; be an odd expression or it could be a declaration. Treat
7838 ;; it as a declaration if "a" has been used as a type
7839 ;; somewhere else (if it's a known type we won't get here).
7840 (setq maybe-expression t)
7841 (throw 'at-decl-or-cast t)))
7842
7843 ;; CASE 18
7844 (when (and context
7845 (or got-prefix
7846 (and (eq context 'decl)
7847 (not c-recognize-paren-inits)
7848 (or got-parens got-suffix))))
7849 ;; Got a type followed by an abstract declarator. If `got-prefix'
7850 ;; is set it's something like "a *" without anything after it. If
7851 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7852 ;; or similar, which we accept only if the context rules out
7853 ;; expressions.
7854 (throw 'at-decl-or-cast t)))
7855
7856 ;; If we had a complete symbol table here (which rules out
7857 ;; `c-found-types') we should return t due to the disambiguation rule
7858 ;; (in at least C++) that anything that can be parsed as a declaration
7859 ;; is a declaration. Now we're being more defensive and prefer to
7860 ;; highlight things like "foo (bar);" as a declaration only if we're
7861 ;; inside an arglist that contains declarations.
7862 ;; CASE 19
7863 (eq context 'decl))))
7864
7865 ;; The point is now after the type decl expression.
7866
7867 (cond
7868 ;; Check for a cast.
7869 ((save-excursion
7870 (and
7871 c-cast-parens
7872
7873 ;; Should be the first type/identifier in a cast paren.
7874 (> preceding-token-end (point-min))
7875 (memq (char-before preceding-token-end) c-cast-parens)
7876
7877 ;; The closing paren should follow.
7878 (progn
7879 (c-forward-syntactic-ws)
7880 (looking-at "\\s)"))
7881
7882 ;; There should be a primary expression after it.
7883 (let (pos)
7884 (forward-char)
7885 (c-forward-syntactic-ws)
7886 (setq cast-end (point))
7887 (and (looking-at c-primary-expr-regexp)
7888 (progn
7889 (setq pos (match-end 0))
7890 (or
7891 ;; Check if the expression begins with a prefix keyword.
7892 (match-beginning 2)
7893 (if (match-beginning 1)
7894 ;; Expression begins with an ambiguous operator. Treat
7895 ;; it as a cast if it's a type decl or if we've
7896 ;; recognized the type somewhere else.
7897 (or at-decl-or-cast
7898 (memq at-type '(t known found)))
7899 ;; Unless it's a keyword, it's the beginning of a primary
7900 ;; expression.
7901 (not (looking-at c-keywords-regexp)))))
7902 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7903 ;; that it matched a whole one so that we don't e.g. confuse
7904 ;; the operator '-' with '->'. It's ok if it matches further,
7905 ;; though, since it e.g. can match the float '.5' while the
7906 ;; operator regexp only matches '.'.
7907 (or (not (looking-at c-nonsymbol-token-regexp))
7908 (<= (match-end 0) pos))))
7909
7910 ;; There should either be a cast before it or something that isn't an
7911 ;; identifier or close paren.
7912 (> preceding-token-end (point-min))
7913 (progn
7914 (goto-char (1- preceding-token-end))
7915 (or (eq (point) last-cast-end)
7916 (progn
7917 (c-backward-syntactic-ws)
7918 (if (< (skip-syntax-backward "w_") 0)
7919 ;; It's a symbol. Accept it only if it's one of the
7920 ;; keywords that can precede an expression (without
7921 ;; surrounding parens).
7922 (looking-at c-simple-stmt-key)
7923 (and
7924 ;; Check that it isn't a close paren (block close is ok,
7925 ;; though).
7926 (not (memq (char-before) '(?\) ?\])))
7927 ;; Check that it isn't a nonsymbol identifier.
7928 (not (c-on-identifier)))))))))
7929
7930 ;; Handle the cast.
7931 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
7932 (let ((c-promote-possible-types t))
7933 (goto-char type-start)
7934 (c-forward-type)))
7935
7936 (goto-char cast-end)
7937 'cast)
7938
7939 (at-decl-or-cast
7940 ;; We're at a declaration. Highlight the type and the following
7941 ;; declarators.
7942
7943 (when backup-if-not-cast
7944 (c-fdoc-shift-type-backward t))
7945
7946 (when (and (eq context 'decl) (looking-at ","))
7947 ;; Make sure to propagate the `c-decl-arg-start' property to
7948 ;; the next argument if it's set in this one, to cope with
7949 ;; interactive refontification.
7950 (c-put-c-type-property (point) 'c-decl-arg-start))
7951
7952 ;; Record the type's coordinates in `c-record-type-identifiers' for
7953 ;; later fontification.
7954 (when (and c-record-type-identifiers at-type ;; (not (eq at-type t))
7955 ;; There seems no reason to exclude a token from
7956 ;; fontification just because it's "a known type that can't
7957 ;; be a name or other expression". 2013-09-18.
7958 )
7959 (let ((c-promote-possible-types t))
7960 (save-excursion
7961 (goto-char type-start)
7962 (c-forward-type))))
7963
7964 (list id-start
7965 (and (or at-type-decl at-typedef)
7966 (cons at-type-decl at-typedef))
7967 maybe-expression
7968 type-start))
7969
7970 (t
7971 ;; False alarm. Restore the recorded ranges.
7972 (setq c-record-type-identifiers save-rec-type-ids
7973 c-record-ref-identifiers save-rec-ref-ids)
7974 nil))))
7975
7976 (defun c-forward-label (&optional assume-markup preceding-token-end limit)
7977 ;; Assuming that point is at the beginning of a token, check if it starts a
7978 ;; label and if so move over it and return non-nil (t in default situations,
7979 ;; specific symbols (see below) for interesting situations), otherwise don't
7980 ;; move and return nil. "Label" here means "most things with a colon".
7981 ;;
7982 ;; More precisely, a "label" is regarded as one of:
7983 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7984 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7985 ;; bare "case", should the colon be missing. We return t;
7986 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7987 ;; return t;
7988 ;; (iv) One of QT's "extended" C++ variants of
7989 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7990 ;; Returns the symbol `qt-2kwds-colon'.
7991 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7992 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7993 ;; colon). Currently (2006-03), this applies only to Objective C's
7994 ;; keywords "@private", "@protected", and "@public". Returns t.
7995 ;;
7996 ;; One of the things which will NOT be recognized as a label is a bit-field
7997 ;; element of a struct, something like "int foo:5".
7998 ;;
7999 ;; The end of the label is taken to be just after the colon, or the end of
8000 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
8001 ;; after the end on return. The terminating char gets marked with
8002 ;; `c-decl-end' to improve recognition of the following declaration or
8003 ;; statement.
8004 ;;
8005 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
8006 ;; label, if any, has already been marked up like that.
8007 ;;
8008 ;; If PRECEDING-TOKEN-END is given, it should be the first position
8009 ;; after the preceding token, i.e. on the other side of the
8010 ;; syntactic ws from the point. Use a value less than or equal to
8011 ;; (point-min) if the point is at the first token in (the visible
8012 ;; part of) the buffer.
8013 ;;
8014 ;; The optional LIMIT limits the forward scan for the colon.
8015 ;;
8016 ;; This function records the ranges of the label symbols on
8017 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
8018 ;; non-nil.
8019 ;;
8020 ;; This function might do hidden buffer changes.
8021
8022 (let ((start (point))
8023 label-end
8024 qt-symbol-idx
8025 macro-start ; if we're in one.
8026 label-type
8027 kwd)
8028 (cond
8029 ;; "case" or "default" (Doesn't apply to AWK).
8030 ((looking-at c-label-kwds-regexp)
8031 (let ((kwd-end (match-end 1)))
8032 ;; Record only the keyword itself for fontification, since in
8033 ;; case labels the following is a constant expression and not
8034 ;; a label.
8035 (when c-record-type-identifiers
8036 (c-record-ref-id (cons (match-beginning 1) kwd-end)))
8037
8038 ;; Find the label end.
8039 (goto-char kwd-end)
8040 (setq label-type
8041 (if (and (c-syntactic-re-search-forward
8042 ;; Stop on chars that aren't allowed in expressions,
8043 ;; and on operator chars that would be meaningless
8044 ;; there. FIXME: This doesn't cope with ?: operators.
8045 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
8046 limit t t nil 1)
8047 (match-beginning 2))
8048
8049 (progn ; there's a proper :
8050 (goto-char (match-beginning 2)) ; just after the :
8051 (c-put-c-type-property (1- (point)) 'c-decl-end)
8052 t)
8053
8054 ;; It's an unfinished label. We consider the keyword enough
8055 ;; to recognize it as a label, so that it gets fontified.
8056 ;; Leave the point at the end of it, but don't put any
8057 ;; `c-decl-end' marker.
8058 (goto-char kwd-end)
8059 t))))
8060
8061 ;; @private, @protected, @public, in Objective C, or similar.
8062 ((and c-opt-extra-label-key
8063 (looking-at c-opt-extra-label-key))
8064 ;; For a `c-opt-extra-label-key' match, we record the whole
8065 ;; thing for fontification. That's to get the leading '@' in
8066 ;; Objective-C protection labels fontified.
8067 (goto-char (match-end 1))
8068 (when c-record-type-identifiers
8069 (c-record-ref-id (cons (match-beginning 1) (point))))
8070 (c-put-c-type-property (1- (point)) 'c-decl-end)
8071 (setq label-type t))
8072
8073 ;; All other cases of labels.
8074 ((and c-recognize-colon-labels ; nil for AWK and IDL, otherwise t.
8075
8076 ;; A colon label must have something before the colon.
8077 (not (eq (char-after) ?:))
8078
8079 ;; Check that we're not after a token that can't precede a label.
8080 (or
8081 ;; Trivially succeeds when there's no preceding token.
8082 ;; Succeeds when we're at a virtual semicolon.
8083 (if preceding-token-end
8084 (<= preceding-token-end (point-min))
8085 (save-excursion
8086 (c-backward-syntactic-ws)
8087 (setq preceding-token-end (point))
8088 (or (bobp)
8089 (c-at-vsemi-p))))
8090
8091 ;; Check if we're after a label, if we're after a closing
8092 ;; paren that belong to statement, and with
8093 ;; `c-label-prefix-re'. It's done in different order
8094 ;; depending on `assume-markup' since the checks have
8095 ;; different expensiveness.
8096 (if assume-markup
8097 (or
8098 (eq (c-get-char-property (1- preceding-token-end) 'c-type)
8099 'c-decl-end)
8100
8101 (save-excursion
8102 (goto-char (1- preceding-token-end))
8103 (c-beginning-of-current-token)
8104 (or (looking-at c-label-prefix-re)
8105 (looking-at c-block-stmt-1-key)))
8106
8107 (and (eq (char-before preceding-token-end) ?\))
8108 (c-after-conditional)))
8109
8110 (or
8111 (save-excursion
8112 (goto-char (1- preceding-token-end))
8113 (c-beginning-of-current-token)
8114 (or (looking-at c-label-prefix-re)
8115 (looking-at c-block-stmt-1-key)))
8116
8117 (cond
8118 ((eq (char-before preceding-token-end) ?\))
8119 (c-after-conditional))
8120
8121 ((eq (char-before preceding-token-end) ?:)
8122 ;; Might be after another label, so check it recursively.
8123 (save-restriction
8124 (save-excursion
8125 (goto-char (1- preceding-token-end))
8126 ;; Essentially the same as the
8127 ;; `c-syntactic-re-search-forward' regexp below.
8128 (setq macro-start
8129 (save-excursion (and (c-beginning-of-macro)
8130 (point))))
8131 (if macro-start (narrow-to-region macro-start (point-max)))
8132 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t)
8133 ;; Note: the following should work instead of the
8134 ;; narrow-to-region above. Investigate why not,
8135 ;; sometime. ACM, 2006-03-31.
8136 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
8137 ;; macro-start t)
8138 (let ((pte (point))
8139 ;; If the caller turned on recording for us,
8140 ;; it shouldn't apply when we check the
8141 ;; preceding label.
8142 c-record-type-identifiers)
8143 ;; A label can't start at a cpp directive. Check for
8144 ;; this, since c-forward-syntactic-ws would foul up on it.
8145 (unless (and c-opt-cpp-prefix (looking-at c-opt-cpp-prefix))
8146 (c-forward-syntactic-ws)
8147 (c-forward-label nil pte start))))))))))
8148
8149 ;; Point is still at the beginning of the possible label construct.
8150 ;;
8151 ;; Check that the next nonsymbol token is ":", or that we're in one
8152 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
8153 ;; arguments. FIXME: Should build this regexp from the language
8154 ;; constants.
8155 (cond
8156 ;; public: protected: private:
8157 ((and
8158 (c-major-mode-is 'c++-mode)
8159 (search-forward-regexp
8160 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t)
8161 (progn (backward-char)
8162 (c-forward-syntactic-ws limit)
8163 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
8164 (forward-char)
8165 (setq label-type t))
8166 ;; QT double keyword like "protected slots:" or goto target.
8167 ((progn (goto-char start) nil))
8168 ((when (c-syntactic-re-search-forward
8169 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t) ; not at EOB
8170 (backward-char)
8171 (setq label-end (point))
8172 (setq qt-symbol-idx
8173 (and (c-major-mode-is 'c++-mode)
8174 (string-match
8175 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
8176 (buffer-substring start (point)))))
8177 (c-forward-syntactic-ws limit)
8178 (cond
8179 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
8180 (forward-char)
8181 (setq label-type
8182 (if (or (string= "signals" ; Special QT macro
8183 (setq kwd (buffer-substring-no-properties start label-end)))
8184 (string= "Q_SIGNALS" kwd))
8185 'qt-1kwd-colon
8186 'goto-target)))
8187 ((and qt-symbol-idx
8188 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t)
8189 (progn (c-forward-syntactic-ws limit)
8190 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
8191 (forward-char)
8192 (setq label-type 'qt-2kwds-colon)))))))
8193
8194 (save-restriction
8195 (narrow-to-region start (point))
8196
8197 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
8198 (catch 'check-label
8199 (goto-char start)
8200 (while (progn
8201 (when (looking-at c-nonlabel-token-key)
8202 (goto-char start)
8203 (setq label-type nil)
8204 (throw 'check-label nil))
8205 (and (c-safe (c-forward-sexp)
8206 (c-forward-syntactic-ws)
8207 t)
8208 (not (eobp)))))
8209
8210 ;; Record the identifiers in the label for fontification, unless
8211 ;; it begins with `c-label-kwds' in which case the following
8212 ;; identifiers are part of a (constant) expression that
8213 ;; shouldn't be fontified.
8214 (when (and c-record-type-identifiers
8215 (progn (goto-char start)
8216 (not (looking-at c-label-kwds-regexp))))
8217 (while (c-syntactic-re-search-forward c-symbol-key nil t)
8218 (c-record-ref-id (cons (match-beginning 0)
8219 (match-end 0)))))
8220
8221 (c-put-c-type-property (1- (point-max)) 'c-decl-end)
8222 (goto-char (point-max)))))
8223
8224 (t
8225 ;; Not a label.
8226 (goto-char start)))
8227 label-type))
8228
8229 (defun c-forward-objc-directive ()
8230 ;; Assuming the point is at the beginning of a token, try to move
8231 ;; forward to the end of the Objective-C directive that starts
8232 ;; there. Return t if a directive was fully recognized, otherwise
8233 ;; the point is moved as far as one could be successfully parsed and
8234 ;; nil is returned.
8235 ;;
8236 ;; This function records identifier ranges on
8237 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
8238 ;; `c-record-type-identifiers' is non-nil.
8239 ;;
8240 ;; This function might do hidden buffer changes.
8241
8242 (let ((start (point))
8243 start-char
8244 (c-promote-possible-types t)
8245 lim
8246 ;; Turn off recognition of angle bracket arglists while parsing
8247 ;; types here since the protocol reference list might then be
8248 ;; considered part of the preceding name or superclass-name.
8249 c-recognize-<>-arglists)
8250
8251 (if (or
8252 (when (looking-at
8253 (eval-when-compile
8254 (c-make-keywords-re t
8255 (append (c-lang-const c-protection-kwds objc)
8256 '("@end"))
8257 'objc-mode)))
8258 (goto-char (match-end 1))
8259 t)
8260
8261 (and
8262 (looking-at
8263 (eval-when-compile
8264 (c-make-keywords-re t
8265 '("@interface" "@implementation" "@protocol")
8266 'objc-mode)))
8267
8268 ;; Handle the name of the class itself.
8269 (progn
8270 ;; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
8271 ;; at EOB.
8272 (goto-char (match-end 0))
8273 (setq lim (point))
8274 (c-skip-ws-forward)
8275 (c-forward-type))
8276
8277 (catch 'break
8278 ;; Look for ": superclass-name" or "( category-name )".
8279 (when (looking-at "[:(]")
8280 (setq start-char (char-after))
8281 (forward-char)
8282 (c-forward-syntactic-ws)
8283 (unless (c-forward-type) (throw 'break nil))
8284 (when (eq start-char ?\()
8285 (unless (eq (char-after) ?\)) (throw 'break nil))
8286 (forward-char)
8287 (c-forward-syntactic-ws)))
8288
8289 ;; Look for a protocol reference list.
8290 (if (eq (char-after) ?<)
8291 (let ((c-recognize-<>-arglists t)
8292 (c-parse-and-markup-<>-arglists t)
8293 c-restricted-<>-arglists)
8294 (c-forward-<>-arglist t))
8295 t))))
8296
8297 (progn
8298 (c-backward-syntactic-ws lim)
8299 (c-clear-c-type-property start (1- (point)) 'c-decl-end)
8300 (c-put-c-type-property (1- (point)) 'c-decl-end)
8301 t)
8302
8303 (c-clear-c-type-property start (point) 'c-decl-end)
8304 nil)))
8305
8306 (defun c-beginning-of-inheritance-list (&optional lim)
8307 ;; Go to the first non-whitespace after the colon that starts a
8308 ;; multiple inheritance introduction. Optional LIM is the farthest
8309 ;; back we should search.
8310 ;;
8311 ;; This function might do hidden buffer changes.
8312 (c-with-syntax-table c++-template-syntax-table
8313 (c-backward-token-2 0 t lim)
8314 (while (and (or (looking-at c-symbol-start)
8315 (looking-at "[<,]\\|::"))
8316 (zerop (c-backward-token-2 1 t lim))))))
8317
8318 (defun c-in-method-def-p ()
8319 ;; Return nil if we aren't in a method definition, otherwise the
8320 ;; position of the initial [+-].
8321 ;;
8322 ;; This function might do hidden buffer changes.
8323 (save-excursion
8324 (beginning-of-line)
8325 (and c-opt-method-key
8326 (looking-at c-opt-method-key)
8327 (point))
8328 ))
8329
8330 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
8331 (defun c-in-gcc-asm-p ()
8332 ;; Return non-nil if point is within a gcc \"asm\" block.
8333 ;;
8334 ;; This should be called with point inside an argument list.
8335 ;;
8336 ;; Only one level of enclosing parentheses is considered, so for
8337 ;; instance nil is returned when in a function call within an asm
8338 ;; operand.
8339 ;;
8340 ;; This function might do hidden buffer changes.
8341
8342 (and c-opt-asm-stmt-key
8343 (save-excursion
8344 (beginning-of-line)
8345 (backward-up-list 1)
8346 (c-beginning-of-statement-1 (point-min) nil t)
8347 (looking-at c-opt-asm-stmt-key))))
8348
8349 (defun c-at-toplevel-p ()
8350 "Return a determination as to whether point is \"at the top level\".
8351 Informally, \"at the top level\" is anywhere where you can write
8352 a function.
8353
8354 More precisely, being at the top-level means that point is either
8355 outside any enclosing block (such as a function definition), or
8356 directly inside a class, namespace or other block that contains
8357 another declaration level.
8358
8359 If point is not at the top-level (e.g. it is inside a method
8360 definition), then nil is returned. Otherwise, if point is at a
8361 top-level not enclosed within a class definition, t is returned.
8362 Otherwise, a 2-vector is returned where the zeroth element is the
8363 buffer position of the start of the class declaration, and the first
8364 element is the buffer position of the enclosing class's opening
8365 brace.
8366
8367 Note that this function might do hidden buffer changes. See the
8368 comment at the start of cc-engine.el for more info."
8369 ;; Note to maintainers: this function consumes a great mass of CPU cycles.
8370 ;; Its use should thus be minimized as far as possible.
8371 (let ((paren-state (c-parse-state)))
8372 (or (not (c-most-enclosing-brace paren-state))
8373 (c-search-uplist-for-classkey paren-state))))
8374
8375 (defun c-just-after-func-arglist-p (&optional lim)
8376 ;; Return non-nil if the point is in the region after the argument
8377 ;; list of a function and its opening brace (or semicolon in case it
8378 ;; got no body). If there are K&R style argument declarations in
8379 ;; that region, the point has to be inside the first one for this
8380 ;; function to recognize it.
8381 ;;
8382 ;; If successful, the point is moved to the first token after the
8383 ;; function header (see `c-forward-decl-or-cast-1' for details) and
8384 ;; the position of the opening paren of the function arglist is
8385 ;; returned.
8386 ;;
8387 ;; The point is clobbered if not successful.
8388 ;;
8389 ;; LIM is used as bound for backward buffer searches.
8390 ;;
8391 ;; This function might do hidden buffer changes.
8392
8393 (let ((beg (point)) id-start)
8394 (and
8395 (eq (c-beginning-of-statement-1 lim) 'same)
8396
8397 (not (and (c-major-mode-is 'objc-mode)
8398 (c-forward-objc-directive)))
8399
8400 (setq id-start
8401 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil)))
8402 (< id-start beg)
8403
8404 ;; There should not be a '=' or ',' between beg and the
8405 ;; start of the declaration since that means we were in the
8406 ;; "expression part" of the declaration.
8407 (or (> (point) beg)
8408 (not (looking-at "[=,]")))
8409
8410 (save-excursion
8411 ;; Check that there's an arglist paren in the
8412 ;; declaration.
8413 (goto-char id-start)
8414 (cond ((eq (char-after) ?\()
8415 ;; The declarator is a paren expression, so skip past it
8416 ;; so that we don't get stuck on that instead of the
8417 ;; function arglist.
8418 (c-forward-sexp))
8419 ((and c-opt-op-identifier-prefix
8420 (looking-at c-opt-op-identifier-prefix))
8421 ;; Don't trip up on "operator ()".
8422 (c-forward-token-2 2 t)))
8423 (and (< (point) beg)
8424 (c-syntactic-re-search-forward "(" beg t t)
8425 (1- (point)))))))
8426
8427 (defun c-in-knr-argdecl (&optional lim)
8428 ;; Return the position of the first argument declaration if point is
8429 ;; inside a K&R style argument declaration list, nil otherwise.
8430 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
8431 ;; position that bounds the backward search for the argument list. This
8432 ;; function doesn't move point.
8433 ;;
8434 ;; Point must be within a possible K&R region, e.g. just before a top-level
8435 ;; "{". It must be outside of parens and brackets. The test can return
8436 ;; false positives otherwise.
8437 ;;
8438 ;; This function might do hidden buffer changes.
8439 (save-excursion
8440 (save-restriction
8441 ;; If we're in a macro, our search range is restricted to it. Narrow to
8442 ;; the searchable range.
8443 (let* ((macro-start (save-excursion (and (c-beginning-of-macro) (point))))
8444 (macro-end (save-excursion (and macro-start (c-end-of-macro) (point))))
8445 (low-lim (max (or lim (point-min)) (or macro-start (point-min))))
8446 before-lparen after-rparen
8447 (here (point))
8448 (pp-count-out 20) ; Max number of paren/brace constructs before
8449 ; we give up.
8450 ids ; List of identifiers in the parenthesized list.
8451 id-start after-prec-token decl-or-cast decl-res
8452 c-last-identifier-range identifier-ok)
8453 (narrow-to-region low-lim (or macro-end (point-max)))
8454
8455 ;; Search backwards for the defun's argument list. We give up if we
8456 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
8457 ;; a knr region) or BOB.
8458 ;;
8459 ;; The criterion for a paren structure being the arg list is:
8460 ;; o - there is non-WS stuff after it but before any "{"; AND
8461 ;; o - the token after it isn't a ";" AND
8462 ;; o - it is preceded by either an identifier (the function name) or
8463 ;; a macro expansion like "DEFUN (...)"; AND
8464 ;; o - its content is a non-empty comma-separated list of identifiers
8465 ;; (an empty arg list won't have a knr region).
8466 ;;
8467 ;; The following snippet illustrates these rules:
8468 ;; int foo (bar, baz, yuk)
8469 ;; int bar [] ;
8470 ;; int (*baz) (my_type) ;
8471 ;; int (*(* yuk) (void)) (void) ;
8472 ;; {
8473 ;;
8474 ;; Additionally, for a knr list to be recognized:
8475 ;; o - The identifier of each declarator up to and including the
8476 ;; one "near" point must be contained in the arg list.
8477
8478 (catch 'knr
8479 (while (> pp-count-out 0) ; go back one paren/bracket pair each time.
8480 (setq pp-count-out (1- pp-count-out))
8481 (c-syntactic-skip-backward "^)]}=")
8482 (cond ((eq (char-before) ?\))
8483 (setq after-rparen (point)))
8484 ((eq (char-before) ?\])
8485 (setq after-rparen nil))
8486 (t ; either } (hit previous defun) or = or no more
8487 ; parens/brackets.
8488 (throw 'knr nil)))
8489
8490 (if after-rparen
8491 ;; We're inside a paren. Could it be our argument list....?
8492 (if
8493 (and
8494 (progn
8495 (goto-char after-rparen)
8496 (unless (c-go-list-backward) (throw 'knr nil)) ;
8497 ;; FIXME!!! What about macros between the parens? 2007/01/20
8498 (setq before-lparen (point)))
8499
8500 ;; It can't be the arg list if next token is ; or {
8501 (progn (goto-char after-rparen)
8502 (c-forward-syntactic-ws)
8503 (not (memq (char-after) '(?\; ?\{ ?\=))))
8504
8505 ;; Is the thing preceding the list an identifier (the
8506 ;; function name), or a macro expansion?
8507 (progn
8508 (goto-char before-lparen)
8509 (eq (c-backward-token-2) 0)
8510 (or (eq (c-on-identifier) (point))
8511 (and (eq (char-after) ?\))
8512 (c-go-up-list-backward)
8513 (eq (c-backward-token-2) 0)
8514 (eq (c-on-identifier) (point)))))
8515
8516 ;; Have we got a non-empty list of comma-separated
8517 ;; identifiers?
8518 (progn
8519 (goto-char before-lparen)
8520 (c-forward-token-2) ; to first token inside parens
8521 (and
8522 (setq id-start (c-on-identifier)) ; Must be at least one.
8523 (catch 'id-list
8524 (while
8525 (progn
8526 (forward-char)
8527 (c-end-of-current-token)
8528 (push (buffer-substring-no-properties id-start
8529 (point))
8530 ids)
8531 (c-forward-syntactic-ws)
8532 (eq (char-after) ?\,))
8533 (c-forward-token-2)
8534 (unless (setq id-start (c-on-identifier))
8535 (throw 'id-list nil)))
8536 (eq (char-after) ?\)))))
8537
8538 ;; Are all the identifiers in the k&r list up to the
8539 ;; current one also in the argument list?
8540 (progn
8541 (forward-char) ; over the )
8542 (setq after-prec-token after-rparen)
8543 (c-forward-syntactic-ws)
8544 (while (and
8545 (or (consp (setq decl-or-cast
8546 (c-forward-decl-or-cast-1
8547 after-prec-token
8548 nil ; Or 'arglist ???
8549 nil)))
8550 (progn
8551 (goto-char after-prec-token)
8552 (c-forward-syntactic-ws)
8553 (setq identifier-ok (eq (char-after) ?{))
8554 nil))
8555 (eq (char-after) ?\;)
8556 (setq after-prec-token (1+ (point)))
8557 (goto-char (car decl-or-cast))
8558 (setq decl-res (c-forward-declarator))
8559 (setq identifier-ok
8560 (member (buffer-substring-no-properties
8561 (car decl-res) (cadr decl-res))
8562 ids))
8563 (progn
8564 (goto-char after-prec-token)
8565 (prog1 (< (point) here)
8566 (c-forward-syntactic-ws))))
8567 (setq identifier-ok nil))
8568 identifier-ok))
8569 ;; ...Yes. We've identified the function's argument list.
8570 (throw 'knr
8571 (progn (goto-char after-rparen)
8572 (c-forward-syntactic-ws)
8573 (point)))
8574 ;; ...No. The current parens aren't the function's arg list.
8575 (goto-char before-lparen))
8576
8577 (or (c-go-list-backward) ; backwards over [ .... ]
8578 (throw 'knr nil)))))))))
8579
8580 (defun c-skip-conditional ()
8581 ;; skip forward over conditional at point, including any predicate
8582 ;; statements in parentheses. No error checking is performed.
8583 ;;
8584 ;; This function might do hidden buffer changes.
8585 (c-forward-sexp (cond
8586 ;; else if()
8587 ((looking-at (concat "\\<else"
8588 "\\([ \t\n]\\|\\\\\n\\)+"
8589 "if\\>\\([^_]\\|$\\)"))
8590 3)
8591 ;; do, else, try, finally
8592 ((looking-at (concat "\\<\\("
8593 "do\\|else\\|try\\|finally"
8594 "\\)\\>\\([^_]\\|$\\)"))
8595 1)
8596 ;; for, if, while, switch, catch, synchronized, foreach
8597 (t 2))))
8598
8599 (defun c-after-conditional (&optional lim)
8600 ;; If looking at the token after a conditional then return the
8601 ;; position of its start, otherwise return nil.
8602 ;;
8603 ;; This function might do hidden buffer changes.
8604 (save-excursion
8605 (and (zerop (c-backward-token-2 1 t lim))
8606 (or (looking-at c-block-stmt-1-key)
8607 (and (eq (char-after) ?\()
8608 (zerop (c-backward-token-2 1 t lim))
8609 (or (looking-at c-block-stmt-2-key)
8610 (looking-at c-block-stmt-1-2-key))))
8611 (point))))
8612
8613 (defun c-after-special-operator-id (&optional lim)
8614 ;; If the point is after an operator identifier that isn't handled
8615 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
8616 ;; position of the start of that identifier is returned. nil is
8617 ;; returned otherwise. The point may be anywhere in the syntactic
8618 ;; whitespace after the last token of the operator identifier.
8619 ;;
8620 ;; This function might do hidden buffer changes.
8621 (save-excursion
8622 (and c-overloadable-operators-regexp
8623 (zerop (c-backward-token-2 1 nil lim))
8624 (looking-at c-overloadable-operators-regexp)
8625 (or (not c-opt-op-identifier-prefix)
8626 (and
8627 (zerop (c-backward-token-2 1 nil lim))
8628 (looking-at c-opt-op-identifier-prefix)))
8629 (point))))
8630
8631 (defsubst c-backward-to-block-anchor (&optional lim)
8632 ;; Assuming point is at a brace that opens a statement block of some
8633 ;; kind, move to the proper anchor point for that block. It might
8634 ;; need to be adjusted further by c-add-stmt-syntax, but the
8635 ;; position at return is suitable as start position for that
8636 ;; function.
8637 ;;
8638 ;; This function might do hidden buffer changes.
8639 (unless (= (point) (c-point 'boi))
8640 (let ((start (c-after-conditional lim)))
8641 (if start
8642 (goto-char start)))))
8643
8644 (defsubst c-backward-to-decl-anchor (&optional lim)
8645 ;; Assuming point is at a brace that opens the block of a top level
8646 ;; declaration of some kind, move to the proper anchor point for
8647 ;; that block.
8648 ;;
8649 ;; This function might do hidden buffer changes.
8650 (unless (= (point) (c-point 'boi))
8651 (c-beginning-of-statement-1 lim)))
8652
8653 (defun c-search-decl-header-end ()
8654 ;; Search forward for the end of the "header" of the current
8655 ;; declaration. That's the position where the definition body
8656 ;; starts, or the first variable initializer, or the ending
8657 ;; semicolon. I.e. search forward for the closest following
8658 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8659 ;; _after_ the first found token, or at point-max if none is found.
8660 ;;
8661 ;; This function might do hidden buffer changes.
8662
8663 (let ((base (point)))
8664 (if (c-major-mode-is 'c++-mode)
8665
8666 ;; In C++ we need to take special care to handle operator
8667 ;; tokens and those pesky template brackets.
8668 (while (and
8669 (c-syntactic-re-search-forward "[;{<=]" nil 'move t t)
8670 (or
8671 (c-end-of-current-token base)
8672 ;; Handle operator identifiers, i.e. ignore any
8673 ;; operator token preceded by "operator".
8674 (save-excursion
8675 (and (c-safe (c-backward-sexp) t)
8676 (looking-at c-opt-op-identifier-prefix)))
8677 (and (eq (char-before) ?<)
8678 (c-with-syntax-table c++-template-syntax-table
8679 (if (c-safe (goto-char (c-up-list-forward (point))))
8680 t
8681 (goto-char (point-max))
8682 nil)))))
8683 (setq base (point)))
8684
8685 (while (and
8686 (c-syntactic-re-search-forward "[;{=]" nil 'move t t)
8687 (c-end-of-current-token base))
8688 (setq base (point))))))
8689
8690 (defun c-beginning-of-decl-1 (&optional lim)
8691 ;; Go to the beginning of the current declaration, or the beginning
8692 ;; of the previous one if already at the start of it. Point won't
8693 ;; be moved out of any surrounding paren. Return a cons cell of the
8694 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8695 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8696 ;; style argument declarations (and they are to be recognized) then
8697 ;; KNR-POS is set to the start of the first such argument
8698 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8699 ;; position that bounds the backward search.
8700 ;;
8701 ;; NB: Cases where the declaration continues after the block, as in
8702 ;; "struct foo { ... } bar;", are currently recognized as two
8703 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8704 ;;
8705 ;; This function might do hidden buffer changes.
8706 (catch 'return
8707 (let* ((start (point))
8708 (last-stmt-start (point))
8709 (move (c-beginning-of-statement-1 lim nil t)))
8710
8711 ;; `c-beginning-of-statement-1' stops at a block start, but we
8712 ;; want to continue if the block doesn't begin a top level
8713 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8714 ;; or an open paren.
8715 (let ((beg (point)) tentative-move)
8716 ;; Go back one "statement" each time round the loop until we're just
8717 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8718 ;; an ObjC method. This will move over a multiple declaration whose
8719 ;; components are comma separated.
8720 (while (and
8721 ;; Must check with c-opt-method-key in ObjC mode.
8722 (not (and c-opt-method-key
8723 (looking-at c-opt-method-key)))
8724 (/= last-stmt-start (point))
8725 (progn
8726 (c-backward-syntactic-ws lim)
8727 (not (memq (char-before) '(?\; ?} ?: nil))))
8728 (save-excursion
8729 (backward-char)
8730 (not (looking-at "\\s(")))
8731 ;; Check that we don't move from the first thing in a
8732 ;; macro to its header.
8733 (not (eq (setq tentative-move
8734 (c-beginning-of-statement-1 lim nil t))
8735 'macro)))
8736 (setq last-stmt-start beg
8737 beg (point)
8738 move tentative-move))
8739 (goto-char beg))
8740
8741 (when c-recognize-knr-p
8742 (let ((fallback-pos (point)) knr-argdecl-start)
8743 ;; Handle K&R argdecls. Back up after the "statement" jumped
8744 ;; over by `c-beginning-of-statement-1', unless it was the
8745 ;; function body, in which case we're sitting on the opening
8746 ;; brace now. Then test if we're in a K&R argdecl region and
8747 ;; that we started at the other side of the first argdecl in
8748 ;; it.
8749 (unless (eq (char-after) ?{)
8750 (goto-char last-stmt-start))
8751 (if (and (setq knr-argdecl-start (c-in-knr-argdecl lim))
8752 (< knr-argdecl-start start)
8753 (progn
8754 (goto-char knr-argdecl-start)
8755 (not (eq (c-beginning-of-statement-1 lim nil t) 'macro))))
8756 (throw 'return
8757 (cons (if (eq (char-after fallback-pos) ?{)
8758 'previous
8759 'same)
8760 knr-argdecl-start))
8761 (goto-char fallback-pos))))
8762
8763 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8764 ;; statement, so the result will be 'previous if we've moved over any.
8765 ;; So change our result back to 'same if necessary.
8766 ;;
8767 ;; If they were brace list initializers we might not have moved over a
8768 ;; declaration boundary though, so change it to 'same if we've moved
8769 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8770 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8771 ;; potentially can search over a large amount of text.). Take special
8772 ;; pains not to get mislead by C++'s "operator=", and the like.
8773 (if (and (eq move 'previous)
8774 (c-with-syntax-table (if (c-major-mode-is 'c++-mode)
8775 c++-template-syntax-table
8776 (syntax-table))
8777 (save-excursion
8778 (and
8779 (progn
8780 (while ; keep going back to "[;={"s until we either find
8781 ; no more, or get to one which isn't an "operator ="
8782 (and (c-syntactic-re-search-forward "[;={]" start t t t)
8783 (eq (char-before) ?=)
8784 c-overloadable-operators-regexp
8785 c-opt-op-identifier-prefix
8786 (save-excursion
8787 (eq (c-backward-token-2) 0)
8788 (looking-at c-overloadable-operators-regexp)
8789 (eq (c-backward-token-2) 0)
8790 (looking-at c-opt-op-identifier-prefix))))
8791 (eq (char-before) ?=))
8792 (c-syntactic-re-search-forward "[;{]" start t t)
8793 (eq (char-before) ?{)
8794 (c-safe (goto-char (c-up-list-forward (point))) t)
8795 (not (c-syntactic-re-search-forward ";" start t t))))))
8796 (cons 'same nil)
8797 (cons move nil)))))
8798
8799 (defun c-end-of-decl-1 ()
8800 ;; Assuming point is at the start of a declaration (as detected by
8801 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8802 ;; `c-beginning-of-decl-1', this function handles the case when a
8803 ;; block is followed by identifiers in e.g. struct declarations in C
8804 ;; or C++. If a proper end was found then t is returned, otherwise
8805 ;; point is moved as far as possible within the current sexp and nil
8806 ;; is returned. This function doesn't handle macros; use
8807 ;; `c-end-of-macro' instead in those cases.
8808 ;;
8809 ;; This function might do hidden buffer changes.
8810 (let ((start (point))
8811 (decl-syntax-table (if (c-major-mode-is 'c++-mode)
8812 c++-template-syntax-table
8813 (syntax-table))))
8814 (catch 'return
8815 (c-search-decl-header-end)
8816
8817 (when (and c-recognize-knr-p
8818 (eq (char-before) ?\;)
8819 (c-in-knr-argdecl start))
8820 ;; Stopped at the ';' in a K&R argdecl section which is
8821 ;; detected using the same criteria as in
8822 ;; `c-beginning-of-decl-1'. Move to the following block
8823 ;; start.
8824 (c-syntactic-re-search-forward "{" nil 'move t))
8825
8826 (when (eq (char-before) ?{)
8827 ;; Encountered a block in the declaration. Jump over it.
8828 (condition-case nil
8829 (goto-char (c-up-list-forward (point)))
8830 (error (goto-char (point-max))
8831 (throw 'return nil)))
8832 (if (or (not c-opt-block-decls-with-vars-key)
8833 (save-excursion
8834 (c-with-syntax-table decl-syntax-table
8835 (let ((lim (point)))
8836 (goto-char start)
8837 (not (and
8838 ;; Check for `c-opt-block-decls-with-vars-key'
8839 ;; before the first paren.
8840 (c-syntactic-re-search-forward
8841 (concat "[;=([{]\\|\\("
8842 c-opt-block-decls-with-vars-key
8843 "\\)")
8844 lim t t t)
8845 (match-beginning 1)
8846 (not (eq (char-before) ?_))
8847 ;; Check that the first following paren is
8848 ;; the block.
8849 (c-syntactic-re-search-forward "[;=([{]"
8850 lim t t t)
8851 (eq (char-before) ?{)))))))
8852 ;; The declaration doesn't have any of the
8853 ;; `c-opt-block-decls-with-vars' keywords in the
8854 ;; beginning, so it ends here at the end of the block.
8855 (throw 'return t)))
8856
8857 (c-with-syntax-table decl-syntax-table
8858 (while (progn
8859 (if (eq (char-before) ?\;)
8860 (throw 'return t))
8861 (c-syntactic-re-search-forward ";" nil 'move t))))
8862 nil)))
8863
8864 (defun c-looking-at-decl-block (containing-sexp goto-start &optional limit)
8865 ;; Assuming the point is at an open brace, check if it starts a
8866 ;; block that contains another declaration level, i.e. that isn't a
8867 ;; statement block or a brace list, and if so return non-nil.
8868 ;;
8869 ;; If the check is successful, the return value is the start of the
8870 ;; keyword that tells what kind of construct it is, i.e. typically
8871 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8872 ;; the point will be at the start of the construct, before any
8873 ;; leading specifiers, otherwise it's at the returned position.
8874 ;;
8875 ;; The point is clobbered if the check is unsuccessful.
8876 ;;
8877 ;; CONTAINING-SEXP is the position of the open of the surrounding
8878 ;; paren, or nil if none.
8879 ;;
8880 ;; The optional LIMIT limits the backward search for the start of
8881 ;; the construct. It's assumed to be at a syntactically relevant
8882 ;; position.
8883 ;;
8884 ;; If any template arglists are found in the searched region before
8885 ;; the open brace, they get marked with paren syntax.
8886 ;;
8887 ;; This function might do hidden buffer changes.
8888
8889 (let ((open-brace (point)) kwd-start first-specifier-pos)
8890 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8891
8892 (when (and c-recognize-<>-arglists
8893 (eq (char-before) ?>))
8894 ;; Could be at the end of a template arglist.
8895 (let ((c-parse-and-markup-<>-arglists t))
8896 (while (and
8897 (c-backward-<>-arglist nil limit)
8898 (progn
8899 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8900 (eq (char-before) ?>))))))
8901
8902 ;; Note: Can't get bogus hits inside template arglists below since they
8903 ;; have gotten paren syntax above.
8904 (when (and
8905 ;; If `goto-start' is set we begin by searching for the
8906 ;; first possible position of a leading specifier list.
8907 ;; The `c-decl-block-key' search continues from there since
8908 ;; we know it can't match earlier.
8909 (if goto-start
8910 (when (c-syntactic-re-search-forward c-symbol-start
8911 open-brace t t)
8912 (goto-char (setq first-specifier-pos (match-beginning 0)))
8913 t)
8914 t)
8915
8916 (cond
8917 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t)
8918 (goto-char (setq kwd-start (match-beginning 0)))
8919 (and
8920 ;; Exclude cases where we matched what would ordinarily
8921 ;; be a block declaration keyword, except where it's not
8922 ;; legal because it's part of a "compound keyword" like
8923 ;; "enum class". Of course, if c-after-brace-list-key
8924 ;; is nil, we can skip the test.
8925 (or (equal c-after-brace-list-key "\\<\\>")
8926 (save-match-data
8927 (save-excursion
8928 (not
8929 (and
8930 (looking-at c-after-brace-list-key)
8931 (= (c-backward-token-2 1 t) 0)
8932 (looking-at c-brace-list-key))))))
8933 (or
8934 ;; Found a keyword that can't be a type?
8935 (match-beginning 1)
8936
8937 ;; Can be a type too, in which case it's the return type of a
8938 ;; function (under the assumption that no declaration level
8939 ;; block construct starts with a type).
8940 (not (c-forward-type))
8941
8942 ;; Jumped over a type, but it could be a declaration keyword
8943 ;; followed by the declared identifier that we've jumped over
8944 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8945 ;; then we should be at the declarator now, so check for a
8946 ;; valid declarator start.
8947 ;;
8948 ;; Note: This doesn't cope with the case when a declared
8949 ;; identifier is followed by e.g. '(' in a language where '('
8950 ;; also might be part of a declarator expression. Currently
8951 ;; there's no such language.
8952 (not (or (looking-at c-symbol-start)
8953 (looking-at c-type-decl-prefix-key))))))
8954
8955 ;; In Pike a list of modifiers may be followed by a brace
8956 ;; to make them apply to many identifiers. Note that the
8957 ;; match data will be empty on return in this case.
8958 ((and (c-major-mode-is 'pike-mode)
8959 (progn
8960 (goto-char open-brace)
8961 (= (c-backward-token-2) 0))
8962 (looking-at c-specifier-key)
8963 ;; Use this variant to avoid yet another special regexp.
8964 (c-keyword-member (c-keyword-sym (match-string 1))
8965 'c-modifier-kwds))
8966 (setq kwd-start (point))
8967 t)))
8968
8969 ;; Got a match.
8970
8971 (if goto-start
8972 ;; Back up over any preceding specifiers and their clauses
8973 ;; by going forward from `first-specifier-pos', which is the
8974 ;; earliest possible position where the specifier list can
8975 ;; start.
8976 (progn
8977 (goto-char first-specifier-pos)
8978
8979 (while (< (point) kwd-start)
8980 (if (looking-at c-symbol-key)
8981 ;; Accept any plain symbol token on the ground that
8982 ;; it's a specifier masked through a macro (just
8983 ;; like `c-forward-decl-or-cast-1' skip forward over
8984 ;; such tokens).
8985 ;;
8986 ;; Could be more restrictive wrt invalid keywords,
8987 ;; but that'd only occur in invalid code so there's
8988 ;; no use spending effort on it.
8989 (let ((end (match-end 0)))
8990 (unless (c-forward-keyword-clause 0)
8991 (goto-char end)
8992 (c-forward-syntactic-ws)))
8993
8994 ;; Can't parse a declaration preamble and is still
8995 ;; before `kwd-start'. That means `first-specifier-pos'
8996 ;; was in some earlier construct. Search again.
8997 (if (c-syntactic-re-search-forward c-symbol-start
8998 kwd-start 'move t)
8999 (goto-char (setq first-specifier-pos (match-beginning 0)))
9000 ;; Got no preamble before the block declaration keyword.
9001 (setq first-specifier-pos kwd-start))))
9002
9003 (goto-char first-specifier-pos))
9004 (goto-char kwd-start))
9005
9006 kwd-start)))
9007
9008 (defun c-search-uplist-for-classkey (paren-state)
9009 ;; Check if the closest containing paren sexp is a declaration
9010 ;; block, returning a 2 element vector in that case. Aref 0
9011 ;; contains the bufpos at boi of the class key line, and aref 1
9012 ;; contains the bufpos of the open brace. This function is an
9013 ;; obsolete wrapper for `c-looking-at-decl-block'.
9014 ;;
9015 ;; This function might do hidden buffer changes.
9016 (let ((open-paren-pos (c-most-enclosing-brace paren-state)))
9017 (when open-paren-pos
9018 (save-excursion
9019 (goto-char open-paren-pos)
9020 (when (and (eq (char-after) ?{)
9021 (c-looking-at-decl-block
9022 (c-safe-position open-paren-pos paren-state)
9023 nil))
9024 (back-to-indentation)
9025 (vector (point) open-paren-pos))))))
9026
9027 (defun c-most-enclosing-decl-block (paren-state)
9028 ;; Return the buffer position of the most enclosing decl-block brace (in the
9029 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
9030 ;; none was found.
9031 (let* ((open-brace (c-pull-open-brace paren-state))
9032 (next-open-brace (c-pull-open-brace paren-state)))
9033 (while (and open-brace
9034 (save-excursion
9035 (goto-char open-brace)
9036 (not (c-looking-at-decl-block next-open-brace nil))))
9037 (setq open-brace next-open-brace
9038 next-open-brace (c-pull-open-brace paren-state)))
9039 open-brace))
9040
9041 (defun c-cheap-inside-bracelist-p (paren-state)
9042 ;; Return the position of the L-brace if point is inside a brace list
9043 ;; initialization of an array, etc. This is an approximate function,
9044 ;; designed for speed over accuracy. It will not find every bracelist, but
9045 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
9046 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
9047 ;; is everywhere else.
9048 (let (b-pos)
9049 (save-excursion
9050 (while
9051 (and (setq b-pos (c-pull-open-brace paren-state))
9052 (progn (goto-char b-pos)
9053 (c-backward-sws)
9054 (c-backward-token-2)
9055 (not (looking-at "=")))))
9056 b-pos)))
9057
9058 (defun c-backward-typed-enum-colon ()
9059 ;; We're at a "{" which might be the opening brace of a enum which is
9060 ;; strongly typed (by a ":" followed by a type). If this is the case, leave
9061 ;; point before the colon and return t. Otherwise leave point unchanged and return nil.
9062 ;; Match data will be clobbered.
9063 (let ((here (point))
9064 (colon-pos nil))
9065 (save-excursion
9066 (while
9067 (and (eql (c-backward-token-2) 0)
9068 (or (not (looking-at "\\s)"))
9069 (c-go-up-list-backward))
9070 (cond
9071 ((and (eql (char-after) ?:)
9072 (save-excursion
9073 (c-backward-syntactic-ws)
9074 (c-on-identifier)))
9075 (setq colon-pos (point))
9076 (forward-char)
9077 (c-forward-syntactic-ws)
9078 (or (and (c-forward-type)
9079 (progn (c-forward-syntactic-ws)
9080 (eq (point) here)))
9081 (setq colon-pos nil))
9082 nil)
9083 ((eql (char-after) ?\()
9084 t)
9085 ((looking-at c-symbol-key)
9086 t)
9087 (t nil)))))
9088 (when colon-pos
9089 (goto-char colon-pos)
9090 t)))
9091
9092 (defun c-backward-over-enum-header ()
9093 ;; We're at a "{". Move back to the enum-like keyword that starts this
9094 ;; declaration and return t, otherwise don't move and return nil.
9095 (let ((here (point))
9096 up-sexp-pos before-identifier)
9097 (when c-recognize-post-brace-list-type-p
9098 (c-backward-typed-enum-colon))
9099 (while
9100 (and
9101 (eq (c-backward-token-2) 0)
9102 (or (not (looking-at "\\s)"))
9103 (c-go-up-list-backward))
9104 (cond
9105 ((and (looking-at c-symbol-key) (c-on-identifier)
9106 (not before-identifier))
9107 (setq before-identifier t))
9108 ((and before-identifier
9109 (or (eql (char-after) ?,)
9110 (looking-at c-postfix-decl-spec-key)))
9111 (setq before-identifier nil)
9112 t)
9113 ((looking-at c-after-brace-list-key) t)
9114 ((looking-at c-brace-list-key) nil)
9115 ((eq (char-after) ?\()
9116 (and (eq (c-backward-token-2) 0)
9117 (or (looking-at c-decl-hangon-key)
9118 (and c-opt-cpp-prefix
9119 (looking-at c-noise-macro-with-parens-name-re)))))
9120
9121 ((and c-recognize-<>-arglists
9122 (eq (char-after) ?<)
9123 (looking-at "\\s("))
9124 t)
9125 (t nil))))
9126 (or (looking-at c-brace-list-key)
9127 (progn (goto-char here) nil))))
9128
9129 (defun c-inside-bracelist-p (containing-sexp paren-state)
9130 ;; return the buffer position of the beginning of the brace list
9131 ;; statement if we're inside a brace list, otherwise return nil.
9132 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
9133 ;; paren. PAREN-STATE is the remainder of the state of enclosing
9134 ;; braces
9135 ;;
9136 ;; N.B.: This algorithm can potentially get confused by cpp macros
9137 ;; placed in inconvenient locations. It's a trade-off we make for
9138 ;; speed.
9139 ;;
9140 ;; This function might do hidden buffer changes.
9141 (or
9142 ;; This will pick up brace list declarations.
9143 (save-excursion
9144 (goto-char containing-sexp)
9145 (c-backward-over-enum-header))
9146 ;; this will pick up array/aggregate init lists, even if they are nested.
9147 (save-excursion
9148 (let ((class-key
9149 ;; Pike can have class definitions anywhere, so we must
9150 ;; check for the class key here.
9151 (and (c-major-mode-is 'pike-mode)
9152 c-decl-block-key))
9153 bufpos braceassignp lim next-containing macro-start)
9154 (while (and (not bufpos)
9155 containing-sexp)
9156 (when paren-state
9157 (if (consp (car paren-state))
9158 (setq lim (cdr (car paren-state))
9159 paren-state (cdr paren-state))
9160 (setq lim (car paren-state)))
9161 (when paren-state
9162 (setq next-containing (car paren-state)
9163 paren-state (cdr paren-state))))
9164 (goto-char containing-sexp)
9165 (if (c-looking-at-inexpr-block next-containing next-containing)
9166 ;; We're in an in-expression block of some kind. Do not
9167 ;; check nesting. We deliberately set the limit to the
9168 ;; containing sexp, so that c-looking-at-inexpr-block
9169 ;; doesn't check for an identifier before it.
9170 (setq containing-sexp nil)
9171 ;; see if the open brace is preceded by = or [...] in
9172 ;; this statement, but watch out for operator=
9173 (setq braceassignp 'dontknow)
9174 (c-backward-token-2 1 t lim)
9175 ;; Checks to do only on the first sexp before the brace.
9176 (when (and c-opt-inexpr-brace-list-key
9177 (eq (char-after) ?\[))
9178 ;; In Java, an initialization brace list may follow
9179 ;; directly after "new Foo[]", so check for a "new"
9180 ;; earlier.
9181 (while (eq braceassignp 'dontknow)
9182 (setq braceassignp
9183 (cond ((/= (c-backward-token-2 1 t lim) 0) nil)
9184 ((looking-at c-opt-inexpr-brace-list-key) t)
9185 ((looking-at "\\sw\\|\\s_\\|[.[]")
9186 ;; Carry on looking if this is an
9187 ;; identifier (may contain "." in Java)
9188 ;; or another "[]" sexp.
9189 'dontknow)
9190 (t nil)))))
9191 ;; Checks to do on all sexps before the brace, up to the
9192 ;; beginning of the statement.
9193 (while (eq braceassignp 'dontknow)
9194 (cond ((eq (char-after) ?\;)
9195 (setq braceassignp nil))
9196 ((and class-key
9197 (looking-at class-key))
9198 (setq braceassignp nil))
9199 ((eq (char-after) ?=)
9200 ;; We've seen a =, but must check earlier tokens so
9201 ;; that it isn't something that should be ignored.
9202 (setq braceassignp 'maybe)
9203 (while (and (eq braceassignp 'maybe)
9204 (zerop (c-backward-token-2 1 t lim)))
9205 (setq braceassignp
9206 (cond
9207 ;; Check for operator =
9208 ((and c-opt-op-identifier-prefix
9209 (looking-at c-opt-op-identifier-prefix))
9210 nil)
9211 ;; Check for `<opchar>= in Pike.
9212 ((and (c-major-mode-is 'pike-mode)
9213 (or (eq (char-after) ?`)
9214 ;; Special case for Pikes
9215 ;; `[]=, since '[' is not in
9216 ;; the punctuation class.
9217 (and (eq (char-after) ?\[)
9218 (eq (char-before) ?`))))
9219 nil)
9220 ((looking-at "\\s.") 'maybe)
9221 ;; make sure we're not in a C++ template
9222 ;; argument assignment
9223 ((and
9224 (c-major-mode-is 'c++-mode)
9225 (save-excursion
9226 (let ((here (point))
9227 (pos< (progn
9228 (skip-chars-backward "^<>")
9229 (point))))
9230 (and (eq (char-before) ?<)
9231 (not (c-crosses-statement-barrier-p
9232 pos< here))
9233 (not (c-in-literal))
9234 ))))
9235 nil)
9236 (t t))))))
9237 (if (and (eq braceassignp 'dontknow)
9238 (/= (c-backward-token-2 1 t lim) 0))
9239 (setq braceassignp nil)))
9240 (cond
9241 (braceassignp
9242 ;; We've hit the beginning of the aggregate list.
9243 (c-beginning-of-statement-1
9244 (c-most-enclosing-brace paren-state))
9245 (setq bufpos (point)))
9246 ((eq (char-after) ?\;)
9247 ;; Brace lists can't contain a semicolon, so we're done.
9248 (setq containing-sexp nil))
9249 ((and (setq macro-start (point))
9250 (c-forward-to-cpp-define-body)
9251 (eq (point) containing-sexp))
9252 ;; We've a macro whose expansion starts with the '{'.
9253 ;; Heuristically, if we have a ';' in it we've not got a
9254 ;; brace list, otherwise we have.
9255 (let ((macro-end (progn (c-end-of-macro) (point))))
9256 (goto-char containing-sexp)
9257 (forward-char)
9258 (if (and (c-syntactic-re-search-forward "[;,]" macro-end t t)
9259 (eq (char-before) ?\;))
9260 (setq bufpos nil
9261 containing-sexp nil)
9262 (setq bufpos macro-start))))
9263 (t
9264 ;; Go up one level
9265 (setq containing-sexp next-containing
9266 lim nil
9267 next-containing nil)))))
9268
9269 bufpos))
9270 ))
9271
9272 (defun c-looking-at-special-brace-list (&optional lim)
9273 ;; If we're looking at the start of a pike-style list, i.e., `({ })',
9274 ;; `([ ])', `(< >)', etc., a cons of a cons of its starting and ending
9275 ;; positions and its entry in c-special-brace-lists is returned, nil
9276 ;; otherwise. The ending position is nil if the list is still open.
9277 ;; LIM is the limit for forward search. The point may either be at
9278 ;; the `(' or at the following paren character. Tries to check the
9279 ;; matching closer, but assumes it's correct if no balanced paren is
9280 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
9281 ;; a special brace list).
9282 ;;
9283 ;; This function might do hidden buffer changes.
9284 (if c-special-brace-lists
9285 (condition-case ()
9286 (save-excursion
9287 (let ((beg (point))
9288 inner-beg end type)
9289 (c-forward-syntactic-ws)
9290 (if (eq (char-after) ?\()
9291 (progn
9292 (forward-char 1)
9293 (c-forward-syntactic-ws)
9294 (setq inner-beg (point))
9295 (setq type (assq (char-after) c-special-brace-lists)))
9296 (if (setq type (assq (char-after) c-special-brace-lists))
9297 (progn
9298 (setq inner-beg (point))
9299 (c-backward-syntactic-ws)
9300 (forward-char -1)
9301 (setq beg (if (eq (char-after) ?\()
9302 (point)
9303 nil)))))
9304 (if (and beg type)
9305 (if (and (c-safe
9306 (goto-char beg)
9307 (c-forward-sexp 1)
9308 (setq end (point))
9309 (= (char-before) ?\)))
9310 (c-safe
9311 (goto-char inner-beg)
9312 (if (looking-at "\\s(")
9313 ;; Check balancing of the inner paren
9314 ;; below.
9315 (progn
9316 (c-forward-sexp 1)
9317 t)
9318 ;; If the inner char isn't a paren then
9319 ;; we can't check balancing, so just
9320 ;; check the char before the outer
9321 ;; closing paren.
9322 (goto-char end)
9323 (backward-char)
9324 (c-backward-syntactic-ws)
9325 (= (char-before) (cdr type)))))
9326 (if (or (/= (char-syntax (char-before)) ?\))
9327 (= (progn
9328 (c-forward-syntactic-ws)
9329 (point))
9330 (1- end)))
9331 (cons (cons beg end) type))
9332 (cons (list beg) type)))))
9333 (error nil))))
9334
9335 (defun c-looking-at-bos (&optional lim)
9336 ;; Return non-nil if between two statements or declarations, assuming
9337 ;; point is not inside a literal or comment.
9338 ;;
9339 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
9340 ;; are recommended instead.
9341 ;;
9342 ;; This function might do hidden buffer changes.
9343 (c-at-statement-start-p))
9344 (make-obsolete 'c-looking-at-bos 'c-at-statement-start-p "22.1")
9345
9346 (defun c-looking-at-inexpr-block (lim containing-sexp &optional check-at-end)
9347 ;; Return non-nil if we're looking at the beginning of a block
9348 ;; inside an expression. The value returned is actually a cons of
9349 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
9350 ;; position of the beginning of the construct.
9351 ;;
9352 ;; LIM limits the backward search. CONTAINING-SEXP is the start
9353 ;; position of the closest containing list. If it's nil, the
9354 ;; containing paren isn't used to decide whether we're inside an
9355 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
9356 ;; needs to be farther back.
9357 ;;
9358 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
9359 ;; brace block might be done. It should only be used when the
9360 ;; construct can be assumed to be complete, i.e. when the original
9361 ;; starting position was further down than that.
9362 ;;
9363 ;; This function might do hidden buffer changes.
9364
9365 (save-excursion
9366 (let ((res 'maybe) passed-paren
9367 (closest-lim (or containing-sexp lim (point-min)))
9368 ;; Look at the character after point only as a last resort
9369 ;; when we can't disambiguate.
9370 (block-follows (and (eq (char-after) ?{) (point))))
9371
9372 (while (and (eq res 'maybe)
9373 (progn (c-backward-syntactic-ws)
9374 (> (point) closest-lim))
9375 (not (bobp))
9376 (progn (backward-char)
9377 (looking-at "[]).]\\|\\w\\|\\s_"))
9378 (c-safe (forward-char)
9379 (goto-char (scan-sexps (point) -1))))
9380
9381 (setq res
9382 (if (looking-at c-keywords-regexp)
9383 (let ((kw-sym (c-keyword-sym (match-string 1))))
9384 (cond
9385 ((and block-follows
9386 (c-keyword-member kw-sym 'c-inexpr-class-kwds))
9387 (and (not (eq passed-paren ?\[))
9388 (or (not (looking-at c-class-key))
9389 ;; If the class definition is at the start of
9390 ;; a statement, we don't consider it an
9391 ;; in-expression class.
9392 (let ((prev (point)))
9393 (while (and
9394 (= (c-backward-token-2 1 nil closest-lim) 0)
9395 (eq (char-syntax (char-after)) ?w))
9396 (setq prev (point)))
9397 (goto-char prev)
9398 (not (c-at-statement-start-p)))
9399 ;; Also, in Pike we treat it as an
9400 ;; in-expression class if it's used in an
9401 ;; object clone expression.
9402 (save-excursion
9403 (and check-at-end
9404 (c-major-mode-is 'pike-mode)
9405 (progn (goto-char block-follows)
9406 (zerop (c-forward-token-2 1 t)))
9407 (eq (char-after) ?\())))
9408 (cons 'inexpr-class (point))))
9409 ((c-keyword-member kw-sym 'c-inexpr-block-kwds)
9410 (when (not passed-paren)
9411 (cons 'inexpr-statement (point))))
9412 ((c-keyword-member kw-sym 'c-lambda-kwds)
9413 (when (or (not passed-paren)
9414 (eq passed-paren ?\())
9415 (cons 'inlambda (point))))
9416 ((c-keyword-member kw-sym 'c-block-stmt-kwds)
9417 nil)
9418 (t
9419 'maybe)))
9420
9421 (if (looking-at "\\s(")
9422 (if passed-paren
9423 (if (and (eq passed-paren ?\[)
9424 (eq (char-after) ?\[))
9425 ;; Accept several square bracket sexps for
9426 ;; Java array initializations.
9427 'maybe)
9428 (setq passed-paren (char-after))
9429 'maybe)
9430 'maybe))))
9431
9432 (if (eq res 'maybe)
9433 (when (and c-recognize-paren-inexpr-blocks
9434 block-follows
9435 containing-sexp
9436 (eq (char-after containing-sexp) ?\())
9437 (goto-char containing-sexp)
9438 (if (or (save-excursion
9439 (c-backward-syntactic-ws lim)
9440 (while (and (eq (char-before) ?>)
9441 (c-get-char-property (1- (point))
9442 'syntax-table)
9443 (c-go-list-backward nil lim))
9444 (c-backward-syntactic-ws lim))
9445 (and (> (point) (or lim (point-min)))
9446 (c-on-identifier)))
9447 (and c-special-brace-lists
9448 (c-looking-at-special-brace-list)))
9449 nil
9450 (cons 'inexpr-statement (point))))
9451
9452 res))))
9453
9454 (defun c-looking-at-inexpr-block-backward (paren-state)
9455 ;; Returns non-nil if we're looking at the end of an in-expression
9456 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
9457 ;; PAREN-STATE is the paren state relevant at the current position.
9458 ;;
9459 ;; This function might do hidden buffer changes.
9460 (save-excursion
9461 ;; We currently only recognize a block.
9462 (let ((here (point))
9463 (elem (car-safe paren-state))
9464 containing-sexp)
9465 (when (and (consp elem)
9466 (progn (goto-char (cdr elem))
9467 (c-forward-syntactic-ws here)
9468 (= (point) here)))
9469 (goto-char (car elem))
9470 (if (setq paren-state (cdr paren-state))
9471 (setq containing-sexp (car-safe paren-state)))
9472 (c-looking-at-inexpr-block (c-safe-position containing-sexp
9473 paren-state)
9474 containing-sexp)))))
9475
9476 (defun c-at-macro-vsemi-p (&optional pos)
9477 ;; Is there a "virtual semicolon" at POS or point?
9478 ;; (See cc-defs.el for full details of "virtual semicolons".)
9479 ;;
9480 ;; This is true when point is at the last non syntactic WS position on the
9481 ;; line, there is a macro call last on the line, and this particular macro's
9482 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
9483 ;; semicolon.
9484 (save-excursion
9485 (save-restriction
9486 (widen)
9487 (if pos
9488 (goto-char pos)
9489 (setq pos (point)))
9490 (and
9491 c-macro-with-semi-re
9492 (eq (skip-chars-backward " \t") 0)
9493
9494 ;; Check we've got nothing after this except comments and empty lines
9495 ;; joined by escaped EOLs.
9496 (skip-chars-forward " \t") ; always returns non-nil.
9497 (progn
9498 (while ; go over 1 block comment per iteration.
9499 (and
9500 (looking-at "\\(\\\\[\n\r][ \t]*\\)*")
9501 (goto-char (match-end 0))
9502 (cond
9503 ((looking-at c-block-comment-start-regexp)
9504 (and (forward-comment 1)
9505 (skip-chars-forward " \t"))) ; always returns non-nil
9506 ((looking-at c-line-comment-start-regexp)
9507 (end-of-line)
9508 nil)
9509 (t nil))))
9510 (eolp))
9511
9512 (goto-char pos)
9513 (progn (c-backward-syntactic-ws)
9514 (eq (point) pos))
9515
9516 ;; Check for one of the listed macros being before point.
9517 (or (not (eq (char-before) ?\)))
9518 (when (c-go-list-backward)
9519 (c-backward-syntactic-ws)
9520 t))
9521 (c-simple-skip-symbol-backward)
9522 (looking-at c-macro-with-semi-re)
9523 (goto-char pos)
9524 (not (c-in-literal)))))) ; The most expensive check last.
9525
9526 (defun c-macro-vsemi-status-unknown-p () t) ; See cc-defs.el.
9527
9528 \f
9529 ;; `c-guess-basic-syntax' and the functions that precedes it below
9530 ;; implements the main decision tree for determining the syntactic
9531 ;; analysis of the current line of code.
9532
9533 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
9534 ;; auto newline analysis.
9535 (defvar c-auto-newline-analysis nil)
9536
9537 (defun c-brace-anchor-point (bracepos)
9538 ;; BRACEPOS is the position of a brace in a construct like "namespace
9539 ;; Bar {". Return the anchor point in this construct; this is the
9540 ;; earliest symbol on the brace's line which isn't earlier than
9541 ;; "namespace".
9542 ;;
9543 ;; Currently (2007-08-17), "like namespace" means "matches
9544 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
9545 ;; or anything like that.
9546 (save-excursion
9547 (let ((boi (c-point 'boi bracepos)))
9548 (goto-char bracepos)
9549 (while (and (> (point) boi)
9550 (not (looking-at c-other-decl-block-key)))
9551 (c-backward-token-2))
9552 (if (> (point) boi) (point) boi))))
9553
9554 (defsubst c-add-syntax (symbol &rest args)
9555 ;; A simple function to prepend a new syntax element to
9556 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
9557 ;; should always be dynamically bound but since we read it first
9558 ;; we'll fail properly anyway if this function is misused.
9559 (setq c-syntactic-context (cons (cons symbol args)
9560 c-syntactic-context)))
9561
9562 (defsubst c-append-syntax (symbol &rest args)
9563 ;; Like `c-add-syntax' but appends to the end of the syntax list.
9564 ;; (Normally not necessary.)
9565 (setq c-syntactic-context (nconc c-syntactic-context
9566 (list (cons symbol args)))))
9567
9568 (defun c-add-stmt-syntax (syntax-symbol
9569 syntax-extra-args
9570 stop-at-boi-only
9571 containing-sexp
9572 paren-state)
9573 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
9574 ;; needed with further syntax elements of the types `substatement',
9575 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
9576 ;; `defun-block-intro'.
9577 ;;
9578 ;; Do the generic processing to anchor the given syntax symbol on
9579 ;; the preceding statement: Skip over any labels and containing
9580 ;; statements on the same line, and then search backward until we
9581 ;; find a statement or block start that begins at boi without a
9582 ;; label or comment.
9583 ;;
9584 ;; Point is assumed to be at the prospective anchor point for the
9585 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
9586 ;; skip past open parens and containing statements. Most of the added
9587 ;; syntax elements will get the same anchor point - the exception is
9588 ;; for an anchor in a construct like "namespace"[*] - this is as early
9589 ;; as possible in the construct but on the same line as the {.
9590 ;;
9591 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
9592 ;;
9593 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
9594 ;; syntax symbol. They are appended after the anchor point.
9595 ;;
9596 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
9597 ;; if the current statement starts there.
9598 ;;
9599 ;; Note: It's not a problem if PAREN-STATE "overshoots"
9600 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
9601 ;;
9602 ;; This function might do hidden buffer changes.
9603
9604 (if (= (point) (c-point 'boi))
9605 ;; This is by far the most common case, so let's give it special
9606 ;; treatment.
9607 (apply 'c-add-syntax syntax-symbol (point) syntax-extra-args)
9608
9609 (let ((syntax-last c-syntactic-context)
9610 (boi (c-point 'boi))
9611 ;; Set when we're on a label, so that we don't stop there.
9612 ;; FIXME: To be complete we should check if we're on a label
9613 ;; now at the start.
9614 on-label)
9615
9616 ;; Use point as the anchor point for "namespace", "extern", etc.
9617 (apply 'c-add-syntax syntax-symbol
9618 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist)
9619 (point) nil)
9620 syntax-extra-args)
9621
9622 ;; Loop while we have to back out of containing blocks.
9623 (while
9624 (and
9625 (catch 'back-up-block
9626
9627 ;; Loop while we have to back up statements.
9628 (while (or (/= (point) boi)
9629 on-label
9630 (looking-at c-comment-start-regexp))
9631
9632 ;; Skip past any comments that stands between the
9633 ;; statement start and boi.
9634 (let ((savepos (point)))
9635 (while (and (/= savepos boi)
9636 (c-backward-single-comment))
9637 (setq savepos (point)
9638 boi (c-point 'boi)))
9639 (goto-char savepos))
9640
9641 ;; Skip to the beginning of this statement or backward
9642 ;; another one.
9643 (let ((old-pos (point))
9644 (old-boi boi)
9645 (step-type (c-beginning-of-statement-1 containing-sexp)))
9646 (setq boi (c-point 'boi)
9647 on-label (eq step-type 'label))
9648
9649 (cond ((= (point) old-pos)
9650 ;; If we didn't move we're at the start of a block and
9651 ;; have to continue outside it.
9652 (throw 'back-up-block t))
9653
9654 ((and (eq step-type 'up)
9655 (>= (point) old-boi)
9656 (looking-at "else\\>[^_]")
9657 (save-excursion
9658 (goto-char old-pos)
9659 (looking-at "if\\>[^_]")))
9660 ;; Special case to avoid deeper and deeper indentation
9661 ;; of "else if" clauses.
9662 )
9663
9664 ((and (not stop-at-boi-only)
9665 (/= old-pos old-boi)
9666 (memq step-type '(up previous)))
9667 ;; If stop-at-boi-only is nil, we shouldn't back up
9668 ;; over previous or containing statements to try to
9669 ;; reach boi, so go back to the last position and
9670 ;; exit.
9671 (goto-char old-pos)
9672 (throw 'back-up-block nil))
9673
9674 (t
9675 (if (and (not stop-at-boi-only)
9676 (memq step-type '(up previous beginning)))
9677 ;; If we've moved into another statement then we
9678 ;; should no longer try to stop in the middle of a
9679 ;; line.
9680 (setq stop-at-boi-only t))
9681
9682 ;; Record this as a substatement if we skipped up one
9683 ;; level.
9684 (when (eq step-type 'up)
9685 (c-add-syntax 'substatement nil))))
9686 )))
9687
9688 containing-sexp)
9689
9690 ;; Now we have to go out of this block.
9691 (goto-char containing-sexp)
9692
9693 ;; Don't stop in the middle of a special brace list opener
9694 ;; like "({".
9695 (when c-special-brace-lists
9696 (let ((special-list (c-looking-at-special-brace-list)))
9697 (when (and special-list
9698 (< (car (car special-list)) (point)))
9699 (setq containing-sexp (car (car special-list)))
9700 (goto-char containing-sexp))))
9701
9702 (setq paren-state (c-whack-state-after containing-sexp paren-state)
9703 containing-sexp (c-most-enclosing-brace paren-state)
9704 boi (c-point 'boi))
9705
9706 ;; Analyze the construct in front of the block we've stepped out
9707 ;; from and add the right syntactic element for it.
9708 (let ((paren-pos (point))
9709 (paren-char (char-after))
9710 step-type)
9711
9712 (if (eq paren-char ?\()
9713 ;; Stepped out of a parenthesis block, so we're in an
9714 ;; expression now.
9715 (progn
9716 (when (/= paren-pos boi)
9717 (if (and c-recognize-paren-inexpr-blocks
9718 (progn
9719 (c-backward-syntactic-ws containing-sexp)
9720 (or (not (looking-at "\\>"))
9721 (not (c-on-identifier))))
9722 (save-excursion
9723 (goto-char (1+ paren-pos))
9724 (c-forward-syntactic-ws)
9725 (eq (char-after) ?{)))
9726 ;; Stepped out of an in-expression statement. This
9727 ;; syntactic element won't get an anchor pos.
9728 (c-add-syntax 'inexpr-statement)
9729
9730 ;; A parenthesis normally belongs to an arglist.
9731 (c-add-syntax 'arglist-cont-nonempty nil paren-pos)))
9732
9733 (goto-char (max boi
9734 (if containing-sexp
9735 (1+ containing-sexp)
9736 (point-min))))
9737 (setq step-type 'same
9738 on-label nil))
9739
9740 ;; Stepped out of a brace block.
9741 (setq step-type (c-beginning-of-statement-1 containing-sexp)
9742 on-label (eq step-type 'label))
9743
9744 (if (and (eq step-type 'same)
9745 (/= paren-pos (point)))
9746 (let (inexpr)
9747 (cond
9748 ((save-excursion
9749 (goto-char paren-pos)
9750 (setq inexpr (c-looking-at-inexpr-block
9751 (c-safe-position containing-sexp paren-state)
9752 containing-sexp)))
9753 (c-add-syntax (if (eq (car inexpr) 'inlambda)
9754 'defun-block-intro
9755 'statement-block-intro)
9756 nil))
9757 ((looking-at c-other-decl-block-key)
9758 (c-add-syntax
9759 (cdr (assoc (match-string 1)
9760 c-other-decl-block-key-in-symbols-alist))
9761 (max (c-point 'boi paren-pos) (point))))
9762 (t (c-add-syntax 'defun-block-intro nil))))
9763
9764 (c-add-syntax 'statement-block-intro nil)))
9765
9766 (if (= paren-pos boi)
9767 ;; Always done if the open brace was at boi. The
9768 ;; c-beginning-of-statement-1 call above is necessary
9769 ;; anyway, to decide the type of block-intro to add.
9770 (goto-char paren-pos)
9771 (setq boi (c-point 'boi)))
9772 ))
9773
9774 ;; Fill in the current point as the anchor for all the symbols
9775 ;; added above.
9776 (let ((p c-syntactic-context) q)
9777 (while (not (eq p syntax-last))
9778 (setq q (cdr (car p))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
9779 (while q
9780 (unless (car q)
9781 (setcar q (point)))
9782 (setq q (cdr q)))
9783 (setq p (cdr p))))
9784 )))
9785
9786 (defun c-add-class-syntax (symbol
9787 containing-decl-open
9788 containing-decl-start
9789 containing-decl-kwd
9790 paren-state)
9791 ;; The inclass and class-close syntactic symbols are added in
9792 ;; several places and some work is needed to fix everything.
9793 ;; Therefore it's collected here.
9794 ;;
9795 ;; This function might do hidden buffer changes.
9796 (goto-char containing-decl-open)
9797 (if (and (eq symbol 'inclass) (= (point) (c-point 'boi)))
9798 (progn
9799 (c-add-syntax symbol containing-decl-open)
9800 containing-decl-open)
9801 (goto-char containing-decl-start)
9802 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9803 ;; here, but we have to do like this for compatibility.
9804 (back-to-indentation)
9805 (c-add-syntax symbol (point))
9806 (if (and (c-keyword-member containing-decl-kwd
9807 'c-inexpr-class-kwds)
9808 (/= containing-decl-start (c-point 'boi containing-decl-start)))
9809 (c-add-syntax 'inexpr-class))
9810 (point)))
9811
9812 (defun c-guess-continued-construct (indent-point
9813 char-after-ip
9814 beg-of-same-or-containing-stmt
9815 containing-sexp
9816 paren-state)
9817 ;; This function contains the decision tree reached through both
9818 ;; cases 18 and 10. It's a continued statement or top level
9819 ;; construct of some kind.
9820 ;;
9821 ;; This function might do hidden buffer changes.
9822
9823 (let (special-brace-list placeholder)
9824 (goto-char indent-point)
9825 (skip-chars-forward " \t")
9826
9827 (cond
9828 ;; (CASE A removed.)
9829 ;; CASE B: open braces for class or brace-lists
9830 ((setq special-brace-list
9831 (or (and c-special-brace-lists
9832 (c-looking-at-special-brace-list))
9833 (eq char-after-ip ?{)))
9834
9835 (cond
9836 ;; CASE B.1: class-open
9837 ((save-excursion
9838 (and (eq (char-after) ?{)
9839 (c-looking-at-decl-block containing-sexp t)
9840 (setq beg-of-same-or-containing-stmt (point))))
9841 (c-add-syntax 'class-open beg-of-same-or-containing-stmt))
9842
9843 ;; CASE B.2: brace-list-open
9844 ((or (consp special-brace-list)
9845 (save-excursion
9846 (goto-char beg-of-same-or-containing-stmt)
9847 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
9848 indent-point t t t)))
9849 ;; The most semantically accurate symbol here is
9850 ;; brace-list-open, but we normally report it simply as a
9851 ;; statement-cont. The reason is that one normally adjusts
9852 ;; brace-list-open for brace lists as top-level constructs,
9853 ;; and brace lists inside statements is a completely different
9854 ;; context. C.f. case 5A.3.
9855 (c-beginning-of-statement-1 containing-sexp)
9856 (c-add-stmt-syntax (if c-auto-newline-analysis
9857 ;; Turn off the dwim above when we're
9858 ;; analyzing the nature of the brace
9859 ;; for the auto newline feature.
9860 'brace-list-open
9861 'statement-cont)
9862 nil nil
9863 containing-sexp paren-state))
9864
9865 ;; CASE B.3: The body of a function declared inside a normal
9866 ;; block. Can occur e.g. in Pike and when using gcc
9867 ;; extensions, but watch out for macros followed by blocks.
9868 ;; C.f. cases E, 16F and 17G.
9869 ((and (not (c-at-statement-start-p))
9870 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9871 'same)
9872 (save-excursion
9873 (let ((c-recognize-typeless-decls nil))
9874 ;; Turn off recognition of constructs that lacks a
9875 ;; type in this case, since that's more likely to be
9876 ;; a macro followed by a block.
9877 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9878 (c-add-stmt-syntax 'defun-open nil t
9879 containing-sexp paren-state))
9880
9881 ;; CASE B.4: Continued statement with block open. The most
9882 ;; accurate analysis is perhaps `statement-cont' together with
9883 ;; `block-open' but we play DWIM and use `substatement-open'
9884 ;; instead. The rationale is that this typically is a macro
9885 ;; followed by a block which makes it very similar to a
9886 ;; statement with a substatement block.
9887 (t
9888 (c-add-stmt-syntax 'substatement-open nil nil
9889 containing-sexp paren-state))
9890 ))
9891
9892 ;; CASE C: iostream insertion or extraction operator
9893 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
9894 (save-excursion
9895 (goto-char beg-of-same-or-containing-stmt)
9896 ;; If there is no preceding streamop in the statement
9897 ;; then indent this line as a normal statement-cont.
9898 (when (c-syntactic-re-search-forward
9899 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point 'move t t)
9900 (c-add-syntax 'stream-op (c-point 'boi))
9901 t))))
9902
9903 ;; CASE E: In the "K&R region" of a function declared inside a
9904 ;; normal block. C.f. case B.3.
9905 ((and (save-excursion
9906 ;; Check that the next token is a '{'. This works as
9907 ;; long as no language that allows nested function
9908 ;; definitions allows stuff like member init lists, K&R
9909 ;; declarations or throws clauses there.
9910 ;;
9911 ;; Note that we do a forward search for something ahead
9912 ;; of the indentation line here. That's not good since
9913 ;; the user might not have typed it yet. Unfortunately
9914 ;; it's exceedingly tricky to recognize a function
9915 ;; prototype in a code block without resorting to this.
9916 (c-forward-syntactic-ws)
9917 (eq (char-after) ?{))
9918 (not (c-at-statement-start-p))
9919 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9920 'same)
9921 (save-excursion
9922 (let ((c-recognize-typeless-decls nil))
9923 ;; Turn off recognition of constructs that lacks a
9924 ;; type in this case, since that's more likely to be
9925 ;; a macro followed by a block.
9926 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9927 (c-add-stmt-syntax 'func-decl-cont nil t
9928 containing-sexp paren-state))
9929
9930 ;;CASE F: continued statement and the only preceding items are
9931 ;;annotations.
9932 ((and (c-major-mode-is 'java-mode)
9933 (setq placeholder (point))
9934 (c-beginning-of-statement-1)
9935 (progn
9936 (while (and (c-forward-annotation)
9937 (< (point) placeholder))
9938 (c-forward-syntactic-ws))
9939 t)
9940 (prog1
9941 (>= (point) placeholder)
9942 (goto-char placeholder)))
9943 (c-beginning-of-statement-1 containing-sexp)
9944 (c-add-syntax 'annotation-var-cont (point)))
9945
9946 ;; CASE G: a template list continuation?
9947 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9948 ((and (c-major-mode-is 'c++-mode)
9949 (save-excursion
9950 (goto-char indent-point)
9951 (c-with-syntax-table c++-template-syntax-table
9952 (setq placeholder (c-up-list-backward)))
9953 (and placeholder
9954 (eq (char-after placeholder) ?<)
9955 (/= (char-before placeholder) ?<)
9956 (progn
9957 (goto-char (1+ placeholder))
9958 (not (looking-at c-<-op-cont-regexp))))))
9959 (c-with-syntax-table c++-template-syntax-table
9960 (goto-char placeholder)
9961 (c-beginning-of-statement-1 containing-sexp t))
9962 (if (save-excursion
9963 (c-backward-syntactic-ws containing-sexp)
9964 (eq (char-before) ?<))
9965 ;; In a nested template arglist.
9966 (progn
9967 (goto-char placeholder)
9968 (c-syntactic-skip-backward "^,;" containing-sexp t)
9969 (c-forward-syntactic-ws))
9970 (back-to-indentation))
9971 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9972 ;; template aware.
9973 (c-add-syntax 'template-args-cont (point) placeholder))
9974
9975 ;; CASE D: continued statement.
9976 (t
9977 (c-beginning-of-statement-1 containing-sexp)
9978 (c-add-stmt-syntax 'statement-cont nil nil
9979 containing-sexp paren-state))
9980 )))
9981
9982 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9983 ;; 2005/11/29).
9984 ;;;###autoload
9985 (defun c-guess-basic-syntax ()
9986 "Return the syntactic context of the current line."
9987 (save-excursion
9988 (beginning-of-line)
9989 (c-save-buffer-state
9990 ((indent-point (point))
9991 (case-fold-search nil)
9992 ;; A whole ugly bunch of various temporary variables. Have
9993 ;; to declare them here since it's not possible to declare
9994 ;; a variable with only the scope of a cond test and the
9995 ;; following result clauses, and most of this function is a
9996 ;; single gigantic cond. :P
9997 literal char-before-ip before-ws-ip char-after-ip macro-start
9998 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9999 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
10000 containing-<
10001 ;; The following record some positions for the containing
10002 ;; declaration block if we're directly within one:
10003 ;; `containing-decl-open' is the position of the open
10004 ;; brace. `containing-decl-start' is the start of the
10005 ;; declaration. `containing-decl-kwd' is the keyword
10006 ;; symbol of the keyword that tells what kind of block it
10007 ;; is.
10008 containing-decl-open
10009 containing-decl-start
10010 containing-decl-kwd
10011 ;; The open paren of the closest surrounding sexp or nil if
10012 ;; there is none.
10013 containing-sexp
10014 ;; The position after the closest preceding brace sexp
10015 ;; (nested sexps are ignored), or the position after
10016 ;; `containing-sexp' if there is none, or (point-min) if
10017 ;; `containing-sexp' is nil.
10018 lim
10019 ;; The paren state outside `containing-sexp', or at
10020 ;; `indent-point' if `containing-sexp' is nil.
10021 (paren-state (c-parse-state))
10022 ;; There's always at most one syntactic element which got
10023 ;; an anchor pos. It's stored in syntactic-relpos.
10024 syntactic-relpos
10025 (c-stmt-delim-chars c-stmt-delim-chars))
10026
10027 ;; Check if we're directly inside an enclosing declaration
10028 ;; level block.
10029 (when (and (setq containing-sexp
10030 (c-most-enclosing-brace paren-state))
10031 (progn
10032 (goto-char containing-sexp)
10033 (eq (char-after) ?{))
10034 (setq placeholder
10035 (c-looking-at-decl-block
10036 (c-most-enclosing-brace paren-state
10037 containing-sexp)
10038 t)))
10039 (setq containing-decl-open containing-sexp
10040 containing-decl-start (point)
10041 containing-sexp nil)
10042 (goto-char placeholder)
10043 (setq containing-decl-kwd (and (looking-at c-keywords-regexp)
10044 (c-keyword-sym (match-string 1)))))
10045
10046 ;; Init some position variables.
10047 (if paren-state
10048 (progn
10049 (setq containing-sexp (car paren-state)
10050 paren-state (cdr paren-state))
10051 (if (consp containing-sexp)
10052 (save-excursion
10053 (goto-char (cdr containing-sexp))
10054 (if (and (c-major-mode-is 'c++-mode)
10055 (c-back-over-member-initializer-braces))
10056 (c-syntactic-skip-backward "^}" nil t))
10057 (setq lim (point))
10058 (if paren-state
10059 ;; Ignore balanced paren. The next entry
10060 ;; can't be another one.
10061 (setq containing-sexp (car paren-state)
10062 paren-state (cdr paren-state))
10063 ;; If there is no surrounding open paren then
10064 ;; put the last balanced pair back on paren-state.
10065 (setq paren-state (cons containing-sexp paren-state)
10066 containing-sexp nil)))
10067 (setq lim (1+ containing-sexp))))
10068 (setq lim (point-min)))
10069
10070 ;; If we're in a parenthesis list then ',' delimits the
10071 ;; "statements" rather than being an operator (with the
10072 ;; exception of the "for" clause). This difference is
10073 ;; typically only noticeable when statements are used in macro
10074 ;; arglists.
10075 (when (and containing-sexp
10076 (eq (char-after containing-sexp) ?\())
10077 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma))
10078 ;; cache char before and after indent point, and move point to
10079 ;; the most likely position to perform the majority of tests
10080 (goto-char indent-point)
10081 (c-backward-syntactic-ws lim)
10082 (setq before-ws-ip (point)
10083 char-before-ip (char-before))
10084 (goto-char indent-point)
10085 (skip-chars-forward " \t")
10086 (setq char-after-ip (char-after))
10087
10088 ;; are we in a literal?
10089 (setq literal (c-in-literal lim))
10090
10091 ;; now figure out syntactic qualities of the current line
10092 (cond
10093
10094 ;; CASE 1: in a string.
10095 ((eq literal 'string)
10096 (c-add-syntax 'string (c-point 'bopl)))
10097
10098 ;; CASE 2: in a C or C++ style comment.
10099 ((and (memq literal '(c c++))
10100 ;; This is a kludge for XEmacs where we use
10101 ;; `buffer-syntactic-context', which doesn't correctly
10102 ;; recognize "\*/" to end a block comment.
10103 ;; `parse-partial-sexp' which is used by
10104 ;; `c-literal-limits' will however do that in most
10105 ;; versions, which results in that we get nil from
10106 ;; `c-literal-limits' even when `c-in-literal' claims
10107 ;; we're inside a comment.
10108 (setq placeholder (c-literal-limits lim)))
10109 (c-add-syntax literal (car placeholder)))
10110
10111 ;; CASE 3: in a cpp preprocessor macro continuation.
10112 ((and (save-excursion
10113 (when (c-beginning-of-macro)
10114 (setq macro-start (point))))
10115 (/= macro-start (c-point 'boi))
10116 (progn
10117 (setq tmpsymbol 'cpp-macro-cont)
10118 (or (not c-syntactic-indentation-in-macros)
10119 (save-excursion
10120 (goto-char macro-start)
10121 ;; If at the beginning of the body of a #define
10122 ;; directive then analyze as cpp-define-intro
10123 ;; only. Go on with the syntactic analysis
10124 ;; otherwise. in-macro-expr is set if we're in a
10125 ;; cpp expression, i.e. before the #define body
10126 ;; or anywhere in a non-#define directive.
10127 (if (c-forward-to-cpp-define-body)
10128 (let ((indent-boi (c-point 'boi indent-point)))
10129 (setq in-macro-expr (> (point) indent-boi)
10130 tmpsymbol 'cpp-define-intro)
10131 (= (point) indent-boi))
10132 (setq in-macro-expr t)
10133 nil)))))
10134 (c-add-syntax tmpsymbol macro-start)
10135 (setq macro-start nil))
10136
10137 ;; CASE 11: an else clause?
10138 ((looking-at "else\\>[^_]")
10139 (c-beginning-of-statement-1 containing-sexp)
10140 (c-add-stmt-syntax 'else-clause nil t
10141 containing-sexp paren-state))
10142
10143 ;; CASE 12: while closure of a do/while construct?
10144 ((and (looking-at "while\\>[^_]")
10145 (save-excursion
10146 (prog1 (eq (c-beginning-of-statement-1 containing-sexp)
10147 'beginning)
10148 (setq placeholder (point)))))
10149 (goto-char placeholder)
10150 (c-add-stmt-syntax 'do-while-closure nil t
10151 containing-sexp paren-state))
10152
10153 ;; CASE 13: A catch or finally clause? This case is simpler
10154 ;; than if-else and do-while, because a block is required
10155 ;; after every try, catch and finally.
10156 ((save-excursion
10157 (and (cond ((c-major-mode-is 'c++-mode)
10158 (looking-at "catch\\>[^_]"))
10159 ((c-major-mode-is 'java-mode)
10160 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
10161 (and (c-safe (c-backward-syntactic-ws)
10162 (c-backward-sexp)
10163 t)
10164 (eq (char-after) ?{)
10165 (c-safe (c-backward-syntactic-ws)
10166 (c-backward-sexp)
10167 t)
10168 (if (eq (char-after) ?\()
10169 (c-safe (c-backward-sexp) t)
10170 t))
10171 (looking-at "\\(try\\|catch\\)\\>[^_]")
10172 (setq placeholder (point))))
10173 (goto-char placeholder)
10174 (c-add-stmt-syntax 'catch-clause nil t
10175 containing-sexp paren-state))
10176
10177 ;; CASE 18: A substatement we can recognize by keyword.
10178 ((save-excursion
10179 (and c-opt-block-stmt-key
10180 (not (eq char-before-ip ?\;))
10181 (not (c-at-vsemi-p before-ws-ip))
10182 (not (memq char-after-ip '(?\) ?\] ?,)))
10183 (or (not (eq char-before-ip ?}))
10184 (c-looking-at-inexpr-block-backward c-state-cache))
10185 (> (point)
10186 (progn
10187 ;; Ought to cache the result from the
10188 ;; c-beginning-of-statement-1 calls here.
10189 (setq placeholder (point))
10190 (while (eq (setq step-type
10191 (c-beginning-of-statement-1 lim))
10192 'label))
10193 (if (eq step-type 'previous)
10194 (goto-char placeholder)
10195 (setq placeholder (point))
10196 (if (and (eq step-type 'same)
10197 (not (looking-at c-opt-block-stmt-key)))
10198 ;; Step up to the containing statement if we
10199 ;; stayed in the same one.
10200 (let (step)
10201 (while (eq
10202 (setq step
10203 (c-beginning-of-statement-1 lim))
10204 'label))
10205 (if (eq step 'up)
10206 (setq placeholder (point))
10207 ;; There was no containing statement after all.
10208 (goto-char placeholder)))))
10209 placeholder))
10210 (if (looking-at c-block-stmt-2-key)
10211 ;; Require a parenthesis after these keywords.
10212 ;; Necessary to catch e.g. synchronized in Java,
10213 ;; which can be used both as statement and
10214 ;; modifier.
10215 (and (zerop (c-forward-token-2 1 nil))
10216 (eq (char-after) ?\())
10217 (looking-at c-opt-block-stmt-key))))
10218
10219 (if (eq step-type 'up)
10220 ;; CASE 18A: Simple substatement.
10221 (progn
10222 (goto-char placeholder)
10223 (cond
10224 ((eq char-after-ip ?{)
10225 (c-add-stmt-syntax 'substatement-open nil nil
10226 containing-sexp paren-state))
10227 ((save-excursion
10228 (goto-char indent-point)
10229 (back-to-indentation)
10230 (c-forward-label))
10231 (c-add-stmt-syntax 'substatement-label nil nil
10232 containing-sexp paren-state))
10233 (t
10234 (c-add-stmt-syntax 'substatement nil nil
10235 containing-sexp paren-state))))
10236
10237 ;; CASE 18B: Some other substatement. This is shared
10238 ;; with case 10.
10239 (c-guess-continued-construct indent-point
10240 char-after-ip
10241 placeholder
10242 lim
10243 paren-state)))
10244
10245 ;; CASE 14: A case or default label
10246 ((save-excursion
10247 (and (looking-at c-label-kwds-regexp)
10248 (or (c-major-mode-is 'idl-mode)
10249 (and
10250 containing-sexp
10251 (goto-char containing-sexp)
10252 (eq (char-after) ?{)
10253 (progn (c-backward-syntactic-ws) t)
10254 (eq (char-before) ?\))
10255 (c-go-list-backward)
10256 (progn (c-backward-syntactic-ws) t)
10257 (c-simple-skip-symbol-backward)
10258 (looking-at c-block-stmt-2-key)))))
10259 (if containing-sexp
10260 (progn
10261 (goto-char containing-sexp)
10262 (setq lim (c-most-enclosing-brace c-state-cache
10263 containing-sexp))
10264 (c-backward-to-block-anchor lim)
10265 (c-add-stmt-syntax 'case-label nil t lim paren-state))
10266 ;; Got a bogus label at the top level. In lack of better
10267 ;; alternatives, anchor it on (point-min).
10268 (c-add-syntax 'case-label (point-min))))
10269
10270 ;; CASE 15: any other label
10271 ((save-excursion
10272 (back-to-indentation)
10273 (and (not (looking-at c-syntactic-ws-start))
10274 (not (looking-at c-label-kwds-regexp))
10275 (c-forward-label)))
10276 (cond (containing-decl-open
10277 (setq placeholder (c-add-class-syntax 'inclass
10278 containing-decl-open
10279 containing-decl-start
10280 containing-decl-kwd
10281 paren-state))
10282 ;; Append access-label with the same anchor point as
10283 ;; inclass gets.
10284 (c-append-syntax 'access-label placeholder))
10285
10286 (containing-sexp
10287 (goto-char containing-sexp)
10288 (setq lim (c-most-enclosing-brace c-state-cache
10289 containing-sexp))
10290 (save-excursion
10291 (setq tmpsymbol
10292 (if (and (eq (c-beginning-of-statement-1 lim) 'up)
10293 (looking-at "switch\\>[^_]"))
10294 ;; If the surrounding statement is a switch then
10295 ;; let's analyze all labels as switch labels, so
10296 ;; that they get lined up consistently.
10297 'case-label
10298 'label)))
10299 (c-backward-to-block-anchor lim)
10300 (c-add-stmt-syntax tmpsymbol nil t lim paren-state))
10301
10302 (t
10303 ;; A label on the top level. Treat it as a class
10304 ;; context. (point-min) is the closest we get to the
10305 ;; class open brace.
10306 (c-add-syntax 'access-label (point-min)))))
10307
10308 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
10309 ;; 17E.
10310 ((setq placeholder (c-looking-at-inexpr-block
10311 (c-safe-position containing-sexp paren-state)
10312 containing-sexp
10313 ;; Have to turn on the heuristics after
10314 ;; the point even though it doesn't work
10315 ;; very well. C.f. test case class-16.pike.
10316 t))
10317 (setq tmpsymbol (assq (car placeholder)
10318 '((inexpr-class . class-open)
10319 (inexpr-statement . block-open))))
10320 (if tmpsymbol
10321 ;; It's a statement block or an anonymous class.
10322 (setq tmpsymbol (cdr tmpsymbol))
10323 ;; It's a Pike lambda. Check whether we are between the
10324 ;; lambda keyword and the argument list or at the defun
10325 ;; opener.
10326 (setq tmpsymbol (if (eq char-after-ip ?{)
10327 'inline-open
10328 'lambda-intro-cont)))
10329 (goto-char (cdr placeholder))
10330 (back-to-indentation)
10331 (c-add-stmt-syntax tmpsymbol nil t
10332 (c-most-enclosing-brace c-state-cache (point))
10333 paren-state)
10334 (unless (eq (point) (cdr placeholder))
10335 (c-add-syntax (car placeholder))))
10336
10337 ;; CASE 5: Line is inside a declaration level block or at top level.
10338 ((or containing-decl-open (null containing-sexp))
10339 (cond
10340
10341 ;; CASE 5A: we are looking at a defun, brace list, class,
10342 ;; or inline-inclass method opening brace
10343 ((setq special-brace-list
10344 (or (and c-special-brace-lists
10345 (c-looking-at-special-brace-list))
10346 (eq char-after-ip ?{)))
10347 (cond
10348
10349 ;; CASE 5A.1: Non-class declaration block open.
10350 ((save-excursion
10351 (let (tmp)
10352 (and (eq char-after-ip ?{)
10353 (setq tmp (c-looking-at-decl-block containing-sexp t))
10354 (progn
10355 (setq placeholder (point))
10356 (goto-char tmp)
10357 (looking-at c-symbol-key))
10358 (c-keyword-member
10359 (c-keyword-sym (setq keyword (match-string 0)))
10360 'c-other-block-decl-kwds))))
10361 (goto-char placeholder)
10362 (c-add-stmt-syntax
10363 (if (string-equal keyword "extern")
10364 ;; Special case for extern-lang-open.
10365 'extern-lang-open
10366 (intern (concat keyword "-open")))
10367 nil t containing-sexp paren-state))
10368
10369 ;; CASE 5A.2: we are looking at a class opening brace
10370 ((save-excursion
10371 (goto-char indent-point)
10372 (skip-chars-forward " \t")
10373 (and (eq (char-after) ?{)
10374 (c-looking-at-decl-block containing-sexp t)
10375 (setq placeholder (point))))
10376 (c-add-syntax 'class-open placeholder))
10377
10378 ;; CASE 5A.3: brace list open
10379 ((save-excursion
10380 (c-beginning-of-decl-1 lim)
10381 (while (cond
10382 ((looking-at c-specifier-key)
10383 (c-forward-keyword-clause 1))
10384 ((and c-opt-cpp-prefix
10385 (looking-at c-noise-macro-with-parens-name-re))
10386 (c-forward-noise-clause))))
10387 (setq placeholder (c-point 'boi))
10388 (or (consp special-brace-list)
10389 (and (or (save-excursion
10390 (goto-char indent-point)
10391 (setq tmpsymbol nil)
10392 (while (and (> (point) placeholder)
10393 (zerop (c-backward-token-2 1 t))
10394 (not (looking-at "=\\([^=]\\|$\\)")))
10395 (and c-opt-inexpr-brace-list-key
10396 (not tmpsymbol)
10397 (looking-at c-opt-inexpr-brace-list-key)
10398 (setq tmpsymbol 'topmost-intro-cont)))
10399 (looking-at "=\\([^=]\\|$\\)"))
10400 (looking-at c-brace-list-key))
10401 (save-excursion
10402 (while (and (< (point) indent-point)
10403 (zerop (c-forward-token-2 1 t))
10404 (not (memq (char-after) '(?\; ?\()))))
10405 (not (memq (char-after) '(?\; ?\()))
10406 ))))
10407 (if (and (not c-auto-newline-analysis)
10408 (c-major-mode-is 'java-mode)
10409 (eq tmpsymbol 'topmost-intro-cont))
10410 ;; We're in Java and have found that the open brace
10411 ;; belongs to a "new Foo[]" initialization list,
10412 ;; which means the brace list is part of an
10413 ;; expression and not a top level definition. We
10414 ;; therefore treat it as any topmost continuation
10415 ;; even though the semantically correct symbol still
10416 ;; is brace-list-open, on the same grounds as in
10417 ;; case B.2.
10418 (progn
10419 (c-beginning-of-statement-1 lim)
10420 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10421 (c-add-syntax 'brace-list-open placeholder)))
10422
10423 ;; CASE 5A.4: inline defun open
10424 ((and containing-decl-open
10425 (not (c-keyword-member containing-decl-kwd
10426 'c-other-block-decl-kwds)))
10427 (c-add-syntax 'inline-open)
10428 (c-add-class-syntax 'inclass
10429 containing-decl-open
10430 containing-decl-start
10431 containing-decl-kwd
10432 paren-state))
10433
10434 ;; CASE 5A.5: ordinary defun open
10435 (t
10436 (save-excursion
10437 (c-beginning-of-decl-1 lim)
10438 (while (cond
10439 ((looking-at c-specifier-key)
10440 (c-forward-keyword-clause 1))
10441 ((and c-opt-cpp-prefix
10442 (looking-at c-noise-macro-with-parens-name-re))
10443 (c-forward-noise-clause))))
10444 (c-add-syntax 'defun-open (c-point 'boi))
10445 ;; Bogus to use bol here, but it's the legacy. (Resolved,
10446 ;; 2007-11-09)
10447 ))))
10448
10449 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
10450 ;; Note there is no limit on the backward search here, since member
10451 ;; init lists can, in practice, be very large.
10452 ((save-excursion
10453 (when (and (c-major-mode-is 'c++-mode)
10454 (setq placeholder (c-back-over-member-initializers)))
10455 (setq tmp-pos (point))))
10456 (if (= (c-point 'bosws) (1+ tmp-pos))
10457 (progn
10458 ;; There is no preceding member init clause.
10459 ;; Indent relative to the beginning of indentation
10460 ;; for the topmost-intro line that contains the
10461 ;; prototype's open paren.
10462 (goto-char placeholder)
10463 (c-add-syntax 'member-init-intro (c-point 'boi)))
10464 ;; Indent relative to the first member init clause.
10465 (goto-char (1+ tmp-pos))
10466 (c-forward-syntactic-ws)
10467 (c-add-syntax 'member-init-cont (point))))
10468
10469 ;; CASE 5B: After a function header but before the body (or
10470 ;; the ending semicolon if there's no body).
10471 ((save-excursion
10472 (when (setq placeholder (c-just-after-func-arglist-p
10473 (max lim (c-determine-limit 500))))
10474 (setq tmp-pos (point))))
10475 (cond
10476
10477 ;; CASE 5B.1: Member init list.
10478 ((eq (char-after tmp-pos) ?:)
10479 ;; There is no preceding member init clause.
10480 ;; Indent relative to the beginning of indentation
10481 ;; for the topmost-intro line that contains the
10482 ;; prototype's open paren.
10483 (goto-char placeholder)
10484 (c-add-syntax 'member-init-intro (c-point 'boi)))
10485
10486 ;; CASE 5B.2: K&R arg decl intro
10487 ((and c-recognize-knr-p
10488 (c-in-knr-argdecl lim))
10489 (c-beginning-of-statement-1 lim)
10490 (c-add-syntax 'knr-argdecl-intro (c-point 'boi))
10491 (if containing-decl-open
10492 (c-add-class-syntax 'inclass
10493 containing-decl-open
10494 containing-decl-start
10495 containing-decl-kwd
10496 paren-state)))
10497
10498 ;; CASE 5B.4: Nether region after a C++ or Java func
10499 ;; decl, which could include a `throws' declaration.
10500 (t
10501 (c-beginning-of-statement-1 lim)
10502 (c-add-syntax 'func-decl-cont (c-point 'boi))
10503 )))
10504
10505 ;; CASE 5C: inheritance line. could be first inheritance
10506 ;; line, or continuation of a multiple inheritance
10507 ((or (and (c-major-mode-is 'c++-mode)
10508 (progn
10509 (when (eq char-after-ip ?,)
10510 (skip-chars-forward " \t")
10511 (forward-char))
10512 (looking-at c-opt-postfix-decl-spec-key)))
10513 (and (or (eq char-before-ip ?:)
10514 ;; watch out for scope operator
10515 (save-excursion
10516 (and (eq char-after-ip ?:)
10517 (c-safe (forward-char 1) t)
10518 (not (eq (char-after) ?:))
10519 )))
10520 (save-excursion
10521 (c-beginning-of-statement-1 lim)
10522 (when (looking-at c-opt-<>-sexp-key)
10523 (goto-char (match-end 1))
10524 (c-forward-syntactic-ws)
10525 (c-forward-<>-arglist nil)
10526 (c-forward-syntactic-ws))
10527 (looking-at c-class-key)))
10528 ;; for Java
10529 (and (c-major-mode-is 'java-mode)
10530 (let ((fence (save-excursion
10531 (c-beginning-of-statement-1 lim)
10532 (point)))
10533 cont done)
10534 (save-excursion
10535 (while (not done)
10536 (cond ((looking-at c-opt-postfix-decl-spec-key)
10537 (setq injava-inher (cons cont (point))
10538 done t))
10539 ((or (not (c-safe (c-forward-sexp -1) t))
10540 (<= (point) fence))
10541 (setq done t))
10542 )
10543 (setq cont t)))
10544 injava-inher)
10545 (not (c-crosses-statement-barrier-p (cdr injava-inher)
10546 (point)))
10547 ))
10548 (cond
10549
10550 ;; CASE 5C.1: non-hanging colon on an inher intro
10551 ((eq char-after-ip ?:)
10552 (c-beginning-of-statement-1 lim)
10553 (c-add-syntax 'inher-intro (c-point 'boi))
10554 ;; don't add inclass symbol since relative point already
10555 ;; contains any class offset
10556 )
10557
10558 ;; CASE 5C.2: hanging colon on an inher intro
10559 ((eq char-before-ip ?:)
10560 (c-beginning-of-statement-1 lim)
10561 (c-add-syntax 'inher-intro (c-point 'boi))
10562 (if containing-decl-open
10563 (c-add-class-syntax 'inclass
10564 containing-decl-open
10565 containing-decl-start
10566 containing-decl-kwd
10567 paren-state)))
10568
10569 ;; CASE 5C.3: in a Java implements/extends
10570 (injava-inher
10571 (let ((where (cdr injava-inher))
10572 (cont (car injava-inher)))
10573 (goto-char where)
10574 (cond ((looking-at "throws\\>[^_]")
10575 (c-add-syntax 'func-decl-cont
10576 (progn (c-beginning-of-statement-1 lim)
10577 (c-point 'boi))))
10578 (cont (c-add-syntax 'inher-cont where))
10579 (t (c-add-syntax 'inher-intro
10580 (progn (goto-char (cdr injava-inher))
10581 (c-beginning-of-statement-1 lim)
10582 (point))))
10583 )))
10584
10585 ;; CASE 5C.4: a continued inheritance line
10586 (t
10587 (c-beginning-of-inheritance-list lim)
10588 (c-add-syntax 'inher-cont (point))
10589 ;; don't add inclass symbol since relative point already
10590 ;; contains any class offset
10591 )))
10592
10593 ;; CASE 5P: AWK pattern or function or continuation
10594 ;; thereof.
10595 ((c-major-mode-is 'awk-mode)
10596 (setq placeholder (point))
10597 (c-add-stmt-syntax
10598 (if (and (eq (c-beginning-of-statement-1) 'same)
10599 (/= (point) placeholder))
10600 'topmost-intro-cont
10601 'topmost-intro)
10602 nil nil
10603 containing-sexp paren-state))
10604
10605 ;; CASE 5D: this could be a top-level initialization, a
10606 ;; member init list continuation, or a template argument
10607 ;; list continuation.
10608 ((save-excursion
10609 ;; Note: We use the fact that lim is always after any
10610 ;; preceding brace sexp.
10611 (if c-recognize-<>-arglists
10612 (while (and
10613 (progn
10614 (c-syntactic-skip-backward "^;,=<>" lim t)
10615 (> (point) lim))
10616 (or
10617 (when c-overloadable-operators-regexp
10618 (when (setq placeholder (c-after-special-operator-id lim))
10619 (goto-char placeholder)
10620 t))
10621 (cond
10622 ((eq (char-before) ?>)
10623 (or (c-backward-<>-arglist nil lim)
10624 (backward-char))
10625 t)
10626 ((eq (char-before) ?<)
10627 (backward-char)
10628 (if (save-excursion
10629 (c-forward-<>-arglist nil))
10630 (progn (forward-char)
10631 nil)
10632 t))
10633 (t nil)))))
10634 ;; NB: No c-after-special-operator-id stuff in this
10635 ;; clause - we assume only C++ needs it.
10636 (c-syntactic-skip-backward "^;,=" lim t))
10637 (memq (char-before) '(?, ?= ?<)))
10638 (cond
10639
10640 ;; CASE 5D.3: perhaps a template list continuation?
10641 ((and (c-major-mode-is 'c++-mode)
10642 (save-excursion
10643 (save-restriction
10644 (c-with-syntax-table c++-template-syntax-table
10645 (goto-char indent-point)
10646 (setq placeholder (c-up-list-backward))
10647 (and placeholder
10648 (eq (char-after placeholder) ?<))))))
10649 (c-with-syntax-table c++-template-syntax-table
10650 (goto-char placeholder)
10651 (c-beginning-of-statement-1 lim t))
10652 (if (save-excursion
10653 (c-backward-syntactic-ws lim)
10654 (eq (char-before) ?<))
10655 ;; In a nested template arglist.
10656 (progn
10657 (goto-char placeholder)
10658 (c-syntactic-skip-backward "^,;" lim t)
10659 (c-forward-syntactic-ws))
10660 (back-to-indentation))
10661 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
10662 ;; template aware.
10663 (c-add-syntax 'template-args-cont (point) placeholder))
10664
10665 ;; CASE 5D.4: perhaps a multiple inheritance line?
10666 ((and (c-major-mode-is 'c++-mode)
10667 (save-excursion
10668 (c-beginning-of-statement-1 lim)
10669 (setq placeholder (point))
10670 (if (looking-at "static\\>[^_]")
10671 (c-forward-token-2 1 nil indent-point))
10672 (and (looking-at c-class-key)
10673 (zerop (c-forward-token-2 2 nil indent-point))
10674 (if (eq (char-after) ?<)
10675 (c-with-syntax-table c++-template-syntax-table
10676 (zerop (c-forward-token-2 1 t indent-point)))
10677 t)
10678 (eq (char-after) ?:))))
10679 (goto-char placeholder)
10680 (c-add-syntax 'inher-cont (c-point 'boi)))
10681
10682 ;; CASE 5D.5: Continuation of the "expression part" of a
10683 ;; top level construct. Or, perhaps, an unrecognized construct.
10684 (t
10685 (while (and (setq placeholder (point))
10686 (eq (car (c-beginning-of-decl-1 containing-sexp)) ; Can't use `lim' here.
10687 'same)
10688 (save-excursion
10689 (c-backward-syntactic-ws)
10690 (eq (char-before) ?}))
10691 (< (point) placeholder)))
10692 (c-add-stmt-syntax
10693 (cond
10694 ((eq (point) placeholder) 'statement) ; unrecognized construct
10695 ;; A preceding comma at the top level means that a
10696 ;; new variable declaration starts here. Use
10697 ;; topmost-intro-cont for it, for consistency with
10698 ;; the first variable declaration. C.f. case 5N.
10699 ((eq char-before-ip ?,) 'topmost-intro-cont)
10700 (t 'statement-cont))
10701 nil nil containing-sexp paren-state))
10702 ))
10703
10704 ;; CASE 5F: Close of a non-class declaration level block.
10705 ((and (eq char-after-ip ?})
10706 (c-keyword-member containing-decl-kwd
10707 'c-other-block-decl-kwds))
10708 ;; This is inconsistent: Should use `containing-decl-open'
10709 ;; here if it's at boi, like in case 5J.
10710 (goto-char containing-decl-start)
10711 (c-add-stmt-syntax
10712 (if (string-equal (symbol-name containing-decl-kwd) "extern")
10713 ;; Special case for compatibility with the
10714 ;; extern-lang syntactic symbols.
10715 'extern-lang-close
10716 (intern (concat (symbol-name containing-decl-kwd)
10717 "-close")))
10718 nil t
10719 (c-most-enclosing-brace paren-state (point))
10720 paren-state))
10721
10722 ;; CASE 5G: we are looking at the brace which closes the
10723 ;; enclosing nested class decl
10724 ((and containing-sexp
10725 (eq char-after-ip ?})
10726 (eq containing-decl-open containing-sexp))
10727 (c-add-class-syntax 'class-close
10728 containing-decl-open
10729 containing-decl-start
10730 containing-decl-kwd
10731 paren-state))
10732
10733 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10734 ((and c-recognize-knr-p
10735 (not containing-sexp) ; can't be knr inside braces.
10736 (not (eq char-before-ip ?}))
10737 (save-excursion
10738 (setq placeholder (cdr (c-beginning-of-decl-1 lim)))
10739 (and placeholder
10740 ;; Do an extra check to avoid tripping up on
10741 ;; statements that occur in invalid contexts
10742 ;; (e.g. in macro bodies where we don't really
10743 ;; know the context of what we're looking at).
10744 (not (and c-opt-block-stmt-key
10745 (looking-at c-opt-block-stmt-key)))))
10746 (< placeholder indent-point))
10747 (goto-char placeholder)
10748 (c-add-syntax 'knr-argdecl (point)))
10749
10750 ;; CASE 5I: ObjC method definition.
10751 ((and c-opt-method-key
10752 (looking-at c-opt-method-key))
10753 (c-beginning-of-statement-1 nil t)
10754 (if (= (point) indent-point)
10755 ;; Handle the case when it's the first (non-comment)
10756 ;; thing in the buffer. Can't look for a 'same return
10757 ;; value from cbos1 since ObjC directives currently
10758 ;; aren't recognized fully, so that we get 'same
10759 ;; instead of 'previous if it moved over a preceding
10760 ;; directive.
10761 (goto-char (point-min)))
10762 (c-add-syntax 'objc-method-intro (c-point 'boi)))
10763
10764 ;; CASE 5N: At a variable declaration that follows a class
10765 ;; definition or some other block declaration that doesn't
10766 ;; end at the closing '}'. C.f. case 5D.5.
10767 ((progn
10768 (c-backward-syntactic-ws lim)
10769 (and (eq (char-before) ?})
10770 (save-excursion
10771 (let ((start (point)))
10772 (if (and c-state-cache
10773 (consp (car c-state-cache))
10774 (eq (cdar c-state-cache) (point)))
10775 ;; Speed up the backward search a bit.
10776 (goto-char (caar c-state-cache)))
10777 (c-beginning-of-decl-1 containing-sexp) ; Can't use `lim' here.
10778 (setq placeholder (point))
10779 (if (= start (point))
10780 ;; The '}' is unbalanced.
10781 nil
10782 (c-end-of-decl-1)
10783 (>= (point) indent-point))))))
10784 (goto-char placeholder)
10785 (c-add-stmt-syntax 'topmost-intro-cont nil nil
10786 containing-sexp paren-state))
10787
10788 ;; NOTE: The point is at the end of the previous token here.
10789
10790 ;; CASE 5J: we are at the topmost level, make
10791 ;; sure we skip back past any access specifiers
10792 ((and
10793 ;; A macro continuation line is never at top level.
10794 (not (and macro-start
10795 (> indent-point macro-start)))
10796 (save-excursion
10797 (setq placeholder (point))
10798 (or (memq char-before-ip '(?\; ?{ ?} nil))
10799 (c-at-vsemi-p before-ws-ip)
10800 (when (and (eq char-before-ip ?:)
10801 (eq (c-beginning-of-statement-1 lim)
10802 'label))
10803 (c-backward-syntactic-ws lim)
10804 (setq placeholder (point)))
10805 (and (c-major-mode-is 'objc-mode)
10806 (catch 'not-in-directive
10807 (c-beginning-of-statement-1 lim)
10808 (setq placeholder (point))
10809 (while (and (c-forward-objc-directive)
10810 (< (point) indent-point))
10811 (c-forward-syntactic-ws)
10812 (if (>= (point) indent-point)
10813 (throw 'not-in-directive t))
10814 (setq placeholder (point)))
10815 nil)))))
10816 ;; For historic reasons we anchor at bol of the last
10817 ;; line of the previous declaration. That's clearly
10818 ;; highly bogus and useless, and it makes our lives hard
10819 ;; to remain compatible. :P
10820 (goto-char placeholder)
10821 (c-add-syntax 'topmost-intro (c-point 'bol))
10822 (if containing-decl-open
10823 (if (c-keyword-member containing-decl-kwd
10824 'c-other-block-decl-kwds)
10825 (progn
10826 (goto-char (c-brace-anchor-point containing-decl-open))
10827 (c-add-stmt-syntax
10828 (if (string-equal (symbol-name containing-decl-kwd)
10829 "extern")
10830 ;; Special case for compatibility with the
10831 ;; extern-lang syntactic symbols.
10832 'inextern-lang
10833 (intern (concat "in"
10834 (symbol-name containing-decl-kwd))))
10835 nil t
10836 (c-most-enclosing-brace paren-state (point))
10837 paren-state))
10838 (c-add-class-syntax 'inclass
10839 containing-decl-open
10840 containing-decl-start
10841 containing-decl-kwd
10842 paren-state)))
10843 (when (and c-syntactic-indentation-in-macros
10844 macro-start
10845 (/= macro-start (c-point 'boi indent-point)))
10846 (c-add-syntax 'cpp-define-intro)
10847 (setq macro-start nil)))
10848
10849 ;; CASE 5K: we are at an ObjC method definition
10850 ;; continuation line.
10851 ((and c-opt-method-key
10852 (save-excursion
10853 (c-beginning-of-statement-1 lim)
10854 (beginning-of-line)
10855 (when (looking-at c-opt-method-key)
10856 (setq placeholder (point)))))
10857 (c-add-syntax 'objc-method-args-cont placeholder))
10858
10859 ;; CASE 5L: we are at the first argument of a template
10860 ;; arglist that begins on the previous line.
10861 ((and c-recognize-<>-arglists
10862 (eq (char-before) ?<)
10863 (not (and c-overloadable-operators-regexp
10864 (c-after-special-operator-id lim))))
10865 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10866 (c-add-syntax 'template-args-cont (c-point 'boi)))
10867
10868 ;; CASE 5Q: we are at a statement within a macro.
10869 (macro-start
10870 (c-beginning-of-statement-1 containing-sexp)
10871 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state))
10872
10873 ;;CASE 5N: We are at a topmost continuation line and the only
10874 ;;preceding items are annotations.
10875 ((and (c-major-mode-is 'java-mode)
10876 (setq placeholder (point))
10877 (c-beginning-of-statement-1)
10878 (progn
10879 (while (and (c-forward-annotation))
10880 (c-forward-syntactic-ws))
10881 t)
10882 (prog1
10883 (>= (point) placeholder)
10884 (goto-char placeholder)))
10885 (c-add-syntax 'annotation-top-cont (c-point 'boi)))
10886
10887 ;; CASE 5M: we are at a topmost continuation line
10888 (t
10889 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10890 (when (c-major-mode-is 'objc-mode)
10891 (setq placeholder (point))
10892 (while (and (c-forward-objc-directive)
10893 (< (point) indent-point))
10894 (c-forward-syntactic-ws)
10895 (setq placeholder (point)))
10896 (goto-char placeholder))
10897 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10898 ))
10899
10900 ;; (CASE 6 has been removed.)
10901
10902 ;; CASE 7: line is an expression, not a statement. Most
10903 ;; likely we are either in a function prototype or a function
10904 ;; call argument list
10905 ((not (or (and c-special-brace-lists
10906 (save-excursion
10907 (goto-char containing-sexp)
10908 (c-looking-at-special-brace-list)))
10909 (eq (char-after containing-sexp) ?{)))
10910 (cond
10911
10912 ;; CASE 7A: we are looking at the arglist closing paren.
10913 ;; C.f. case 7F.
10914 ((memq char-after-ip '(?\) ?\]))
10915 (goto-char containing-sexp)
10916 (setq placeholder (c-point 'boi))
10917 (if (and (c-safe (backward-up-list 1) t)
10918 (>= (point) placeholder))
10919 (progn
10920 (forward-char)
10921 (skip-chars-forward " \t"))
10922 (goto-char placeholder))
10923 (c-add-stmt-syntax 'arglist-close (list containing-sexp) t
10924 (c-most-enclosing-brace paren-state (point))
10925 paren-state))
10926
10927 ;; CASE 7B: Looking at the opening brace of an
10928 ;; in-expression block or brace list. C.f. cases 4, 16A
10929 ;; and 17E.
10930 ((and (eq char-after-ip ?{)
10931 (progn
10932 (setq placeholder (c-inside-bracelist-p (point)
10933 paren-state))
10934 (if placeholder
10935 (setq tmpsymbol '(brace-list-open . inexpr-class))
10936 (setq tmpsymbol '(block-open . inexpr-statement)
10937 placeholder
10938 (cdr-safe (c-looking-at-inexpr-block
10939 (c-safe-position containing-sexp
10940 paren-state)
10941 containing-sexp)))
10942 ;; placeholder is nil if it's a block directly in
10943 ;; a function arglist. That makes us skip out of
10944 ;; this case.
10945 )))
10946 (goto-char placeholder)
10947 (back-to-indentation)
10948 (c-add-stmt-syntax (car tmpsymbol) nil t
10949 (c-most-enclosing-brace paren-state (point))
10950 paren-state)
10951 (if (/= (point) placeholder)
10952 (c-add-syntax (cdr tmpsymbol))))
10953
10954 ;; CASE 7C: we are looking at the first argument in an empty
10955 ;; argument list. Use arglist-close if we're actually
10956 ;; looking at a close paren or bracket.
10957 ((memq char-before-ip '(?\( ?\[))
10958 (goto-char containing-sexp)
10959 (setq placeholder (c-point 'boi))
10960 (if (and (c-safe (backward-up-list 1) t)
10961 (>= (point) placeholder))
10962 (progn
10963 (forward-char)
10964 (skip-chars-forward " \t"))
10965 (goto-char placeholder))
10966 (c-add-stmt-syntax 'arglist-intro (list containing-sexp) t
10967 (c-most-enclosing-brace paren-state (point))
10968 paren-state))
10969
10970 ;; CASE 7D: we are inside a conditional test clause. treat
10971 ;; these things as statements
10972 ((progn
10973 (goto-char containing-sexp)
10974 (and (c-safe (c-forward-sexp -1) t)
10975 (looking-at "\\<for\\>[^_]")))
10976 (goto-char (1+ containing-sexp))
10977 (c-forward-syntactic-ws indent-point)
10978 (if (eq char-before-ip ?\;)
10979 (c-add-syntax 'statement (point))
10980 (c-add-syntax 'statement-cont (point))
10981 ))
10982
10983 ;; CASE 7E: maybe a continued ObjC method call. This is the
10984 ;; case when we are inside a [] bracketed exp, and what
10985 ;; precede the opening bracket is not an identifier.
10986 ((and c-opt-method-key
10987 (eq (char-after containing-sexp) ?\[)
10988 (progn
10989 (goto-char (1- containing-sexp))
10990 (c-backward-syntactic-ws (c-point 'bod))
10991 (if (not (looking-at c-symbol-key))
10992 (c-add-syntax 'objc-method-call-cont containing-sexp))
10993 )))
10994
10995 ;; CASE 7F: we are looking at an arglist continuation line,
10996 ;; but the preceding argument is on the same line as the
10997 ;; opening paren. This case includes multi-line
10998 ;; mathematical paren groupings, but we could be on a
10999 ;; for-list continuation line. C.f. case 7A.
11000 ((progn
11001 (goto-char (1+ containing-sexp))
11002 (< (save-excursion
11003 (c-forward-syntactic-ws)
11004 (point))
11005 (c-point 'bonl)))
11006 (goto-char containing-sexp) ; paren opening the arglist
11007 (setq placeholder (c-point 'boi))
11008 (if (and (c-safe (backward-up-list 1) t)
11009 (>= (point) placeholder))
11010 (progn
11011 (forward-char)
11012 (skip-chars-forward " \t"))
11013 (goto-char placeholder))
11014 (c-add-stmt-syntax 'arglist-cont-nonempty (list containing-sexp) t
11015 (c-most-enclosing-brace c-state-cache (point))
11016 paren-state))
11017
11018 ;; CASE 7G: we are looking at just a normal arglist
11019 ;; continuation line
11020 (t (c-forward-syntactic-ws indent-point)
11021 (c-add-syntax 'arglist-cont (c-point 'boi)))
11022 ))
11023
11024 ;; CASE 8: func-local multi-inheritance line
11025 ((and (c-major-mode-is 'c++-mode)
11026 (save-excursion
11027 (goto-char indent-point)
11028 (skip-chars-forward " \t")
11029 (looking-at c-opt-postfix-decl-spec-key)))
11030 (goto-char indent-point)
11031 (skip-chars-forward " \t")
11032 (cond
11033
11034 ;; CASE 8A: non-hanging colon on an inher intro
11035 ((eq char-after-ip ?:)
11036 (c-backward-syntactic-ws lim)
11037 (c-add-syntax 'inher-intro (c-point 'boi)))
11038
11039 ;; CASE 8B: hanging colon on an inher intro
11040 ((eq char-before-ip ?:)
11041 (c-add-syntax 'inher-intro (c-point 'boi)))
11042
11043 ;; CASE 8C: a continued inheritance line
11044 (t
11045 (c-beginning-of-inheritance-list lim)
11046 (c-add-syntax 'inher-cont (point))
11047 )))
11048
11049 ;; CASE 9: we are inside a brace-list
11050 ((and (not (c-major-mode-is 'awk-mode)) ; Maybe this isn't needed (ACM, 2002/3/29)
11051 (setq special-brace-list
11052 (or (and c-special-brace-lists ;;;; ALWAYS NIL FOR AWK!!
11053 (save-excursion
11054 (goto-char containing-sexp)
11055 (c-looking-at-special-brace-list)))
11056 (c-inside-bracelist-p containing-sexp paren-state))))
11057 (cond
11058
11059 ;; CASE 9A: In the middle of a special brace list opener.
11060 ((and (consp special-brace-list)
11061 (save-excursion
11062 (goto-char containing-sexp)
11063 (eq (char-after) ?\())
11064 (eq char-after-ip (car (cdr special-brace-list))))
11065 (goto-char (car (car special-brace-list)))
11066 (skip-chars-backward " \t")
11067 (if (and (bolp)
11068 (assoc 'statement-cont
11069 (setq placeholder (c-guess-basic-syntax))))
11070 (setq c-syntactic-context placeholder)
11071 (c-beginning-of-statement-1
11072 (c-safe-position (1- containing-sexp) paren-state))
11073 (c-forward-token-2 0)
11074 (while (cond
11075 ((looking-at c-specifier-key)
11076 (c-forward-keyword-clause 1))
11077 ((and c-opt-cpp-prefix
11078 (looking-at c-noise-macro-with-parens-name-re))
11079 (c-forward-noise-clause))))
11080 (c-add-syntax 'brace-list-open (c-point 'boi))))
11081
11082 ;; CASE 9B: brace-list-close brace
11083 ((if (consp special-brace-list)
11084 ;; Check special brace list closer.
11085 (progn
11086 (goto-char (car (car special-brace-list)))
11087 (save-excursion
11088 (goto-char indent-point)
11089 (back-to-indentation)
11090 (or
11091 ;; We were between the special close char and the `)'.
11092 (and (eq (char-after) ?\))
11093 (eq (1+ (point)) (cdr (car special-brace-list))))
11094 ;; We were before the special close char.
11095 (and (eq (char-after) (cdr (cdr special-brace-list)))
11096 (zerop (c-forward-token-2))
11097 (eq (1+ (point)) (cdr (car special-brace-list)))))))
11098 ;; Normal brace list check.
11099 (and (eq char-after-ip ?})
11100 (c-safe (goto-char (c-up-list-backward (point))) t)
11101 (= (point) containing-sexp)))
11102 (if (eq (point) (c-point 'boi))
11103 (c-add-syntax 'brace-list-close (point))
11104 (setq lim (c-most-enclosing-brace c-state-cache (point)))
11105 (c-beginning-of-statement-1 lim nil nil t)
11106 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state)))
11107
11108 (t
11109 ;; Prepare for the rest of the cases below by going to the
11110 ;; token following the opening brace
11111 (if (consp special-brace-list)
11112 (progn
11113 (goto-char (car (car special-brace-list)))
11114 (c-forward-token-2 1 nil indent-point))
11115 (goto-char containing-sexp))
11116 (forward-char)
11117 (let ((start (point)))
11118 (c-forward-syntactic-ws indent-point)
11119 (goto-char (max start (c-point 'bol))))
11120 (c-skip-ws-forward indent-point)
11121 (cond
11122
11123 ;; CASE 9C: we're looking at the first line in a brace-list
11124 ((= (point) indent-point)
11125 (if (consp special-brace-list)
11126 (goto-char (car (car special-brace-list)))
11127 (goto-char containing-sexp))
11128 (if (eq (point) (c-point 'boi))
11129 (c-add-syntax 'brace-list-intro (point))
11130 (setq lim (c-most-enclosing-brace c-state-cache (point)))
11131 (c-beginning-of-statement-1 lim)
11132 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state)))
11133
11134 ;; CASE 9D: this is just a later brace-list-entry or
11135 ;; brace-entry-open
11136 (t (if (or (eq char-after-ip ?{)
11137 (and c-special-brace-lists
11138 (save-excursion
11139 (goto-char indent-point)
11140 (c-forward-syntactic-ws (c-point 'eol))
11141 (c-looking-at-special-brace-list (point)))))
11142 (c-add-syntax 'brace-entry-open (point))
11143 (c-add-syntax 'brace-list-entry (point))
11144 ))
11145 ))))
11146
11147 ;; CASE 10: A continued statement or top level construct.
11148 ((and (not (memq char-before-ip '(?\; ?:)))
11149 (not (c-at-vsemi-p before-ws-ip))
11150 (or (not (eq char-before-ip ?}))
11151 (c-looking-at-inexpr-block-backward c-state-cache))
11152 (> (point)
11153 (save-excursion
11154 (c-beginning-of-statement-1 containing-sexp)
11155 (setq placeholder (point))))
11156 (/= placeholder containing-sexp))
11157 ;; This is shared with case 18.
11158 (c-guess-continued-construct indent-point
11159 char-after-ip
11160 placeholder
11161 containing-sexp
11162 paren-state))
11163
11164 ;; CASE 16: block close brace, possibly closing the defun or
11165 ;; the class
11166 ((eq char-after-ip ?})
11167 ;; From here on we have the next containing sexp in lim.
11168 (setq lim (c-most-enclosing-brace paren-state))
11169 (goto-char containing-sexp)
11170 (cond
11171
11172 ;; CASE 16E: Closing a statement block? This catches
11173 ;; cases where it's preceded by a statement keyword,
11174 ;; which works even when used in an "invalid" context,
11175 ;; e.g. a macro argument.
11176 ((c-after-conditional)
11177 (c-backward-to-block-anchor lim)
11178 (c-add-stmt-syntax 'block-close nil t lim paren-state))
11179
11180 ;; CASE 16A: closing a lambda defun or an in-expression
11181 ;; block? C.f. cases 4, 7B and 17E.
11182 ((setq placeholder (c-looking-at-inexpr-block
11183 (c-safe-position containing-sexp paren-state)
11184 nil))
11185 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
11186 'inline-close
11187 'block-close))
11188 (goto-char containing-sexp)
11189 (back-to-indentation)
11190 (if (= containing-sexp (point))
11191 (c-add-syntax tmpsymbol (point))
11192 (goto-char (cdr placeholder))
11193 (back-to-indentation)
11194 (c-add-stmt-syntax tmpsymbol nil t
11195 (c-most-enclosing-brace paren-state (point))
11196 paren-state)
11197 (if (/= (point) (cdr placeholder))
11198 (c-add-syntax (car placeholder)))))
11199
11200 ;; CASE 16B: does this close an inline or a function in
11201 ;; a non-class declaration level block?
11202 ((save-excursion
11203 (and lim
11204 (progn
11205 (goto-char lim)
11206 (c-looking-at-decl-block
11207 (c-most-enclosing-brace paren-state lim)
11208 nil))
11209 (setq placeholder (point))))
11210 (c-backward-to-decl-anchor lim)
11211 (back-to-indentation)
11212 (if (save-excursion
11213 (goto-char placeholder)
11214 (looking-at c-other-decl-block-key))
11215 (c-add-syntax 'defun-close (point))
11216 (c-add-syntax 'inline-close (point))))
11217
11218 ;; CASE 16F: Can be a defun-close of a function declared
11219 ;; in a statement block, e.g. in Pike or when using gcc
11220 ;; extensions, but watch out for macros followed by
11221 ;; blocks. Let it through to be handled below.
11222 ;; C.f. cases B.3 and 17G.
11223 ((save-excursion
11224 (and (not (c-at-statement-start-p))
11225 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
11226 (setq placeholder (point))
11227 (let ((c-recognize-typeless-decls nil))
11228 ;; Turn off recognition of constructs that
11229 ;; lacks a type in this case, since that's more
11230 ;; likely to be a macro followed by a block.
11231 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
11232 (back-to-indentation)
11233 (if (/= (point) containing-sexp)
11234 (goto-char placeholder))
11235 (c-add-stmt-syntax 'defun-close nil t lim paren-state))
11236
11237 ;; CASE 16C: If there is an enclosing brace then this is
11238 ;; a block close since defun closes inside declaration
11239 ;; level blocks have been handled above.
11240 (lim
11241 ;; If the block is preceded by a case/switch label on
11242 ;; the same line, we anchor at the first preceding label
11243 ;; at boi. The default handling in c-add-stmt-syntax
11244 ;; really fixes it better, but we do like this to keep
11245 ;; the indentation compatible with version 5.28 and
11246 ;; earlier. C.f. case 17H.
11247 (while (and (/= (setq placeholder (point)) (c-point 'boi))
11248 (eq (c-beginning-of-statement-1 lim) 'label)))
11249 (goto-char placeholder)
11250 (if (looking-at c-label-kwds-regexp)
11251 (c-add-syntax 'block-close (point))
11252 (goto-char containing-sexp)
11253 ;; c-backward-to-block-anchor not necessary here; those
11254 ;; situations are handled in case 16E above.
11255 (c-add-stmt-syntax 'block-close nil t lim paren-state)))
11256
11257 ;; CASE 16D: Only top level defun close left.
11258 (t
11259 (goto-char containing-sexp)
11260 (c-backward-to-decl-anchor lim)
11261 (c-add-stmt-syntax 'defun-close nil nil
11262 (c-most-enclosing-brace paren-state)
11263 paren-state))
11264 ))
11265
11266 ;; CASE 19: line is an expression, not a statement, and is directly
11267 ;; contained by a template delimiter. Most likely, we are in a
11268 ;; template arglist within a statement. This case is based on CASE
11269 ;; 7. At some point in the future, we may wish to create more
11270 ;; syntactic symbols such as `template-intro',
11271 ;; `template-cont-nonempty', etc., and distinguish between them as we
11272 ;; do for `arglist-intro' etc. (2009-12-07).
11273 ((and c-recognize-<>-arglists
11274 (setq containing-< (c-up-list-backward indent-point containing-sexp))
11275 (eq (char-after containing-<) ?\<))
11276 (setq placeholder (c-point 'boi containing-<))
11277 (goto-char containing-sexp) ; Most nested Lbrace/Lparen (but not
11278 ; '<') before indent-point.
11279 (if (>= (point) placeholder)
11280 (progn
11281 (forward-char)
11282 (skip-chars-forward " \t"))
11283 (goto-char placeholder))
11284 (c-add-stmt-syntax 'template-args-cont (list containing-<) t
11285 (c-most-enclosing-brace c-state-cache (point))
11286 paren-state))
11287
11288 ;; CASE 17: Statement or defun catchall.
11289 (t
11290 (goto-char indent-point)
11291 ;; Back up statements until we find one that starts at boi.
11292 (while (let* ((prev-point (point))
11293 (last-step-type (c-beginning-of-statement-1
11294 containing-sexp)))
11295 (if (= (point) prev-point)
11296 (progn
11297 (setq step-type (or step-type last-step-type))
11298 nil)
11299 (setq step-type last-step-type)
11300 (/= (point) (c-point 'boi)))))
11301 (cond
11302
11303 ;; CASE 17B: continued statement
11304 ((and (eq step-type 'same)
11305 (/= (point) indent-point))
11306 (c-add-stmt-syntax 'statement-cont nil nil
11307 containing-sexp paren-state))
11308
11309 ;; CASE 17A: After a case/default label?
11310 ((progn
11311 (while (and (eq step-type 'label)
11312 (not (looking-at c-label-kwds-regexp)))
11313 (setq step-type
11314 (c-beginning-of-statement-1 containing-sexp)))
11315 (eq step-type 'label))
11316 (c-add-stmt-syntax (if (eq char-after-ip ?{)
11317 'statement-case-open
11318 'statement-case-intro)
11319 nil t containing-sexp paren-state))
11320
11321 ;; CASE 17D: any old statement
11322 ((progn
11323 (while (eq step-type 'label)
11324 (setq step-type
11325 (c-beginning-of-statement-1 containing-sexp)))
11326 (eq step-type 'previous))
11327 (c-add-stmt-syntax 'statement nil t
11328 containing-sexp paren-state)
11329 (if (eq char-after-ip ?{)
11330 (c-add-syntax 'block-open)))
11331
11332 ;; CASE 17I: Inside a substatement block.
11333 ((progn
11334 ;; The following tests are all based on containing-sexp.
11335 (goto-char containing-sexp)
11336 ;; From here on we have the next containing sexp in lim.
11337 (setq lim (c-most-enclosing-brace paren-state containing-sexp))
11338 (c-after-conditional))
11339 (c-backward-to-block-anchor lim)
11340 (c-add-stmt-syntax 'statement-block-intro nil t
11341 lim paren-state)
11342 (if (eq char-after-ip ?{)
11343 (c-add-syntax 'block-open)))
11344
11345 ;; CASE 17E: first statement in an in-expression block.
11346 ;; C.f. cases 4, 7B and 16A.
11347 ((setq placeholder (c-looking-at-inexpr-block
11348 (c-safe-position containing-sexp paren-state)
11349 nil))
11350 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
11351 'defun-block-intro
11352 'statement-block-intro))
11353 (back-to-indentation)
11354 (if (= containing-sexp (point))
11355 (c-add-syntax tmpsymbol (point))
11356 (goto-char (cdr placeholder))
11357 (back-to-indentation)
11358 (c-add-stmt-syntax tmpsymbol nil t
11359 (c-most-enclosing-brace c-state-cache (point))
11360 paren-state)
11361 (if (/= (point) (cdr placeholder))
11362 (c-add-syntax (car placeholder))))
11363 (if (eq char-after-ip ?{)
11364 (c-add-syntax 'block-open)))
11365
11366 ;; CASE 17F: first statement in an inline, or first
11367 ;; statement in a top-level defun. we can tell this is it
11368 ;; if there are no enclosing braces that haven't been
11369 ;; narrowed out by a class (i.e. don't use bod here).
11370 ((save-excursion
11371 (or (not (setq placeholder (c-most-enclosing-brace
11372 paren-state)))
11373 (and (progn
11374 (goto-char placeholder)
11375 (eq (char-after) ?{))
11376 (c-looking-at-decl-block (c-most-enclosing-brace
11377 paren-state (point))
11378 nil))))
11379 (c-backward-to-decl-anchor lim)
11380 (back-to-indentation)
11381 (c-add-syntax 'defun-block-intro (point)))
11382
11383 ;; CASE 17G: First statement in a function declared inside
11384 ;; a normal block. This can occur in Pike and with
11385 ;; e.g. the gcc extensions, but watch out for macros
11386 ;; followed by blocks. C.f. cases B.3 and 16F.
11387 ((save-excursion
11388 (and (not (c-at-statement-start-p))
11389 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
11390 (setq placeholder (point))
11391 (let ((c-recognize-typeless-decls nil))
11392 ;; Turn off recognition of constructs that lacks
11393 ;; a type in this case, since that's more likely
11394 ;; to be a macro followed by a block.
11395 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
11396 (back-to-indentation)
11397 (if (/= (point) containing-sexp)
11398 (goto-char placeholder))
11399 (c-add-stmt-syntax 'defun-block-intro nil t
11400 lim paren-state))
11401
11402 ;; CASE 17H: First statement in a block.
11403 (t
11404 ;; If the block is preceded by a case/switch label on the
11405 ;; same line, we anchor at the first preceding label at
11406 ;; boi. The default handling in c-add-stmt-syntax is
11407 ;; really fixes it better, but we do like this to keep the
11408 ;; indentation compatible with version 5.28 and earlier.
11409 ;; C.f. case 16C.
11410 (while (and (/= (setq placeholder (point)) (c-point 'boi))
11411 (eq (c-beginning-of-statement-1 lim) 'label)))
11412 (goto-char placeholder)
11413 (if (looking-at c-label-kwds-regexp)
11414 (c-add-syntax 'statement-block-intro (point))
11415 (goto-char containing-sexp)
11416 ;; c-backward-to-block-anchor not necessary here; those
11417 ;; situations are handled in case 17I above.
11418 (c-add-stmt-syntax 'statement-block-intro nil t
11419 lim paren-state))
11420 (if (eq char-after-ip ?{)
11421 (c-add-syntax 'block-open)))
11422 ))
11423 )
11424
11425 ;; now we need to look at any modifiers
11426 (goto-char indent-point)
11427 (skip-chars-forward " \t")
11428
11429 ;; are we looking at a comment only line?
11430 (when (and (looking-at c-comment-start-regexp)
11431 (/= (c-forward-token-2 0 nil (c-point 'eol)) 0))
11432 (c-append-syntax 'comment-intro))
11433
11434 ;; we might want to give additional offset to friends (in C++).
11435 (when (and c-opt-friend-key
11436 (looking-at c-opt-friend-key))
11437 (c-append-syntax 'friend))
11438
11439 ;; Set syntactic-relpos.
11440 (let ((p c-syntactic-context))
11441 (while (and p
11442 (if (integerp (c-langelem-pos (car p)))
11443 (progn
11444 (setq syntactic-relpos (c-langelem-pos (car p)))
11445 nil)
11446 t))
11447 (setq p (cdr p))))
11448
11449 ;; Start of or a continuation of a preprocessor directive?
11450 (if (and macro-start
11451 (eq macro-start (c-point 'boi))
11452 (not (and (c-major-mode-is 'pike-mode)
11453 (eq (char-after (1+ macro-start)) ?\"))))
11454 (c-append-syntax 'cpp-macro)
11455 (when (and c-syntactic-indentation-in-macros macro-start)
11456 (if in-macro-expr
11457 (when (or
11458 (< syntactic-relpos macro-start)
11459 (not (or
11460 (assq 'arglist-intro c-syntactic-context)
11461 (assq 'arglist-cont c-syntactic-context)
11462 (assq 'arglist-cont-nonempty c-syntactic-context)
11463 (assq 'arglist-close c-syntactic-context))))
11464 ;; If inside a cpp expression, i.e. anywhere in a
11465 ;; cpp directive except a #define body, we only let
11466 ;; through the syntactic analysis that is internal
11467 ;; in the expression. That means the arglist
11468 ;; elements, if they are anchored inside the cpp
11469 ;; expression.
11470 (setq c-syntactic-context nil)
11471 (c-add-syntax 'cpp-macro-cont macro-start))
11472 (when (and (eq macro-start syntactic-relpos)
11473 (not (assq 'cpp-define-intro c-syntactic-context))
11474 (save-excursion
11475 (goto-char macro-start)
11476 (or (not (c-forward-to-cpp-define-body))
11477 (<= (point) (c-point 'boi indent-point)))))
11478 ;; Inside a #define body and the syntactic analysis is
11479 ;; anchored on the start of the #define. In this case
11480 ;; we add cpp-define-intro to get the extra
11481 ;; indentation of the #define body.
11482 (c-add-syntax 'cpp-define-intro)))))
11483
11484 ;; return the syntax
11485 c-syntactic-context)))
11486
11487 \f
11488 ;; Indentation calculation.
11489
11490 (defun c-evaluate-offset (offset langelem symbol)
11491 ;; offset can be a number, a function, a variable, a list, or one of
11492 ;; the symbols + or -
11493 ;;
11494 ;; This function might do hidden buffer changes.
11495 (let ((res
11496 (cond
11497 ((numberp offset) offset)
11498 ((vectorp offset) offset)
11499 ((null offset) nil)
11500
11501 ((eq offset '+) c-basic-offset)
11502 ((eq offset '-) (- c-basic-offset))
11503 ((eq offset '++) (* 2 c-basic-offset))
11504 ((eq offset '--) (* 2 (- c-basic-offset)))
11505 ((eq offset '*) (/ c-basic-offset 2))
11506 ((eq offset '/) (/ (- c-basic-offset) 2))
11507
11508 ((functionp offset)
11509 (c-evaluate-offset
11510 (funcall offset
11511 (cons (c-langelem-sym langelem)
11512 (c-langelem-pos langelem)))
11513 langelem symbol))
11514
11515 ((listp offset)
11516 (cond
11517 ((eq (car offset) 'quote)
11518 (c-benign-error "The offset %S for %s was mistakenly quoted"
11519 offset symbol)
11520 nil)
11521
11522 ((memq (car offset) '(min max))
11523 (let (res val (method (car offset)))
11524 (setq offset (cdr offset))
11525 (while offset
11526 (setq val (c-evaluate-offset (car offset) langelem symbol))
11527 (cond
11528 ((not val))
11529 ((not res)
11530 (setq res val))
11531 ((integerp val)
11532 (if (vectorp res)
11533 (c-benign-error "\
11534 Error evaluating offset %S for %s: \
11535 Cannot combine absolute offset %S with relative %S in `%s' method"
11536 (car offset) symbol res val method)
11537 (setq res (funcall method res val))))
11538 (t
11539 (if (integerp res)
11540 (c-benign-error "\
11541 Error evaluating offset %S for %s: \
11542 Cannot combine relative offset %S with absolute %S in `%s' method"
11543 (car offset) symbol res val method)
11544 (setq res (vector (funcall method (aref res 0)
11545 (aref val 0)))))))
11546 (setq offset (cdr offset)))
11547 res))
11548
11549 ((eq (car offset) 'add)
11550 (let (res val)
11551 (setq offset (cdr offset))
11552 (while offset
11553 (setq val (c-evaluate-offset (car offset) langelem symbol))
11554 (cond
11555 ((not val))
11556 ((not res)
11557 (setq res val))
11558 ((integerp val)
11559 (if (vectorp res)
11560 (setq res (vector (+ (aref res 0) val)))
11561 (setq res (+ res val))))
11562 (t
11563 (if (vectorp res)
11564 (c-benign-error "\
11565 Error evaluating offset %S for %s: \
11566 Cannot combine absolute offsets %S and %S in `add' method"
11567 (car offset) symbol res val)
11568 (setq res val)))) ; Override.
11569 (setq offset (cdr offset)))
11570 res))
11571
11572 (t
11573 (let (res)
11574 (when (eq (car offset) 'first)
11575 (setq offset (cdr offset)))
11576 (while (and (not res) offset)
11577 (setq res (c-evaluate-offset (car offset) langelem symbol)
11578 offset (cdr offset)))
11579 res))))
11580
11581 ((and (symbolp offset) (boundp offset))
11582 (symbol-value offset))
11583
11584 (t
11585 (c-benign-error "Unknown offset format %S for %s" offset symbol)
11586 nil))))
11587
11588 (if (or (null res) (integerp res)
11589 (and (vectorp res) (= (length res) 1) (integerp (aref res 0))))
11590 res
11591 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
11592 offset symbol res)
11593 nil)))
11594
11595 (defun c-calc-offset (langelem)
11596 ;; Get offset from LANGELEM which is a list beginning with the
11597 ;; syntactic symbol and followed by any analysis data it provides.
11598 ;; That data may be zero or more elements, but if at least one is
11599 ;; given then the first is the anchor position (or nil). The symbol
11600 ;; is matched against `c-offsets-alist' and the offset calculated
11601 ;; from that is returned.
11602 ;;
11603 ;; This function might do hidden buffer changes.
11604 (let* ((symbol (c-langelem-sym langelem))
11605 (match (assq symbol c-offsets-alist))
11606 (offset (cdr-safe match)))
11607 (if match
11608 (setq offset (c-evaluate-offset offset langelem symbol))
11609 (if c-strict-syntax-p
11610 (c-benign-error "No offset found for syntactic symbol %s" symbol))
11611 (setq offset 0))
11612 (if (vectorp offset)
11613 offset
11614 (or (and (numberp offset) offset)
11615 (and (symbolp offset) (symbol-value offset))
11616 0))
11617 ))
11618
11619 (defun c-get-offset (langelem)
11620 ;; This is a compatibility wrapper for `c-calc-offset' in case
11621 ;; someone is calling it directly. It takes an old style syntactic
11622 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
11623 ;; new list form.
11624 ;;
11625 ;; This function might do hidden buffer changes.
11626 (if (c-langelem-pos langelem)
11627 (c-calc-offset (list (c-langelem-sym langelem)
11628 (c-langelem-pos langelem)))
11629 (c-calc-offset langelem)))
11630
11631 (defun c-get-syntactic-indentation (langelems)
11632 ;; Calculate the syntactic indentation from a syntactic description
11633 ;; as returned by `c-guess-syntax'.
11634 ;;
11635 ;; Note that topmost-intro always has an anchor position at bol, for
11636 ;; historical reasons. It's often used together with other symbols
11637 ;; that has more sane positions. Since we always use the first
11638 ;; found anchor position, we rely on that these other symbols always
11639 ;; precede topmost-intro in the LANGELEMS list.
11640 ;;
11641 ;; This function might do hidden buffer changes.
11642 (let ((indent 0) anchor)
11643
11644 (while langelems
11645 (let* ((c-syntactic-element (car langelems))
11646 (res (c-calc-offset c-syntactic-element)))
11647
11648 (if (vectorp res)
11649 ;; Got an absolute column that overrides any indentation
11650 ;; we've collected so far, but not the relative
11651 ;; indentation we might get for the nested structures
11652 ;; further down the langelems list.
11653 (setq indent (elt res 0)
11654 anchor (point-min)) ; A position at column 0.
11655
11656 ;; Got a relative change of the current calculated
11657 ;; indentation.
11658 (setq indent (+ indent res))
11659
11660 ;; Use the anchor position from the first syntactic
11661 ;; element with one.
11662 (unless anchor
11663 (setq anchor (c-langelem-pos (car langelems)))))
11664
11665 (setq langelems (cdr langelems))))
11666
11667 (if anchor
11668 (+ indent (save-excursion
11669 (goto-char anchor)
11670 (current-column)))
11671 indent)))
11672
11673 \f
11674 (cc-provide 'cc-engine)
11675
11676 ;; Local Variables:
11677 ;; indent-tabs-mode: t
11678 ;; tab-width: 8
11679 ;; End:
11680 ;;; cc-engine.el ends here