]> code.delx.au - gnu-emacs/blob - lisp/progmodes/cc-engine.el
Merge from origin/emacs-25
[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-syntactic-content (from to paren-level)
389 ;; Return the given region as a string where all syntactic
390 ;; whitespace is removed or, where necessary, replaced with a single
391 ;; space. If PAREN-LEVEL is given then all parens in the region are
392 ;; collapsed to "()", "[]" etc.
393 ;;
394 ;; This function might do hidden buffer changes.
395
396 (save-excursion
397 (save-restriction
398 (narrow-to-region from to)
399 (goto-char from)
400 (let* ((parts (list nil)) (tail parts) pos in-paren)
401
402 (while (re-search-forward c-syntactic-ws-start to t)
403 (goto-char (setq pos (match-beginning 0)))
404 (c-forward-syntactic-ws)
405 (if (= (point) pos)
406 (forward-char)
407
408 (when paren-level
409 (save-excursion
410 (setq in-paren (= (car (parse-partial-sexp from pos 1)) 1)
411 pos (point))))
412
413 (if (and (> pos from)
414 (< (point) to)
415 (looking-at "\\w\\|\\s_")
416 (save-excursion
417 (goto-char (1- pos))
418 (looking-at "\\w\\|\\s_")))
419 (progn
420 (setcdr tail (list (buffer-substring-no-properties from pos)
421 " "))
422 (setq tail (cddr tail)))
423 (setcdr tail (list (buffer-substring-no-properties from pos)))
424 (setq tail (cdr tail)))
425
426 (when in-paren
427 (when (= (car (parse-partial-sexp pos to -1)) -1)
428 (setcdr tail (list (buffer-substring-no-properties
429 (1- (point)) (point))))
430 (setq tail (cdr tail))))
431
432 (setq from (point))))
433
434 (setcdr tail (list (buffer-substring-no-properties from to)))
435 (apply 'concat (cdr parts))))))
436
437 (defun c-shift-line-indentation (shift-amt)
438 ;; Shift the indentation of the current line with the specified
439 ;; amount (positive inwards). The buffer is modified only if
440 ;; SHIFT-AMT isn't equal to zero.
441 (let ((pos (- (point-max) (point)))
442 (c-macro-start c-macro-start)
443 tmp-char-inserted)
444 (if (zerop shift-amt)
445 nil
446 ;; If we're on an empty line inside a macro, we take the point
447 ;; to be at the current indentation and shift it to the
448 ;; appropriate column. This way we don't treat the extra
449 ;; whitespace out to the line continuation as indentation.
450 (when (and (c-query-and-set-macro-start)
451 (looking-at "[ \t]*\\\\$")
452 (save-excursion
453 (skip-chars-backward " \t")
454 (bolp)))
455 (insert ?x)
456 (backward-char)
457 (setq tmp-char-inserted t))
458 (unwind-protect
459 (let ((col (current-indentation)))
460 (delete-region (c-point 'bol) (c-point 'boi))
461 (beginning-of-line)
462 (indent-to (+ col shift-amt)))
463 (when tmp-char-inserted
464 (delete-char 1))))
465 ;; If initial point was within line's indentation and we're not on
466 ;; a line with a line continuation in a macro, position after the
467 ;; indentation. Else stay at same point in text.
468 (if (and (< (point) (c-point 'boi))
469 (not tmp-char-inserted))
470 (back-to-indentation)
471 (if (> (- (point-max) pos) (point))
472 (goto-char (- (point-max) pos))))))
473
474 (defsubst c-keyword-sym (keyword)
475 ;; Return non-nil if the string KEYWORD is a known keyword. More
476 ;; precisely, the value is the symbol for the keyword in
477 ;; `c-keywords-obarray'.
478 (intern-soft keyword c-keywords-obarray))
479
480 (defsubst c-keyword-member (keyword-sym lang-constant)
481 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
482 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
483 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
484 ;; nil then the result is nil.
485 (get keyword-sym lang-constant))
486
487 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
488 (defconst c-string-syntax (if (memq 'gen-string-delim c-emacs-features)
489 "\"|"
490 "\""))
491
492 ;; Regexp matching string limit syntax.
493 (defconst c-string-limit-regexp (if (memq 'gen-string-delim c-emacs-features)
494 "\\s\"\\|\\s|"
495 "\\s\""))
496
497 ;; Regexp matching WS followed by string limit syntax.
498 (defconst c-ws*-string-limit-regexp
499 (concat "[ \t]*\\(" c-string-limit-regexp "\\)"))
500
501 ;; Holds formatted error strings for the few cases where parse errors
502 ;; are reported.
503 (defvar c-parsing-error nil)
504 (make-variable-buffer-local 'c-parsing-error)
505
506 (defun c-echo-parsing-error (&optional quiet)
507 (when (and c-report-syntactic-errors c-parsing-error (not quiet))
508 (c-benign-error "%s" c-parsing-error))
509 c-parsing-error)
510
511 ;; Faces given to comments and string literals. This is used in some
512 ;; situations to speed up recognition; it isn't mandatory that font
513 ;; locking is in use. This variable is extended with the face in
514 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
515 (defvar c-literal-faces
516 (append '(font-lock-comment-face font-lock-string-face)
517 (when (facep 'font-lock-comment-delimiter-face)
518 ;; New in Emacs 22.
519 '(font-lock-comment-delimiter-face))))
520
521 (defsubst c-put-c-type-property (pos value)
522 ;; Put a c-type property with the given value at POS.
523 (c-put-char-property pos 'c-type value))
524
525 (defun c-clear-c-type-property (from to value)
526 ;; Remove all occurrences of the c-type property that has the given
527 ;; value in the region between FROM and TO. VALUE is assumed to not
528 ;; be nil.
529 ;;
530 ;; Note: This assumes that c-type is put on single chars only; it's
531 ;; very inefficient if matching properties cover large regions.
532 (save-excursion
533 (goto-char from)
534 (while (progn
535 (when (eq (get-text-property (point) 'c-type) value)
536 (c-clear-char-property (point) 'c-type))
537 (goto-char (c-next-single-property-change (point) 'c-type nil to))
538 (< (point) to)))))
539
540 \f
541 ;; Some debug tools to visualize various special positions. This
542 ;; debug code isn't as portable as the rest of CC Mode.
543
544 (cc-bytecomp-defun overlays-in)
545 (cc-bytecomp-defun overlay-get)
546 (cc-bytecomp-defun overlay-start)
547 (cc-bytecomp-defun overlay-end)
548 (cc-bytecomp-defun delete-overlay)
549 (cc-bytecomp-defun overlay-put)
550 (cc-bytecomp-defun make-overlay)
551
552 (defun c-debug-add-face (beg end face)
553 (c-save-buffer-state ((overlays (overlays-in beg end)) overlay)
554 (while overlays
555 (setq overlay (car overlays)
556 overlays (cdr overlays))
557 (when (eq (overlay-get overlay 'face) face)
558 (setq beg (min beg (overlay-start overlay))
559 end (max end (overlay-end overlay)))
560 (delete-overlay overlay)))
561 (overlay-put (make-overlay beg end) 'face face)))
562
563 (defun c-debug-remove-face (beg end face)
564 (c-save-buffer-state ((overlays (overlays-in beg end)) overlay
565 (ol-beg beg) (ol-end end))
566 (while overlays
567 (setq overlay (car overlays)
568 overlays (cdr overlays))
569 (when (eq (overlay-get overlay 'face) face)
570 (setq ol-beg (min ol-beg (overlay-start overlay))
571 ol-end (max ol-end (overlay-end overlay)))
572 (delete-overlay overlay)))
573 (when (< ol-beg beg)
574 (overlay-put (make-overlay ol-beg beg) 'face face))
575 (when (> ol-end end)
576 (overlay-put (make-overlay end ol-end) 'face face))))
577
578 \f
579 ;; `c-beginning-of-statement-1' and accompanying stuff.
580
581 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
582 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
583 ;; better way should be implemented, but this will at least shut up
584 ;; the byte compiler.
585 (defvar c-maybe-labelp)
586
587 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
588
589 ;; Macros used internally in c-beginning-of-statement-1 for the
590 ;; automaton actions.
591 (defmacro c-bos-push-state ()
592 '(setq stack (cons (cons state saved-pos)
593 stack)))
594 (defmacro c-bos-pop-state (&optional do-if-done)
595 `(if (setq state (car (car stack))
596 saved-pos (cdr (car stack))
597 stack (cdr stack))
598 t
599 ,do-if-done
600 (throw 'loop nil)))
601 (defmacro c-bos-pop-state-and-retry ()
602 '(throw 'loop (setq state (car (car stack))
603 saved-pos (cdr (car stack))
604 ;; Throw nil if stack is empty, else throw non-nil.
605 stack (cdr stack))))
606 (defmacro c-bos-save-pos ()
607 '(setq saved-pos (vector pos tok ptok pptok)))
608 (defmacro c-bos-restore-pos ()
609 '(unless (eq (elt saved-pos 0) start)
610 (setq pos (elt saved-pos 0)
611 tok (elt saved-pos 1)
612 ptok (elt saved-pos 2)
613 pptok (elt saved-pos 3))
614 (goto-char pos)
615 (setq sym nil)))
616 (defmacro c-bos-save-error-info (missing got)
617 `(setq saved-pos (vector pos ,missing ,got)))
618 (defmacro c-bos-report-error ()
619 '(unless noerror
620 (setq c-parsing-error
621 (format-message
622 "No matching `%s' found for `%s' on line %d"
623 (elt saved-pos 1)
624 (elt saved-pos 2)
625 (1+ (count-lines (point-min)
626 (c-point 'bol (elt saved-pos 0))))))))
627
628 (defun c-beginning-of-statement-1 (&optional lim ignore-labels
629 noerror comma-delim)
630 "Move to the start of the current statement or declaration, or to
631 the previous one if already at the beginning of one. Only
632 statements/declarations on the same level are considered, i.e. don't
633 move into or out of sexps (not even normal expression parentheses).
634
635 If point is already at the earliest statement within braces or parens,
636 this function doesn't move back into any whitespace preceding it; it
637 returns `same' in this case.
638
639 Stop at statement continuation tokens like \"else\", \"catch\",
640 \"finally\" and the \"while\" in \"do ... while\" if the start point
641 is within the continuation. If starting at such a token, move to the
642 corresponding statement start. If at the beginning of a statement,
643 move to the closest containing statement if there is any. This might
644 also stop at a continuation clause.
645
646 Labels are treated as part of the following statements if
647 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
648 statement start keyword.) Otherwise, each label is treated as a
649 separate statement.
650
651 Macros are ignored \(i.e. skipped over) unless point is within one, in
652 which case the content of the macro is treated as normal code. Aside
653 from any normal statement starts found in it, stop at the first token
654 of the content in the macro, i.e. the expression of an \"#if\" or the
655 start of the definition in a \"#define\". Also stop at start of
656 macros before leaving them.
657
658 Return:
659 `label' if stopped at a label or \"case...:\" or \"default:\";
660 `same' if stopped at the beginning of the current statement;
661 `up' if stepped to a containing statement;
662 `previous' if stepped to a preceding statement;
663 `beginning' if stepped from a statement continuation clause to
664 its start clause; or
665 `macro' if stepped to a macro start.
666 Note that `same' and not `label' is returned if stopped at the same
667 label without crossing the colon character.
668
669 LIM may be given to limit the search. If the search hits the limit,
670 point will be left at the closest following token, or at the start
671 position if that is less (`same' is returned in this case).
672
673 NOERROR turns off error logging to `c-parsing-error'.
674
675 Normally only `;' and virtual semicolons are considered to delimit
676 statements, but if COMMA-DELIM is non-nil then `,' is treated
677 as a delimiter too.
678
679 Note that this function might do hidden buffer changes. See the
680 comment at the start of cc-engine.el for more info."
681
682 ;; The bulk of this function is a pushdown automaton that looks at statement
683 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
684 ;; purpose is to keep track of nested statements, ensuring that such
685 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
686 ;; does with nested braces/brackets/parentheses).
687 ;;
688 ;; Note: The position of a boundary is the following token.
689 ;;
690 ;; Beginning with the current token (the one following point), move back one
691 ;; sexp at a time (where a sexp is, more or less, either a token or the
692 ;; entire contents of a brace/bracket/paren pair). Each time a statement
693 ;; boundary is crossed or a "while"-like token is found, update the state of
694 ;; the PDA. Stop at the beginning of a statement when the stack (holding
695 ;; nested statement info) is empty and the position has been moved.
696 ;;
697 ;; The following variables constitute the PDA:
698 ;;
699 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
700 ;; scanned back over, 'boundary if we've just gone back over a
701 ;; statement boundary, or nil otherwise.
702 ;; state: takes one of the values (nil else else-boundary while
703 ;; while-boundary catch catch-boundary).
704 ;; nil means "no "while"-like token yet scanned".
705 ;; 'else, for example, means "just gone back over an else".
706 ;; 'else-boundary means "just gone back over a statement boundary
707 ;; immediately after having gone back over an else".
708 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
709 ;; of error reporting information.
710 ;; stack: The stack onto which the PDA pushes its state. Each entry
711 ;; consists of a saved value of state and saved-pos. An entry is
712 ;; pushed when we move back over a "continuation" token (e.g. else)
713 ;; and popped when we encounter the corresponding opening token
714 ;; (e.g. if).
715 ;;
716 ;;
717 ;; The following diagram briefly outlines the PDA.
718 ;;
719 ;; Common state:
720 ;; "else": Push state, goto state `else'.
721 ;; "while": Push state, goto state `while'.
722 ;; "catch" or "finally": Push state, goto state `catch'.
723 ;; boundary: Pop state.
724 ;; other: Do nothing special.
725 ;;
726 ;; State `else':
727 ;; boundary: Goto state `else-boundary'.
728 ;; other: Error, pop state, retry token.
729 ;;
730 ;; State `else-boundary':
731 ;; "if": Pop state.
732 ;; boundary: Error, pop state.
733 ;; other: See common state.
734 ;;
735 ;; State `while':
736 ;; boundary: Save position, goto state `while-boundary'.
737 ;; other: Pop state, retry token.
738 ;;
739 ;; State `while-boundary':
740 ;; "do": Pop state.
741 ;; boundary: Restore position if it's not at start, pop state. [*see below]
742 ;; other: See common state.
743 ;;
744 ;; State `catch':
745 ;; boundary: Goto state `catch-boundary'.
746 ;; other: Error, pop state, retry token.
747 ;;
748 ;; State `catch-boundary':
749 ;; "try": Pop state.
750 ;; "catch": Goto state `catch'.
751 ;; boundary: Error, pop state.
752 ;; other: See common state.
753 ;;
754 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
755 ;; searching for a "do" which would have opened a do-while. If we didn't
756 ;; find it, we discard the analysis done since the "while", go back to this
757 ;; token in the buffer and restart the scanning there, this time WITHOUT
758 ;; pushing the 'while state onto the stack.
759 ;;
760 ;; In addition to the above there is some special handling of labels
761 ;; and macros.
762
763 (let ((case-fold-search nil)
764 (start (point))
765 macro-start
766 (delims (if comma-delim '(?\; ?,) '(?\;)))
767 (c-stmt-delim-chars (if comma-delim
768 c-stmt-delim-chars-with-comma
769 c-stmt-delim-chars))
770 c-in-literal-cache c-maybe-labelp after-case:-pos saved
771 ;; Current position.
772 pos
773 ;; Position of last stmt boundary character (e.g. ;).
774 boundary-pos
775 ;; The position of the last sexp or bound that follows the
776 ;; first found colon, i.e. the start of the nonlabel part of
777 ;; the statement. It's `start' if a colon is found just after
778 ;; the start.
779 after-labels-pos
780 ;; Like `after-labels-pos', but the first such position inside
781 ;; a label, i.e. the start of the last label before the start
782 ;; of the nonlabel part of the statement.
783 last-label-pos
784 ;; The last position where a label is possible provided the
785 ;; statement started there. It's nil as long as no invalid
786 ;; label content has been found (according to
787 ;; `c-nonlabel-token-key'). It's `start' if no valid label
788 ;; content was found in the label. Note that we might still
789 ;; regard it a label if it starts with `c-label-kwds'.
790 label-good-pos
791 ;; Putative positions of the components of a bitfield declaration,
792 ;; e.g. "int foo : NUM_FOO_BITS ;"
793 bitfield-type-pos bitfield-id-pos bitfield-size-pos
794 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
795 ;; See above.
796 sym
797 ;; Current state in the automaton. See above.
798 state
799 ;; Current saved positions. See above.
800 saved-pos
801 ;; Stack of conses (state . saved-pos).
802 stack
803 ;; Regexp which matches "for", "if", etc.
804 (cond-key (or c-opt-block-stmt-key
805 "\\<\\>")) ; Matches nothing.
806 ;; Return value.
807 (ret 'same)
808 ;; Positions of the last three sexps or bounds we've stopped at.
809 tok ptok pptok)
810
811 (save-restriction
812 (if lim (narrow-to-region lim (point-max)))
813
814 (if (save-excursion
815 (and (c-beginning-of-macro)
816 (/= (point) start)))
817 (setq macro-start (point)))
818
819 ;; Try to skip back over unary operator characters, to register
820 ;; that we've moved.
821 (while (progn
822 (setq pos (point))
823 (c-backward-syntactic-ws)
824 ;; Protect post-++/-- operators just before a virtual semicolon.
825 (and (not (c-at-vsemi-p))
826 (/= (skip-chars-backward "-+!*&~@`#") 0))))
827
828 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
829 ;; done. Later on we ignore the boundaries for statements that don't
830 ;; contain any sexp. The only thing that is affected is that the error
831 ;; checking is a little less strict, and we really don't bother.
832 (if (and (memq (char-before) delims)
833 (progn (forward-char -1)
834 (setq saved (point))
835 (c-backward-syntactic-ws)
836 (or (memq (char-before) delims)
837 (memq (char-before) '(?: nil))
838 (eq (char-syntax (char-before)) ?\()
839 (c-at-vsemi-p))))
840 (setq ret 'previous
841 pos saved)
842
843 ;; Begin at start and not pos to detect macros if we stand
844 ;; directly after the #.
845 (goto-char start)
846 (if (looking-at "\\<\\|\\W")
847 ;; Record this as the first token if not starting inside it.
848 (setq tok start))
849
850 ;; The following while loop goes back one sexp (balanced parens,
851 ;; etc. with contents, or symbol or suchlike) each iteration. This
852 ;; movement is accomplished with a call to c-backward-sexp approx 170
853 ;; lines below.
854 ;;
855 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
856 ;; 1. On reaching the start of a macro;
857 ;; 2. On having passed a stmt boundary with the PDA stack empty;
858 ;; 3. On reaching the start of an Objective C method def;
859 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
860 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
861 (while
862 (catch 'loop ;; Throw nil to break, non-nil to continue.
863 (cond
864 ;; Are we in a macro, just after the opening #?
865 ((save-excursion
866 (and macro-start ; Always NIL for AWK.
867 (progn (skip-chars-backward " \t")
868 (eq (char-before) ?#))
869 (progn (setq saved (1- (point)))
870 (beginning-of-line)
871 (not (eq (char-before (1- (point))) ?\\)))
872 (looking-at c-opt-cpp-start)
873 (progn (skip-chars-forward " \t")
874 (eq (point) saved))))
875 (goto-char saved)
876 (if (and (c-forward-to-cpp-define-body)
877 (progn (c-forward-syntactic-ws start)
878 (< (point) start)))
879 ;; Stop at the first token in the content of the macro.
880 (setq pos (point)
881 ignore-labels t) ; Avoid the label check on exit.
882 (setq pos saved
883 ret 'macro
884 ignore-labels t))
885 (throw 'loop nil)) ; 1. Start of macro.
886
887 ;; Do a round through the automaton if we've just passed a
888 ;; statement boundary or passed a "while"-like token.
889 ((or sym
890 (and (looking-at cond-key)
891 (setq sym (intern (match-string 1)))))
892
893 (when (and (< pos start) (null stack))
894 (throw 'loop nil)) ; 2. Statement boundary.
895
896 ;; The PDA state handling.
897 ;;
898 ;; Refer to the description of the PDA in the opening
899 ;; comments. In the following OR form, the first leaf
900 ;; attempts to handles one of the specific actions detailed
901 ;; (e.g., finding token "if" whilst in state `else-boundary').
902 ;; We drop through to the second leaf (which handles common
903 ;; state) if no specific handler is found in the first cond.
904 ;; If a parsing error is detected (e.g. an "else" with no
905 ;; preceding "if"), we throw to the enclosing catch.
906 ;;
907 ;; Note that the (eq state 'else) means
908 ;; "we've just passed an else", NOT "we're looking for an
909 ;; else".
910 (or (cond
911 ((eq state 'else)
912 (if (eq sym 'boundary)
913 (setq state 'else-boundary)
914 (c-bos-report-error)
915 (c-bos-pop-state-and-retry)))
916
917 ((eq state 'else-boundary)
918 (cond ((eq sym 'if)
919 (c-bos-pop-state (setq ret 'beginning)))
920 ((eq sym 'boundary)
921 (c-bos-report-error)
922 (c-bos-pop-state))))
923
924 ((eq state 'while)
925 (if (and (eq sym 'boundary)
926 ;; Since this can cause backtracking we do a
927 ;; little more careful analysis to avoid it:
928 ;; If there's a label in front of the while
929 ;; it can't be part of a do-while.
930 (not after-labels-pos))
931 (progn (c-bos-save-pos)
932 (setq state 'while-boundary))
933 (c-bos-pop-state-and-retry))) ; Can't be a do-while
934
935 ((eq state 'while-boundary)
936 (cond ((eq sym 'do)
937 (c-bos-pop-state (setq ret 'beginning)))
938 ((eq sym 'boundary) ; isn't a do-while
939 (c-bos-restore-pos) ; the position of the while
940 (c-bos-pop-state)))) ; no longer searching for do.
941
942 ((eq state 'catch)
943 (if (eq sym 'boundary)
944 (setq state 'catch-boundary)
945 (c-bos-report-error)
946 (c-bos-pop-state-and-retry)))
947
948 ((eq state 'catch-boundary)
949 (cond
950 ((eq sym 'try)
951 (c-bos-pop-state (setq ret 'beginning)))
952 ((eq sym 'catch)
953 (setq state 'catch))
954 ((eq sym 'boundary)
955 (c-bos-report-error)
956 (c-bos-pop-state)))))
957
958 ;; This is state common. We get here when the previous
959 ;; cond statement found no particular state handler.
960 (cond ((eq sym 'boundary)
961 ;; If we have a boundary at the start
962 ;; position we push a frame to go to the
963 ;; previous statement.
964 (if (>= pos start)
965 (c-bos-push-state)
966 (c-bos-pop-state)))
967 ((eq sym 'else)
968 (c-bos-push-state)
969 (c-bos-save-error-info 'if 'else)
970 (setq state 'else))
971 ((eq sym 'while)
972 ;; Is this a real while, or a do-while?
973 ;; The next `when' triggers unless we are SURE that
974 ;; the `while' is not the tail end of a `do-while'.
975 (when (or (not pptok)
976 (memq (char-after pptok) delims)
977 ;; The following kludge is to prevent
978 ;; infinite recursion when called from
979 ;; c-awk-after-if-for-while-condition-p,
980 ;; or the like.
981 (and (eq (point) start)
982 (c-vsemi-status-unknown-p))
983 (c-at-vsemi-p pptok))
984 ;; Since this can cause backtracking we do a
985 ;; little more careful analysis to avoid it: If
986 ;; the while isn't followed by a (possibly
987 ;; virtual) semicolon it can't be a do-while.
988 (c-bos-push-state)
989 (setq state 'while)))
990 ((memq sym '(catch finally))
991 (c-bos-push-state)
992 (c-bos-save-error-info 'try sym)
993 (setq state 'catch))))
994
995 (when c-maybe-labelp
996 ;; We're either past a statement boundary or at the
997 ;; start of a statement, so throw away any label data
998 ;; for the previous one.
999 (setq after-labels-pos nil
1000 last-label-pos nil
1001 c-maybe-labelp nil))))
1002
1003 ;; Step to the previous sexp, but not if we crossed a
1004 ;; boundary, since that doesn't consume an sexp.
1005 (if (eq sym 'boundary)
1006 (setq ret 'previous)
1007
1008 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
1009 ;; BACKWARDS THROUGH THE SOURCE.
1010
1011 (c-backward-syntactic-ws)
1012 (let ((before-sws-pos (point))
1013 ;; The end position of the area to search for statement
1014 ;; barriers in this round.
1015 (maybe-after-boundary-pos pos))
1016
1017 ;; Go back over exactly one logical sexp, taking proper
1018 ;; account of macros and escaped EOLs.
1019 (while
1020 (progn
1021 (unless (c-safe (c-backward-sexp) t)
1022 ;; Give up if we hit an unbalanced block. Since the
1023 ;; stack won't be empty the code below will report a
1024 ;; suitable error.
1025 (throw 'loop nil))
1026 (cond
1027 ;; Have we moved into a macro?
1028 ((and (not macro-start)
1029 (c-beginning-of-macro))
1030 ;; Have we crossed a statement boundary? If not,
1031 ;; keep going back until we find one or a "real" sexp.
1032 (and
1033 (save-excursion
1034 (c-end-of-macro)
1035 (not (c-crosses-statement-barrier-p
1036 (point) maybe-after-boundary-pos)))
1037 (setq maybe-after-boundary-pos (point))))
1038 ;; Have we just gone back over an escaped NL? This
1039 ;; doesn't count as a sexp.
1040 ((looking-at "\\\\$")))))
1041
1042 ;; Have we crossed a statement boundary?
1043 (setq boundary-pos
1044 (cond
1045 ;; Are we at a macro beginning?
1046 ((and (not macro-start)
1047 c-opt-cpp-prefix
1048 (looking-at c-opt-cpp-prefix))
1049 (save-excursion
1050 (c-end-of-macro)
1051 (c-crosses-statement-barrier-p
1052 (point) maybe-after-boundary-pos)))
1053 ;; Just gone back over a brace block?
1054 ((and
1055 (eq (char-after) ?{)
1056 (not (c-looking-at-inexpr-block lim nil t))
1057 (save-excursion
1058 (c-backward-token-2 1 t nil)
1059 (not (looking-at "=\\([^=]\\|$\\)"))))
1060 (save-excursion
1061 (c-forward-sexp) (point)))
1062 ;; Just gone back over some paren block?
1063 ((looking-at "\\s(")
1064 (save-excursion
1065 (goto-char (1+ (c-down-list-backward
1066 before-sws-pos)))
1067 (c-crosses-statement-barrier-p
1068 (point) maybe-after-boundary-pos)))
1069 ;; Just gone back over an ordinary symbol of some sort?
1070 (t (c-crosses-statement-barrier-p
1071 (point) maybe-after-boundary-pos))))
1072
1073 (when boundary-pos
1074 (setq pptok ptok
1075 ptok tok
1076 tok boundary-pos
1077 sym 'boundary)
1078 ;; Like a C "continue". Analyze the next sexp.
1079 (throw 'loop t))))
1080
1081 ;; ObjC method def?
1082 (when (and c-opt-method-key
1083 (setq saved (c-in-method-def-p)))
1084 (setq pos saved
1085 ignore-labels t) ; Avoid the label check on exit.
1086 (throw 'loop nil)) ; 3. ObjC method def.
1087
1088 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1089 (if c-has-bitfields
1090 (cond
1091 ;; The : <size> and <id> fields?
1092 ((and (numberp c-maybe-labelp)
1093 (not bitfield-size-pos)
1094 (save-excursion
1095 (goto-char (or tok start))
1096 (not (looking-at c-keywords-regexp)))
1097 (not (looking-at c-keywords-regexp))
1098 (not (c-punctuation-in (point) c-maybe-labelp)))
1099 (setq bitfield-size-pos (or tok start)
1100 bitfield-id-pos (point)))
1101 ;; The <type> field?
1102 ((and bitfield-id-pos
1103 (not bitfield-type-pos))
1104 (if (and (looking-at c-symbol-key) ; Can only be an integer type. :-)
1105 (not (looking-at c-not-primitive-type-keywords-regexp))
1106 (not (c-punctuation-in (point) tok)))
1107 (setq bitfield-type-pos (point))
1108 (setq bitfield-size-pos nil
1109 bitfield-id-pos nil)))))
1110
1111 ;; Handle labels.
1112 (unless (eq ignore-labels t)
1113 (when (numberp c-maybe-labelp)
1114 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1115 ;; might be in a label now. Have we got a real label
1116 ;; (including a case label) or something like C++'s "public:"?
1117 ;; A case label might use an expression rather than a token.
1118 (setq after-case:-pos (or tok start))
1119 (if (or (looking-at c-nonlabel-token-key) ; e.g. "while" or "'a'"
1120 ;; Catch C++'s inheritance construct "class foo : bar".
1121 (save-excursion
1122 (and
1123 (c-safe (c-backward-sexp) t)
1124 (looking-at c-nonlabel-token-2-key))))
1125 (setq c-maybe-labelp nil)
1126 (if after-labels-pos ; Have we already encountered a label?
1127 (if (not last-label-pos)
1128 (setq last-label-pos (or tok start)))
1129 (setq after-labels-pos (or tok start)))
1130 (setq c-maybe-labelp t
1131 label-good-pos nil))) ; bogus "label"
1132
1133 (when (and (not label-good-pos) ; i.e. no invalid "label"'s yet
1134 ; been found.
1135 (looking-at c-nonlabel-token-key)) ; e.g. "while :"
1136 ;; We're in a potential label and it's the first
1137 ;; time we've found something that isn't allowed in
1138 ;; one.
1139 (setq label-good-pos (or tok start))))
1140
1141 ;; We've moved back by a sexp, so update the token positions.
1142 (setq sym nil
1143 pptok ptok
1144 ptok tok
1145 tok (point)
1146 pos tok) ; always non-nil
1147 ) ; end of (catch loop ....)
1148 ) ; end of sexp-at-a-time (while ....)
1149
1150 ;; If the stack isn't empty there might be errors to report.
1151 (while stack
1152 (if (and (vectorp saved-pos) (eq (length saved-pos) 3))
1153 (c-bos-report-error))
1154 (setq saved-pos (cdr (car stack))
1155 stack (cdr stack)))
1156
1157 (when (and (eq ret 'same)
1158 (not (memq sym '(boundary ignore nil))))
1159 ;; Need to investigate closer whether we've crossed
1160 ;; between a substatement and its containing statement.
1161 (if (setq saved
1162 (cond ((and (looking-at c-block-stmt-1-2-key)
1163 (eq (char-after ptok) ?\())
1164 pptok)
1165 ((looking-at c-block-stmt-1-key)
1166 ptok)
1167 (t pptok)))
1168 (cond ((> start saved) (setq pos saved))
1169 ((= start saved) (setq ret 'up)))))
1170
1171 (when (and (not ignore-labels)
1172 (eq c-maybe-labelp t)
1173 (not (eq ret 'beginning))
1174 after-labels-pos
1175 (not bitfield-type-pos) ; Bitfields take precedence over labels.
1176 (or (not label-good-pos)
1177 (<= label-good-pos pos)
1178 (progn
1179 (goto-char (if (and last-label-pos
1180 (< last-label-pos start))
1181 last-label-pos
1182 pos))
1183 (looking-at c-label-kwds-regexp))))
1184 ;; We're in a label. Maybe we should step to the statement
1185 ;; after it.
1186 (if (< after-labels-pos start)
1187 (setq pos after-labels-pos)
1188 (setq ret 'label)
1189 (if (and last-label-pos (< last-label-pos start))
1190 ;; Might have jumped over several labels. Go to the last one.
1191 (setq pos last-label-pos)))))
1192
1193 ;; Have we got "case <expression>:"?
1194 (goto-char pos)
1195 (when (and after-case:-pos
1196 (not (eq ret 'beginning))
1197 (looking-at c-case-kwds-regexp))
1198 (if (< after-case:-pos start)
1199 (setq pos after-case:-pos))
1200 (if (eq ret 'same)
1201 (setq ret 'label)))
1202
1203 ;; Skip over the unary operators that can start the statement.
1204 (while (progn
1205 (c-backward-syntactic-ws)
1206 ;; protect AWK post-inc/decrement operators, etc.
1207 (and (not (c-at-vsemi-p (point)))
1208 (/= (skip-chars-backward "-+!*&~@`#") 0)))
1209 (setq pos (point)))
1210 (goto-char pos)
1211 ret)))
1212
1213 (defun c-punctuation-in (from to)
1214 "Return non-nil if there is a non-comment non-macro punctuation character
1215 between FROM and TO. FROM must not be in a string or comment. The returned
1216 value is the position of the first such character."
1217 (save-excursion
1218 (goto-char from)
1219 (let ((pos (point)))
1220 (while (progn (skip-chars-forward c-symbol-chars to)
1221 (c-forward-syntactic-ws to)
1222 (> (point) pos))
1223 (setq pos (point))))
1224 (and (< (point) to) (point))))
1225
1226 (defun c-crosses-statement-barrier-p (from to)
1227 "Return non-nil if buffer positions FROM to TO cross one or more
1228 statement or declaration boundaries. The returned value is actually
1229 the position of the earliest boundary char. FROM must not be within
1230 a string or comment.
1231
1232 The variable `c-maybe-labelp' is set to the position of the first `:' that
1233 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1234 single `?' is found, then `c-maybe-labelp' is cleared.
1235
1236 For AWK, a statement which is terminated by an EOL (not a ; or a }) is
1237 regarded as having a \"virtual semicolon\" immediately after the last token on
1238 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1239
1240 Note that this function might do hidden buffer changes. See the
1241 comment at the start of cc-engine.el for more info."
1242 (let* ((skip-chars
1243 ;; If the current language has CPP macros, insert # into skip-chars.
1244 (if c-opt-cpp-symbol
1245 (concat (substring c-stmt-delim-chars 0 1) ; "^"
1246 c-opt-cpp-symbol ; usually "#"
1247 (substring c-stmt-delim-chars 1)) ; e.g. ";{}?:"
1248 c-stmt-delim-chars))
1249 (non-skip-list
1250 (append (substring skip-chars 1) nil)) ; e.g. (?# ?\; ?{ ?} ?? ?:)
1251 lit-range vsemi-pos)
1252 (save-restriction
1253 (widen)
1254 (save-excursion
1255 (catch 'done
1256 (goto-char from)
1257 (while (progn (skip-chars-forward
1258 skip-chars
1259 (min to (c-point 'bonl)))
1260 (< (point) to))
1261 (cond
1262 ;; Virtual semicolon?
1263 ((and (bolp)
1264 (save-excursion
1265 (progn
1266 (if (setq lit-range (c-literal-limits from)) ; Have we landed in a string/comment?
1267 (goto-char (car lit-range)))
1268 (c-backward-syntactic-ws) ; ? put a limit here, maybe?
1269 (setq vsemi-pos (point))
1270 (c-at-vsemi-p))))
1271 (throw 'done vsemi-pos))
1272 ;; In a string/comment?
1273 ((setq lit-range (c-literal-limits from))
1274 (goto-char (cdr lit-range)))
1275 ((eq (char-after) ?:)
1276 (forward-char)
1277 (if (and (eq (char-after) ?:)
1278 (< (point) to))
1279 ;; Ignore scope operators.
1280 (forward-char)
1281 (setq c-maybe-labelp (1- (point)))))
1282 ((eq (char-after) ??)
1283 ;; A question mark. Can't be a label, so stop
1284 ;; looking for more : and ?.
1285 (setq c-maybe-labelp nil
1286 skip-chars (substring c-stmt-delim-chars 0 -2)))
1287 ;; At a CPP construct or a "#" or "##" operator?
1288 ((and c-opt-cpp-symbol (looking-at c-opt-cpp-symbol))
1289 (if (save-excursion
1290 (skip-chars-backward " \t")
1291 (and (bolp)
1292 (or (bobp)
1293 (not (eq (char-before (1- (point))) ?\\)))))
1294 (c-end-of-macro)
1295 (skip-chars-forward c-opt-cpp-symbol)))
1296 ((memq (char-after) non-skip-list)
1297 (throw 'done (point)))))
1298 ;; In trailing space after an as yet undetected virtual semicolon?
1299 (c-backward-syntactic-ws from)
1300 (when (and (bolp) (not (bobp))) ; Can happen in AWK Mode with an
1301 ; unterminated string/regexp.
1302 (backward-char))
1303 (if (and (< (point) to)
1304 (c-at-vsemi-p))
1305 (point)
1306 nil))))))
1307
1308 (defun c-at-statement-start-p ()
1309 "Return non-nil if the point is at the first token in a statement
1310 or somewhere in the syntactic whitespace before it.
1311
1312 A \"statement\" here is not restricted to those inside code blocks.
1313 Any kind of declaration-like construct that occur outside function
1314 bodies is also considered a \"statement\".
1315
1316 Note that this function might do hidden buffer changes. See the
1317 comment at the start of cc-engine.el for more info."
1318
1319 (save-excursion
1320 (let ((end (point))
1321 c-maybe-labelp)
1322 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1323 (or (bobp)
1324 (eq (char-before) ?})
1325 (and (eq (char-before) ?{)
1326 (not (and c-special-brace-lists
1327 (progn (backward-char)
1328 (c-looking-at-special-brace-list)))))
1329 (c-crosses-statement-barrier-p (point) end)))))
1330
1331 (defun c-at-expression-start-p ()
1332 "Return non-nil if the point is at the first token in an expression or
1333 statement, or somewhere in the syntactic whitespace before it.
1334
1335 An \"expression\" here is a bit different from the normal language
1336 grammar sense: It's any sequence of expression tokens except commas,
1337 unless they are enclosed inside parentheses of some kind. Also, an
1338 expression never continues past an enclosing parenthesis, but it might
1339 contain parenthesis pairs of any sort except braces.
1340
1341 Since expressions never cross statement boundaries, this function also
1342 recognizes statement beginnings, just like `c-at-statement-start-p'.
1343
1344 Note that this function might do hidden buffer changes. See the
1345 comment at the start of cc-engine.el for more info."
1346
1347 (save-excursion
1348 (let ((end (point))
1349 (c-stmt-delim-chars c-stmt-delim-chars-with-comma)
1350 c-maybe-labelp)
1351 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1352 (or (bobp)
1353 (memq (char-before) '(?{ ?}))
1354 (save-excursion (backward-char)
1355 (looking-at "\\s("))
1356 (c-crosses-statement-barrier-p (point) end)))))
1357
1358 \f
1359 ;; A set of functions that covers various idiosyncrasies in
1360 ;; implementations of `forward-comment'.
1361
1362 ;; Note: Some emacsen considers incorrectly that any line comment
1363 ;; ending with a backslash continues to the next line. I can't think
1364 ;; of any way to work around that in a reliable way without changing
1365 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1366 ;; changing the syntax for backslash doesn't work since we must treat
1367 ;; escapes in string literals correctly.)
1368
1369 (defun c-forward-single-comment ()
1370 "Move forward past whitespace and the closest following comment, if any.
1371 Return t if a comment was found, nil otherwise. In either case, the
1372 point is moved past the following whitespace. Line continuations,
1373 i.e. a backslashes followed by line breaks, are treated as whitespace.
1374 The line breaks that end line comments are considered to be the
1375 comment enders, so the point will be put on the beginning of the next
1376 line if it moved past a line comment.
1377
1378 This function does not do any hidden buffer changes."
1379
1380 (let ((start (point)))
1381 (when (looking-at "\\([ \t\n\r\f\v]\\|\\\\[\n\r]\\)+")
1382 (goto-char (match-end 0)))
1383
1384 (when (forward-comment 1)
1385 (if (eobp)
1386 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1387 ;; forwards at eob.
1388 nil
1389
1390 ;; Emacs includes the ending newline in a b-style (c++)
1391 ;; comment, but XEmacs doesn't. We depend on the Emacs
1392 ;; behavior (which also is symmetric).
1393 (if (and (eolp) (elt (parse-partial-sexp start (point)) 7))
1394 (condition-case nil (forward-char 1)))
1395
1396 t))))
1397
1398 (defsubst c-forward-comments ()
1399 "Move forward past all following whitespace and comments.
1400 Line continuations, i.e. a backslashes followed by line breaks, are
1401 treated as whitespace.
1402
1403 Note that this function might do hidden buffer changes. See the
1404 comment at the start of cc-engine.el for more info."
1405
1406 (while (or
1407 ;; If forward-comment in at least XEmacs 21 is given a large
1408 ;; positive value, it'll loop all the way through if it hits
1409 ;; eob.
1410 (and (forward-comment 5)
1411 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1412 ;; forwards at eob.
1413 (not (eobp)))
1414
1415 (when (looking-at "\\\\[\n\r]")
1416 (forward-char 2)
1417 t))))
1418
1419 (defun c-backward-single-comment ()
1420 "Move backward past whitespace and the closest preceding comment, if any.
1421 Return t if a comment was found, nil otherwise. In either case, the
1422 point is moved past the preceding whitespace. Line continuations,
1423 i.e. a backslashes followed by line breaks, are treated as whitespace.
1424 The line breaks that end line comments are considered to be the
1425 comment enders, so the point cannot be at the end of the same line to
1426 move over a line comment.
1427
1428 This function does not do any hidden buffer changes."
1429
1430 (let ((start (point)))
1431 ;; When we got newline terminated comments, forward-comment in all
1432 ;; supported emacsen so far will stop at eol of each line not
1433 ;; ending with a comment when moving backwards. This corrects for
1434 ;; that, and at the same time handles line continuations.
1435 (while (progn
1436 (skip-chars-backward " \t\n\r\f\v")
1437 (and (looking-at "[\n\r]")
1438 (eq (char-before) ?\\)))
1439 (backward-char))
1440
1441 (if (bobp)
1442 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1443 ;; backwards at bob.
1444 nil
1445
1446 ;; Leave point after the closest following newline if we've
1447 ;; backed up over any above, since forward-comment won't move
1448 ;; backward over a line comment if point is at the end of the
1449 ;; same line.
1450 (re-search-forward "\\=\\s *[\n\r]" start t)
1451
1452 (if (if (forward-comment -1)
1453 (if (eolp)
1454 ;; If forward-comment above succeeded and we're at eol
1455 ;; then the newline we moved over above didn't end a
1456 ;; line comment, so we give it another go.
1457 (forward-comment -1)
1458 t))
1459
1460 ;; Emacs <= 20 and XEmacs move back over the closer of a
1461 ;; block comment that lacks an opener.
1462 (if (looking-at "\\*/")
1463 (progn (forward-char 2) nil)
1464 t)))))
1465
1466 (defsubst c-backward-comments ()
1467 "Move backward past all preceding whitespace and comments.
1468 Line continuations, i.e. a backslashes followed by line breaks, are
1469 treated as whitespace. The line breaks that end line comments are
1470 considered to be the comment enders, so the point cannot be at the end
1471 of the same line to move over a line comment. Unlike
1472 c-backward-syntactic-ws, this function doesn't move back over
1473 preprocessor directives.
1474
1475 Note that this function might do hidden buffer changes. See the
1476 comment at the start of cc-engine.el for more info."
1477
1478 (let ((start (point)))
1479 (while (and
1480 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1481 ;; return t when moving backwards at bob.
1482 (not (bobp))
1483
1484 (if (let (moved-comment)
1485 (while
1486 (and (not (setq moved-comment (forward-comment -1)))
1487 ;; Cope specifically with ^M^J here -
1488 ;; forward-comment sometimes gets stuck after ^Ms,
1489 ;; sometimes after ^M^J.
1490 (or
1491 (when (eq (char-before) ?\r)
1492 (backward-char)
1493 t)
1494 (when (and (eq (char-before) ?\n)
1495 (eq (char-before (1- (point))) ?\r))
1496 (backward-char 2)
1497 t))))
1498 moved-comment)
1499 (if (looking-at "\\*/")
1500 ;; Emacs <= 20 and XEmacs move back over the
1501 ;; closer of a block comment that lacks an opener.
1502 (progn (forward-char 2) nil)
1503 t)
1504
1505 ;; XEmacs treats line continuations as whitespace but
1506 ;; only in the backward direction, which seems a bit
1507 ;; odd. Anyway, this is necessary for Emacs.
1508 (when (and (looking-at "[\n\r]")
1509 (eq (char-before) ?\\)
1510 (< (point) start))
1511 (backward-char)
1512 t))))))
1513
1514 \f
1515 ;; Tools for skipping over syntactic whitespace.
1516
1517 ;; The following functions use text properties to cache searches over
1518 ;; large regions of syntactic whitespace. It works as follows:
1519 ;;
1520 ;; o If a syntactic whitespace region contains anything but simple
1521 ;; whitespace (i.e. space, tab and line breaks), the text property
1522 ;; `c-in-sws' is put over it. At places where we have stopped
1523 ;; within that region there's also a `c-is-sws' text property.
1524 ;; That since there typically are nested whitespace inside that
1525 ;; must be handled separately, e.g. whitespace inside a comment or
1526 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1527 ;; to jump to another point with that property within the same
1528 ;; `c-in-sws' region. It can be likened to a ladder where
1529 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1530 ;;
1531 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1532 ;; a "rung position" and also maybe on the first following char.
1533 ;; As many characters as can be conveniently found in this range
1534 ;; are marked, but no assumption can be made that the whole range
1535 ;; is marked (it could be clobbered by later changes, for
1536 ;; instance).
1537 ;;
1538 ;; Note that some part of the beginning of a sequence of simple
1539 ;; whitespace might be part of the end of a preceding line comment
1540 ;; or cpp directive and must not be considered part of the "rung".
1541 ;; Such whitespace is some amount of horizontal whitespace followed
1542 ;; by a newline. In the case of cpp directives it could also be
1543 ;; two newlines with horizontal whitespace between them.
1544 ;;
1545 ;; The reason to include the first following char is to cope with
1546 ;; "rung positions" that don't have any ordinary whitespace. If
1547 ;; `c-is-sws' is put on a token character it does not have
1548 ;; `c-in-sws' set simultaneously. That's the only case when that
1549 ;; can occur, and the reason for not extending the `c-in-sws'
1550 ;; region to cover it is that the `c-in-sws' region could then be
1551 ;; accidentally merged with a following one if the token is only
1552 ;; one character long.
1553 ;;
1554 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1555 ;; removed in the changed region. If the change was inside
1556 ;; syntactic whitespace that means that the "ladder" is broken, but
1557 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1558 ;; parts on either side and use an ordinary search only to "repair"
1559 ;; the gap.
1560 ;;
1561 ;; Special care needs to be taken if a region is removed: If there
1562 ;; are `c-in-sws' on both sides of it which do not connect inside
1563 ;; the region then they can't be joined. If e.g. a marked macro is
1564 ;; broken, syntactic whitespace inside the new text might be
1565 ;; marked. If those marks would become connected with the old
1566 ;; `c-in-sws' range around the macro then we could get a ladder
1567 ;; with one end outside the macro and the other at some whitespace
1568 ;; within it.
1569 ;;
1570 ;; The main motivation for this system is to increase the speed in
1571 ;; skipping over the large whitespace regions that can occur at the
1572 ;; top level in e.g. header files that contain a lot of comments and
1573 ;; cpp directives. For small comments inside code it's probably
1574 ;; slower than using `forward-comment' straightforwardly, but speed is
1575 ;; not a significant factor there anyway.
1576
1577 ; (defface c-debug-is-sws-face
1578 ; '((t (:background "GreenYellow")))
1579 ; "Debug face to mark the `c-is-sws' property.")
1580 ; (defface c-debug-in-sws-face
1581 ; '((t (:underline t)))
1582 ; "Debug face to mark the `c-in-sws' property.")
1583
1584 ; (defun c-debug-put-sws-faces ()
1585 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1586 ; ;; properties in the buffer.
1587 ; (interactive)
1588 ; (save-excursion
1589 ; (c-save-buffer-state (in-face)
1590 ; (goto-char (point-min))
1591 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1592 ; (point)))
1593 ; (while (progn
1594 ; (goto-char (next-single-property-change
1595 ; (point) 'c-is-sws nil (point-max)))
1596 ; (if in-face
1597 ; (progn
1598 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1599 ; (setq in-face nil))
1600 ; (setq in-face (point)))
1601 ; (not (eobp))))
1602 ; (goto-char (point-min))
1603 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1604 ; (point)))
1605 ; (while (progn
1606 ; (goto-char (next-single-property-change
1607 ; (point) 'c-in-sws nil (point-max)))
1608 ; (if in-face
1609 ; (progn
1610 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1611 ; (setq in-face nil))
1612 ; (setq in-face (point)))
1613 ; (not (eobp)))))))
1614
1615 (defmacro c-debug-sws-msg (&rest args)
1616 ;;`(message ,@args)
1617 )
1618
1619 (defmacro c-put-is-sws (beg end)
1620 ;; This macro does a hidden buffer change.
1621 `(let ((beg ,beg) (end ,end))
1622 (put-text-property beg end 'c-is-sws t)
1623 ,@(when (facep 'c-debug-is-sws-face)
1624 `((c-debug-add-face beg end 'c-debug-is-sws-face)))))
1625
1626 (defmacro c-put-in-sws (beg end)
1627 ;; This macro does a hidden buffer change.
1628 `(let ((beg ,beg) (end ,end))
1629 (put-text-property beg end 'c-in-sws t)
1630 ,@(when (facep 'c-debug-is-sws-face)
1631 `((c-debug-add-face beg end 'c-debug-in-sws-face)))))
1632
1633 (defmacro c-remove-is-sws (beg end)
1634 ;; This macro does a hidden buffer change.
1635 `(let ((beg ,beg) (end ,end))
1636 (remove-text-properties beg end '(c-is-sws nil))
1637 ,@(when (facep 'c-debug-is-sws-face)
1638 `((c-debug-remove-face beg end 'c-debug-is-sws-face)))))
1639
1640 (defmacro c-remove-in-sws (beg end)
1641 ;; This macro does a hidden buffer change.
1642 `(let ((beg ,beg) (end ,end))
1643 (remove-text-properties beg end '(c-in-sws nil))
1644 ,@(when (facep 'c-debug-is-sws-face)
1645 `((c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1646
1647 (defmacro c-remove-is-and-in-sws (beg end)
1648 ;; This macro does a hidden buffer change.
1649 `(let ((beg ,beg) (end ,end))
1650 (remove-text-properties beg end '(c-is-sws nil c-in-sws nil))
1651 ,@(when (facep 'c-debug-is-sws-face)
1652 `((c-debug-remove-face beg end 'c-debug-is-sws-face)
1653 (c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1654
1655 (defsubst c-invalidate-sws-region-after (beg end)
1656 ;; Called from `after-change-functions'. Note that if
1657 ;; `c-forward-sws' or `c-backward-sws' are used outside
1658 ;; `c-save-buffer-state' or similar then this will remove the cache
1659 ;; properties right after they're added.
1660 ;;
1661 ;; This function does hidden buffer changes.
1662
1663 (save-excursion
1664 ;; Adjust the end to remove the properties in any following simple
1665 ;; ws up to and including the next line break, if there is any
1666 ;; after the changed region. This is necessary e.g. when a rung
1667 ;; marked empty line is converted to a line comment by inserting
1668 ;; "//" before the line break. In that case the line break would
1669 ;; keep the rung mark which could make a later `c-backward-sws'
1670 ;; move into the line comment instead of over it.
1671 (goto-char end)
1672 (skip-chars-forward " \t\f\v")
1673 (when (and (eolp) (not (eobp)))
1674 (setq end (1+ (point)))))
1675
1676 (when (and (= beg end)
1677 (get-text-property beg 'c-in-sws)
1678 (> beg (point-min))
1679 (get-text-property (1- beg) 'c-in-sws))
1680 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1681 ;; safe to keep a range that was continuous before the change. E.g:
1682 ;;
1683 ;; #define foo
1684 ;; \
1685 ;; bar
1686 ;;
1687 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1688 ;; after "foo" is removed then "bar" will become part of the cpp
1689 ;; directive instead of a syntactically relevant token. In that
1690 ;; case there's no longer syntactic ws from "#" to "b".
1691 (setq beg (1- beg)))
1692
1693 (c-debug-sws-msg "c-invalidate-sws-region-after [%s..%s]" beg end)
1694 (c-remove-is-and-in-sws beg end))
1695
1696 (defun c-forward-sws ()
1697 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1698 ;;
1699 ;; This function might do hidden buffer changes.
1700
1701 (let (;; `rung-pos' is set to a position as early as possible in the
1702 ;; unmarked part of the simple ws region.
1703 (rung-pos (point)) next-rung-pos rung-end-pos last-put-in-sws-pos
1704 rung-is-marked next-rung-is-marked simple-ws-end
1705 ;; `safe-start' is set when it's safe to cache the start position.
1706 ;; It's not set if we've initially skipped over comments and line
1707 ;; continuations since we might have gone out through the end of a
1708 ;; macro then. This provision makes `c-forward-sws' not populate the
1709 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1710 ;; more common.
1711 safe-start)
1712
1713 ;; Skip simple ws and do a quick check on the following character to see
1714 ;; if it's anything that can't start syntactic ws, so we can bail out
1715 ;; early in the majority of cases when there just are a few ws chars.
1716 (skip-chars-forward " \t\n\r\f\v")
1717 (when (or (looking-at c-syntactic-ws-start)
1718 (and c-opt-cpp-prefix
1719 (looking-at c-noise-macro-name-re)))
1720
1721 (setq rung-end-pos (min (1+ (point)) (point-max)))
1722 (if (setq rung-is-marked (text-property-any rung-pos rung-end-pos
1723 'c-is-sws t))
1724 ;; Find the last rung position to avoid setting properties in all
1725 ;; the cases when the marked rung is complete.
1726 ;; (`next-single-property-change' is certain to move at least one
1727 ;; step forward.)
1728 (setq rung-pos (1- (c-next-single-property-change
1729 rung-is-marked 'c-is-sws nil rung-end-pos)))
1730 ;; Got no marked rung here. Since the simple ws might have started
1731 ;; inside a line comment or cpp directive we must set `rung-pos' as
1732 ;; high as possible.
1733 (setq rung-pos (point)))
1734
1735 (with-silent-modifications
1736 (while
1737 (progn
1738 ;; In the following while form, we move over a "ladder" and
1739 ;; following simple WS each time round the loop, appending the WS
1740 ;; onto the ladder, joining adjacent ladders, and terminating when
1741 ;; there is no more WS or we reach EOB.
1742 (while
1743 (when (and rung-is-marked
1744 (get-text-property (point) 'c-in-sws))
1745
1746 ;; The following search is the main reason that `c-in-sws'
1747 ;; and `c-is-sws' aren't combined to one property.
1748 (goto-char (c-next-single-property-change
1749 (point) 'c-in-sws nil (point-max)))
1750 (unless (get-text-property (point) 'c-is-sws)
1751 ;; If the `c-in-sws' region extended past the last
1752 ;; `c-is-sws' char we have to go back a bit.
1753 (or (get-text-property (1- (point)) 'c-is-sws)
1754 (goto-char (previous-single-property-change
1755 (point) 'c-is-sws)))
1756 (backward-char))
1757
1758 (c-debug-sws-msg
1759 "c-forward-sws cached move %s -> %s (max %s)"
1760 rung-pos (point) (point-max))
1761
1762 (setq rung-pos (point))
1763 (and (> (skip-chars-forward " \t\n\r\f\v") 0)
1764 (not (eobp))))
1765
1766 ;; We'll loop here if there is simple ws after the last rung.
1767 ;; That means that there's been some change in it and it's
1768 ;; possible that we've stepped into another ladder, so extend
1769 ;; the previous one to join with it if there is one, and try to
1770 ;; use the cache again.
1771 (c-debug-sws-msg
1772 "c-forward-sws extending rung with [%s..%s] (max %s)"
1773 (1+ rung-pos) (1+ (point)) (point-max))
1774 (unless (get-text-property (point) 'c-is-sws)
1775 ;; Remove any `c-in-sws' property from the last char of
1776 ;; the rung before we mark it with `c-is-sws', so that we
1777 ;; won't connect with the remains of a broken "ladder".
1778 (c-remove-in-sws (point) (1+ (point))))
1779 (c-put-is-sws (1+ rung-pos)
1780 (1+ (point)))
1781 (c-put-in-sws rung-pos
1782 (setq rung-pos (point)
1783 last-put-in-sws-pos rung-pos)))
1784
1785 ;; Now move over any comments (x)or a CPP construct.
1786 (setq simple-ws-end (point))
1787 (c-forward-comments)
1788
1789 (cond
1790 ((/= (point) simple-ws-end)
1791 ;; Skipped over comments. Don't cache at eob in case the buffer
1792 ;; is narrowed.
1793 (not (eobp)))
1794
1795 ((save-excursion
1796 (and c-opt-cpp-prefix
1797 (looking-at c-opt-cpp-start)
1798 (progn (skip-chars-backward " \t")
1799 (bolp))
1800 (or (bobp)
1801 (progn (backward-char)
1802 (not (eq (char-before) ?\\))))))
1803 ;; Skip a preprocessor directive.
1804 (end-of-line)
1805 (while (and (eq (char-before) ?\\)
1806 (= (forward-line 1) 0))
1807 (end-of-line))
1808 (forward-line 1)
1809 (setq safe-start t)
1810 ;; Don't cache at eob in case the buffer is narrowed.
1811 (not (eobp)))
1812
1813 ((and c-opt-cpp-prefix
1814 (looking-at c-noise-macro-name-re))
1815 ;; Skip over a noise macro.
1816 (goto-char (match-end 1))
1817 (setq safe-start t)
1818 (not (eobp)))))
1819
1820 ;; We've searched over a piece of non-white syntactic ws. See if this
1821 ;; can be cached.
1822 (setq next-rung-pos (point))
1823 (skip-chars-forward " \t\n\r\f\v")
1824 (setq rung-end-pos (min (1+ (point)) (point-max)))
1825
1826 (if (or
1827 ;; Cache if we haven't skipped comments only, and if we started
1828 ;; either from a marked rung or from a completely uncached
1829 ;; position.
1830 (and safe-start
1831 (or rung-is-marked
1832 (not (get-text-property simple-ws-end 'c-in-sws))))
1833
1834 ;; See if there's a marked rung in the encountered simple ws. If
1835 ;; so then we can cache, unless `safe-start' is nil. Even then
1836 ;; we need to do this to check if the cache can be used for the
1837 ;; next step.
1838 (and (setq next-rung-is-marked
1839 (text-property-any next-rung-pos rung-end-pos
1840 'c-is-sws t))
1841 safe-start))
1842
1843 (progn
1844 (c-debug-sws-msg
1845 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1846 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1847 (point-max))
1848
1849 ;; Remove the properties for any nested ws that might be cached.
1850 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1851 ;; anyway.
1852 (c-remove-is-sws (1+ simple-ws-end) next-rung-pos)
1853 (unless (and rung-is-marked (= rung-pos simple-ws-end))
1854 (c-put-is-sws rung-pos
1855 (1+ simple-ws-end))
1856 (setq rung-is-marked t))
1857 (c-put-in-sws rung-pos
1858 (setq rung-pos (point)
1859 last-put-in-sws-pos rung-pos))
1860 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
1861 ;; Remove any `c-in-sws' property from the last char of
1862 ;; the rung before we mark it with `c-is-sws', so that we
1863 ;; won't connect with the remains of a broken "ladder".
1864 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
1865 (c-put-is-sws next-rung-pos
1866 rung-end-pos))
1867
1868 (c-debug-sws-msg
1869 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1870 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1871 (point-max))
1872
1873 ;; Set `rung-pos' for the next rung. It's the same thing here as
1874 ;; initially, except that the rung position is set as early as
1875 ;; possible since we can't be in the ending ws of a line comment or
1876 ;; cpp directive now.
1877 (if (setq rung-is-marked next-rung-is-marked)
1878 (setq rung-pos (1- (c-next-single-property-change
1879 rung-is-marked 'c-is-sws nil rung-end-pos)))
1880 (setq rung-pos next-rung-pos))
1881 (setq safe-start t)))
1882
1883 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1884 ;; another one after the point (which might occur when editing inside a
1885 ;; comment or macro).
1886 (when (eq last-put-in-sws-pos (point))
1887 (cond ((< last-put-in-sws-pos (point-max))
1888 (c-debug-sws-msg
1889 "c-forward-sws clearing at %s for cache separation"
1890 last-put-in-sws-pos)
1891 (c-remove-in-sws last-put-in-sws-pos
1892 (1+ last-put-in-sws-pos)))
1893 (t
1894 ;; If at eob we have to clear the last character before the end
1895 ;; instead since the buffer might be narrowed and there might
1896 ;; be a `c-in-sws' after (point-max). In this case it's
1897 ;; necessary to clear both properties.
1898 (c-debug-sws-msg
1899 "c-forward-sws clearing thoroughly at %s for cache separation"
1900 (1- last-put-in-sws-pos))
1901 (c-remove-is-and-in-sws (1- last-put-in-sws-pos)
1902 last-put-in-sws-pos))))
1903 ))))
1904
1905 (defun c-backward-sws ()
1906 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1907 ;;
1908 ;; This function might do hidden buffer changes.
1909
1910 (let (;; `rung-pos' is set to a position as late as possible in the unmarked
1911 ;; part of the simple ws region.
1912 (rung-pos (point)) next-rung-pos last-put-in-sws-pos
1913 rung-is-marked simple-ws-beg cmt-skip-pos)
1914
1915 ;; Skip simple horizontal ws and do a quick check on the preceding
1916 ;; character to see if it's anything that can't end syntactic ws, so we can
1917 ;; bail out early in the majority of cases when there just are a few ws
1918 ;; chars. Newlines are complicated in the backward direction, so we can't
1919 ;; skip over them.
1920 (skip-chars-backward " \t\f")
1921 (when (and (not (bobp))
1922 (save-excursion
1923 (backward-char)
1924 (or (looking-at c-syntactic-ws-end)
1925 (and c-opt-cpp-prefix
1926 (looking-at c-symbol-char-key)
1927 (progn (c-beginning-of-current-token)
1928 (looking-at c-noise-macro-name-re))))))
1929 ;; Try to find a rung position in the simple ws preceding point, so that
1930 ;; we can get a cache hit even if the last bit of the simple ws has
1931 ;; changed recently.
1932 (setq simple-ws-beg (point))
1933 (skip-chars-backward " \t\n\r\f\v")
1934 (if (setq rung-is-marked (text-property-any
1935 (point) (min (1+ rung-pos) (point-max))
1936 'c-is-sws t))
1937 ;; `rung-pos' will be the earliest marked position, which means that
1938 ;; there might be later unmarked parts in the simple ws region.
1939 ;; It's not worth the effort to fix that; the last part of the
1940 ;; simple ws is also typically edited often, so it could be wasted.
1941 (goto-char (setq rung-pos rung-is-marked))
1942 (goto-char simple-ws-beg))
1943
1944 (with-silent-modifications
1945 (while
1946 (progn
1947 ;; Each time round the next while form, we move back over a ladder
1948 ;; and append any simple WS preceding it, if possible joining with
1949 ;; the previous ladder.
1950 (while
1951 (when (and rung-is-marked
1952 (not (bobp))
1953 (get-text-property (1- (point)) 'c-in-sws))
1954
1955 ;; The following search is the main reason that `c-in-sws'
1956 ;; and `c-is-sws' aren't combined to one property.
1957 (goto-char (previous-single-property-change
1958 (point) 'c-in-sws nil (point-min)))
1959 (unless (get-text-property (point) 'c-is-sws)
1960 ;; If the `c-in-sws' region extended past the first
1961 ;; `c-is-sws' char we have to go forward a bit.
1962 (goto-char (c-next-single-property-change
1963 (point) 'c-is-sws)))
1964
1965 (c-debug-sws-msg
1966 "c-backward-sws cached move %s <- %s (min %s)"
1967 (point) rung-pos (point-min))
1968
1969 (setq rung-pos (point))
1970 (if (and (< (min (skip-chars-backward " \t\f\v")
1971 (progn
1972 (setq simple-ws-beg (point))
1973 (skip-chars-backward " \t\n\r\f\v")))
1974 0)
1975 (setq rung-is-marked
1976 (text-property-any (point) rung-pos
1977 'c-is-sws t)))
1978 t
1979 (goto-char simple-ws-beg)
1980 nil))
1981
1982 ;; We'll loop here if there is simple ws before the first rung.
1983 ;; That means that there's been some change in it and it's
1984 ;; possible that we've stepped into another ladder, so extend
1985 ;; the previous one to join with it if there is one, and try to
1986 ;; use the cache again.
1987 (c-debug-sws-msg
1988 "c-backward-sws extending rung with [%s..%s] (min %s)"
1989 rung-is-marked rung-pos (point-min))
1990 (unless (get-text-property (1- rung-pos) 'c-is-sws)
1991 ;; Remove any `c-in-sws' property from the last char of
1992 ;; the rung before we mark it with `c-is-sws', so that we
1993 ;; won't connect with the remains of a broken "ladder".
1994 (c-remove-in-sws (1- rung-pos) rung-pos))
1995 (c-put-is-sws rung-is-marked
1996 rung-pos)
1997 (c-put-in-sws rung-is-marked
1998 (1- rung-pos))
1999 (setq rung-pos rung-is-marked
2000 last-put-in-sws-pos rung-pos))
2001
2002 (c-backward-comments)
2003 (setq cmt-skip-pos (point))
2004
2005 (cond
2006 ((and c-opt-cpp-prefix
2007 (/= cmt-skip-pos simple-ws-beg)
2008 (c-beginning-of-macro))
2009 ;; Inside a cpp directive. See if it should be skipped over.
2010 (let ((cpp-beg (point)))
2011
2012 ;; Move back over all line continuations in the region skipped
2013 ;; over by `c-backward-comments'. If we go past it then we
2014 ;; started inside the cpp directive.
2015 (goto-char simple-ws-beg)
2016 (beginning-of-line)
2017 (while (and (> (point) cmt-skip-pos)
2018 (progn (backward-char)
2019 (eq (char-before) ?\\)))
2020 (beginning-of-line))
2021
2022 (if (< (point) cmt-skip-pos)
2023 ;; Don't move past the cpp directive if we began inside
2024 ;; it. Note that the position at the end of the last line
2025 ;; of the macro is also considered to be within it.
2026 (progn (goto-char cmt-skip-pos)
2027 nil)
2028
2029 ;; It's worthwhile to spend a little bit of effort on finding
2030 ;; the end of the macro, to get a good `simple-ws-beg'
2031 ;; position for the cache. Note that `c-backward-comments'
2032 ;; could have stepped over some comments before going into
2033 ;; the macro, and then `simple-ws-beg' must be kept on the
2034 ;; same side of those comments.
2035 (goto-char simple-ws-beg)
2036 (skip-chars-backward " \t\n\r\f\v")
2037 (if (eq (char-before) ?\\)
2038 (forward-char))
2039 (forward-line 1)
2040 (if (< (point) simple-ws-beg)
2041 ;; Might happen if comments after the macro were skipped
2042 ;; over.
2043 (setq simple-ws-beg (point)))
2044
2045 (goto-char cpp-beg)
2046 t)))
2047
2048 ((/= (save-excursion
2049 (skip-chars-forward " \t\n\r\f\v" simple-ws-beg)
2050 (setq next-rung-pos (point)))
2051 simple-ws-beg)
2052 ;; Skipped over comments. Must put point at the end of
2053 ;; the simple ws at point since we might be after a line
2054 ;; comment or cpp directive that's been partially
2055 ;; narrowed out, and we can't risk marking the simple ws
2056 ;; at the end of it.
2057 (goto-char next-rung-pos)
2058 t)
2059
2060 ((and c-opt-cpp-prefix
2061 (save-excursion
2062 (and (< (skip-syntax-backward "w_") 0)
2063 (progn (setq next-rung-pos (point))
2064 (looking-at c-noise-macro-name-re)))))
2065 ;; Skipped over a noise macro
2066 (goto-char next-rung-pos)
2067 t)))
2068
2069 ;; We've searched over a piece of non-white syntactic ws. See if this
2070 ;; can be cached.
2071 (setq next-rung-pos (point))
2072 (skip-chars-backward " \t\f\v")
2073
2074 (if (or
2075 ;; Cache if we started either from a marked rung or from a
2076 ;; completely uncached position.
2077 rung-is-marked
2078 (not (get-text-property (1- simple-ws-beg) 'c-in-sws))
2079
2080 ;; Cache if there's a marked rung in the encountered simple ws.
2081 (save-excursion
2082 (skip-chars-backward " \t\n\r\f\v")
2083 (text-property-any (point) (min (1+ next-rung-pos) (point-max))
2084 'c-is-sws t)))
2085
2086 (progn
2087 (c-debug-sws-msg
2088 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2089 (point) (1+ next-rung-pos)
2090 simple-ws-beg (min (1+ rung-pos) (point-max))
2091 (point-min))
2092
2093 ;; Remove the properties for any nested ws that might be cached.
2094 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2095 ;; anyway.
2096 (c-remove-is-sws (1+ next-rung-pos) simple-ws-beg)
2097 (unless (and rung-is-marked (= simple-ws-beg rung-pos))
2098 (let ((rung-end-pos (min (1+ rung-pos) (point-max))))
2099 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
2100 ;; Remove any `c-in-sws' property from the last char of
2101 ;; the rung before we mark it with `c-is-sws', so that we
2102 ;; won't connect with the remains of a broken "ladder".
2103 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
2104 (c-put-is-sws simple-ws-beg
2105 rung-end-pos)
2106 (setq rung-is-marked t)))
2107 (c-put-in-sws (setq simple-ws-beg (point)
2108 last-put-in-sws-pos simple-ws-beg)
2109 rung-pos)
2110 (c-put-is-sws (setq rung-pos simple-ws-beg)
2111 (1+ next-rung-pos)))
2112
2113 (c-debug-sws-msg
2114 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2115 (point) (1+ next-rung-pos)
2116 simple-ws-beg (min (1+ rung-pos) (point-max))
2117 (point-min))
2118 (setq rung-pos next-rung-pos
2119 simple-ws-beg (point))
2120 ))
2121
2122 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2123 ;; another one before the point (which might occur when editing inside a
2124 ;; comment or macro).
2125 (when (eq last-put-in-sws-pos (point))
2126 (cond ((< (point-min) last-put-in-sws-pos)
2127 (c-debug-sws-msg
2128 "c-backward-sws clearing at %s for cache separation"
2129 (1- last-put-in-sws-pos))
2130 (c-remove-in-sws (1- last-put-in-sws-pos)
2131 last-put-in-sws-pos))
2132 ((> (point-min) 1)
2133 ;; If at bob and the buffer is narrowed, we have to clear the
2134 ;; character we're standing on instead since there might be a
2135 ;; `c-in-sws' before (point-min). In this case it's necessary
2136 ;; to clear both properties.
2137 (c-debug-sws-msg
2138 "c-backward-sws clearing thoroughly at %s for cache separation"
2139 last-put-in-sws-pos)
2140 (c-remove-is-and-in-sws last-put-in-sws-pos
2141 (1+ last-put-in-sws-pos)))))
2142 ))))
2143
2144 \f
2145 ;; Other whitespace tools
2146 (defun c-partial-ws-p (beg end)
2147 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2148 ;; region? This is a "heuristic" function. .....
2149 ;;
2150 ;; The motivation for the second bit is to check whether removing this
2151 ;; region would coalesce two symbols.
2152 ;;
2153 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2154 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2155 (save-excursion
2156 (let ((end+1 (min (1+ end) (point-max))))
2157 (or (progn (goto-char (max (point-min) (1- beg)))
2158 (c-skip-ws-forward end)
2159 (eq (point) end))
2160 (progn (goto-char beg)
2161 (c-skip-ws-forward end+1)
2162 (eq (point) end+1))))))
2163 \f
2164 ;; A system for finding noteworthy parens before the point.
2165
2166 (defconst c-state-cache-too-far 5000)
2167 ;; A maximum comfortable scanning distance, e.g. between
2168 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2169 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2170 ;; the cache and starting again from point-min or a beginning of defun. This
2171 ;; value can be tuned for efficiency or set to a lower value for testing.
2172
2173 (defvar c-state-cache nil)
2174 (make-variable-buffer-local 'c-state-cache)
2175 ;; The state cache used by `c-parse-state' to cut down the amount of
2176 ;; searching. It's the result from some earlier `c-parse-state' call. See
2177 ;; `c-parse-state''s doc string for details of its structure.
2178 ;;
2179 ;; The use of the cached info is more effective if the next
2180 ;; `c-parse-state' call is on a line close by the one the cached state
2181 ;; was made at; the cache can actually slow down a little if the
2182 ;; cached state was made very far back in the buffer. The cache is
2183 ;; most effective if `c-parse-state' is used on each line while moving
2184 ;; forward.
2185
2186 (defvar c-state-cache-good-pos 1)
2187 (make-variable-buffer-local 'c-state-cache-good-pos)
2188 ;; This is a position where `c-state-cache' is known to be correct, or
2189 ;; nil (see below). It's a position inside one of the recorded unclosed
2190 ;; parens or the top level, but not further nested inside any literal or
2191 ;; subparen that is closed before the last recorded position.
2192 ;;
2193 ;; The exact position is chosen to try to be close to yet earlier than
2194 ;; the position where `c-state-cache' will be called next. Right now
2195 ;; the heuristic is to set it to the position after the last found
2196 ;; closing paren (of any type) before the line on which
2197 ;; `c-parse-state' was called. That is chosen primarily to work well
2198 ;; with refontification of the current line.
2199 ;;
2200 ;; 2009-07-28: When `c-state-point-min' and the last position where
2201 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2202 ;; both in the same literal, there is no such "good position", and
2203 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2204 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2205 ;;
2206 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2207 ;; the middle of the desert, as long as it is not within a brace pair
2208 ;; recorded in `c-state-cache' or a paren/bracket pair.
2209
2210 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2211 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2212 ;; speed up testing for non-literality.
2213 (defconst c-state-nonlit-pos-interval 3000)
2214 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2215
2216 (defvar c-state-nonlit-pos-cache nil)
2217 (make-variable-buffer-local 'c-state-nonlit-pos-cache)
2218 ;; A list of buffer positions which are known not to be in a literal or a cpp
2219 ;; construct. This is ordered with higher positions at the front of the list.
2220 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2221
2222 (defvar c-state-nonlit-pos-cache-limit 1)
2223 (make-variable-buffer-local 'c-state-nonlit-pos-cache-limit)
2224 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2225 ;; reduced by buffer changes, and increased by invocations of
2226 ;; `c-state-literal-at'.
2227
2228 (defvar c-state-semi-nonlit-pos-cache nil)
2229 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache)
2230 ;; A list of buffer positions which are known not to be in a literal. This is
2231 ;; ordered with higher positions at the front of the list. Only those which
2232 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2233
2234 (defvar c-state-semi-nonlit-pos-cache-limit 1)
2235 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache-limit)
2236 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2237 ;; reduced by buffer changes, and increased by invocations of
2238 ;; `c-state-literal-at'. FIXME!!!
2239
2240 (defsubst c-state-pp-to-literal (from to &optional not-in-delimiter)
2241 ;; Do a parse-partial-sexp from FROM to TO, returning either
2242 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2243 ;; (STATE) otherwise,
2244 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2245 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2246 ;;
2247 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2248 ;; comment opener, this is recognized as being in a comment literal.
2249 ;;
2250 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2251 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2252 ;; STATE are valid.
2253 (save-excursion
2254 (let ((s (parse-partial-sexp from to))
2255 ty co-st)
2256 (cond
2257 ((or (nth 3 s) (nth 4 s)) ; in a string or comment
2258 (setq ty (cond
2259 ((nth 3 s) 'string)
2260 ((nth 7 s) 'c++)
2261 (t 'c)))
2262 (parse-partial-sexp (point) (point-max)
2263 nil ; TARGETDEPTH
2264 nil ; STOPBEFORE
2265 s ; OLDSTATE
2266 'syntax-table) ; stop at end of literal
2267 `(,s ,ty (,(nth 8 s) . ,(point))))
2268
2269 ((and (not not-in-delimiter) ; inside a comment starter
2270 (not (bobp))
2271 (progn (backward-char)
2272 (and (not (looking-at "\\s!"))
2273 (looking-at c-comment-start-regexp))))
2274 (setq ty (if (looking-at c-block-comment-start-regexp) 'c 'c++)
2275 co-st (point))
2276 (forward-comment 1)
2277 `(,s ,ty (,co-st . ,(point))))
2278
2279 (t `(,s))))))
2280
2281 (defun c-state-safe-place (here)
2282 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2283 ;; string, comment, or macro.
2284 ;;
2285 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2286 ;; MAY NOT contain any positions within macros, since macros are frequently
2287 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2288 ;; We cannot rely on this mechanism whilst determining a cache pos since
2289 ;; this function is also called from outwith `c-parse-state'.
2290 (save-restriction
2291 (widen)
2292 (save-excursion
2293 (let ((c c-state-nonlit-pos-cache)
2294 pos npos high-pos lit macro-beg macro-end)
2295 ;; Trim the cache to take account of buffer changes.
2296 (while (and c (> (car c) c-state-nonlit-pos-cache-limit))
2297 (setq c (cdr c)))
2298 (setq c-state-nonlit-pos-cache c)
2299
2300 (while (and c (> (car c) here))
2301 (setq high-pos (car c))
2302 (setq c (cdr c)))
2303 (setq pos (or (car c) (point-min)))
2304
2305 (unless high-pos
2306 (while
2307 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2308 (and
2309 (setq npos
2310 (when (<= (+ pos c-state-nonlit-pos-interval) here)
2311 (+ pos c-state-nonlit-pos-interval)))
2312
2313 ;; Test for being in a literal. If so, go to after it.
2314 (progn
2315 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2316 (or (null lit)
2317 (prog1 (<= (cdr lit) here)
2318 (setq npos (cdr lit)))))
2319
2320 ;; Test for being in a macro. If so, go to after it.
2321 (progn
2322 (goto-char npos)
2323 (setq macro-beg
2324 (and (c-beginning-of-macro) (/= (point) npos) (point)))
2325 (when macro-beg
2326 (c-syntactic-end-of-macro)
2327 (or (eobp) (forward-char))
2328 (setq macro-end (point)))
2329 (or (null macro-beg)
2330 (prog1 (<= macro-end here)
2331 (setq npos macro-end)))))
2332
2333 (setq pos npos)
2334 (setq c-state-nonlit-pos-cache (cons pos c-state-nonlit-pos-cache)))
2335 ;; Add one extra element above HERE so as to to avoid the previous
2336 ;; expensive calculation when the next call is close to the current
2337 ;; one. This is especially useful when inside a large macro.
2338 (when npos
2339 (setq c-state-nonlit-pos-cache
2340 (cons npos c-state-nonlit-pos-cache))))
2341
2342 (if (> pos c-state-nonlit-pos-cache-limit)
2343 (setq c-state-nonlit-pos-cache-limit pos))
2344 pos))))
2345
2346 (defun c-state-semi-safe-place (here)
2347 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2348 ;; string or comment. It may be in a macro.
2349 (save-restriction
2350 (widen)
2351 (save-excursion
2352 (let ((c c-state-semi-nonlit-pos-cache)
2353 pos npos high-pos lit macro-beg macro-end)
2354 ;; Trim the cache to take account of buffer changes.
2355 (while (and c (> (car c) c-state-semi-nonlit-pos-cache-limit))
2356 (setq c (cdr c)))
2357 (setq c-state-semi-nonlit-pos-cache c)
2358
2359 (while (and c (> (car c) here))
2360 (setq high-pos (car c))
2361 (setq c (cdr c)))
2362 (setq pos (or (car c) (point-min)))
2363
2364 (unless high-pos
2365 (while
2366 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2367 (and
2368 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2369
2370 ;; Test for being in a literal. If so, go to after it.
2371 (progn
2372 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2373 (or (null lit)
2374 (prog1 (<= (cdr lit) here)
2375 (setq npos (cdr lit))))))
2376
2377 (setq pos npos)
2378 (setq c-state-semi-nonlit-pos-cache
2379 (cons pos c-state-semi-nonlit-pos-cache))))
2380
2381 (if (> pos c-state-semi-nonlit-pos-cache-limit)
2382 (setq c-state-semi-nonlit-pos-cache-limit pos))
2383 pos))))
2384
2385 (defun c-state-literal-at (here)
2386 ;; If position HERE is inside a literal, return (START . END), the
2387 ;; boundaries of the literal (which may be outside the accessible bit of the
2388 ;; buffer). Otherwise, return nil.
2389 ;;
2390 ;; This function is almost the same as `c-literal-limits'. Previously, it
2391 ;; differed in that it was a lower level function, and that it rigorously
2392 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2393 ;; virtually identical to this function.
2394 (save-restriction
2395 (widen)
2396 (save-excursion
2397 (let ((pos (c-state-safe-place here)))
2398 (car (cddr (c-state-pp-to-literal pos here)))))))
2399
2400 (defsubst c-state-lit-beg (pos)
2401 ;; Return the start of the literal containing POS, or POS itself.
2402 (or (car (c-state-literal-at pos))
2403 pos))
2404
2405 (defsubst c-state-cache-non-literal-place (pos state)
2406 ;; Return a position outside of a string/comment/macro at or before POS.
2407 ;; STATE is the parse-partial-sexp state at POS.
2408 (let ((res (if (or (nth 3 state) ; in a string?
2409 (nth 4 state)) ; in a comment?
2410 (nth 8 state)
2411 pos)))
2412 (save-excursion
2413 (goto-char res)
2414 (if (c-beginning-of-macro)
2415 (point)
2416 res))))
2417
2418 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2419 ;; Stuff to do with point-min, and coping with any literal there.
2420 (defvar c-state-point-min 1)
2421 (make-variable-buffer-local 'c-state-point-min)
2422 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2423 ;; narrowing is likely to affect the parens that are visible before the point.
2424
2425 (defvar c-state-point-min-lit-type nil)
2426 (make-variable-buffer-local 'c-state-point-min-lit-type)
2427 (defvar c-state-point-min-lit-start nil)
2428 (make-variable-buffer-local 'c-state-point-min-lit-start)
2429 ;; These two variables define the literal, if any, containing point-min.
2430 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2431 ;; literal. If there's no literal there, they're both nil.
2432
2433 (defvar c-state-min-scan-pos 1)
2434 (make-variable-buffer-local 'c-state-min-scan-pos)
2435 ;; This is the earliest buffer-pos from which scanning can be done. It is
2436 ;; either the end of the literal containing point-min, or point-min itself.
2437 ;; It becomes nil if the buffer is changed earlier than this point.
2438 (defun c-state-get-min-scan-pos ()
2439 ;; Return the lowest valid scanning pos. This will be the end of the
2440 ;; literal enclosing point-min, or point-min itself.
2441 (or c-state-min-scan-pos
2442 (save-restriction
2443 (save-excursion
2444 (widen)
2445 (goto-char c-state-point-min-lit-start)
2446 (if (eq c-state-point-min-lit-type 'string)
2447 (forward-sexp)
2448 (forward-comment 1))
2449 (setq c-state-min-scan-pos (point))))))
2450
2451 (defun c-state-mark-point-min-literal ()
2452 ;; Determine the properties of any literal containing POINT-MIN, setting the
2453 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2454 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2455 (let ((p-min (point-min))
2456 lit)
2457 (save-restriction
2458 (widen)
2459 (setq lit (c-state-literal-at p-min))
2460 (if lit
2461 (setq c-state-point-min-lit-type
2462 (save-excursion
2463 (goto-char (car lit))
2464 (cond
2465 ((looking-at c-block-comment-start-regexp) 'c)
2466 ((looking-at c-line-comment-starter) 'c++)
2467 (t 'string)))
2468 c-state-point-min-lit-start (car lit)
2469 c-state-min-scan-pos (cdr lit))
2470 (setq c-state-point-min-lit-type nil
2471 c-state-point-min-lit-start nil
2472 c-state-min-scan-pos p-min)))))
2473
2474
2475 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2476 ;; A variable which signals a brace dessert - helpful for reducing the number
2477 ;; of fruitless backward scans.
2478 (defvar c-state-brace-pair-desert nil)
2479 (make-variable-buffer-local 'c-state-brace-pair-desert)
2480 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2481 ;; that defun has searched backwards for a brace pair and not found one. Its
2482 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2483 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2484 ;; nil when at top level) and FROM is where the backward search started. It
2485 ;; is reset to nil in `c-invalidate-state-cache'.
2486
2487
2488 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2489 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2490 ;; list of like structure.
2491 (defmacro c-state-cache-top-lparen (&optional cache)
2492 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2493 ;; (default `c-state-cache') (or nil).
2494 (let ((cash (or cache 'c-state-cache)))
2495 `(if (consp (car ,cash))
2496 (caar ,cash)
2497 (car ,cash))))
2498
2499 (defmacro c-state-cache-top-paren (&optional cache)
2500 ;; Return the address of the latest brace/bracket/paren (whether left or
2501 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2502 (let ((cash (or cache 'c-state-cache)))
2503 `(if (consp (car ,cash))
2504 (cdar ,cash)
2505 (car ,cash))))
2506
2507 (defmacro c-state-cache-after-top-paren (&optional cache)
2508 ;; Return the position just after the latest brace/bracket/paren (whether
2509 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2510 (let ((cash (or cache 'c-state-cache)))
2511 `(if (consp (car ,cash))
2512 (cdar ,cash)
2513 (and (car ,cash)
2514 (1+ (car ,cash))))))
2515
2516 (defun c-get-cache-scan-pos (here)
2517 ;; From the state-cache, determine the buffer position from which we might
2518 ;; scan forward to HERE to update this cache. This position will be just
2519 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2520 ;; return the earliest position in the accessible region which isn't within
2521 ;; a literal. If the visible portion of the buffer is entirely within a
2522 ;; literal, return NIL.
2523 (let ((c c-state-cache) elt)
2524 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2525 (while (and c
2526 (>= (c-state-cache-top-lparen c) here))
2527 (setq c (cdr c)))
2528
2529 (setq elt (car c))
2530 (cond
2531 ((consp elt)
2532 (if (> (cdr elt) here)
2533 (1+ (car elt))
2534 (cdr elt)))
2535 (elt (1+ elt))
2536 ((<= (c-state-get-min-scan-pos) here)
2537 (c-state-get-min-scan-pos))
2538 (t nil))))
2539
2540 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2541 ;; Variables which keep track of preprocessor constructs.
2542 (defvar c-state-old-cpp-beg-marker nil)
2543 (make-variable-buffer-local 'c-state-old-cpp-beg-marker)
2544 (defvar c-state-old-cpp-beg nil)
2545 (make-variable-buffer-local 'c-state-old-cpp-beg)
2546 (defvar c-state-old-cpp-end-marker nil)
2547 (make-variable-buffer-local 'c-state-old-cpp-end-marker)
2548 (defvar c-state-old-cpp-end nil)
2549 (make-variable-buffer-local 'c-state-old-cpp-end)
2550 ;; These are the limits of the macro containing point at the previous call of
2551 ;; `c-parse-state', or nil.
2552
2553 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2554 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2555 (defun c-get-fallback-scan-pos (here)
2556 ;; Return a start position for building `c-state-cache' from
2557 ;; scratch. This will be at the top level, 2 defuns back.
2558 (save-excursion
2559 ;; Go back 2 bods, but ignore any bogus positions returned by
2560 ;; beginning-of-defun (i.e. open paren in column zero).
2561 (goto-char here)
2562 (let ((cnt 2))
2563 (while (not (or (bobp) (zerop cnt)))
2564 (c-beginning-of-defun-1) ; Pure elisp BOD.
2565 (if (eq (char-after) ?\{)
2566 (setq cnt (1- cnt)))))
2567 (point)))
2568
2569 (defun c-state-balance-parens-backwards (here- here+ top)
2570 ;; Return the position of the opening paren/brace/bracket before HERE- which
2571 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2572 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2573 ;;
2574 ;; ............................................
2575 ;; | |
2576 ;; ( [ ( .........#macro.. ) ( ) ] )
2577 ;; ^ ^ ^ ^
2578 ;; | | | |
2579 ;; return HERE- HERE+ TOP
2580 ;;
2581 ;; If there aren't enough opening paren/brace/brackets, return the position
2582 ;; of the outermost one found, or HERE- if there are none. If there are no
2583 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2584 ;; must not be inside literals. Only the accessible portion of the buffer
2585 ;; will be scanned.
2586
2587 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2588 ;; `here'. Go round the next loop each time we pass over such a ")". These
2589 ;; probably match "("s before `here-'.
2590 (let (pos pa ren+1 lonely-rens)
2591 (save-excursion
2592 (save-restriction
2593 (narrow-to-region (point-min) top) ; This can move point, sometimes.
2594 (setq pos here+)
2595 (c-safe
2596 (while
2597 (setq ren+1 (c-sc-scan-lists pos 1 1)) ; might signal
2598 (setq lonely-rens (cons ren+1 lonely-rens)
2599 pos ren+1)))))
2600
2601 ;; PART 2: Scan back before `here-' searching for the "("s
2602 ;; matching/mismatching the ")"s found above. We only need to direct the
2603 ;; caller to scan when we've encountered unmatched right parens.
2604 (setq pos here-)
2605 (when lonely-rens
2606 (c-safe
2607 (while
2608 (and lonely-rens ; actual values aren't used.
2609 (setq pa (c-sc-scan-lists pos -1 1)))
2610 (setq pos pa)
2611 (setq lonely-rens (cdr lonely-rens)))))
2612 pos))
2613
2614 (defun c-parse-state-get-strategy (here good-pos)
2615 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2616 ;; to minimize the amount of scanning. HERE is the pertinent position in
2617 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2618 ;; its head trimmed) is known to be good, or nil if there is no such
2619 ;; position.
2620 ;;
2621 ;; The return value is a list, one of the following:
2622 ;;
2623 ;; o - ('forward START-POINT) - scan forward from START-POINT,
2624 ;; which is not less than the highest position in `c-state-cache' below HERE,
2625 ;; which is after GOOD-POS.
2626 ;; o - ('backward nil) - scan backwards (from HERE).
2627 ;; o - ('back-and-forward START-POINT) - like 'forward, but when HERE is earlier
2628 ;; than GOOD-POS.
2629 ;; o - ('BOD START-POINT) - scan forwards from START-POINT, which is at the
2630 ;; top level.
2631 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
2632 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
2633 BOD-pos ; position of 2nd BOD before HERE.
2634 strategy ; 'forward, 'backward, 'BOD, or 'IN-LIT.
2635 start-point
2636 how-far) ; putative scanning distance.
2637 (setq good-pos (or good-pos (c-state-get-min-scan-pos)))
2638 (cond
2639 ((< here (c-state-get-min-scan-pos))
2640 (setq strategy 'IN-LIT
2641 start-point nil
2642 cache-pos nil
2643 how-far 0))
2644 ((<= good-pos here)
2645 (setq strategy 'forward
2646 start-point (max good-pos cache-pos)
2647 how-far (- here start-point)))
2648 ((< (- good-pos here) (- here cache-pos)) ; FIXME!!! ; apply some sort of weighting.
2649 (setq strategy 'backward
2650 how-far (- good-pos here)))
2651 (t
2652 (setq strategy 'back-and-forward
2653 start-point cache-pos
2654 how-far (- here start-point))))
2655
2656 ;; Might we be better off starting from the top level, two defuns back,
2657 ;; instead? This heuristic no longer works well in C++, where
2658 ;; declarations inside namespace brace blocks are frequently placed at
2659 ;; column zero. (2015-11-10): Remove the condition on C++ Mode.
2660 (when (and (or (not (memq 'col-0-paren c-emacs-features))
2661 open-paren-in-column-0-is-defun-start)
2662 ;; (not (c-major-mode-is 'c++-mode))
2663 (> how-far c-state-cache-too-far))
2664 (setq BOD-pos (c-get-fallback-scan-pos here)) ; somewhat EXPENSIVE!!!
2665 (if (< (- here BOD-pos) how-far)
2666 (setq strategy 'BOD
2667 start-point BOD-pos)))
2668
2669 (list strategy start-point)))
2670
2671
2672 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2673 ;; Routines which change `c-state-cache' and associated values.
2674 (defun c-renarrow-state-cache ()
2675 ;; The region (more precisely, point-min) has changed since we
2676 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2677 (if (< (point-min) c-state-point-min)
2678 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2679 ;; It would be possible to do a better job here and recalculate the top
2680 ;; only.
2681 (progn
2682 (c-state-mark-point-min-literal)
2683 (setq c-state-cache nil
2684 c-state-cache-good-pos c-state-min-scan-pos
2685 c-state-brace-pair-desert nil))
2686
2687 ;; point-min has MOVED FORWARD.
2688
2689 ;; Is the new point-min inside a (different) literal?
2690 (unless (and c-state-point-min-lit-start ; at prev. point-min
2691 (< (point-min) (c-state-get-min-scan-pos)))
2692 (c-state-mark-point-min-literal))
2693
2694 ;; Cut off a bit of the tail from `c-state-cache'.
2695 (let ((ptr (cons nil c-state-cache))
2696 pa)
2697 (while (and (setq pa (c-state-cache-top-lparen (cdr ptr)))
2698 (>= pa (point-min)))
2699 (setq ptr (cdr ptr)))
2700
2701 (when (consp ptr)
2702 (if (eq (cdr ptr) c-state-cache)
2703 (setq c-state-cache nil
2704 c-state-cache-good-pos c-state-min-scan-pos)
2705 (setcdr ptr nil)
2706 (setq c-state-cache-good-pos (1+ (c-state-cache-top-lparen))))
2707 )))
2708
2709 (setq c-state-point-min (point-min)))
2710
2711 (defun c-append-lower-brace-pair-to-state-cache (from here &optional upper-lim)
2712 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2713 ;; of nesting (not necessarily immediately preceding), push a cons onto
2714 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2715 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2716 ;; UPPER-LIM.
2717 ;;
2718 ;; Return non-nil when this has been done.
2719 ;;
2720 ;; The situation it copes with is this transformation:
2721 ;;
2722 ;; OLD: { (.) {...........}
2723 ;; ^ ^
2724 ;; FROM HERE
2725 ;;
2726 ;; NEW: { {....} (.) {.........
2727 ;; ^ ^ ^
2728 ;; LOWER BRACE PAIR HERE or HERE
2729 ;;
2730 ;; This routine should be fast. Since it can get called a LOT, we maintain
2731 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2732 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2733 (save-excursion
2734 (save-restriction
2735 (let* (new-cons
2736 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2737 (macro-start-or-from
2738 (progn (goto-char from)
2739 (c-beginning-of-macro)
2740 (point)))
2741 (bra ; Position of "{".
2742 ;; Don't start scanning in the middle of a CPP construct unless
2743 ;; it contains HERE - these constructs, in Emacs, are "commented
2744 ;; out" with category properties.
2745 (if (eq (c-get-char-property macro-start-or-from 'category)
2746 'c-cpp-delimiter)
2747 macro-start-or-from
2748 from))
2749 ce) ; Position of "}"
2750 (or upper-lim (setq upper-lim from))
2751
2752 ;; If we're essentially repeating a fruitless search, just give up.
2753 (unless (and c-state-brace-pair-desert
2754 (eq cache-pos (car c-state-brace-pair-desert))
2755 (or (null (car c-state-brace-pair-desert))
2756 (> from (car c-state-brace-pair-desert)))
2757 (<= from (cdr c-state-brace-pair-desert)))
2758 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2759 (let ((desert-lim
2760 (and c-state-brace-pair-desert
2761 (eq cache-pos (car c-state-brace-pair-desert))
2762 (>= from (cdr c-state-brace-pair-desert))
2763 (cdr c-state-brace-pair-desert)))
2764 ;; CACHE-LIM. This limit will be necessary when an opening
2765 ;; paren at `cache-pos' has just had its matching close paren
2766 ;; inserted into the buffer. `cache-pos' continues to be a
2767 ;; search bound, even though the algorithm below would skip
2768 ;; over the new paren pair.
2769 (cache-lim (and cache-pos (< cache-pos from) cache-pos)))
2770 (narrow-to-region
2771 (cond
2772 ((and desert-lim cache-lim)
2773 (max desert-lim cache-lim))
2774 (desert-lim)
2775 (cache-lim)
2776 ((point-min)))
2777 ;; The top limit is EOB to ensure that `bra' is inside the
2778 ;; accessible part of the buffer at the next scan operation.
2779 (1+ (buffer-size))))
2780
2781 ;; In the next pair of nested loops, the inner one moves back past a
2782 ;; pair of (mis-)matching parens or brackets; the outer one moves
2783 ;; back over a sequence of unmatched close brace/paren/bracket each
2784 ;; time round.
2785 (while
2786 (progn
2787 (c-safe
2788 (while
2789 (and (setq ce (c-sc-scan-lists bra -1 -1)) ; back past )/]/}; might signal
2790 (setq bra (c-sc-scan-lists ce -1 1)) ; back past (/[/{; might signal
2791 (or (> bra here) ;(> ce here)
2792 (and
2793 (< ce here)
2794 (or (not (eq (char-after bra) ?\{))
2795 (and (goto-char bra)
2796 (c-beginning-of-macro)
2797 (< (point) macro-start-or-from))))))))
2798 (and ce (< ce bra)))
2799 (setq bra ce)) ; If we just backed over an unbalanced closing
2800 ; brace, ignore it.
2801
2802 (if (and ce (< ce here) (< bra ce) (eq (char-after bra) ?\{))
2803 ;; We've found the desired brace-pair.
2804 (progn
2805 (setq new-cons (cons bra (1+ ce)))
2806 (cond
2807 ((consp (car c-state-cache))
2808 (setcar c-state-cache new-cons))
2809 ((and (numberp (car c-state-cache)) ; probably never happens
2810 (< ce (car c-state-cache)))
2811 (setcdr c-state-cache
2812 (cons new-cons (cdr c-state-cache))))
2813 (t (setq c-state-cache (cons new-cons c-state-cache)))))
2814
2815 ;; We haven't found a brace pair. Record this in the cache.
2816 (setq c-state-brace-pair-desert
2817 (cons (if (and ce (< bra ce) (> ce here)) ; {..} straddling HERE?
2818 bra
2819 (point-min))
2820 (min here from)))))))))
2821
2822 (defsubst c-state-push-any-brace-pair (bra+1 macro-start-or-here)
2823 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2824 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2825 ;; "push" "a" brace pair onto `c-state-cache'.
2826 ;;
2827 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2828 ;; otherwise push it normally.
2829 ;;
2830 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2831 ;; latter is inside a macro, not being a macro containing
2832 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2833 ;; base pair. This latter case is assumed to be rare.
2834 ;;
2835 ;; Note: POINT is not preserved in this routine.
2836 (if bra+1
2837 (if (or (> bra+1 macro-start-or-here)
2838 (progn (goto-char bra+1)
2839 (not (c-beginning-of-macro))))
2840 (setq c-state-cache
2841 (cons (cons (1- bra+1)
2842 (c-sc-scan-lists bra+1 1 1))
2843 (if (consp (car c-state-cache))
2844 (cdr c-state-cache)
2845 c-state-cache)))
2846 ;; N.B. This defsubst codes one method for the simple, normal case,
2847 ;; and a more sophisticated, slower way for the general case. Don't
2848 ;; eliminate this defsubst - it's a speed optimization.
2849 (c-append-lower-brace-pair-to-state-cache (1- bra+1) (point-max)))))
2850
2851 (defun c-append-to-state-cache (from here)
2852 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
2853 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
2854 ;;
2855 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2856 ;; any. Typically, it is immediately after it. It must not be inside a
2857 ;; literal.
2858 (let ((here-bol (c-point 'bol here))
2859 (macro-start-or-here
2860 (save-excursion (goto-char here)
2861 (if (c-beginning-of-macro)
2862 (point)
2863 here)))
2864 pa+1 ; pos just after an opening PAren (or brace).
2865 (ren+1 from) ; usually a pos just after an closing paREN etc.
2866 ; Is actually the pos. to scan for a (/{/[ from,
2867 ; which sometimes is after a silly )/}/].
2868 paren+1 ; Pos after some opening or closing paren.
2869 paren+1s ; A list of `paren+1's; used to determine a
2870 ; good-pos.
2871 bra+1 ; just after L bra-ce.
2872 bra+1s ; list of OLD values of bra+1.
2873 mstart) ; start of a macro.
2874
2875 (save-excursion
2876 (save-restriction
2877 (narrow-to-region (point-min) here)
2878 ;; Each time round the following loop, we enter a successively deeper
2879 ;; level of brace/paren nesting. (Except sometimes we "continue at
2880 ;; the existing level".) `pa+1' is a pos inside an opening
2881 ;; brace/paren/bracket, usually just after it.
2882 (while
2883 (progn
2884 ;; Each time round the next loop moves forward over an opening then
2885 ;; a closing brace/bracket/paren. This loop is white hot, so it
2886 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2887 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2888 ;; call of `scan-lists' signals an error, which happens when there
2889 ;; are no more b/b/p's to scan.
2890 (c-safe
2891 (while t
2892 (setq pa+1 (c-sc-scan-lists ren+1 1 -1) ; Into (/{/[; might signal
2893 paren+1s (cons pa+1 paren+1s))
2894 (setq ren+1 (c-sc-scan-lists pa+1 1 1)) ; Out of )/}/]; might signal
2895 (if (and (eq (char-before pa+1) ?{)) ; Check for a macro later.
2896 (setq bra+1 pa+1))
2897 (setcar paren+1s ren+1)))
2898
2899 (if (and pa+1 (> pa+1 ren+1))
2900 ;; We've just entered a deeper nesting level.
2901 (progn
2902 ;; Insert the brace pair (if present) and the single open
2903 ;; paren/brace/bracket into `c-state-cache' It cannot be
2904 ;; inside a macro, except one around point, because of what
2905 ;; `c-neutralize-syntax-in-CPP' has done.
2906 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2907 ;; Insert the opening brace/bracket/paren position.
2908 (setq c-state-cache (cons (1- pa+1) c-state-cache))
2909 ;; Clear admin stuff for the next more nested part of the scan.
2910 (setq ren+1 pa+1 pa+1 nil bra+1 nil bra+1s nil)
2911 t) ; Carry on the loop
2912
2913 ;; All open p/b/b's at this nesting level, if any, have probably
2914 ;; been closed by matching/mismatching ones. We're probably
2915 ;; finished - we just need to check for having found an
2916 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2917 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2918 (c-safe (setq ren+1 (c-sc-scan-lists ren+1 1 1)))))) ; acts as loop control.
2919
2920 ;; Record the final, innermost, brace-pair if there is one.
2921 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2922
2923 ;; Determine a good pos
2924 (while (and (setq paren+1 (car paren+1s))
2925 (> (if (> paren+1 macro-start-or-here)
2926 paren+1
2927 (goto-char paren+1)
2928 (setq mstart (and (c-beginning-of-macro)
2929 (point)))
2930 (or mstart paren+1))
2931 here-bol))
2932 (setq paren+1s (cdr paren+1s)))
2933 (cond
2934 ((and paren+1 mstart)
2935 (min paren+1 mstart))
2936 (paren+1)
2937 (t from))))))
2938
2939 (defun c-remove-stale-state-cache (start-point here pps-point)
2940 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2941 ;; not be in it when it is amended for position HERE. This may involve
2942 ;; replacing a CONS element for a brace pair containing HERE with its car.
2943 ;; Additionally, the "outermost" open-brace entry before HERE will be
2944 ;; converted to a cons if the matching close-brace is below HERE.
2945 ;;
2946 ;; START-POINT is a "maximal" "safe position" - there must be no open
2947 ;; parens/braces/brackets between START-POINT and HERE.
2948 ;;
2949 ;; As a second thing, calculate the result of parse-partial-sexp at
2950 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
2951 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2952 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2953 ;; needs to be FAST).
2954 ;;
2955 ;; Return a list (GOOD-POS SCAN-BACK-POS CONS-SEPARATED PPS-STATE), where
2956 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2957 ;; to be good (we aim for this to be as high as possible);
2958 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2959 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2960 ;; position to scan backwards from. It is the position of the "{" of the
2961 ;; last element to be removed from `c-state-cache', when that elt is a
2962 ;; cons, otherwise nil.
2963 ;; o - CONS-SEPARATED is t when a cons element in `c-state-cache' has been
2964 ;; replaced by its car because HERE lies inside the brace pair represented
2965 ;; by the cons.
2966 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2967 (save-excursion
2968 (save-restriction
2969 (narrow-to-region 1 (point-max))
2970 (let* ((in-macro-start ; start of macro containing HERE or nil.
2971 (save-excursion
2972 (goto-char here)
2973 (and (c-beginning-of-macro)
2974 (point))))
2975 (start-point-actual-macro-start ; Start of macro containing
2976 ; start-point or nil
2977 (and (< start-point here)
2978 (save-excursion
2979 (goto-char start-point)
2980 (and (c-beginning-of-macro)
2981 (point)))))
2982 (start-point-actual-macro-end ; End of this macro, (maybe
2983 ; HERE), or nil.
2984 (and start-point-actual-macro-start
2985 (save-excursion
2986 (goto-char start-point-actual-macro-start)
2987 (c-end-of-macro)
2988 (point))))
2989 pps-state ; Will be 9 or 10 elements long.
2990 pos
2991 upper-lim ; ,beyond which `c-state-cache' entries are removed
2992 scan-back-pos
2993 cons-separated
2994 pair-beg pps-point-state target-depth)
2995
2996 ;; Remove entries beyond HERE. Also remove any entries inside
2997 ;; a macro, unless HERE is in the same macro.
2998 (setq upper-lim
2999 (if (or (null c-state-old-cpp-beg)
3000 (and (> here c-state-old-cpp-beg)
3001 (< here c-state-old-cpp-end)))
3002 here
3003 (min here c-state-old-cpp-beg)))
3004 (while (and c-state-cache (>= (c-state-cache-top-lparen) upper-lim))
3005 (setq scan-back-pos (car-safe (car c-state-cache)))
3006 (setq c-state-cache (cdr c-state-cache)))
3007
3008 ;; If `upper-lim' is inside the last recorded brace pair, remove its
3009 ;; RBrace and indicate we'll need to search backwards for a previous
3010 ;; brace pair.
3011 (when (and c-state-cache
3012 (consp (car c-state-cache))
3013 (> (cdar c-state-cache) upper-lim))
3014 (setcar c-state-cache (caar c-state-cache))
3015 (setq scan-back-pos (car c-state-cache)
3016 cons-separated t))
3017
3018 ;; The next loop jumps forward out of a nested level of parens each
3019 ;; time round; the corresponding elements in `c-state-cache' are
3020 ;; removed. `pos' is just after the brace-pair or the open paren at
3021 ;; (car c-state-cache). There can be no open parens/braces/brackets
3022 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
3023 ;; due to the interface spec to this function.
3024 (setq pos (if (and start-point-actual-macro-end
3025 (not (eq start-point-actual-macro-start
3026 in-macro-start)))
3027 (1+ start-point-actual-macro-end) ; get outside the macro as
3028 ; marked by a `category' text property.
3029 start-point))
3030 (goto-char pos)
3031 (while (and c-state-cache
3032 (or (numberp (car c-state-cache)) ; Have we a { at all?
3033 (cdr c-state-cache))
3034 (< (point) here))
3035 (cond
3036 ((null pps-state) ; first time through
3037 (setq target-depth -1))
3038 ((eq (car pps-state) target-depth) ; found closing ),},]
3039 (setq target-depth (1- (car pps-state))))
3040 ;; Do nothing when we've merely reached pps-point.
3041 )
3042
3043 ;; Scan!
3044 (setq pps-state
3045 (c-sc-parse-partial-sexp
3046 (point) (if (< (point) pps-point) pps-point here)
3047 target-depth
3048 nil pps-state))
3049
3050 (if (= (point) pps-point)
3051 (setq pps-point-state pps-state))
3052
3053 (when (eq (car pps-state) target-depth)
3054 (setq pos (point)) ; POS is now just after an R-paren/brace.
3055 (cond
3056 ((and (consp (car c-state-cache))
3057 (eq (point) (cdar c-state-cache)))
3058 ;; We've just moved out of the paren pair containing the brace-pair
3059 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
3060 ;; and is potentially where the open brace of a cons in
3061 ;; c-state-cache will be.
3062 (setq pair-beg (car-safe (cdr c-state-cache))
3063 c-state-cache (cdr-safe (cdr c-state-cache)))) ; remove {}pair + containing Lparen.
3064 ((numberp (car c-state-cache))
3065 (setq pair-beg (car c-state-cache)
3066 c-state-cache (cdr c-state-cache))) ; remove this
3067 ; containing Lparen
3068 ((numberp (cadr c-state-cache))
3069 (setq pair-beg (cadr c-state-cache)
3070 c-state-cache (cddr c-state-cache))) ; Remove a paren pair
3071 ; together with enclosed brace pair.
3072 ;; (t nil) ; Ignore an unmated Rparen.
3073 )))
3074
3075 (if (< (point) pps-point)
3076 (setq pps-state (c-sc-parse-partial-sexp
3077 (point) pps-point
3078 nil nil ; TARGETDEPTH, STOPBEFORE
3079 pps-state)))
3080
3081 ;; If the last paren pair we moved out of was actually a brace pair,
3082 ;; insert it into `c-state-cache'.
3083 (when (and pair-beg (eq (char-after pair-beg) ?{))
3084 (if (consp (car-safe c-state-cache))
3085 (setq c-state-cache (cdr c-state-cache)))
3086 (setq c-state-cache (cons (cons pair-beg pos)
3087 c-state-cache)))
3088
3089 (list pos scan-back-pos cons-separated pps-state)))))
3090
3091 (defun c-remove-stale-state-cache-backwards (here)
3092 ;; Strip stale elements of `c-state-cache' by moving backwards through the
3093 ;; buffer, and inform the caller of the scenario detected.
3094 ;;
3095 ;; HERE is the position we're setting `c-state-cache' for.
3096 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
3097 ;; position in `c-state-cache' before HERE, or a position at or near
3098 ;; point-min which isn't in a literal.
3099 ;;
3100 ;; This function must only be called only when (> `c-state-cache-good-pos'
3101 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
3102 ;; optimized to eliminate (or minimize) scanning between these two
3103 ;; positions.
3104 ;;
3105 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3106 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3107 ;; could become so after missing elements are inserted into
3108 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3109 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3110 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3111 ;; before `here''s line, or the start of the literal containing it.
3112 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3113 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3114 ;; to scan backwards from.
3115 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3116 ;; POS and HERE which aren't recorded in `c-state-cache'.
3117 ;;
3118 ;; The comments in this defun use "paren" to mean parenthesis or square
3119 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3120 ;;
3121 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3122 ;; | | | | | |
3123 ;; CP E here D C good
3124 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
3125 (pos c-state-cache-good-pos)
3126 pa ren ; positions of "(" and ")"
3127 dropped-cons ; whether the last element dropped from `c-state-cache'
3128 ; was a cons (representing a brace-pair)
3129 good-pos ; see above.
3130 lit ; (START . END) of a literal containing some point.
3131 here-lit-start here-lit-end ; bounds of literal containing `here'
3132 ; or `here' itself.
3133 here- here+ ; start/end of macro around HERE, or HERE
3134 (here-bol (c-point 'bol here))
3135 (too-far-back (max (- here c-state-cache-too-far) (point-min))))
3136
3137 ;; Remove completely irrelevant entries from `c-state-cache'.
3138 (while (and c-state-cache
3139 (>= (setq pa (c-state-cache-top-lparen)) here))
3140 (setq dropped-cons (consp (car c-state-cache)))
3141 (setq c-state-cache (cdr c-state-cache))
3142 (setq pos pa))
3143 ;; At this stage, (>= pos here);
3144 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3145
3146 (cond
3147 ((and (consp (car c-state-cache))
3148 (> (cdar c-state-cache) here))
3149 ;; CASE 1: The top of the cache is a brace pair which now encloses
3150 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3151 ;; knowledge of what's inside these braces, we have no alternative but
3152 ;; to direct the caller to scan the buffer from the opening brace.
3153 (setq pos (caar c-state-cache))
3154 (setcar c-state-cache pos)
3155 (list (1+ pos) pos t)) ; return value. We've just converted a brace pair
3156 ; entry into a { entry, so the caller needs to
3157 ; search for a brace pair before the {.
3158
3159 ;; `here' might be inside a literal. Check for this.
3160 ((progn
3161 (setq lit (c-state-literal-at here)
3162 here-lit-start (or (car lit) here)
3163 here-lit-end (or (cdr lit) here))
3164 ;; Has `here' just "newly entered" a macro?
3165 (save-excursion
3166 (goto-char here-lit-start)
3167 (if (and (c-beginning-of-macro)
3168 (or (null c-state-old-cpp-beg)
3169 (not (= (point) c-state-old-cpp-beg))))
3170 (progn
3171 (setq here- (point))
3172 (c-end-of-macro)
3173 (setq here+ (point)))
3174 (setq here- here-lit-start
3175 here+ here-lit-end)))
3176
3177 ;; `here' might be nested inside any depth of parens (or brackets but
3178 ;; not braces). Scan backwards to find the outermost such opening
3179 ;; paren, if there is one. This will be the scan position to return.
3180 (save-restriction
3181 (narrow-to-region cache-pos (point-max))
3182 (setq pos (c-state-balance-parens-backwards here- here+ pos)))
3183 nil)) ; for the cond
3184
3185 ((< pos here-lit-start)
3186 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3187 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3188 ;; a brace pair preceding this, it will already be in `c-state-cache',
3189 ;; unless there was a brace pair after it, i.e. there'll only be one to
3190 ;; scan for if we've just deleted one.
3191 (list pos (and dropped-cons pos) t)) ; Return value.
3192
3193 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3194 ;; Further forward scanning isn't needed, but we still need to find a
3195 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3196 ((progn
3197 (save-restriction
3198 (narrow-to-region here-bol (point-max))
3199 (setq pos here-lit-start)
3200 (c-safe (while (setq pa (c-sc-scan-lists pos -1 1))
3201 (setq pos pa)))) ; might signal
3202 nil)) ; for the cond
3203
3204 ((save-restriction
3205 (narrow-to-region too-far-back (point-max))
3206 (setq ren (c-safe (c-sc-scan-lists pos -1 -1))))
3207 ;; CASE 3: After a }/)/] before `here''s BOL.
3208 (list (1+ ren) (and dropped-cons pos) nil)) ; Return value
3209
3210 ((progn (setq good-pos (c-state-lit-beg (c-point 'bopl here-bol)))
3211 (>= cache-pos good-pos))
3212 ;; CASE 3.5: Just after an existing entry in `c-state-cache' on `here''s
3213 ;; line or the previous line.
3214 (list cache-pos nil nil))
3215
3216 (t
3217 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3218 ;; literal containing it.
3219 (list good-pos (and dropped-cons good-pos) nil)))))
3220
3221
3222 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3223 ;; Externally visible routines.
3224
3225 (defun c-state-cache-init ()
3226 (setq c-state-cache nil
3227 c-state-cache-good-pos 1
3228 c-state-nonlit-pos-cache nil
3229 c-state-nonlit-pos-cache-limit 1
3230 c-state-semi-nonlit-pos-cache nil
3231 c-state-semi-nonlit-pos-cache-limit 1
3232 c-state-brace-pair-desert nil
3233 c-state-point-min 1
3234 c-state-point-min-lit-type nil
3235 c-state-point-min-lit-start nil
3236 c-state-min-scan-pos 1
3237 c-state-old-cpp-beg nil
3238 c-state-old-cpp-end nil)
3239 (c-state-mark-point-min-literal))
3240
3241 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3242 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3243 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3244 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3245 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3246 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3247 ;; (defun c-state-dump ()
3248 ;; ;; For debugging.
3249 ;; ;(message
3250 ;; (concat
3251 ;; (c-sc-qde c-state-cache)
3252 ;; (c-sc-de c-state-cache-good-pos)
3253 ;; (c-sc-qde c-state-nonlit-pos-cache)
3254 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3255 ;; (c-sc-qde c-state-brace-pair-desert)
3256 ;; (c-sc-de c-state-point-min)
3257 ;; (c-sc-de c-state-point-min-lit-type)
3258 ;; (c-sc-de c-state-point-min-lit-start)
3259 ;; (c-sc-de c-state-min-scan-pos)
3260 ;; (c-sc-de c-state-old-cpp-beg)
3261 ;; (c-sc-de c-state-old-cpp-end)))
3262 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3263
3264 (defun c-invalidate-state-cache-1 (here)
3265 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3266 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3267 ;; left in a consistent state.
3268 ;;
3269 ;; This is much like `c-whack-state-after', but it never changes a paren
3270 ;; pair element into an open paren element. Doing that would mean that the
3271 ;; new open paren wouldn't have the required preceding paren pair element.
3272 ;;
3273 ;; This function is called from c-before-change.
3274
3275 ;; The caches of non-literals:
3276 ;; Note that we use "<=" for the possibility of the second char of a two-char
3277 ;; comment opener being typed; this would invalidate any cache position at
3278 ;; HERE.
3279 (if (<= here c-state-nonlit-pos-cache-limit)
3280 (setq c-state-nonlit-pos-cache-limit (1- here)))
3281 (if (<= here c-state-semi-nonlit-pos-cache-limit)
3282 (setq c-state-semi-nonlit-pos-cache-limit (1- here)))
3283
3284 ;; `c-state-cache':
3285 ;; Case 1: if `here' is in a literal containing point-min, everything
3286 ;; becomes (or is already) nil.
3287 (if (or (null c-state-cache-good-pos)
3288 (< here (c-state-get-min-scan-pos)))
3289 (setq c-state-cache nil
3290 c-state-cache-good-pos nil
3291 c-state-min-scan-pos nil)
3292
3293 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3294 ;; below `here'. To maintain its consistency, we may need to insert a new
3295 ;; brace pair.
3296 (let ((here-bol (c-point 'bol here))
3297 too-high-pa ; recorded {/(/[ next above or just below here, or nil.
3298 dropped-cons ; was the last removed element a brace pair?
3299 pa)
3300 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3301 (while (and c-state-cache
3302 (>= (setq pa (c-state-cache-top-paren)) here))
3303 (setq dropped-cons (consp (car c-state-cache))
3304 too-high-pa (c-state-cache-top-lparen)
3305 c-state-cache (cdr c-state-cache)))
3306
3307 ;; Do we need to add in an earlier brace pair, having lopped one off?
3308 (if (and dropped-cons
3309 (<= too-high-pa here))
3310 (c-append-lower-brace-pair-to-state-cache too-high-pa here here-bol))
3311 (setq c-state-cache-good-pos (or (c-state-cache-after-top-paren)
3312 (c-state-get-min-scan-pos)))))
3313
3314 ;; The brace-pair desert marker:
3315 (when (car c-state-brace-pair-desert)
3316 (if (< here (car c-state-brace-pair-desert))
3317 (setq c-state-brace-pair-desert nil)
3318 (if (< here (cdr c-state-brace-pair-desert))
3319 (setcdr c-state-brace-pair-desert here)))))
3320
3321 (defun c-parse-state-1 ()
3322 ;; Find and record all noteworthy parens between some good point earlier in
3323 ;; the file and point. That good point is at least the beginning of the
3324 ;; top-level construct we are in, or the beginning of the preceding
3325 ;; top-level construct if we aren't in one.
3326 ;;
3327 ;; The returned value is a list of the noteworthy parens with the last one
3328 ;; first. If an element in the list is an integer, it's the position of an
3329 ;; open paren (of any type) which has not been closed before the point. If
3330 ;; an element is a cons, it gives the position of a closed BRACE paren
3331 ;; pair[*]; the car is the start brace position and the cdr is the position
3332 ;; following the closing brace. Only the last closed brace paren pair
3333 ;; before each open paren and before the point is recorded, and thus the
3334 ;; state never contains two cons elements in succession. When a close brace
3335 ;; has no matching open brace (e.g., the matching brace is outside the
3336 ;; visible region), it is not represented in the returned value.
3337 ;;
3338 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3339 ;; This defun explicitly treats mismatching parens/braces/brackets as
3340 ;; matching. It is the open brace which makes it a "brace" pair.
3341 ;;
3342 ;; If POINT is within a macro, open parens and brace pairs within
3343 ;; THIS macro MIGHT be recorded. This depends on whether their
3344 ;; syntactic properties have been suppressed by
3345 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3346 ;;
3347 ;; Currently no characters which are given paren syntax with the
3348 ;; syntax-table property are recorded, i.e. angle bracket arglist
3349 ;; parens are never present here. Note that this might change.
3350 ;;
3351 ;; BUG: This function doesn't cope entirely well with unbalanced
3352 ;; parens in macros. (2008-12-11: this has probably been resolved
3353 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3354 ;; following case the brace before the macro isn't balanced with the
3355 ;; one after it:
3356 ;;
3357 ;; {
3358 ;; #define X {
3359 ;; }
3360 ;;
3361 ;; Note to maintainers: this function DOES get called with point
3362 ;; within comments and strings, so don't assume it doesn't!
3363 ;;
3364 ;; This function might do hidden buffer changes.
3365 (let* ((here (point))
3366 (here-bopl (c-point 'bopl))
3367 strategy ; 'forward, 'backward etc..
3368 ;; Candidate positions to start scanning from:
3369 cache-pos ; highest position below HERE already existing in
3370 ; cache (or 1).
3371 good-pos
3372 start-point ; (when scanning forward) a place below HERE where there
3373 ; are no open parens/braces between it and HERE.
3374 bopl-state
3375 res
3376 cons-separated
3377 scan-backward-pos scan-forward-p) ; used for 'backward.
3378 ;; If POINT-MIN has changed, adjust the cache
3379 (unless (= (point-min) c-state-point-min)
3380 (c-renarrow-state-cache))
3381
3382 ;; Strategy?
3383 (setq res (c-parse-state-get-strategy here c-state-cache-good-pos)
3384 strategy (car res)
3385 start-point (cadr res))
3386
3387 (when (eq strategy 'BOD)
3388 (setq c-state-cache nil
3389 c-state-cache-good-pos start-point))
3390
3391 ;; SCAN!
3392 (cond
3393 ((memq strategy '(forward back-and-forward BOD))
3394 (setq res (c-remove-stale-state-cache start-point here here-bopl))
3395 (setq cache-pos (car res)
3396 scan-backward-pos (cadr res)
3397 cons-separated (car (cddr res))
3398 bopl-state (cadr (cddr res))) ; will be nil if (< here-bopl
3399 ; start-point)
3400 (if (and scan-backward-pos
3401 (or cons-separated (eq strategy 'forward))) ;scan-backward-pos
3402 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3403 (setq good-pos
3404 (c-append-to-state-cache cache-pos here))
3405 (setq c-state-cache-good-pos
3406 (if (and bopl-state
3407 (< good-pos (- here c-state-cache-too-far)))
3408 (c-state-cache-non-literal-place here-bopl bopl-state)
3409 good-pos)))
3410
3411 ((eq strategy 'backward)
3412 (setq res (c-remove-stale-state-cache-backwards here)
3413 good-pos (car res)
3414 scan-backward-pos (cadr res)
3415 scan-forward-p (car (cddr res)))
3416 (if scan-backward-pos
3417 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3418 (setq c-state-cache-good-pos
3419 (if scan-forward-p
3420 (c-append-to-state-cache good-pos here)
3421 good-pos)))
3422
3423 (t ; (eq strategy 'IN-LIT)
3424 (setq c-state-cache nil
3425 c-state-cache-good-pos nil))))
3426
3427 c-state-cache)
3428
3429 (defun c-invalidate-state-cache (here)
3430 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3431 ;;
3432 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3433 ;; of all parens in preprocessor constructs, except for any such construct
3434 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3435 ;; worrying further about macros and template delimiters.
3436 (if (eval-when-compile (memq 'category-properties c-emacs-features))
3437 ;; Emacs
3438 (c-with-<->-as-parens-suppressed
3439 (if (and c-state-old-cpp-beg
3440 (< c-state-old-cpp-beg here))
3441 (c-with-all-but-one-cpps-commented-out
3442 c-state-old-cpp-beg
3443 c-state-old-cpp-end
3444 (c-invalidate-state-cache-1 here))
3445 (c-with-cpps-commented-out
3446 (c-invalidate-state-cache-1 here))))
3447 ;; XEmacs
3448 (c-invalidate-state-cache-1 here)))
3449
3450 (defmacro c-state-maybe-marker (place marker)
3451 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3452 ;; We (re)use MARKER.
3453 `(and ,place
3454 (or ,marker (setq ,marker (make-marker)))
3455 (set-marker ,marker ,place)))
3456
3457 (defun c-parse-state ()
3458 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3459 ;; description of the functionality and return value.
3460 ;;
3461 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3462 ;; of all parens in preprocessor constructs, except for any such construct
3463 ;; containing point. We can then call `c-parse-state-1' without worrying
3464 ;; further about macros and template delimiters.
3465 (let (here-cpp-beg here-cpp-end)
3466 (save-excursion
3467 (when (c-beginning-of-macro)
3468 (setq here-cpp-beg (point))
3469 (unless
3470 (> (setq here-cpp-end (c-syntactic-end-of-macro))
3471 here-cpp-beg)
3472 (setq here-cpp-beg nil here-cpp-end nil))))
3473 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3474 ;; subsystem.
3475 (prog1
3476 (if (eval-when-compile (memq 'category-properties c-emacs-features))
3477 ;; Emacs
3478 (c-with-<->-as-parens-suppressed
3479 (if (and here-cpp-beg (> here-cpp-end here-cpp-beg))
3480 (c-with-all-but-one-cpps-commented-out
3481 here-cpp-beg here-cpp-end
3482 (c-parse-state-1))
3483 (c-with-cpps-commented-out
3484 (c-parse-state-1))))
3485 ;; XEmacs
3486 (c-parse-state-1))
3487 (setq c-state-old-cpp-beg
3488 (c-state-maybe-marker here-cpp-beg c-state-old-cpp-beg-marker)
3489 c-state-old-cpp-end
3490 (c-state-maybe-marker here-cpp-end c-state-old-cpp-end-marker)))))
3491
3492 ;; Debug tool to catch cache inconsistencies. This is called from
3493 ;; 000tests.el.
3494 (defvar c-debug-parse-state nil)
3495 (unless (fboundp 'c-real-parse-state)
3496 (fset 'c-real-parse-state (symbol-function 'c-parse-state)))
3497 (cc-bytecomp-defun c-real-parse-state)
3498
3499 (defvar c-parse-state-point nil)
3500 (defvar c-parse-state-state nil)
3501 (make-variable-buffer-local 'c-parse-state-state)
3502 (defun c-record-parse-state-state ()
3503 (setq c-parse-state-point (point))
3504 (when (markerp (cdr (assq 'c-state-old-cpp-beg c-parse-state-state)))
3505 (move-marker (cdr (assq 'c-state-old-cpp-beg c-parse-state-state)) nil)
3506 (move-marker (cdr (assq 'c-state-old-cpp-end c-parse-state-state)) nil))
3507 (setq c-parse-state-state
3508 (mapcar
3509 (lambda (arg)
3510 (let ((val (symbol-value arg)))
3511 (cons arg
3512 (cond ((consp val) (copy-tree val))
3513 ((markerp val) (copy-marker val))
3514 (t val)))))
3515 '(c-state-cache
3516 c-state-cache-good-pos
3517 c-state-nonlit-pos-cache
3518 c-state-nonlit-pos-cache-limit
3519 c-state-semi-nonlit-pos-cache
3520 c-state-semi-nonlit-pos-cache-limit
3521 c-state-brace-pair-desert
3522 c-state-point-min
3523 c-state-point-min-lit-type
3524 c-state-point-min-lit-start
3525 c-state-min-scan-pos
3526 c-state-old-cpp-beg
3527 c-state-old-cpp-end
3528 c-parse-state-point))))
3529 (defun c-replay-parse-state-state ()
3530 (message
3531 (concat "(setq "
3532 (mapconcat
3533 (lambda (arg)
3534 (format "%s %s%s" (car arg)
3535 (if (atom (cdr arg)) "" "'")
3536 (if (markerp (cdr arg))
3537 (format "(copy-marker %s)" (marker-position (cdr arg)))
3538 (cdr arg))))
3539 c-parse-state-state " ")
3540 ")")))
3541
3542 (defun c-debug-parse-state-double-cons (state)
3543 (let (state-car conses-not-ok)
3544 (while state
3545 (setq state-car (car state)
3546 state (cdr state))
3547 (if (and (consp state-car)
3548 (consp (car state)))
3549 (setq conses-not-ok t)))
3550 conses-not-ok))
3551
3552 (defun c-debug-parse-state ()
3553 (let ((here (point)) (res1 (c-real-parse-state)) res2)
3554 (let ((c-state-cache nil)
3555 (c-state-cache-good-pos 1)
3556 (c-state-nonlit-pos-cache nil)
3557 (c-state-nonlit-pos-cache-limit 1)
3558 (c-state-brace-pair-desert nil)
3559 (c-state-point-min 1)
3560 (c-state-point-min-lit-type nil)
3561 (c-state-point-min-lit-start nil)
3562 (c-state-min-scan-pos 1)
3563 (c-state-old-cpp-beg nil)
3564 (c-state-old-cpp-end nil))
3565 (setq res2 (c-real-parse-state)))
3566 (unless (equal res1 res2)
3567 ;; The cache can actually go further back due to the ad-hoc way
3568 ;; the first paren is found, so try to whack off a bit of its
3569 ;; start before complaining.
3570 ;; (save-excursion
3571 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3572 ;; (c-beginning-of-defun-1)
3573 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3574 ;; (c-beginning-of-defun-1))
3575 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3576 ;; (message (concat "c-parse-state inconsistency at %s: "
3577 ;; "using cache: %s, from scratch: %s")
3578 ;; here res1 res2)))
3579 (message (concat "c-parse-state inconsistency at %s: "
3580 "using cache: %s, from scratch: %s")
3581 here res1 res2)
3582 (message "Old state:")
3583 (c-replay-parse-state-state))
3584
3585 (when (c-debug-parse-state-double-cons res1)
3586 (message "c-parse-state INVALIDITY at %s: %s"
3587 here res1)
3588 (message "Old state:")
3589 (c-replay-parse-state-state))
3590
3591 (c-record-parse-state-state)
3592 res2 ; res1 correct a cascading series of errors ASAP
3593 ))
3594
3595 (defun c-toggle-parse-state-debug (&optional arg)
3596 (interactive "P")
3597 (setq c-debug-parse-state (c-calculate-state arg c-debug-parse-state))
3598 (fset 'c-parse-state (symbol-function (if c-debug-parse-state
3599 'c-debug-parse-state
3600 'c-real-parse-state)))
3601 (c-keep-region-active)
3602 (message "c-debug-parse-state %sabled"
3603 (if c-debug-parse-state "en" "dis")))
3604 (when c-debug-parse-state
3605 (c-toggle-parse-state-debug 1))
3606
3607 \f
3608 (defun c-whack-state-before (bufpos paren-state)
3609 ;; Whack off any state information from PAREN-STATE which lies
3610 ;; before BUFPOS. Not destructive on PAREN-STATE.
3611 (let* ((newstate (list nil))
3612 (ptr newstate)
3613 car)
3614 (while paren-state
3615 (setq car (car paren-state)
3616 paren-state (cdr paren-state))
3617 (if (< (if (consp car) (car car) car) bufpos)
3618 (setq paren-state nil)
3619 (setcdr ptr (list car))
3620 (setq ptr (cdr ptr))))
3621 (cdr newstate)))
3622
3623 (defun c-whack-state-after (bufpos paren-state)
3624 ;; Whack off any state information from PAREN-STATE which lies at or
3625 ;; after BUFPOS. Not destructive on PAREN-STATE.
3626 (catch 'done
3627 (while paren-state
3628 (let ((car (car paren-state)))
3629 (if (consp car)
3630 ;; just check the car, because in a balanced brace
3631 ;; expression, it must be impossible for the corresponding
3632 ;; close brace to be before point, but the open brace to
3633 ;; be after.
3634 (if (<= bufpos (car car))
3635 nil ; whack it off
3636 (if (< bufpos (cdr car))
3637 ;; its possible that the open brace is before
3638 ;; bufpos, but the close brace is after. In that
3639 ;; case, convert this to a non-cons element. The
3640 ;; rest of the state is before bufpos, so we're
3641 ;; done.
3642 (throw 'done (cons (car car) (cdr paren-state)))
3643 ;; we know that both the open and close braces are
3644 ;; before bufpos, so we also know that everything else
3645 ;; on state is before bufpos.
3646 (throw 'done paren-state)))
3647 (if (<= bufpos car)
3648 nil ; whack it off
3649 ;; it's before bufpos, so everything else should too.
3650 (throw 'done paren-state)))
3651 (setq paren-state (cdr paren-state)))
3652 nil)))
3653
3654 (defun c-most-enclosing-brace (paren-state &optional bufpos)
3655 ;; Return the bufpos of the innermost enclosing open paren before
3656 ;; bufpos, or nil if none was found.
3657 (let (enclosingp)
3658 (or bufpos (setq bufpos 134217727))
3659 (while paren-state
3660 (setq enclosingp (car paren-state)
3661 paren-state (cdr paren-state))
3662 (if (or (consp enclosingp)
3663 (>= enclosingp bufpos))
3664 (setq enclosingp nil)
3665 (setq paren-state nil)))
3666 enclosingp))
3667
3668 (defun c-least-enclosing-brace (paren-state)
3669 ;; Return the bufpos of the outermost enclosing open paren, or nil
3670 ;; if none was found.
3671 (let (pos elem)
3672 (while paren-state
3673 (setq elem (car paren-state)
3674 paren-state (cdr paren-state))
3675 (if (integerp elem)
3676 (setq pos elem)))
3677 pos))
3678
3679 (defun c-safe-position (bufpos paren-state)
3680 ;; Return the closest "safe" position recorded on PAREN-STATE that
3681 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3682 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3683 ;; find the closest limit before a given limit that might be nil.
3684 ;;
3685 ;; A "safe" position is a position at or after a recorded open
3686 ;; paren, or after a recorded close paren. The returned position is
3687 ;; thus either the first position after a close brace, or the first
3688 ;; position after an enclosing paren, or at the enclosing paren in
3689 ;; case BUFPOS is immediately after it.
3690 (when bufpos
3691 (let (elem)
3692 (catch 'done
3693 (while paren-state
3694 (setq elem (car paren-state))
3695 (if (consp elem)
3696 (cond ((< (cdr elem) bufpos)
3697 (throw 'done (cdr elem)))
3698 ((< (car elem) bufpos)
3699 ;; See below.
3700 (throw 'done (min (1+ (car elem)) bufpos))))
3701 (if (< elem bufpos)
3702 ;; elem is the position at and not after the opening paren, so
3703 ;; we can go forward one more step unless it's equal to
3704 ;; bufpos. This is useful in some cases avoid an extra paren
3705 ;; level between the safe position and bufpos.
3706 (throw 'done (min (1+ elem) bufpos))))
3707 (setq paren-state (cdr paren-state)))))))
3708
3709 (defun c-beginning-of-syntax ()
3710 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3711 ;; goes to the closest previous point that is known to be outside
3712 ;; any string literal or comment. `c-state-cache' is used if it has
3713 ;; a position in the vicinity.
3714 (let* ((paren-state c-state-cache)
3715 elem
3716
3717 (pos (catch 'done
3718 ;; Note: Similar code in `c-safe-position'. The
3719 ;; difference is that we accept a safe position at
3720 ;; the point and don't bother to go forward past open
3721 ;; parens.
3722 (while paren-state
3723 (setq elem (car paren-state))
3724 (if (consp elem)
3725 (cond ((<= (cdr elem) (point))
3726 (throw 'done (cdr elem)))
3727 ((<= (car elem) (point))
3728 (throw 'done (car elem))))
3729 (if (<= elem (point))
3730 (throw 'done elem)))
3731 (setq paren-state (cdr paren-state)))
3732 (point-min))))
3733
3734 (if (> pos (- (point) 4000))
3735 (goto-char pos)
3736 ;; The position is far back. Try `c-beginning-of-defun-1'
3737 ;; (although we can't be entirely sure it will go to a position
3738 ;; outside a comment or string in current emacsen). FIXME:
3739 ;; Consult `syntax-ppss' here.
3740 (c-beginning-of-defun-1)
3741 (if (< (point) pos)
3742 (goto-char pos)))))
3743
3744 \f
3745 ;; Tools for scanning identifiers and other tokens.
3746
3747 (defun c-on-identifier ()
3748 "Return non-nil if the point is on or directly after an identifier.
3749 Keywords are recognized and not considered identifiers. If an
3750 identifier is detected, the returned value is its starting position.
3751 If an identifier ends at the point and another begins at it \(can only
3752 happen in Pike) then the point for the preceding one is returned.
3753
3754 Note that this function might do hidden buffer changes. See the
3755 comment at the start of cc-engine.el for more info."
3756
3757 ;; FIXME: Shouldn't this function handle "operator" in C++?
3758
3759 (save-excursion
3760 (skip-syntax-backward "w_")
3761
3762 (or
3763
3764 ;; Check for a normal (non-keyword) identifier.
3765 (and (looking-at c-symbol-start)
3766 (not (looking-at c-keywords-regexp))
3767 (point))
3768
3769 (when (c-major-mode-is 'pike-mode)
3770 ;; Handle the `<operator> syntax in Pike.
3771 (let ((pos (point)))
3772 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3773 (and (if (< (skip-chars-backward "`") 0)
3774 t
3775 (goto-char pos)
3776 (eq (char-after) ?\`))
3777 (looking-at c-symbol-key)
3778 (>= (match-end 0) pos)
3779 (point))))
3780
3781 ;; Handle the "operator +" syntax in C++.
3782 (when (and c-overloadable-operators-regexp
3783 (= (c-backward-token-2 0) 0))
3784
3785 (cond ((and (looking-at c-overloadable-operators-regexp)
3786 (or (not c-opt-op-identifier-prefix)
3787 (and (= (c-backward-token-2 1) 0)
3788 (looking-at c-opt-op-identifier-prefix))))
3789 (point))
3790
3791 ((save-excursion
3792 (and c-opt-op-identifier-prefix
3793 (looking-at c-opt-op-identifier-prefix)
3794 (= (c-forward-token-2 1) 0)
3795 (looking-at c-overloadable-operators-regexp)))
3796 (point))))
3797
3798 )))
3799
3800 (defsubst c-simple-skip-symbol-backward ()
3801 ;; If the point is at the end of a symbol then skip backward to the
3802 ;; beginning of it. Don't move otherwise. Return non-nil if point
3803 ;; moved.
3804 ;;
3805 ;; This function might do hidden buffer changes.
3806 (or (< (skip-syntax-backward "w_") 0)
3807 (and (c-major-mode-is 'pike-mode)
3808 ;; Handle the `<operator> syntax in Pike.
3809 (let ((pos (point)))
3810 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3811 (< (skip-chars-backward "`") 0)
3812 (looking-at c-symbol-key)
3813 (>= (match-end 0) pos))
3814 t
3815 (goto-char pos)
3816 nil)))))
3817
3818 (defun c-beginning-of-current-token (&optional back-limit)
3819 ;; Move to the beginning of the current token. Do not move if not
3820 ;; in the middle of one. BACK-LIMIT may be used to bound the
3821 ;; backward search; if given it's assumed to be at the boundary
3822 ;; between two tokens. Return non-nil if the point is moved, nil
3823 ;; otherwise.
3824 ;;
3825 ;; This function might do hidden buffer changes.
3826 (let ((start (point)))
3827 (if (looking-at "\\w\\|\\s_")
3828 (skip-syntax-backward "w_" back-limit)
3829 (when (< (skip-syntax-backward ".()" back-limit) 0)
3830 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp)
3831 (match-end 0))
3832 ;; `c-nonsymbol-token-regexp' should always match
3833 ;; since we've skipped backward over punctuation
3834 ;; or paren syntax, but consume one char in case
3835 ;; it doesn't so that we don't leave point before
3836 ;; some earlier incorrect token.
3837 (1+ (point)))))
3838 (if (<= pos start)
3839 (goto-char pos))))))
3840 (< (point) start)))
3841
3842 (defun c-end-of-current-token (&optional back-limit)
3843 ;; Move to the end of the current token. Do not move if not in the
3844 ;; middle of one. BACK-LIMIT may be used to bound the backward
3845 ;; search; if given it's assumed to be at the boundary between two
3846 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3847 ;;
3848 ;; This function might do hidden buffer changes.
3849 (let ((start (point)))
3850 (cond ((< (skip-syntax-backward "w_" (1- start)) 0)
3851 (skip-syntax-forward "w_"))
3852 ((< (skip-syntax-backward ".()" back-limit) 0)
3853 (while (progn
3854 (if (looking-at c-nonsymbol-token-regexp)
3855 (goto-char (match-end 0))
3856 ;; `c-nonsymbol-token-regexp' should always match since
3857 ;; we've skipped backward over punctuation or paren
3858 ;; syntax, but move forward in case it doesn't so that
3859 ;; we don't leave point earlier than we started with.
3860 (forward-char))
3861 (< (point) start)))))
3862 (> (point) start)))
3863
3864 (defconst c-jump-syntax-balanced
3865 (if (memq 'gen-string-delim c-emacs-features)
3866 "\\w\\|\\s_\\|\\s(\\|\\s)\\|\\s\"\\|\\s|"
3867 "\\w\\|\\s_\\|\\s(\\|\\s)\\|\\s\""))
3868
3869 (defconst c-jump-syntax-unbalanced
3870 (if (memq 'gen-string-delim c-emacs-features)
3871 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3872 "\\w\\|\\s_\\|\\s\""))
3873
3874 (defun c-forward-token-2 (&optional count balanced limit)
3875 "Move forward by tokens.
3876 A token is defined as all symbols and identifiers which aren't
3877 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3878 treated properly). Point is always either left at the beginning of a
3879 token or not moved at all. COUNT specifies the number of tokens to
3880 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3881 moves to the next token beginning only if not already at one. If
3882 BALANCED is true, move over balanced parens, otherwise move into them.
3883 Also, if BALANCED is true, never move out of an enclosing paren.
3884
3885 LIMIT sets the limit for the movement and defaults to the point limit.
3886 The case when LIMIT is set in the middle of a token, comment or macro
3887 is handled correctly, i.e. the point won't be left there.
3888
3889 Return the number of tokens left to move \(positive or negative). If
3890 BALANCED is true, a move over a balanced paren counts as one. Note
3891 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3892 be returned. Thus, a return value of 0 guarantees that point is at
3893 the requested position and a return value less \(without signs) than
3894 COUNT guarantees that point is at the beginning of some token.
3895
3896 Note that this function might do hidden buffer changes. See the
3897 comment at the start of cc-engine.el for more info."
3898
3899 (or count (setq count 1))
3900 (if (< count 0)
3901 (- (c-backward-token-2 (- count) balanced limit))
3902
3903 (let ((jump-syntax (if balanced
3904 c-jump-syntax-balanced
3905 c-jump-syntax-unbalanced))
3906 (last (point))
3907 (prev (point)))
3908
3909 (if (zerop count)
3910 ;; If count is zero we should jump if in the middle of a token.
3911 (c-end-of-current-token))
3912
3913 (save-restriction
3914 (if limit (narrow-to-region (point-min) limit))
3915 (if (/= (point)
3916 (progn (c-forward-syntactic-ws) (point)))
3917 ;; Skip whitespace. Count this as a move if we did in
3918 ;; fact move.
3919 (setq count (max (1- count) 0)))
3920
3921 (if (eobp)
3922 ;; Moved out of bounds. Make sure the returned count isn't zero.
3923 (progn
3924 (if (zerop count) (setq count 1))
3925 (goto-char last))
3926
3927 ;; Use `condition-case' to avoid having the limit tests
3928 ;; inside the loop.
3929 (condition-case nil
3930 (while (and
3931 (> count 0)
3932 (progn
3933 (setq last (point))
3934 (cond ((looking-at jump-syntax)
3935 (goto-char (scan-sexps (point) 1))
3936 t)
3937 ((looking-at c-nonsymbol-token-regexp)
3938 (goto-char (match-end 0))
3939 t)
3940 ;; `c-nonsymbol-token-regexp' above should always
3941 ;; match if there are correct tokens. Try to
3942 ;; widen to see if the limit was set in the
3943 ;; middle of one, else fall back to treating
3944 ;; the offending thing as a one character token.
3945 ((and limit
3946 (save-restriction
3947 (widen)
3948 (looking-at c-nonsymbol-token-regexp)))
3949 nil)
3950 (t
3951 (forward-char)
3952 t))))
3953 (c-forward-syntactic-ws)
3954 (setq prev last
3955 count (1- count)))
3956 (error (goto-char last)))
3957
3958 (when (eobp)
3959 (goto-char prev)
3960 (setq count (1+ count)))))
3961
3962 count)))
3963
3964 (defun c-backward-token-2 (&optional count balanced limit)
3965 "Move backward by tokens.
3966 See `c-forward-token-2' for details."
3967
3968 (or count (setq count 1))
3969 (if (< count 0)
3970 (- (c-forward-token-2 (- count) balanced limit))
3971
3972 (or limit (setq limit (point-min)))
3973 (let ((jump-syntax (if balanced
3974 c-jump-syntax-balanced
3975 c-jump-syntax-unbalanced))
3976 (last (point)))
3977
3978 (if (zerop count)
3979 ;; The count is zero so try to skip to the beginning of the
3980 ;; current token.
3981 (if (> (point)
3982 (progn (c-beginning-of-current-token) (point)))
3983 (if (< (point) limit)
3984 ;; The limit is inside the same token, so return 1.
3985 (setq count 1))
3986
3987 ;; We're not in the middle of a token. If there's
3988 ;; whitespace after the point then we must move backward,
3989 ;; so set count to 1 in that case.
3990 (and (looking-at c-syntactic-ws-start)
3991 ;; If we're looking at a '#' that might start a cpp
3992 ;; directive then we have to do a more elaborate check.
3993 (or (/= (char-after) ?#)
3994 (not c-opt-cpp-prefix)
3995 (save-excursion
3996 (and (= (point)
3997 (progn (beginning-of-line)
3998 (looking-at "[ \t]*")
3999 (match-end 0)))
4000 (or (bobp)
4001 (progn (backward-char)
4002 (not (eq (char-before) ?\\)))))))
4003 (setq count 1))))
4004
4005 ;; Use `condition-case' to avoid having to check for buffer
4006 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
4007 (condition-case nil
4008 (while (and
4009 (> count 0)
4010 (progn
4011 (c-backward-syntactic-ws)
4012 (backward-char)
4013 (if (looking-at jump-syntax)
4014 (goto-char (scan-sexps (1+ (point)) -1))
4015 ;; This can be very inefficient if there's a long
4016 ;; sequence of operator tokens without any separation.
4017 ;; That doesn't happen in practice, anyway.
4018 (c-beginning-of-current-token))
4019 (>= (point) limit)))
4020 (setq last (point)
4021 count (1- count)))
4022 (error (goto-char last)))
4023
4024 (if (< (point) limit)
4025 (goto-char last))
4026
4027 count)))
4028
4029 (defun c-forward-token-1 (&optional count balanced limit)
4030 "Like `c-forward-token-2' but doesn't treat multicharacter operator
4031 tokens like \"==\" as single tokens, i.e. all sequences of symbol
4032 characters are jumped over character by character. This function is
4033 for compatibility only; it's only a wrapper over `c-forward-token-2'."
4034 (let ((c-nonsymbol-token-regexp "\\s."))
4035 (c-forward-token-2 count balanced limit)))
4036
4037 (defun c-backward-token-1 (&optional count balanced limit)
4038 "Like `c-backward-token-2' but doesn't treat multicharacter operator
4039 tokens like \"==\" as single tokens, i.e. all sequences of symbol
4040 characters are jumped over character by character. This function is
4041 for compatibility only; it's only a wrapper over `c-backward-token-2'."
4042 (let ((c-nonsymbol-token-regexp "\\s."))
4043 (c-backward-token-2 count balanced limit)))
4044
4045 \f
4046 ;; Tools for doing searches restricted to syntactically relevant text.
4047
4048 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
4049 paren-level not-inside-token
4050 lookbehind-submatch)
4051 "Like `re-search-forward', but only report matches that are found
4052 in syntactically significant text. I.e. matches in comments, macros
4053 or string literals are ignored. The start point is assumed to be
4054 outside any comment, macro or string literal, or else the content of
4055 that region is taken as syntactically significant text.
4056
4057 If PAREN-LEVEL is non-nil, an additional restriction is added to
4058 ignore matches in nested paren sexps. The search will also not go
4059 outside the current list sexp, which has the effect that if the point
4060 should be moved to BOUND when no match is found \(i.e. NOERROR is
4061 neither nil nor t), then it will be at the closing paren if the end of
4062 the current list sexp is encountered first.
4063
4064 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
4065 ignored. Things like multicharacter operators and special symbols
4066 \(e.g. \"`()\" in Pike) are handled but currently not floating point
4067 constants.
4068
4069 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
4070 subexpression in REGEXP. The end of that submatch is used as the
4071 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
4072 isn't used or if that subexpression didn't match then the start
4073 position of the whole match is used instead. The \"look behind\"
4074 subexpression is never tested before the starting position, so it
4075 might be a good idea to include \\=\\= as a match alternative in it.
4076
4077 Optimization note: Matches might be missed if the \"look behind\"
4078 subexpression can match the end of nonwhite syntactic whitespace,
4079 i.e. the end of comments or cpp directives. This since the function
4080 skips over such things before resuming the search. It's on the other
4081 hand not safe to assume that the \"look behind\" subexpression never
4082 matches syntactic whitespace.
4083
4084 Bug: Unbalanced parens inside cpp directives are currently not handled
4085 correctly \(i.e. they don't get ignored as they should) when
4086 PAREN-LEVEL is set.
4087
4088 Note that this function might do hidden buffer changes. See the
4089 comment at the start of cc-engine.el for more info."
4090
4091 (or bound (setq bound (point-max)))
4092 (if paren-level (setq paren-level -1))
4093
4094 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
4095
4096 (let ((start (point))
4097 tmp
4098 ;; Start position for the last search.
4099 search-pos
4100 ;; The `parse-partial-sexp' state between the start position
4101 ;; and the point.
4102 state
4103 ;; The current position after the last state update. The next
4104 ;; `parse-partial-sexp' continues from here.
4105 (state-pos (point))
4106 ;; The position at which to check the state and the state
4107 ;; there. This is separate from `state-pos' since we might
4108 ;; need to back up before doing the next search round.
4109 check-pos check-state
4110 ;; Last position known to end a token.
4111 (last-token-end-pos (point-min))
4112 ;; Set when a valid match is found.
4113 found)
4114
4115 (condition-case err
4116 (while
4117 (and
4118 (progn
4119 (setq search-pos (point))
4120 (re-search-forward regexp bound noerror))
4121
4122 (progn
4123 (setq state (parse-partial-sexp
4124 state-pos (match-beginning 0) paren-level nil state)
4125 state-pos (point))
4126 (if (setq check-pos (and lookbehind-submatch
4127 (or (not paren-level)
4128 (>= (car state) 0))
4129 (match-end lookbehind-submatch)))
4130 (setq check-state (parse-partial-sexp
4131 state-pos check-pos paren-level nil state))
4132 (setq check-pos state-pos
4133 check-state state))
4134
4135 ;; NOTE: If we got a look behind subexpression and get
4136 ;; an insignificant match in something that isn't
4137 ;; syntactic whitespace (i.e. strings or in nested
4138 ;; parentheses), then we can never skip more than a
4139 ;; single character from the match start position
4140 ;; (i.e. `state-pos' here) before continuing the
4141 ;; search. That since the look behind subexpression
4142 ;; might match the end of the insignificant region in
4143 ;; the next search.
4144
4145 (cond
4146 ((elt check-state 7)
4147 ;; Match inside a line comment. Skip to eol. Use
4148 ;; `re-search-forward' instead of `skip-chars-forward' to get
4149 ;; the right bound behavior.
4150 (re-search-forward "[\n\r]" bound noerror))
4151
4152 ((elt check-state 4)
4153 ;; Match inside a block comment. Skip to the '*/'.
4154 (search-forward "*/" bound noerror))
4155
4156 ((and (not (elt check-state 5))
4157 (eq (char-before check-pos) ?/)
4158 (not (c-get-char-property (1- check-pos) 'syntax-table))
4159 (memq (char-after check-pos) '(?/ ?*)))
4160 ;; Match in the middle of the opener of a block or line
4161 ;; comment.
4162 (if (= (char-after check-pos) ?/)
4163 (re-search-forward "[\n\r]" bound noerror)
4164 (search-forward "*/" bound noerror)))
4165
4166 ;; The last `parse-partial-sexp' above might have
4167 ;; stopped short of the real check position if the end
4168 ;; of the current sexp was encountered in paren-level
4169 ;; mode. The checks above are always false in that
4170 ;; case, and since they can do better skipping in
4171 ;; lookbehind-submatch mode, we do them before
4172 ;; checking the paren level.
4173
4174 ((and paren-level
4175 (/= (setq tmp (car check-state)) 0))
4176 ;; Check the paren level first since we're short of the
4177 ;; syntactic checking position if the end of the
4178 ;; current sexp was encountered by `parse-partial-sexp'.
4179 (if (> tmp 0)
4180
4181 ;; Inside a nested paren sexp.
4182 (if lookbehind-submatch
4183 ;; See the NOTE above.
4184 (progn (goto-char state-pos) t)
4185 ;; Skip out of the paren quickly.
4186 (setq state (parse-partial-sexp state-pos bound 0 nil state)
4187 state-pos (point)))
4188
4189 ;; Have exited the current paren sexp.
4190 (if noerror
4191 (progn
4192 ;; The last `parse-partial-sexp' call above
4193 ;; has left us just after the closing paren
4194 ;; in this case, so we can modify the bound
4195 ;; to leave the point at the right position
4196 ;; upon return.
4197 (setq bound (1- (point)))
4198 nil)
4199 (signal 'search-failed (list regexp)))))
4200
4201 ((setq tmp (elt check-state 3))
4202 ;; Match inside a string.
4203 (if (or lookbehind-submatch
4204 (not (integerp tmp)))
4205 ;; See the NOTE above.
4206 (progn (goto-char state-pos) t)
4207 ;; Skip to the end of the string before continuing.
4208 (let ((ender (make-string 1 tmp)) (continue t))
4209 (while (if (search-forward ender bound noerror)
4210 (progn
4211 (setq state (parse-partial-sexp
4212 state-pos (point) nil nil state)
4213 state-pos (point))
4214 (elt state 3))
4215 (setq continue nil)))
4216 continue)))
4217
4218 ((save-excursion
4219 (save-match-data
4220 (c-beginning-of-macro start)))
4221 ;; Match inside a macro. Skip to the end of it.
4222 (c-end-of-macro)
4223 (cond ((<= (point) bound) t)
4224 (noerror nil)
4225 (t (signal 'search-failed (list regexp)))))
4226
4227 ((and not-inside-token
4228 (or (< check-pos last-token-end-pos)
4229 (< check-pos
4230 (save-excursion
4231 (goto-char check-pos)
4232 (save-match-data
4233 (c-end-of-current-token last-token-end-pos))
4234 (setq last-token-end-pos (point))))))
4235 ;; Inside a token.
4236 (if lookbehind-submatch
4237 ;; See the NOTE above.
4238 (goto-char state-pos)
4239 (goto-char (min last-token-end-pos bound))))
4240
4241 (t
4242 ;; A real match.
4243 (setq found t)
4244 nil)))
4245
4246 ;; Should loop to search again, but take care to avoid
4247 ;; looping on the same spot.
4248 (or (/= search-pos (point))
4249 (if (= (point) bound)
4250 (if noerror
4251 nil
4252 (signal 'search-failed (list regexp)))
4253 (forward-char)
4254 t))))
4255
4256 (error
4257 (goto-char start)
4258 (signal (car err) (cdr err))))
4259
4260 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4261
4262 (if found
4263 (progn
4264 (goto-char (match-end 0))
4265 (match-end 0))
4266
4267 ;; Search failed. Set point as appropriate.
4268 (if (eq noerror t)
4269 (goto-char start)
4270 (goto-char bound))
4271 nil)))
4272
4273 (defvar safe-pos-list) ; bound in c-syntactic-skip-backward
4274
4275 (defsubst c-ssb-lit-begin ()
4276 ;; Return the start of the literal point is in, or nil.
4277 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4278 ;; bound in the caller.
4279
4280 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4281 ;; if it's outside comments and strings.
4282 (save-excursion
4283 (let ((pos (point)) safe-pos state)
4284 ;; Pick a safe position as close to the point as possible.
4285 ;;
4286 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4287 ;; position.
4288
4289 (while (and safe-pos-list
4290 (> (car safe-pos-list) (point)))
4291 (setq safe-pos-list (cdr safe-pos-list)))
4292 (unless (setq safe-pos (car-safe safe-pos-list))
4293 (setq safe-pos (max (or (c-safe-position
4294 (point) (c-parse-state))
4295 0)
4296 (point-min))
4297 safe-pos-list (list safe-pos)))
4298
4299 ;; Cache positions along the way to use if we have to back up more. We
4300 ;; cache every closing paren on the same level. If the paren cache is
4301 ;; relevant in this region then we're typically already on the same
4302 ;; level as the target position. Note that we might cache positions
4303 ;; after opening parens in case safe-pos is in a nested list. That's
4304 ;; both uncommon and harmless.
4305 (while (progn
4306 (setq state (parse-partial-sexp
4307 safe-pos pos 0))
4308 (< (point) pos))
4309 (setq safe-pos (point)
4310 safe-pos-list (cons safe-pos safe-pos-list)))
4311
4312 ;; If the state contains the start of the containing sexp we cache that
4313 ;; position too, so that parse-partial-sexp in the next run has a bigger
4314 ;; chance of starting at the same level as the target position and thus
4315 ;; will get more good safe positions into the list.
4316 (if (elt state 1)
4317 (setq safe-pos (1+ (elt state 1))
4318 safe-pos-list (cons safe-pos safe-pos-list)))
4319
4320 (if (or (elt state 3) (elt state 4))
4321 ;; Inside string or comment. Continue search at the
4322 ;; beginning of it.
4323 (elt state 8)))))
4324
4325 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4326 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4327 i.e. don't stop at positions inside syntactic whitespace or string
4328 literals. Preprocessor directives are also ignored, with the exception
4329 of the one that the point starts within, if any. If LIMIT is given,
4330 it's assumed to be at a syntactically relevant position.
4331
4332 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4333 sexps, and the search will also not go outside the current paren sexp.
4334 However, if LIMIT or the buffer limit is reached inside a nested paren
4335 then the point will be left at the limit.
4336
4337 Non-nil is returned if the point moved, nil otherwise.
4338
4339 Note that this function might do hidden buffer changes. See the
4340 comment at the start of cc-engine.el for more info."
4341
4342 (c-self-bind-state-cache
4343 (let ((start (point))
4344 state-2
4345 ;; A list of syntactically relevant positions in descending
4346 ;; order. It's used to avoid scanning repeatedly over
4347 ;; potentially large regions with `parse-partial-sexp' to verify
4348 ;; each position. Used in `c-ssb-lit-begin'
4349 safe-pos-list
4350 ;; The result from `c-beginning-of-macro' at the start position or the
4351 ;; start position itself if it isn't within a macro. Evaluated on
4352 ;; demand.
4353 start-macro-beg
4354 ;; The earliest position after the current one with the same paren
4355 ;; level. Used only when `paren-level' is set.
4356 lit-beg
4357 (paren-level-pos (point)))
4358
4359 (while
4360 (progn
4361 ;; The next loop "tries" to find the end point each time round,
4362 ;; loops when it hasn't succeeded.
4363 (while
4364 (and
4365 (let ((pos (point)))
4366 (while (and
4367 (< (skip-chars-backward skip-chars limit) 0)
4368 ;; Don't stop inside a literal.
4369 (when (setq lit-beg (c-ssb-lit-begin))
4370 (goto-char lit-beg)
4371 t)))
4372 (< (point) pos))
4373
4374 (let ((pos (point)) state-2 pps-end-pos)
4375
4376 (cond
4377 ((and paren-level
4378 (save-excursion
4379 (setq state-2 (parse-partial-sexp
4380 pos paren-level-pos -1)
4381 pps-end-pos (point))
4382 (/= (car state-2) 0)))
4383 ;; Not at the right level.
4384
4385 (if (and (< (car state-2) 0)
4386 ;; We stop above if we go out of a paren.
4387 ;; Now check whether it precedes or is
4388 ;; nested in the starting sexp.
4389 (save-excursion
4390 (setq state-2
4391 (parse-partial-sexp
4392 pps-end-pos paren-level-pos
4393 nil nil state-2))
4394 (< (car state-2) 0)))
4395
4396 ;; We've stopped short of the starting position
4397 ;; so the hit was inside a nested list. Go up
4398 ;; until we are at the right level.
4399 (condition-case nil
4400 (progn
4401 (goto-char (scan-lists pos -1
4402 (- (car state-2))))
4403 (setq paren-level-pos (point))
4404 (if (and limit (>= limit paren-level-pos))
4405 (progn
4406 (goto-char limit)
4407 nil)
4408 t))
4409 (error
4410 (goto-char (or limit (point-min)))
4411 nil))
4412
4413 ;; The hit was outside the list at the start
4414 ;; position. Go to the start of the list and exit.
4415 (goto-char (1+ (elt state-2 1)))
4416 nil))
4417
4418 ((c-beginning-of-macro limit)
4419 ;; Inside a macro.
4420 (if (< (point)
4421 (or start-macro-beg
4422 (setq start-macro-beg
4423 (save-excursion
4424 (goto-char start)
4425 (c-beginning-of-macro limit)
4426 (point)))))
4427 t
4428
4429 ;; It's inside the same macro we started in so it's
4430 ;; a relevant match.
4431 (goto-char pos)
4432 nil))))))
4433
4434 (> (point)
4435 (progn
4436 ;; Skip syntactic ws afterwards so that we don't stop at the
4437 ;; end of a comment if `skip-chars' is something like "^/".
4438 (c-backward-syntactic-ws)
4439 (point)))))
4440
4441 ;; We might want to extend this with more useful return values in
4442 ;; the future.
4443 (/= (point) start))))
4444
4445 ;; The following is an alternative implementation of
4446 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4447 ;; track of the syntactic context. It turned out to be generally
4448 ;; slower than the one above which uses forward checks from earlier
4449 ;; safe positions.
4450 ;;
4451 ;;(defconst c-ssb-stop-re
4452 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4453 ;; ;; stop at to avoid going into comments and literals.
4454 ;; (concat
4455 ;; ;; Match comment end syntax and string literal syntax. Also match
4456 ;; ;; '/' for block comment endings (not covered by comment end
4457 ;; ;; syntax).
4458 ;; "\\s>\\|/\\|\\s\""
4459 ;; (if (memq 'gen-string-delim c-emacs-features)
4460 ;; "\\|\\s|"
4461 ;; "")
4462 ;; (if (memq 'gen-comment-delim c-emacs-features)
4463 ;; "\\|\\s!"
4464 ;; "")))
4465 ;;
4466 ;;(defconst c-ssb-stop-paren-re
4467 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4468 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4469 ;;
4470 ;;(defconst c-ssb-sexp-end-re
4471 ;; ;; Regexp matching the ending syntax of a complex sexp.
4472 ;; (concat c-string-limit-regexp "\\|\\s)"))
4473 ;;
4474 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4475 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4476 ;;i.e. don't stop at positions inside syntactic whitespace or string
4477 ;;literals. Preprocessor directives are also ignored. However, if the
4478 ;;point is within a comment, string literal or preprocessor directory to
4479 ;;begin with, its contents is treated as syntactically relevant chars.
4480 ;;If LIMIT is given, it limits the backward search and the point will be
4481 ;;left there if no earlier position is found.
4482 ;;
4483 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4484 ;;sexps, and the search will also not go outside the current paren sexp.
4485 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4486 ;;then the point will be left at the limit.
4487 ;;
4488 ;;Non-nil is returned if the point moved, nil otherwise.
4489 ;;
4490 ;;Note that this function might do hidden buffer changes. See the
4491 ;;comment at the start of cc-engine.el for more info."
4492 ;;
4493 ;; (save-restriction
4494 ;; (when limit
4495 ;; (narrow-to-region limit (point-max)))
4496 ;;
4497 ;; (let ((start (point)))
4498 ;; (catch 'done
4499 ;; (while (let ((last-pos (point))
4500 ;; (stop-pos (progn
4501 ;; (skip-chars-backward skip-chars)
4502 ;; (point))))
4503 ;;
4504 ;; ;; Skip back over the same region as
4505 ;; ;; `skip-chars-backward' above, but keep to
4506 ;; ;; syntactically relevant positions.
4507 ;; (goto-char last-pos)
4508 ;; (while (and
4509 ;; ;; `re-search-backward' with a single char regexp
4510 ;; ;; should be fast.
4511 ;; (re-search-backward
4512 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4513 ;; stop-pos 'move)
4514 ;;
4515 ;; (progn
4516 ;; (cond
4517 ;; ((looking-at "\\s(")
4518 ;; ;; `paren-level' is set and we've found the
4519 ;; ;; start of the containing paren.
4520 ;; (forward-char)
4521 ;; (throw 'done t))
4522 ;;
4523 ;; ((looking-at c-ssb-sexp-end-re)
4524 ;; ;; We're at the end of a string literal or paren
4525 ;; ;; sexp (if `paren-level' is set).
4526 ;; (forward-char)
4527 ;; (condition-case nil
4528 ;; (c-backward-sexp)
4529 ;; (error
4530 ;; (goto-char limit)
4531 ;; (throw 'done t))))
4532 ;;
4533 ;; (t
4534 ;; (forward-char)
4535 ;; ;; At the end of some syntactic ws or possibly
4536 ;; ;; after a plain '/' operator.
4537 ;; (let ((pos (point)))
4538 ;; (c-backward-syntactic-ws)
4539 ;; (if (= pos (point))
4540 ;; ;; Was a plain '/' operator. Go past it.
4541 ;; (backward-char)))))
4542 ;;
4543 ;; (> (point) stop-pos))))
4544 ;;
4545 ;; ;; Now the point is either at `stop-pos' or at some
4546 ;; ;; position further back if `stop-pos' was at a
4547 ;; ;; syntactically irrelevant place.
4548 ;;
4549 ;; ;; Skip additional syntactic ws so that we don't stop
4550 ;; ;; at the end of a comment if `skip-chars' is
4551 ;; ;; something like "^/".
4552 ;; (c-backward-syntactic-ws)
4553 ;;
4554 ;; (< (point) stop-pos))))
4555 ;;
4556 ;; ;; We might want to extend this with more useful return values
4557 ;; ;; in the future.
4558 ;; (/= (point) start))))
4559
4560 \f
4561 ;; Tools for handling comments and string literals.
4562
4563 (defun c-in-literal (&optional lim detect-cpp)
4564 "Return the type of literal point is in, if any.
4565 The return value is `c' if in a C-style comment, `c++' if in a C++
4566 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4567 is non-nil and in a preprocessor line, or nil if somewhere else.
4568 Optional LIM is used as the backward limit of the search. If omitted,
4569 or nil, `c-beginning-of-defun' is used.
4570
4571 The last point calculated is cached if the cache is enabled, i.e. if
4572 `c-in-literal-cache' is bound to a two element vector.
4573
4574 Note that this function might do hidden buffer changes. See the
4575 comment at the start of cc-engine.el for more info."
4576 (save-restriction
4577 (widen)
4578 (let* ((safe-place (c-state-semi-safe-place (point)))
4579 (lit (c-state-pp-to-literal safe-place (point))))
4580 (or (cadr lit)
4581 (and detect-cpp
4582 (save-excursion (c-beginning-of-macro))
4583 'pound)))))
4584
4585 (defun c-literal-limits (&optional lim near not-in-delimiter)
4586 "Return a cons of the beginning and end positions of the comment or
4587 string surrounding point (including both delimiters), or nil if point
4588 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4589 to start parsing from. If NEAR is non-nil, then the limits of any
4590 literal next to point is returned. \"Next to\" means there's only
4591 spaces and tabs between point and the literal. The search for such a
4592 literal is done first in forward direction. If NOT-IN-DELIMITER is
4593 non-nil, the case when point is inside a starting delimiter won't be
4594 recognized. This only has effect for comments which have starting
4595 delimiters with more than one character.
4596
4597 Note that this function might do hidden buffer changes. See the
4598 comment at the start of cc-engine.el for more info."
4599
4600 (save-excursion
4601 (let* ((pos (point))
4602 (lim (or lim (c-state-semi-safe-place pos)))
4603 (pp-to-lit (save-restriction
4604 (widen)
4605 (c-state-pp-to-literal lim pos not-in-delimiter)))
4606 (state (car pp-to-lit))
4607 (lit-limits (car (cddr pp-to-lit))))
4608
4609 (cond
4610 (lit-limits)
4611
4612 (near
4613 (goto-char pos)
4614 ;; Search forward for a literal.
4615 (skip-chars-forward " \t")
4616 (cond
4617 ((looking-at c-string-limit-regexp) ; String.
4618 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4619 (point-max))))
4620
4621 ((looking-at c-comment-start-regexp) ; Line or block comment.
4622 (cons (point) (progn (c-forward-single-comment) (point))))
4623
4624 (t
4625 ;; Search backward.
4626 (skip-chars-backward " \t")
4627
4628 (let ((end (point)) beg)
4629 (cond
4630 ((save-excursion
4631 (< (skip-syntax-backward c-string-syntax) 0)) ; String.
4632 (setq beg (c-safe (c-backward-sexp 1) (point))))
4633
4634 ((and (c-safe (forward-char -2) t)
4635 (looking-at "*/"))
4636 ;; Block comment. Due to the nature of line
4637 ;; comments, they will always be covered by the
4638 ;; normal case above.
4639 (goto-char end)
4640 (c-backward-single-comment)
4641 ;; If LIM is bogus, beg will be bogus.
4642 (setq beg (point))))
4643
4644 (if beg (cons beg end))))))
4645 ))))
4646
4647 ;; In case external callers use this; it did have a docstring.
4648 (defalias 'c-literal-limits-fast 'c-literal-limits)
4649
4650 (defun c-collect-line-comments (range)
4651 "If the argument is a cons of two buffer positions (such as returned by
4652 `c-literal-limits'), and that range contains a C++ style line comment,
4653 then an extended range is returned that contains all adjacent line
4654 comments (i.e. all comments that starts in the same column with no
4655 empty lines or non-whitespace characters between them). Otherwise the
4656 argument is returned.
4657
4658 Note that this function might do hidden buffer changes. See the
4659 comment at the start of cc-engine.el for more info."
4660
4661 (save-excursion
4662 (condition-case nil
4663 (if (and (consp range) (progn
4664 (goto-char (car range))
4665 (looking-at c-line-comment-starter)))
4666 (let ((col (current-column))
4667 (beg (point))
4668 (bopl (c-point 'bopl))
4669 (end (cdr range)))
4670 ;; Got to take care in the backward direction to handle
4671 ;; comments which are preceded by code.
4672 (while (and (c-backward-single-comment)
4673 (>= (point) bopl)
4674 (looking-at c-line-comment-starter)
4675 (= col (current-column)))
4676 (setq beg (point)
4677 bopl (c-point 'bopl)))
4678 (goto-char end)
4679 (while (and (progn (skip-chars-forward " \t")
4680 (looking-at c-line-comment-starter))
4681 (= col (current-column))
4682 (prog1 (zerop (forward-line 1))
4683 (setq end (point)))))
4684 (cons beg end))
4685 range)
4686 (error range))))
4687
4688 (defun c-literal-type (range)
4689 "Convenience function that given the result of `c-literal-limits',
4690 returns nil or the type of literal that the range surrounds, one
4691 of the symbols `c', `c++' or `string'. It's much faster than using
4692 `c-in-literal' and is intended to be used when you need both the
4693 type of a literal and its limits.
4694
4695 Note that this function might do hidden buffer changes. See the
4696 comment at the start of cc-engine.el for more info."
4697
4698 (if (consp range)
4699 (save-excursion
4700 (goto-char (car range))
4701 (cond ((looking-at c-string-limit-regexp) 'string)
4702 ((or (looking-at "//") ; c++ line comment
4703 (and (looking-at "\\s<") ; comment starter
4704 (looking-at "#"))) ; awk comment.
4705 'c++)
4706 (t 'c))) ; Assuming the range is valid.
4707 range))
4708
4709 (defsubst c-determine-limit-get-base (start try-size)
4710 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4711 ;; This doesn't preserve point.
4712 (let* ((pos (max (- start try-size) (point-min)))
4713 (base (c-state-semi-safe-place pos))
4714 (s (parse-partial-sexp base pos)))
4715 (if (or (nth 4 s) (nth 3 s)) ; comment or string
4716 (nth 8 s)
4717 (point))))
4718
4719 (defun c-determine-limit (how-far-back &optional start try-size)
4720 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4721 ;; (default point). This is done by going back further in the buffer then
4722 ;; searching forward for literals. The position found won't be in a
4723 ;; literal. We start searching for the sought position TRY-SIZE (default
4724 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4725 ;; :-)
4726 (save-excursion
4727 (let* ((start (or start (point)))
4728 (try-size (or try-size (* 2 how-far-back)))
4729 (base (c-determine-limit-get-base start try-size))
4730 (pos base)
4731
4732 (s (parse-partial-sexp pos pos)) ; null state.
4733 stack elt size
4734 (count 0))
4735 (while (< pos start)
4736 ;; Move forward one literal each time round this loop.
4737 ;; Move forward to the start of a comment or string.
4738 (setq s (parse-partial-sexp
4739 pos
4740 start
4741 nil ; target-depth
4742 nil ; stop-before
4743 s ; state
4744 'syntax-table)) ; stop-comment
4745
4746 ;; Gather details of the non-literal-bit - starting pos and size.
4747 (setq size (- (if (or (nth 4 s) (nth 3 s))
4748 (nth 8 s)
4749 (point))
4750 pos))
4751 (if (> size 0)
4752 (setq stack (cons (cons pos size) stack)))
4753
4754 ;; Move forward to the end of the comment/string.
4755 (if (or (nth 4 s) (nth 3 s))
4756 (setq s (parse-partial-sexp
4757 (point)
4758 start
4759 nil ; target-depth
4760 nil ; stop-before
4761 s ; state
4762 'syntax-table))) ; stop-comment
4763 (setq pos (point)))
4764
4765 ;; Now try and find enough non-literal characters recorded on the stack.
4766 ;; Go back one recorded literal each time round this loop.
4767 (while (and (< count how-far-back)
4768 stack)
4769 (setq elt (car stack)
4770 stack (cdr stack))
4771 (setq count (+ count (cdr elt))))
4772
4773 ;; Have we found enough yet?
4774 (cond
4775 ((>= count how-far-back)
4776 (+ (car elt) (- count how-far-back)))
4777 ((eq base (point-min))
4778 (point-min))
4779 (t
4780 (c-determine-limit (- how-far-back count) base try-size))))))
4781
4782 (defun c-determine-+ve-limit (how-far &optional start-pos)
4783 ;; Return a buffer position about HOW-FAR non-literal characters forward
4784 ;; from START-POS (default point), which must not be inside a literal.
4785 (save-excursion
4786 (let ((pos (or start-pos (point)))
4787 (count how-far)
4788 (s (parse-partial-sexp (point) (point)))) ; null state
4789 (while (and (not (eobp))
4790 (> count 0))
4791 ;; Scan over counted characters.
4792 (setq s (parse-partial-sexp
4793 pos
4794 (min (+ pos count) (point-max))
4795 nil ; target-depth
4796 nil ; stop-before
4797 s ; state
4798 'syntax-table)) ; stop-comment
4799 (setq count (- count (- (point) pos) 1)
4800 pos (point))
4801 ;; Scan over literal characters.
4802 (if (nth 8 s)
4803 (setq s (parse-partial-sexp
4804 pos
4805 (point-max)
4806 nil ; target-depth
4807 nil ; stop-before
4808 s ; state
4809 'syntax-table) ; stop-comment
4810 pos (point))))
4811 (point))))
4812
4813 \f
4814 ;; `c-find-decl-spots' and accompanying stuff.
4815
4816 ;; Variables used in `c-find-decl-spots' to cache the search done for
4817 ;; the first declaration in the last call. When that function starts,
4818 ;; it needs to back up over syntactic whitespace to look at the last
4819 ;; token before the region being searched. That can sometimes cause
4820 ;; moves back and forth over a quite large region of comments and
4821 ;; macros, which would be repeated for each changed character when
4822 ;; we're called during fontification, since font-lock refontifies the
4823 ;; current line for each change. Thus it's worthwhile to cache the
4824 ;; first match.
4825 ;;
4826 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4827 ;; the syntactic whitespace less or equal to some start position.
4828 ;; There's no cached value if it's nil.
4829 ;;
4830 ;; `c-find-decl-match-pos' is the match position if
4831 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4832 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4833 (defvar c-find-decl-syntactic-pos nil)
4834 (make-variable-buffer-local 'c-find-decl-syntactic-pos)
4835 (defvar c-find-decl-match-pos nil)
4836 (make-variable-buffer-local 'c-find-decl-match-pos)
4837
4838 (defsubst c-invalidate-find-decl-cache (change-min-pos)
4839 (and c-find-decl-syntactic-pos
4840 (< change-min-pos c-find-decl-syntactic-pos)
4841 (setq c-find-decl-syntactic-pos nil)))
4842
4843 ; (defface c-debug-decl-spot-face
4844 ; '((t (:background "Turquoise")))
4845 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4846 ; (defface c-debug-decl-sws-face
4847 ; '((t (:background "Khaki")))
4848 ; "Debug face to mark the syntactic whitespace between the declaration
4849 ; spots and the preceding token end.")
4850
4851 (defmacro c-debug-put-decl-spot-faces (match-pos decl-pos)
4852 (when (facep 'c-debug-decl-spot-face)
4853 `(c-save-buffer-state ((match-pos ,match-pos) (decl-pos ,decl-pos))
4854 (c-debug-add-face (max match-pos (point-min)) decl-pos
4855 'c-debug-decl-sws-face)
4856 (c-debug-add-face decl-pos (min (1+ decl-pos) (point-max))
4857 'c-debug-decl-spot-face))))
4858 (defmacro c-debug-remove-decl-spot-faces (beg end)
4859 (when (facep 'c-debug-decl-spot-face)
4860 `(c-save-buffer-state ()
4861 (c-debug-remove-face ,beg ,end 'c-debug-decl-spot-face)
4862 (c-debug-remove-face ,beg ,end 'c-debug-decl-sws-face))))
4863
4864 (defmacro c-find-decl-prefix-search ()
4865 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4866 ;; but it contains lots of free variables that refer to things
4867 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4868 ;; if there is a match, otherwise at `cfd-limit'.
4869 ;;
4870 ;; The macro moves point forward to the next putative start of a declaration
4871 ;; or cfd-limit. This decl start is the next token after a "declaration
4872 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
4873 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
4874 ;;
4875 ;; This macro might do hidden buffer changes.
4876
4877 '(progn
4878 ;; Find the next property match position if we haven't got one already.
4879 (unless cfd-prop-match
4880 (save-excursion
4881 (while (progn
4882 (goto-char (c-next-single-property-change
4883 (point) 'c-type nil cfd-limit))
4884 (and (< (point) cfd-limit)
4885 (not (eq (c-get-char-property (1- (point)) 'c-type)
4886 'c-decl-end)))))
4887 (setq cfd-prop-match (point))))
4888
4889 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4890 ;; got one already.
4891 (unless cfd-re-match
4892
4893 (if (> cfd-re-match-end (point))
4894 (goto-char cfd-re-match-end))
4895
4896 ;; Each time round, the next `while' moves forward over a pseudo match
4897 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
4898 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
4899 ;; `cfd-re-match-end' get set.
4900 (while
4901 (progn
4902 (setq cfd-re-match-end (re-search-forward c-decl-prefix-or-start-re
4903 cfd-limit 'move))
4904 (cond
4905 ((null cfd-re-match-end)
4906 ;; No match. Finish up and exit the loop.
4907 (setq cfd-re-match cfd-limit)
4908 nil)
4909 ((c-got-face-at
4910 (if (setq cfd-re-match (match-end 1))
4911 ;; Matched the end of a token preceding a decl spot.
4912 (progn
4913 (goto-char cfd-re-match)
4914 (1- cfd-re-match))
4915 ;; Matched a token that start a decl spot.
4916 (goto-char (match-beginning 0))
4917 (point))
4918 c-literal-faces)
4919 ;; Pseudo match inside a comment or string literal. Skip out
4920 ;; of comments and string literals.
4921 (while (progn
4922 (goto-char (c-next-single-property-change
4923 (point) 'face nil cfd-limit))
4924 (and (< (point) cfd-limit)
4925 (c-got-face-at (point) c-literal-faces))))
4926 t) ; Continue the loop over pseudo matches.
4927 ((and (match-string 1)
4928 (string= (match-string 1) ":")
4929 (save-excursion
4930 (or (/= (c-backward-token-2 2) 0) ; no search limit. :-(
4931 (not (looking-at c-decl-start-colon-kwd-re)))))
4932 ;; Found a ":" which isn't part of "public:", etc.
4933 t)
4934 (t nil)))) ;; Found a real match. Exit the pseudo-match loop.
4935
4936 ;; If our match was at the decl start, we have to back up over the
4937 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4938 ;; any decl spots in the syntactic ws.
4939 (unless cfd-re-match
4940 (c-backward-syntactic-ws)
4941 (setq cfd-re-match (point))))
4942
4943 ;; Choose whichever match is closer to the start.
4944 (if (< cfd-re-match cfd-prop-match)
4945 (setq cfd-match-pos cfd-re-match
4946 cfd-re-match nil)
4947 (setq cfd-match-pos cfd-prop-match
4948 cfd-prop-match nil))
4949
4950 (goto-char cfd-match-pos)
4951
4952 (when (< cfd-match-pos cfd-limit)
4953 ;; Skip forward past comments only so we don't skip macros.
4954 (c-forward-comments)
4955 ;; Set the position to continue at. We can avoid going over
4956 ;; the comments skipped above a second time, but it's possible
4957 ;; that the comment skipping has taken us past `cfd-prop-match'
4958 ;; since the property might be used inside comments.
4959 (setq cfd-continue-pos (if cfd-prop-match
4960 (min cfd-prop-match (point))
4961 (point))))))
4962
4963 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun)
4964 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4965 ;; label from the point to CFD-LIMIT.
4966 ;;
4967 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4968 ;; arguments: The first is the end position of the token preceding the spot,
4969 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4970 ;; the match is inside a macro. Point should be moved forward by at least
4971 ;; one token.
4972 ;;
4973 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4974 ;; it should return non-nil to ensure that the next search will find them.
4975 ;;
4976 ;; Such a spot is:
4977 ;; o The first token after bob.
4978 ;; o The first token after the end of submatch 1 in
4979 ;; `c-decl-prefix-or-start-re' when that submatch matches. This
4980 ;; submatch is typically a (L or R) brace or paren, a ;, or a ,.
4981 ;; o The start of each `c-decl-prefix-or-start-re' match when
4982 ;; submatch 1 doesn't match. This is, for example, the keyword
4983 ;; "class" in Pike.
4984 ;; o The start of a previously recognized declaration; "recognized"
4985 ;; means that the last char of the previous token has a `c-type'
4986 ;; text property with the value `c-decl-end'; this only holds
4987 ;; when `c-type-decl-end-used' is set.
4988 ;;
4989 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4990 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4991 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4992 ;;
4993 ;; If the match is inside a macro then the buffer is narrowed to the
4994 ;; end of it, so that CFD-FUN can investigate the following tokens
4995 ;; without matching something that begins inside a macro and ends
4996 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4997 ;; CFD-FACE-CHECKLIST checks exist.
4998 ;;
4999 ;; The spots are visited approximately in order from top to bottom.
5000 ;; It's however the positions where `c-decl-prefix-or-start-re'
5001 ;; matches and where `c-decl-end' properties are found that are in
5002 ;; order. Since the spots often are at the following token, they
5003 ;; might be visited out of order insofar as more spots are reported
5004 ;; later on within the syntactic whitespace between the match
5005 ;; positions and their spots.
5006 ;;
5007 ;; It's assumed that comments and strings are fontified in the
5008 ;; searched range.
5009 ;;
5010 ;; This is mainly used in fontification, and so has an elaborate
5011 ;; cache to handle repeated calls from the same start position; see
5012 ;; the variables above.
5013 ;;
5014 ;; All variables in this function begin with `cfd-' to avoid name
5015 ;; collision with the (dynamically bound) variables used in CFD-FUN.
5016 ;;
5017 ;; This function might do hidden buffer changes.
5018
5019 (let ((cfd-start-pos (point)) ; never changed
5020 (cfd-buffer-end (point-max))
5021 ;; The end of the token preceding the decl spot last found
5022 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
5023 ;; no match.
5024 cfd-re-match
5025 ;; The end position of the last `c-decl-prefix-or-start-re'
5026 ;; match. If this is greater than `cfd-continue-pos', the
5027 ;; next regexp search is started here instead.
5028 (cfd-re-match-end (point-min))
5029 ;; The end of the last `c-decl-end' found by
5030 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
5031 ;; match. If searching for the property isn't needed then we
5032 ;; disable it by setting it to `cfd-limit' directly.
5033 (cfd-prop-match (unless c-type-decl-end-used cfd-limit))
5034 ;; The end of the token preceding the decl spot last found by
5035 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
5036 ;; bob. `cfd-limit' if there's no match. In other words,
5037 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
5038 (cfd-match-pos cfd-limit)
5039 ;; The position to continue searching at.
5040 cfd-continue-pos
5041 ;; The position of the last "real" token we've stopped at.
5042 ;; This can be greater than `cfd-continue-pos' when we get
5043 ;; hits inside macros or at `c-decl-end' positions inside
5044 ;; comments.
5045 (cfd-token-pos 0)
5046 ;; The end position of the last entered macro.
5047 (cfd-macro-end 0))
5048
5049 ;; Initialize by finding a syntactically relevant start position
5050 ;; before the point, and do the first `c-decl-prefix-or-start-re'
5051 ;; search unless we're at bob.
5052
5053 (let (start-in-literal start-in-macro syntactic-pos)
5054 ;; Must back up a bit since we look for the end of the previous
5055 ;; statement or declaration, which is earlier than the first
5056 ;; returned match.
5057
5058 ;; This `cond' moves back over any literals or macros. It has special
5059 ;; handling for when the region being searched is entirely within a
5060 ;; macro. It sets `cfd-continue-pos' (unless we've reached
5061 ;; `cfd-limit').
5062 (cond
5063 ;; First we need to move to a syntactically relevant position.
5064 ;; Begin by backing out of comment or string literals.
5065 ;;
5066 ;; This arm of the cond actually triggers if we're in a literal,
5067 ;; and cfd-limit is at most at BONL.
5068 ((and
5069 ;; This arm of the `and' moves backwards out of a literal when
5070 ;; the face at point is a literal face. In this case, its value
5071 ;; is always non-nil.
5072 (when (c-got-face-at (point) c-literal-faces)
5073 ;; Try to use the faces to back up to the start of the
5074 ;; literal. FIXME: What if the point is on a declaration
5075 ;; inside a comment?
5076 (while (and (not (bobp))
5077 (c-got-face-at (1- (point)) c-literal-faces))
5078 (goto-char (previous-single-property-change
5079 (point) 'face nil (point-min))))
5080
5081 ;; XEmacs doesn't fontify the quotes surrounding string
5082 ;; literals.
5083 (and (featurep 'xemacs)
5084 (eq (get-text-property (point) 'face)
5085 'font-lock-string-face)
5086 (not (bobp))
5087 (progn (backward-char)
5088 (not (looking-at c-string-limit-regexp)))
5089 (forward-char))
5090
5091 ;; Don't trust the literal to contain only literal faces
5092 ;; (the font lock package might not have fontified the
5093 ;; start of it at all, for instance) so check that we have
5094 ;; arrived at something that looks like a start or else
5095 ;; resort to `c-literal-limits'.
5096 (unless (looking-at c-literal-start-regexp)
5097 (let ((range (c-literal-limits)))
5098 (if range (goto-char (car range)))))
5099
5100 (setq start-in-literal (point))) ; end of `and' arm.
5101
5102 ;; The start is in a literal. If the limit is in the same
5103 ;; one we don't have to find a syntactic position etc. We
5104 ;; only check that if the limit is at or before bonl to save
5105 ;; time; it covers the by far most common case when font-lock
5106 ;; refontifies the current line only.
5107 (<= cfd-limit (c-point 'bonl cfd-start-pos))
5108 (save-excursion
5109 (goto-char cfd-start-pos)
5110 (while (progn
5111 (goto-char (c-next-single-property-change
5112 (point) 'face nil cfd-limit))
5113 (and (< (point) cfd-limit)
5114 (c-got-face-at (point) c-literal-faces))))
5115 (= (point) cfd-limit))) ; end of `cond' arm condition
5116
5117 ;; Completely inside a literal. Set up variables to trig the
5118 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5119 ;; find a suitable start position.
5120 (setq cfd-continue-pos start-in-literal)) ; end of `cond' arm
5121
5122 ;; Check if the region might be completely inside a macro, to
5123 ;; optimize that like the completely-inside-literal above.
5124 ((save-excursion
5125 (and (= (forward-line 1) 0)
5126 (bolp) ; forward-line has funny behavior at eob.
5127 (>= (point) cfd-limit)
5128 (progn (backward-char)
5129 (eq (char-before) ?\\))))
5130 ;; (Maybe) completely inside a macro. Only need to trig the
5131 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5132 ;; set things up.
5133 (setq cfd-continue-pos (1- cfd-start-pos)
5134 start-in-macro t))
5135
5136 ;; The default arm of the `cond' moves back over any macro we're in
5137 ;; and over any syntactic WS. It sets `c-find-decl-syntactic-pos'.
5138 (t
5139 ;; Back out of any macro so we don't miss any declaration
5140 ;; that could follow after it.
5141 (when (c-beginning-of-macro)
5142 (setq start-in-macro t))
5143
5144 ;; Now we're at a proper syntactically relevant position so we
5145 ;; can use the cache. But first clear it if it applied
5146 ;; further down.
5147 (c-invalidate-find-decl-cache cfd-start-pos)
5148
5149 (setq syntactic-pos (point))
5150 (unless (eq syntactic-pos c-find-decl-syntactic-pos)
5151 ;; Don't have to do this if the cache is relevant here,
5152 ;; typically if the same line is refontified again. If
5153 ;; we're just some syntactic whitespace further down we can
5154 ;; still use the cache to limit the skipping.
5155 (c-backward-syntactic-ws c-find-decl-syntactic-pos))
5156
5157 ;; If we hit `c-find-decl-syntactic-pos' and
5158 ;; `c-find-decl-match-pos' is set then we install the cached
5159 ;; values. If we hit `c-find-decl-syntactic-pos' and
5160 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5161 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5162 ;; and so we can continue the search from this point. If we
5163 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5164 ;; the right spot to begin searching anyway.
5165 (if (and (eq (point) c-find-decl-syntactic-pos)
5166 c-find-decl-match-pos)
5167 (setq cfd-match-pos c-find-decl-match-pos
5168 cfd-continue-pos syntactic-pos)
5169
5170 (setq c-find-decl-syntactic-pos syntactic-pos)
5171
5172 (when (if (bobp)
5173 ;; Always consider bob a match to get the first
5174 ;; declaration in the file. Do this separately instead of
5175 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5176 ;; regexp always can consume at least one character to
5177 ;; ensure that we won't get stuck in an infinite loop.
5178 (setq cfd-re-match 0)
5179 (backward-char)
5180 (c-beginning-of-current-token)
5181 (< (point) cfd-limit))
5182 ;; Do an initial search now. In the bob case above it's
5183 ;; only done to search for a `c-decl-end' spot.
5184 (c-find-decl-prefix-search)) ; sets cfd-continue-pos
5185
5186 (setq c-find-decl-match-pos (and (< cfd-match-pos cfd-start-pos)
5187 cfd-match-pos))))) ; end of `cond'
5188
5189 ;; Advance `cfd-continue-pos' if it's before the start position.
5190 ;; The closest continue position that might have effect at or
5191 ;; after the start depends on what we started in. This also
5192 ;; finds a suitable start position in the special cases when the
5193 ;; region is completely within a literal or macro.
5194 (when (and cfd-continue-pos (< cfd-continue-pos cfd-start-pos))
5195
5196 (cond
5197 (start-in-macro
5198 ;; If we're in a macro then it's the closest preceding token
5199 ;; in the macro. Check this before `start-in-literal',
5200 ;; since if we're inside a literal in a macro, the preceding
5201 ;; token is earlier than any `c-decl-end' spot inside the
5202 ;; literal (comment).
5203 (goto-char (or start-in-literal cfd-start-pos))
5204 ;; The only syntactic ws in macros are comments.
5205 (c-backward-comments)
5206 (backward-char)
5207 (c-beginning-of-current-token))
5208
5209 (start-in-literal
5210 ;; If we're in a comment it can only be the closest
5211 ;; preceding `c-decl-end' position within that comment, if
5212 ;; any. Go back to the beginning of such a property so that
5213 ;; `c-find-decl-prefix-search' will find the end of it.
5214 ;; (Can't stop at the end and install it directly on
5215 ;; `cfd-prop-match' since that variable might be cleared
5216 ;; after `cfd-fun' below.)
5217 ;;
5218 ;; Note that if the literal is a string then the property
5219 ;; search will simply skip to the beginning of it right
5220 ;; away.
5221 (if (not c-type-decl-end-used)
5222 (goto-char start-in-literal)
5223 (goto-char cfd-start-pos)
5224 (while (progn
5225 (goto-char (previous-single-property-change
5226 (point) 'c-type nil start-in-literal))
5227 (and (> (point) start-in-literal)
5228 (not (eq (c-get-char-property (point) 'c-type)
5229 'c-decl-end))))))
5230
5231 (when (= (point) start-in-literal)
5232 ;; Didn't find any property inside the comment, so we can
5233 ;; skip it entirely. (This won't skip past a string, but
5234 ;; that'll be handled quickly by the next
5235 ;; `c-find-decl-prefix-search' anyway.)
5236 (c-forward-single-comment)
5237 (if (> (point) cfd-limit)
5238 (goto-char cfd-limit))))
5239
5240 (t
5241 ;; If we started in normal code, the only match that might
5242 ;; apply before the start is what we already got in
5243 ;; `cfd-match-pos' so we can continue at the start position.
5244 ;; (Note that we don't get here if the first match is below
5245 ;; it.)
5246 (goto-char cfd-start-pos))) ; end of `cond'
5247
5248 ;; Delete found matches if they are before our new continue
5249 ;; position, so that `c-find-decl-prefix-search' won't back up
5250 ;; to them later on.
5251 (setq cfd-continue-pos (point))
5252 (when (and cfd-re-match (< cfd-re-match cfd-continue-pos))
5253 (setq cfd-re-match nil))
5254 (when (and cfd-prop-match (< cfd-prop-match cfd-continue-pos))
5255 (setq cfd-prop-match nil))) ; end of `when'
5256
5257 (if syntactic-pos
5258 ;; This is the normal case and we got a proper syntactic
5259 ;; position. If there's a match then it's always outside
5260 ;; macros and comments, so advance to the next token and set
5261 ;; `cfd-token-pos'. The loop below will later go back using
5262 ;; `cfd-continue-pos' to fix declarations inside the
5263 ;; syntactic ws.
5264 (when (and cfd-match-pos (< cfd-match-pos syntactic-pos))
5265 (goto-char syntactic-pos)
5266 (c-forward-syntactic-ws)
5267 (and cfd-continue-pos
5268 (< cfd-continue-pos (point))
5269 (setq cfd-token-pos (point))))
5270
5271 ;; Have one of the special cases when the region is completely
5272 ;; within a literal or macro. `cfd-continue-pos' is set to a
5273 ;; good start position for the search, so do it.
5274 (c-find-decl-prefix-search)))
5275
5276 ;; Now loop, one decl spot per iteration. We already have the first
5277 ;; match in `cfd-match-pos'.
5278 (while (progn
5279 ;; Go forward over "false matches", one per iteration.
5280 (while (and
5281 (< cfd-match-pos cfd-limit)
5282
5283 (or
5284 ;; Kludge to filter out matches on the "<" that
5285 ;; aren't open parens, for the sake of languages
5286 ;; that got `c-recognize-<>-arglists' set.
5287 (and (eq (char-before cfd-match-pos) ?<)
5288 (not (c-get-char-property (1- cfd-match-pos)
5289 'syntax-table)))
5290
5291 ;; If `cfd-continue-pos' is less or equal to
5292 ;; `cfd-token-pos', we've got a hit inside a macro
5293 ;; that's in the syntactic whitespace before the last
5294 ;; "real" declaration we've checked. If they're equal
5295 ;; we've arrived at the declaration a second time, so
5296 ;; there's nothing to do.
5297 (= cfd-continue-pos cfd-token-pos)
5298
5299 (progn
5300 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5301 ;; we're still searching for declarations embedded in
5302 ;; the syntactic whitespace. In that case we need
5303 ;; only to skip comments and not macros, since they
5304 ;; can't be nested, and that's already been done in
5305 ;; `c-find-decl-prefix-search'.
5306 (when (> cfd-continue-pos cfd-token-pos)
5307 (c-forward-syntactic-ws)
5308 (setq cfd-token-pos (point)))
5309
5310 ;; Continue if the following token fails the
5311 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5312 (when (or (>= (point) cfd-limit)
5313 (not (looking-at cfd-decl-re))
5314 (and cfd-face-checklist
5315 (not (c-got-face-at
5316 (point) cfd-face-checklist))))
5317 (goto-char cfd-continue-pos)
5318 t)))
5319
5320 (< (point) cfd-limit)) ; end of "false matches" condition
5321 (c-find-decl-prefix-search)) ; end of "false matches" loop
5322
5323 (< (point) cfd-limit)) ; end of condition for "decl-spot" while
5324
5325 (when (and
5326 (>= (point) cfd-start-pos)
5327
5328 (progn
5329 ;; Narrow to the end of the macro if we got a hit inside
5330 ;; one, to avoid recognizing things that start inside the
5331 ;; macro and end outside it.
5332 (when (> cfd-match-pos cfd-macro-end)
5333 ;; Not in the same macro as in the previous round.
5334 (save-excursion
5335 (goto-char cfd-match-pos)
5336 (setq cfd-macro-end
5337 (if (save-excursion (and (c-beginning-of-macro)
5338 (< (point) cfd-match-pos)))
5339 (progn (c-end-of-macro)
5340 (point))
5341 0))))
5342
5343 (if (zerop cfd-macro-end)
5344 t
5345 (if (> cfd-macro-end (point))
5346 (progn (narrow-to-region (point-min) cfd-macro-end)
5347 t)
5348 ;; The matched token was the last thing in the macro,
5349 ;; so the whole match is bogus.
5350 (setq cfd-macro-end 0)
5351 nil)))) ; end of when condition
5352
5353 (c-debug-put-decl-spot-faces cfd-match-pos (point))
5354 (if (funcall cfd-fun cfd-match-pos (/= cfd-macro-end 0))
5355 (setq cfd-prop-match nil))
5356
5357 (when (/= cfd-macro-end 0)
5358 ;; Restore limits if we did macro narrowing above.
5359 (narrow-to-region (point-min) cfd-buffer-end)))
5360
5361 (goto-char cfd-continue-pos)
5362 (if (= cfd-continue-pos cfd-limit)
5363 (setq cfd-match-pos cfd-limit)
5364 (c-find-decl-prefix-search))))) ; Moves point, sets cfd-continue-pos,
5365 ; cfd-match-pos, etc.
5366
5367 \f
5368 ;; A cache for found types.
5369
5370 ;; Buffer local variable that contains an obarray with the types we've
5371 ;; found. If a declaration is recognized somewhere we record the
5372 ;; fully qualified identifier in it to recognize it as a type
5373 ;; elsewhere in the file too. This is not accurate since we do not
5374 ;; bother with the scoping rules of the languages, but in practice the
5375 ;; same name is seldom used as both a type and something else in a
5376 ;; file, and we only use this as a last resort in ambiguous cases (see
5377 ;; `c-forward-decl-or-cast-1').
5378 ;;
5379 ;; Not every type need be in this cache. However, things which have
5380 ;; ceased to be types must be removed from it.
5381 ;;
5382 ;; Template types in C++ are added here too but with the template
5383 ;; arglist replaced with "<>" in references or "<" for the one in the
5384 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5385 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5386 ;; template specs can be fairly sized programs in themselves) and
5387 ;; improves the hit ratio (it's a type regardless of the template
5388 ;; args; it's just not the same type, but we're only interested in
5389 ;; recognizing types, not telling distinct types apart). Note that
5390 ;; template types in references are added here too; from the example
5391 ;; above there will also be an entry "Foo<".
5392 (defvar c-found-types nil)
5393 (make-variable-buffer-local 'c-found-types)
5394
5395 (defsubst c-clear-found-types ()
5396 ;; Clears `c-found-types'.
5397 (setq c-found-types (make-vector 53 0)))
5398
5399 (defun c-add-type (from to)
5400 ;; Add the given region as a type in `c-found-types'. If the region
5401 ;; doesn't match an existing type but there is a type which is equal
5402 ;; to the given one except that the last character is missing, then
5403 ;; the shorter type is removed. That's done to avoid adding all
5404 ;; prefixes of a type as it's being entered and font locked. This
5405 ;; doesn't cover cases like when characters are removed from a type
5406 ;; or added in the middle. We'd need the position of point when the
5407 ;; font locking is invoked to solve this well.
5408 ;;
5409 ;; This function might do hidden buffer changes.
5410 (let ((type (c-syntactic-content from to c-recognize-<>-arglists)))
5411 (unless (intern-soft type c-found-types)
5412 (unintern (substring type 0 -1) c-found-types)
5413 (intern type c-found-types))))
5414
5415 (defun c-unfind-type (name)
5416 ;; Remove the "NAME" from c-found-types, if present.
5417 (unintern name c-found-types))
5418
5419 (defsubst c-check-type (from to)
5420 ;; Return non-nil if the given region contains a type in
5421 ;; `c-found-types'.
5422 ;;
5423 ;; This function might do hidden buffer changes.
5424 (intern-soft (c-syntactic-content from to c-recognize-<>-arglists)
5425 c-found-types))
5426
5427 (defun c-list-found-types ()
5428 ;; Return all the types in `c-found-types' as a sorted list of
5429 ;; strings.
5430 (let (type-list)
5431 (mapatoms (lambda (type)
5432 (setq type-list (cons (symbol-name type)
5433 type-list)))
5434 c-found-types)
5435 (sort type-list 'string-lessp)))
5436
5437 ;; Shut up the byte compiler.
5438 (defvar c-maybe-stale-found-type)
5439
5440 (defun c-trim-found-types (beg end old-len)
5441 ;; An after change function which, in conjunction with the info in
5442 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5443 ;; from `c-found-types', should this type have become stale. For
5444 ;; example, this happens to "foo" when "foo \n bar();" becomes
5445 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5446 ;; the fontification.
5447 ;;
5448 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5449 ;; type?
5450 (when (> end beg)
5451 (save-excursion
5452 (when (< end (point-max))
5453 (goto-char end)
5454 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
5455 (progn (goto-char end)
5456 (c-end-of-current-token)))
5457 (c-unfind-type (buffer-substring-no-properties
5458 end (point)))))
5459 (when (> beg (point-min))
5460 (goto-char beg)
5461 (if (and (c-end-of-current-token) ; only moves when we started in the middle
5462 (progn (goto-char beg)
5463 (c-beginning-of-current-token)))
5464 (c-unfind-type (buffer-substring-no-properties
5465 (point) beg))))))
5466
5467 (if c-maybe-stale-found-type ; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
5468 (cond
5469 ;; Changing the amount of (already existing) whitespace - don't do anything.
5470 ((and (c-partial-ws-p beg end)
5471 (or (= beg end) ; removal of WS
5472 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type)))))
5473
5474 ;; The syntactic relationship which defined a "found type" has been
5475 ;; destroyed.
5476 ((eq (car c-maybe-stale-found-type) 'c-decl-id-start)
5477 (c-unfind-type (cadr c-maybe-stale-found-type)))
5478 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5479 )))
5480
5481 \f
5482 ;; Setting and removing syntax properties on < and > in languages (C++
5483 ;; and Java) where they can be template/generic delimiters as well as
5484 ;; their normal meaning of "less/greater than".
5485
5486 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5487 ;; be delimiters, they are marked as such with the category properties
5488 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5489
5490 ;; STRATEGY:
5491 ;;
5492 ;; It is impossible to determine with certainty whether a <..> pair in
5493 ;; C++ is two comparison operators or is template delimiters, unless
5494 ;; one duplicates a lot of a C++ compiler. For example, the following
5495 ;; code fragment:
5496 ;;
5497 ;; foo (a < b, c > d) ;
5498 ;;
5499 ;; could be a function call with two integer parameters (each a
5500 ;; relational expression), or it could be a constructor for class foo
5501 ;; taking one parameter d of templated type "a < b, c >". They are
5502 ;; somewhat easier to distinguish in Java.
5503 ;;
5504 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5505 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5506 ;; individually when their context so indicated. This gave rise to
5507 ;; intractable problems when one of a matching pair was deleted, or
5508 ;; pulled into a literal.]
5509 ;;
5510 ;; At each buffer change, the syntax-table properties are removed in a
5511 ;; before-change function and reapplied, when needed, in an
5512 ;; after-change function. It is far more important that the
5513 ;; properties get removed when they they are spurious than that they
5514 ;; be present when wanted.
5515 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5516 (defun c-clear-<-pair-props (&optional pos)
5517 ;; POS (default point) is at a < character. If it is marked with
5518 ;; open paren syntax-table text property, remove the property,
5519 ;; together with the close paren property on the matching > (if
5520 ;; any).
5521 (save-excursion
5522 (if pos
5523 (goto-char pos)
5524 (setq pos (point)))
5525 (when (equal (c-get-char-property (point) 'syntax-table)
5526 c-<-as-paren-syntax)
5527 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5528 (c-go-list-forward))
5529 (when (equal (c-get-char-property (1- (point)) 'syntax-table)
5530 c->-as-paren-syntax) ; should always be true.
5531 (c-unmark-<->-as-paren (1- (point))))
5532 (c-unmark-<->-as-paren pos))))
5533
5534 (defun c-clear->-pair-props (&optional pos)
5535 ;; POS (default point) is at a > character. If it is marked with
5536 ;; close paren syntax-table property, remove the property, together
5537 ;; with the open paren property on the matching < (if any).
5538 (save-excursion
5539 (if pos
5540 (goto-char pos)
5541 (setq pos (point)))
5542 (when (equal (c-get-char-property (point) 'syntax-table)
5543 c->-as-paren-syntax)
5544 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5545 (c-go-up-list-backward))
5546 (when (equal (c-get-char-property (point) 'syntax-table)
5547 c-<-as-paren-syntax) ; should always be true.
5548 (c-unmark-<->-as-paren (point)))
5549 (c-unmark-<->-as-paren pos))))
5550
5551 (defun c-clear-<>-pair-props (&optional pos)
5552 ;; POS (default point) is at a < or > character. If it has an
5553 ;; open/close paren syntax-table property, remove this property both
5554 ;; from the current character and its partner (which will also be
5555 ;; thusly marked).
5556 (cond
5557 ((eq (char-after) ?\<)
5558 (c-clear-<-pair-props pos))
5559 ((eq (char-after) ?\>)
5560 (c-clear->-pair-props pos))
5561 (t (c-benign-error
5562 "c-clear-<>-pair-props called from wrong position"))))
5563
5564 (defun c-clear-<-pair-props-if-match-after (lim &optional pos)
5565 ;; POS (default point) is at a < character. If it is both marked
5566 ;; with open/close paren syntax-table property, and has a matching >
5567 ;; (also marked) which is after LIM, remove the property both from
5568 ;; the current > and its partner. Return t when this happens, nil
5569 ;; when it doesn't.
5570 (save-excursion
5571 (if pos
5572 (goto-char pos)
5573 (setq pos (point)))
5574 (when (equal (c-get-char-property (point) 'syntax-table)
5575 c-<-as-paren-syntax)
5576 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5577 (c-go-list-forward))
5578 (when (and (>= (point) lim)
5579 (equal (c-get-char-property (1- (point)) 'syntax-table)
5580 c->-as-paren-syntax)) ; should always be true.
5581 (c-unmark-<->-as-paren (1- (point)))
5582 (c-unmark-<->-as-paren pos))
5583 t)))
5584
5585 (defun c-clear->-pair-props-if-match-before (lim &optional pos)
5586 ;; POS (default point) is at a > character. If it is both marked
5587 ;; with open/close paren syntax-table property, and has a matching <
5588 ;; (also marked) which is before LIM, remove the property both from
5589 ;; the current < and its partner. Return t when this happens, nil
5590 ;; when it doesn't.
5591 (save-excursion
5592 (if pos
5593 (goto-char pos)
5594 (setq pos (point)))
5595 (when (equal (c-get-char-property (point) 'syntax-table)
5596 c->-as-paren-syntax)
5597 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5598 (c-go-up-list-backward))
5599 (when (and (<= (point) lim)
5600 (equal (c-get-char-property (point) 'syntax-table)
5601 c-<-as-paren-syntax)) ; should always be true.
5602 (c-unmark-<->-as-paren (point))
5603 (c-unmark-<->-as-paren pos))
5604 t)))
5605
5606 ;; Set by c-common-init in cc-mode.el.
5607 (defvar c-new-BEG)
5608 (defvar c-new-END)
5609
5610 (defun c-before-change-check-<>-operators (beg end)
5611 ;; Unmark certain pairs of "< .... >" which are currently marked as
5612 ;; template/generic delimiters. (This marking is via syntax-table text
5613 ;; properties), and expand the (c-new-BEG c-new-END) region to include all
5614 ;; unmarked < and > operators within the certain bounds (see below).
5615 ;;
5616 ;; These pairs are those which are in the current "statement" (i.e.,
5617 ;; the region between the {, }, or ; before BEG and the one after
5618 ;; END), and which enclose any part of the interval (BEG END).
5619 ;;
5620 ;; Note that in C++ (?and Java), template/generic parens cannot
5621 ;; enclose a brace or semicolon, so we use these as bounds on the
5622 ;; region we must work on.
5623 ;;
5624 ;; This function is called from before-change-functions (via
5625 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5626 ;; and point is undefined, both at entry and exit.
5627 ;;
5628 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5629 ;; 2010-01-29.
5630 (save-excursion
5631 (c-save-buffer-state
5632 ((beg-lit-limits (progn (goto-char beg) (c-literal-limits)))
5633 (end-lit-limits (progn (goto-char end) (c-literal-limits)))
5634 new-beg new-end beg-limit end-limit)
5635 ;; Locate the earliest < after the barrier before the changed region,
5636 ;; which isn't already marked as a paren.
5637 (goto-char (if beg-lit-limits (car beg-lit-limits) beg))
5638 (setq beg-limit (c-determine-limit 512))
5639
5640 ;; Remove the syntax-table/category properties from each pertinent <...>
5641 ;; pair. Firstly, the ones with the < before beg and > after beg....
5642 (while (progn (c-syntactic-skip-backward "^;{}<" beg-limit)
5643 (eq (char-before) ?<))
5644 (c-backward-token-2)
5645 (when (eq (char-after) ?<)
5646 (c-clear-<-pair-props-if-match-after beg)))
5647 (c-forward-syntactic-ws)
5648 (setq new-beg (point))
5649
5650 ;; ...Then the ones with < before end and > after end.
5651 (goto-char (if end-lit-limits (cdr end-lit-limits) end))
5652 (setq end-limit (c-determine-+ve-limit 512))
5653 (while (and (c-syntactic-re-search-forward "[;{}>]" end-limit 'end)
5654 (eq (char-before) ?>))
5655 (c-end-of-current-token)
5656 (when (eq (char-before) ?>)
5657 (c-clear->-pair-props-if-match-before end (1- (point)))))
5658 (c-backward-syntactic-ws)
5659 (setq new-end (point))
5660
5661 ;; Extend the fontification region, if needed.
5662 (and new-beg
5663 (< new-beg c-new-BEG)
5664 (setq c-new-BEG new-beg))
5665 (and new-end
5666 (> new-end c-new-END)
5667 (setq c-new-END new-end)))))
5668
5669 (defun c-after-change-check-<>-operators (beg end)
5670 ;; This is called from `after-change-functions' when
5671 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5672 ;; chars with paren syntax become part of another operator like "<<"
5673 ;; or ">=".
5674 ;;
5675 ;; This function might do hidden buffer changes.
5676
5677 (save-excursion
5678 (goto-char beg)
5679 (when (or (looking-at "[<>]")
5680 (< (skip-chars-backward "<>") 0))
5681
5682 (goto-char beg)
5683 (c-beginning-of-current-token)
5684 (when (and (< (point) beg)
5685 (looking-at c-<>-multichar-token-regexp)
5686 (< beg (setq beg (match-end 0))))
5687 (while (progn (skip-chars-forward "^<>" beg)
5688 (< (point) beg))
5689 (c-clear-<>-pair-props)
5690 (forward-char))))
5691
5692 (when (< beg end)
5693 (goto-char end)
5694 (when (or (looking-at "[<>]")
5695 (< (skip-chars-backward "<>") 0))
5696
5697 (goto-char end)
5698 (c-beginning-of-current-token)
5699 (when (and (< (point) end)
5700 (looking-at c-<>-multichar-token-regexp)
5701 (< end (setq end (match-end 0))))
5702 (while (progn (skip-chars-forward "^<>" end)
5703 (< (point) end))
5704 (c-clear-<>-pair-props)
5705 (forward-char)))))))
5706
5707 (defun c-restore-<>-properties (_beg _end _old-len)
5708 ;; This function is called as an after-change function. It restores the
5709 ;; category/syntax-table properties on template/generic <..> pairs between
5710 ;; c-new-BEG and c-new-END. It may do hidden buffer changes.
5711 (c-save-buffer-state ((c-parse-and-markup-<>-arglists t)
5712 c-restricted-<>-arglists lit-limits)
5713 (goto-char c-new-BEG)
5714 (if (setq lit-limits (c-literal-limits))
5715 (goto-char (cdr lit-limits)))
5716 (while (and (< (point) c-new-END)
5717 (c-syntactic-re-search-forward "<" c-new-END 'bound))
5718 (backward-char)
5719 (save-excursion
5720 (c-backward-token-2)
5721 (setq c-restricted-<>-arglists
5722 (and (not (looking-at c-opt-<>-sexp-key))
5723 (progn (c-backward-syntactic-ws) ; to ( or ,
5724 (and (memq (char-before) '(?\( ?,)) ; what about <?
5725 (not (eq (c-get-char-property (point) 'c-type)
5726 'c-decl-arg-start)))))))
5727 (or (c-forward-<>-arglist nil)
5728 (forward-char)))))
5729 \f
5730 ;; Handling of small scale constructs like types and names.
5731
5732 ;; Dynamically bound variable that instructs `c-forward-type' to also
5733 ;; treat possible types (i.e. those that it normally returns 'maybe or
5734 ;; 'found for) as actual types (and always return 'found for them).
5735 ;; This means that it records them in `c-record-type-identifiers' if
5736 ;; that is set, and that it adds them to `c-found-types'.
5737 (defvar c-promote-possible-types nil)
5738
5739 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5740 ;; mark up successfully parsed arglists with paren syntax properties on
5741 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5742 ;; `c-type' property of each argument separating comma.
5743 ;;
5744 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5745 ;; all arglists for side effects (i.e. recording types), otherwise it
5746 ;; exploits any existing paren syntax properties to quickly jump to the
5747 ;; end of already parsed arglists.
5748 ;;
5749 ;; Marking up the arglists is not the default since doing that correctly
5750 ;; depends on a proper value for `c-restricted-<>-arglists'.
5751 (defvar c-parse-and-markup-<>-arglists nil)
5752
5753 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5754 ;; not accept arglists that contain binary operators.
5755 ;;
5756 ;; This is primarily used to handle C++ template arglists. C++
5757 ;; disambiguates them by checking whether the preceding name is a
5758 ;; template or not. We can't do that, so we assume it is a template
5759 ;; if it can be parsed as one. That usually works well since
5760 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5761 ;; in almost all cases would be pointless.
5762 ;;
5763 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5764 ;; should let the comma separate the function arguments instead. And
5765 ;; in a context where the value of the expression is taken, e.g. in
5766 ;; "if (a < b || c > d)", it's probably not a template.
5767 (defvar c-restricted-<>-arglists nil)
5768
5769 ;; Dynamically bound variables that instructs
5770 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5771 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5772 ;; `c-forward-label' to record the ranges of all the type and
5773 ;; reference identifiers they encounter. They will build lists on
5774 ;; these variables where each element is a cons of the buffer
5775 ;; positions surrounding each identifier. This recording is only
5776 ;; activated when `c-record-type-identifiers' is non-nil.
5777 ;;
5778 ;; All known types that can't be identifiers are recorded, and also
5779 ;; other possible types if `c-promote-possible-types' is set.
5780 ;; Recording is however disabled inside angle bracket arglists that
5781 ;; are encountered inside names and other angle bracket arglists.
5782 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5783 ;; instead.
5784 ;;
5785 ;; Only the names in C++ template style references (e.g. "tmpl" in
5786 ;; "tmpl<a,b>::foo") are recorded as references, other references
5787 ;; aren't handled here.
5788 ;;
5789 ;; `c-forward-label' records the label identifier(s) on
5790 ;; `c-record-ref-identifiers'.
5791 (defvar c-record-type-identifiers nil)
5792 (defvar c-record-ref-identifiers nil)
5793
5794 ;; This variable will receive a cons cell of the range of the last
5795 ;; single identifier symbol stepped over by `c-forward-name' if it's
5796 ;; successful. This is the range that should be put on one of the
5797 ;; record lists above by the caller. It's assigned nil if there's no
5798 ;; such symbol in the name.
5799 (defvar c-last-identifier-range nil)
5800
5801 (defmacro c-record-type-id (range)
5802 (if (eq (car-safe range) 'cons)
5803 ;; Always true.
5804 `(setq c-record-type-identifiers
5805 (cons ,range c-record-type-identifiers))
5806 `(let ((range ,range))
5807 (if range
5808 (setq c-record-type-identifiers
5809 (cons range c-record-type-identifiers))))))
5810
5811 (defmacro c-record-ref-id (range)
5812 (if (eq (car-safe range) 'cons)
5813 ;; Always true.
5814 `(setq c-record-ref-identifiers
5815 (cons ,range c-record-ref-identifiers))
5816 `(let ((range ,range))
5817 (if range
5818 (setq c-record-ref-identifiers
5819 (cons range c-record-ref-identifiers))))))
5820
5821 ;; Dynamically bound variable that instructs `c-forward-type' to
5822 ;; record the ranges of types that only are found. Behaves otherwise
5823 ;; like `c-record-type-identifiers'.
5824 (defvar c-record-found-types nil)
5825
5826 (defmacro c-forward-keyword-prefixed-id (type)
5827 ;; Used internally in `c-forward-keyword-clause' to move forward
5828 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5829 ;; possibly is prefixed by keywords and their associated clauses.
5830 ;; Try with a type/name first to not trip up on those that begin
5831 ;; with a keyword. Return t if a known or found type is moved
5832 ;; over. The point is clobbered if nil is returned. If range
5833 ;; recording is enabled, the identifier is recorded on as a type
5834 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5835 ;;
5836 ;; This macro might do hidden buffer changes.
5837 `(let (res)
5838 (setq c-last-identifier-range nil)
5839 (while (if (setq res ,(if (eq type 'type)
5840 `(c-forward-type)
5841 `(c-forward-name)))
5842 nil
5843 (cond ((looking-at c-keywords-regexp)
5844 (c-forward-keyword-clause 1))
5845 ((and c-opt-cpp-prefix
5846 (looking-at c-noise-macro-with-parens-name-re))
5847 (c-forward-noise-clause)))))
5848 (when (memq res '(t known found prefix maybe))
5849 (when c-record-type-identifiers
5850 ,(if (eq type 'type)
5851 `(c-record-type-id c-last-identifier-range)
5852 `(c-record-ref-id c-last-identifier-range)))
5853 t)))
5854
5855 (defmacro c-forward-id-comma-list (type update-safe-pos)
5856 ;; Used internally in `c-forward-keyword-clause' to move forward
5857 ;; over a comma separated list of types or names using
5858 ;; `c-forward-keyword-prefixed-id'.
5859 ;;
5860 ;; This macro might do hidden buffer changes.
5861 `(while (and (progn
5862 ,(when update-safe-pos
5863 `(setq safe-pos (point)))
5864 (eq (char-after) ?,))
5865 (progn
5866 (forward-char)
5867 (c-forward-syntactic-ws)
5868 (c-forward-keyword-prefixed-id ,type)))))
5869
5870 (defun c-forward-noise-clause ()
5871 ;; Point is at a c-noise-macro-with-parens-names macro identifier. Go
5872 ;; forward over this name, any parenthesis expression which follows it, and
5873 ;; any syntactic WS, ending up at the next token. If there is an unbalanced
5874 ;; paren expression, leave point at it. Always Return t.
5875 (c-forward-token-2)
5876 (if (and (eq (char-after) ?\()
5877 (c-go-list-forward))
5878 (c-forward-syntactic-ws))
5879 t)
5880
5881 (defun c-forward-keyword-clause (match)
5882 ;; Submatch MATCH in the current match data is assumed to surround a
5883 ;; token. If it's a keyword, move over it and any immediately
5884 ;; following clauses associated with it, stopping at the start of
5885 ;; the next token. t is returned in that case, otherwise the point
5886 ;; stays and nil is returned. The kind of clauses that are
5887 ;; recognized are those specified by `c-type-list-kwds',
5888 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5889 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5890 ;; and `c-<>-arglist-kwds'.
5891 ;;
5892 ;; This function records identifier ranges on
5893 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5894 ;; `c-record-type-identifiers' is non-nil.
5895 ;;
5896 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5897 ;; apply directly after the keyword, the type list is moved over
5898 ;; only when there is no unaccounted token before it (i.e. a token
5899 ;; that isn't moved over due to some other keyword list). The
5900 ;; identifier ranges in the list are still recorded if that should
5901 ;; be done, though.
5902 ;;
5903 ;; This function might do hidden buffer changes.
5904
5905 (let ((kwd-sym (c-keyword-sym (match-string match))) safe-pos pos
5906 ;; The call to `c-forward-<>-arglist' below is made after
5907 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5908 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5909 ;; should therefore be nil.
5910 (c-parse-and-markup-<>-arglists t)
5911 c-restricted-<>-arglists)
5912
5913 (when kwd-sym
5914 (goto-char (match-end match))
5915 (c-forward-syntactic-ws)
5916 (setq safe-pos (point))
5917
5918 (cond
5919 ((and (c-keyword-member kwd-sym 'c-type-list-kwds)
5920 (c-forward-keyword-prefixed-id type))
5921 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5922 (c-forward-id-comma-list type t))
5923
5924 ((and (c-keyword-member kwd-sym 'c-ref-list-kwds)
5925 (c-forward-keyword-prefixed-id ref))
5926 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5927 (c-forward-id-comma-list ref t))
5928
5929 ((and (c-keyword-member kwd-sym 'c-paren-any-kwds)
5930 (eq (char-after) ?\())
5931 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5932
5933 (forward-char)
5934 (when (and (setq pos (c-up-list-forward))
5935 (eq (char-before pos) ?\)))
5936 (when (and c-record-type-identifiers
5937 (c-keyword-member kwd-sym 'c-paren-type-kwds))
5938 ;; Use `c-forward-type' on every identifier we can find
5939 ;; inside the paren, to record the types.
5940 (while (c-syntactic-re-search-forward c-symbol-start pos t)
5941 (goto-char (match-beginning 0))
5942 (unless (c-forward-type)
5943 (looking-at c-symbol-key) ; Always matches.
5944 (goto-char (match-end 0)))))
5945
5946 (goto-char pos)
5947 (c-forward-syntactic-ws)
5948 (setq safe-pos (point))))
5949
5950 ((and (c-keyword-member kwd-sym 'c-<>-sexp-kwds)
5951 (eq (char-after) ?<)
5952 (c-forward-<>-arglist (c-keyword-member kwd-sym 'c-<>-type-kwds)))
5953 (c-forward-syntactic-ws)
5954 (setq safe-pos (point)))
5955
5956 ((and (c-keyword-member kwd-sym 'c-nonsymbol-sexp-kwds)
5957 (not (looking-at c-symbol-start))
5958 (c-safe (c-forward-sexp) t))
5959 (c-forward-syntactic-ws)
5960 (setq safe-pos (point))))
5961
5962 (when (c-keyword-member kwd-sym 'c-colon-type-list-kwds)
5963 (if (eq (char-after) ?:)
5964 ;; If we are at the colon already, we move over the type
5965 ;; list after it.
5966 (progn
5967 (forward-char)
5968 (c-forward-syntactic-ws)
5969 (when (c-forward-keyword-prefixed-id type)
5970 (c-forward-id-comma-list type t)))
5971 ;; Not at the colon, so stop here. But the identifier
5972 ;; ranges in the type list later on should still be
5973 ;; recorded.
5974 (and c-record-type-identifiers
5975 (progn
5976 ;; If a keyword matched both one of the types above and
5977 ;; this one, we match `c-colon-type-list-re' after the
5978 ;; clause matched above.
5979 (goto-char safe-pos)
5980 (looking-at c-colon-type-list-re))
5981 (progn
5982 (goto-char (match-end 0))
5983 (c-forward-syntactic-ws)
5984 (c-forward-keyword-prefixed-id type))
5985 ;; There's a type after the `c-colon-type-list-re' match
5986 ;; after a keyword in `c-colon-type-list-kwds'.
5987 (c-forward-id-comma-list type nil))))
5988
5989 (goto-char safe-pos)
5990 t)))
5991
5992 ;; cc-mode requires cc-fonts.
5993 (declare-function c-fontify-recorded-types-and-refs "cc-fonts" ())
5994
5995 (defun c-forward-<>-arglist (all-types)
5996 ;; The point is assumed to be at a "<". Try to treat it as the open
5997 ;; paren of an angle bracket arglist and move forward to the
5998 ;; corresponding ">". If successful, the point is left after the
5999 ;; ">" and t is returned, otherwise the point isn't moved and nil is
6000 ;; returned. If ALL-TYPES is t then all encountered arguments in
6001 ;; the arglist that might be types are treated as found types.
6002 ;;
6003 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
6004 ;; function handles text properties on the angle brackets and argument
6005 ;; separating commas.
6006 ;;
6007 ;; `c-restricted-<>-arglists' controls how lenient the template
6008 ;; arglist recognition should be.
6009 ;;
6010 ;; This function records identifier ranges on
6011 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6012 ;; `c-record-type-identifiers' is non-nil.
6013 ;;
6014 ;; This function might do hidden buffer changes.
6015
6016 (let ((start (point))
6017 ;; If `c-record-type-identifiers' is set then activate
6018 ;; recording of any found types that constitute an argument in
6019 ;; the arglist.
6020 (c-record-found-types (if c-record-type-identifiers t)))
6021 (if (catch 'angle-bracket-arglist-escape
6022 (setq c-record-found-types
6023 (c-forward-<>-arglist-recur all-types)))
6024 (progn
6025 (when (consp c-record-found-types)
6026 (setq c-record-type-identifiers
6027 ;; `nconc' doesn't mind that the tail of
6028 ;; `c-record-found-types' is t.
6029 (nconc c-record-found-types c-record-type-identifiers)))
6030 t)
6031
6032 (goto-char start)
6033 nil)))
6034
6035 (defun c-forward-<>-arglist-recur (all-types)
6036 ;; Recursive part of `c-forward-<>-arglist'.
6037 ;;
6038 ;; This function might do hidden buffer changes.
6039 (let ((start (point)) res pos
6040 ;; Cover this so that any recorded found type ranges are
6041 ;; automatically lost if it turns out to not be an angle
6042 ;; bracket arglist. It's propagated through the return value
6043 ;; on successful completion.
6044 (c-record-found-types c-record-found-types)
6045 ;; List that collects the positions after the argument
6046 ;; separating ',' in the arglist.
6047 arg-start-pos)
6048 ;; If the '<' has paren open syntax then we've marked it as an angle
6049 ;; bracket arglist before, so skip to the end.
6050 (if (and (not c-parse-and-markup-<>-arglists)
6051 (c-get-char-property (point) 'syntax-table))
6052
6053 (progn
6054 (forward-char)
6055 (if (and (c-go-up-list-forward)
6056 (eq (char-before) ?>))
6057 t
6058 ;; Got unmatched paren angle brackets. We don't clear the paren
6059 ;; syntax properties and retry, on the basis that it's very
6060 ;; unlikely that paren angle brackets become operators by code
6061 ;; manipulation. It's far more likely that it doesn't match due
6062 ;; to narrowing or some temporary change.
6063 (goto-char start)
6064 nil))
6065
6066 (forward-char) ; Forward over the opening '<'.
6067
6068 (unless (looking-at c-<-op-cont-regexp)
6069 ;; go forward one non-alphanumeric character (group) per iteration of
6070 ;; this loop.
6071 (while (and
6072 (progn
6073 (c-forward-syntactic-ws)
6074 (when (or (and c-record-type-identifiers all-types)
6075 (not (equal c-inside-<>-type-key "\\(\\<\\>\\)")))
6076 (c-forward-syntactic-ws)
6077 (cond
6078 ((eq (char-after) ??)
6079 (forward-char))
6080 ((and (looking-at c-identifier-start)
6081 (not (looking-at c-keywords-regexp)))
6082 (if (or (and all-types c-record-type-identifiers)
6083 (c-major-mode-is 'java-mode))
6084 ;; All encountered identifiers are types, so set the
6085 ;; promote flag and parse the type.
6086 (let ((c-promote-possible-types t)
6087 (c-record-found-types t))
6088 (c-forward-type))
6089 (c-forward-token-2))))
6090
6091 (c-forward-syntactic-ws)
6092
6093 (when (looking-at c-inside-<>-type-key)
6094 (goto-char (match-end 1))
6095 (c-forward-syntactic-ws)
6096 (let ((c-promote-possible-types t)
6097 (c-record-found-types t))
6098 (c-forward-type))
6099 (c-forward-syntactic-ws)))
6100
6101 (setq pos (point)) ; e.g. first token inside the '<'
6102
6103 ;; Note: These regexps exploit the match order in \| so
6104 ;; that "<>" is matched by "<" rather than "[^>:-]>".
6105 (c-syntactic-re-search-forward
6106 ;; Stop on ',', '|', '&', '+' and '-' to catch
6107 ;; common binary operators that could be between
6108 ;; two comparison expressions "a<b" and "c>d".
6109 ;; 2016-02-11: C++11 templates can now contain arithmetic
6110 ;; expressions, so template detection in C++ is now less
6111 ;; robust than it was.
6112 c-<>-notable-chars-re
6113 nil t t))
6114
6115 (cond
6116 ((eq (char-before) ?>)
6117 ;; Either an operator starting with '>' or the end of
6118 ;; the angle bracket arglist.
6119
6120 (if (save-excursion
6121 (c-backward-token-2)
6122 (looking-at c-multichar->-op-not->>-regexp))
6123 (progn
6124 (goto-char (match-end 0))
6125 t) ; Continue the loop.
6126
6127 ;; The angle bracket arglist is finished.
6128 (when c-parse-and-markup-<>-arglists
6129 (while arg-start-pos
6130 (c-put-c-type-property (1- (car arg-start-pos))
6131 'c-<>-arg-sep)
6132 (setq arg-start-pos (cdr arg-start-pos)))
6133 (c-mark-<-as-paren start)
6134 (c-mark->-as-paren (1- (point))))
6135 (setq res t)
6136 nil)) ; Exit the loop.
6137
6138 ((eq (char-before) ?<)
6139 ;; Either an operator starting with '<' or a nested arglist.
6140 (setq pos (point))
6141 (let (id-start id-end subres keyword-match)
6142 (cond
6143 ;; The '<' begins a multi-char operator.
6144 ((looking-at c-<-op-cont-regexp)
6145 (goto-char (match-end 0)))
6146 ;; We're at a nested <.....>
6147 ((progn
6148 (backward-char) ; to the '<'
6149 (and
6150 (save-excursion
6151 ;; There's always an identifier before an angle
6152 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
6153 ;; or `c-<>-arglist-kwds'.
6154 (c-backward-syntactic-ws)
6155 (setq id-end (point))
6156 (c-simple-skip-symbol-backward)
6157 (when (or (setq keyword-match
6158 (looking-at c-opt-<>-sexp-key))
6159 (not (looking-at c-keywords-regexp)))
6160 (setq id-start (point))))
6161 (setq subres
6162 (let ((c-promote-possible-types t)
6163 (c-record-found-types t))
6164 (c-forward-<>-arglist-recur
6165 (and keyword-match
6166 (c-keyword-member
6167 (c-keyword-sym (match-string 1))
6168 'c-<>-type-kwds))))))
6169 (or subres (goto-char pos))
6170 subres)
6171 ;; It was an angle bracket arglist.
6172 (setq c-record-found-types subres)
6173
6174 ;; Record the identifier before the template as a type
6175 ;; or reference depending on whether the arglist is last
6176 ;; in a qualified identifier.
6177 (when (and c-record-type-identifiers
6178 (not keyword-match))
6179 (if (and c-opt-identifier-concat-key
6180 (progn
6181 (c-forward-syntactic-ws)
6182 (looking-at c-opt-identifier-concat-key)))
6183 (c-record-ref-id (cons id-start id-end))
6184 (c-record-type-id (cons id-start id-end)))))
6185
6186 ;; At a "less than" operator.
6187 (t
6188 ;; (forward-char) ; NO! We've already gone over the <.
6189 )))
6190 t) ; carry on looping.
6191
6192 ((and
6193 (eq (char-before) ?\()
6194 (c-go-up-list-forward)
6195 (eq (char-before) ?\))))
6196
6197 ((and (not c-restricted-<>-arglists)
6198 (or (and (eq (char-before) ?&)
6199 (not (eq (char-after) ?&)))
6200 (eq (char-before) ?,)))
6201 ;; Just another argument. Record the position. The
6202 ;; type check stuff that made us stop at it is at
6203 ;; the top of the loop.
6204 (setq arg-start-pos (cons (point) arg-start-pos)))
6205
6206 (t
6207 ;; Got a character that can't be in an angle bracket
6208 ;; arglist argument. Abort using `throw', since
6209 ;; it's useless to try to find a surrounding arglist
6210 ;; if we're nested.
6211 (throw 'angle-bracket-arglist-escape nil))))))
6212 (if res
6213 (or c-record-found-types t)))))
6214
6215 (defun c-backward-<>-arglist (all-types &optional limit)
6216 ;; The point is assumed to be directly after a ">". Try to treat it
6217 ;; as the close paren of an angle bracket arglist and move back to
6218 ;; the corresponding "<". If successful, the point is left at
6219 ;; the "<" and t is returned, otherwise the point isn't moved and
6220 ;; nil is returned. ALL-TYPES is passed on to
6221 ;; `c-forward-<>-arglist'.
6222 ;;
6223 ;; If the optional LIMIT is given, it bounds the backward search.
6224 ;; It's then assumed to be at a syntactically relevant position.
6225 ;;
6226 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6227 ;; function for more details.
6228
6229 (let ((start (point)))
6230 (backward-char)
6231 (if (and (not c-parse-and-markup-<>-arglists)
6232 (c-get-char-property (point) 'syntax-table))
6233
6234 (if (and (c-go-up-list-backward)
6235 (eq (char-after) ?<))
6236 t
6237 ;; See corresponding note in `c-forward-<>-arglist'.
6238 (goto-char start)
6239 nil)
6240
6241 (while (progn
6242 (c-syntactic-skip-backward "^<;{}" limit t)
6243
6244 (and
6245 (if (eq (char-before) ?<)
6246 t
6247 ;; Stopped at bob or a char that isn't allowed in an
6248 ;; arglist, so we've failed.
6249 (goto-char start)
6250 nil)
6251
6252 (if (> (point)
6253 (progn (c-beginning-of-current-token)
6254 (point)))
6255 ;; If we moved then the "<" was part of some
6256 ;; multicharacter token.
6257 t
6258
6259 (backward-char)
6260 (let ((beg-pos (point)))
6261 (if (c-forward-<>-arglist all-types)
6262 (cond ((= (point) start)
6263 ;; Matched the arglist. Break the while.
6264 (goto-char beg-pos)
6265 nil)
6266 ((> (point) start)
6267 ;; We started from a non-paren ">" inside an
6268 ;; arglist.
6269 (goto-char start)
6270 nil)
6271 (t
6272 ;; Matched a shorter arglist. Can be a nested
6273 ;; one so continue looking.
6274 (goto-char beg-pos)
6275 t))
6276 t))))))
6277
6278 (/= (point) start))))
6279
6280 (defun c-forward-name ()
6281 ;; Move forward over a complete name if at the beginning of one,
6282 ;; stopping at the next following token. A keyword, as such,
6283 ;; doesn't count as a name. If the point is not at something that
6284 ;; is recognized as a name then it stays put.
6285 ;;
6286 ;; A name could be something as simple as "foo" in C or something as
6287 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6288 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6289 ;; int>::*volatile const" in C++ (this function is actually little
6290 ;; more than a `looking-at' call in all modes except those that,
6291 ;; like C++, have `c-recognize-<>-arglists' set).
6292 ;;
6293 ;; Return
6294 ;; o - nil if no name is found;
6295 ;; o - 'template if it's an identifier ending with an angle bracket
6296 ;; arglist;
6297 ;; o - 'operator of it's an operator identifier;
6298 ;; o - t if it's some other kind of name.
6299 ;;
6300 ;; This function records identifier ranges on
6301 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6302 ;; `c-record-type-identifiers' is non-nil.
6303 ;;
6304 ;; This function might do hidden buffer changes.
6305
6306 (let ((pos (point)) (start (point)) res id-start id-end
6307 ;; Turn off `c-promote-possible-types' here since we might
6308 ;; call `c-forward-<>-arglist' and we don't want it to promote
6309 ;; every suspect thing in the arglist to a type. We're
6310 ;; typically called from `c-forward-type' in this case, and
6311 ;; the caller only wants the top level type that it finds to
6312 ;; be promoted.
6313 c-promote-possible-types)
6314 (while
6315 (and
6316 (looking-at c-identifier-key)
6317
6318 (progn
6319 ;; Check for keyword. We go to the last symbol in
6320 ;; `c-identifier-key' first.
6321 (goto-char (setq id-end (match-end 0)))
6322 (c-simple-skip-symbol-backward)
6323 (setq id-start (point))
6324
6325 (if (looking-at c-keywords-regexp)
6326 (when (and (c-major-mode-is 'c++-mode)
6327 (looking-at
6328 (cc-eval-when-compile
6329 (concat "\\(operator\\|\\(template\\)\\)"
6330 "\\(" (c-lang-const c-nonsymbol-key c++)
6331 "\\|$\\)")))
6332 (if (match-beginning 2)
6333 ;; "template" is only valid inside an
6334 ;; identifier if preceded by "::".
6335 (save-excursion
6336 (c-backward-syntactic-ws)
6337 (and (c-safe (backward-char 2) t)
6338 (looking-at "::")))
6339 t))
6340
6341 ;; Handle a C++ operator or template identifier.
6342 (goto-char id-end)
6343 (c-forward-syntactic-ws)
6344 (cond ((eq (char-before id-end) ?e)
6345 ;; Got "... ::template".
6346 (let ((subres (c-forward-name)))
6347 (when subres
6348 (setq pos (point)
6349 res subres))))
6350
6351 ((looking-at c-identifier-start)
6352 ;; Got a cast operator.
6353 (when (c-forward-type)
6354 (setq pos (point)
6355 res 'operator)
6356 ;; Now we should match a sequence of either
6357 ;; '*', '&' or a name followed by ":: *",
6358 ;; where each can be followed by a sequence
6359 ;; of `c-opt-type-modifier-key'.
6360 (while (cond ((looking-at "[*&]")
6361 (goto-char (match-end 0))
6362 t)
6363 ((looking-at c-identifier-start)
6364 (and (c-forward-name)
6365 (looking-at "::")
6366 (progn
6367 (goto-char (match-end 0))
6368 (c-forward-syntactic-ws)
6369 (eq (char-after) ?*))
6370 (progn
6371 (forward-char)
6372 t))))
6373 (while (progn
6374 (c-forward-syntactic-ws)
6375 (setq pos (point))
6376 (looking-at c-opt-type-modifier-key))
6377 (goto-char (match-end 1))))))
6378
6379 ((looking-at c-overloadable-operators-regexp)
6380 ;; Got some other operator.
6381 (setq c-last-identifier-range
6382 (cons (point) (match-end 0)))
6383 (goto-char (match-end 0))
6384 (c-forward-syntactic-ws)
6385 (setq pos (point)
6386 res 'operator)))
6387
6388 nil)
6389
6390 ;; `id-start' is equal to `id-end' if we've jumped over
6391 ;; an identifier that doesn't end with a symbol token.
6392 ;; That can occur e.g. for Java import directives on the
6393 ;; form "foo.bar.*".
6394 (when (and id-start (/= id-start id-end))
6395 (setq c-last-identifier-range
6396 (cons id-start id-end)))
6397 (goto-char id-end)
6398 (c-forward-syntactic-ws)
6399 (setq pos (point)
6400 res t)))
6401
6402 (progn
6403 (goto-char pos)
6404 (when (or c-opt-identifier-concat-key
6405 c-recognize-<>-arglists)
6406
6407 (cond
6408 ((and c-opt-identifier-concat-key
6409 (looking-at c-opt-identifier-concat-key))
6410 ;; Got a concatenated identifier. This handles the
6411 ;; cases with tricky syntactic whitespace that aren't
6412 ;; covered in `c-identifier-key'.
6413 (goto-char (match-end 0))
6414 (c-forward-syntactic-ws)
6415 t)
6416
6417 ((and c-recognize-<>-arglists
6418 (eq (char-after) ?<))
6419 ;; Maybe an angle bracket arglist.
6420 (when (let (c-last-identifier-range)
6421 (c-forward-<>-arglist nil))
6422
6423 (c-forward-syntactic-ws)
6424 (unless (eq (char-after) ?\()
6425 (setq c-last-identifier-range nil)
6426 (c-add-type start (1+ pos)))
6427 (setq pos (point))
6428
6429 (if (and c-opt-identifier-concat-key
6430 (looking-at c-opt-identifier-concat-key))
6431
6432 ;; Continue if there's an identifier concatenation
6433 ;; operator after the template argument.
6434 (progn
6435 (when (and c-record-type-identifiers id-start)
6436 (c-record-ref-id (cons id-start id-end)))
6437 (forward-char 2)
6438 (c-forward-syntactic-ws)
6439 t)
6440
6441 (when (and c-record-type-identifiers id-start
6442 (not (eq (char-after) ?\()))
6443 (c-record-type-id (cons id-start id-end)))
6444 (setq res 'template)
6445 nil)))
6446 )))))
6447
6448 (goto-char pos)
6449 res))
6450
6451 (defun c-forward-type (&optional brace-block-too)
6452 ;; Move forward over a type spec if at the beginning of one,
6453 ;; stopping at the next following token. The keyword "typedef"
6454 ;; isn't part of a type spec here.
6455 ;;
6456 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6457 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6458 ;; The current (2009-03-10) intention is to convert all uses of
6459 ;; `c-forward-type' to call with this parameter set, then to
6460 ;; eliminate it.
6461 ;;
6462 ;; Return
6463 ;; o - t if it's a known type that can't be a name or other
6464 ;; expression;
6465 ;; o - 'known if it's an otherwise known type (according to
6466 ;; `*-font-lock-extra-types');
6467 ;; o - 'prefix if it's a known prefix of a type;
6468 ;; o - 'found if it's a type that matches one in `c-found-types';
6469 ;; o - 'maybe if it's an identifier that might be a type;
6470 ;; o - 'decltype if it's a decltype(variable) declaration; - or
6471 ;; o - nil if it can't be a type (the point isn't moved then).
6472 ;;
6473 ;; The point is assumed to be at the beginning of a token.
6474 ;;
6475 ;; Note that this function doesn't skip past the brace definition
6476 ;; that might be considered part of the type, e.g.
6477 ;; "enum {a, b, c} foo".
6478 ;;
6479 ;; This function records identifier ranges on
6480 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6481 ;; `c-record-type-identifiers' is non-nil.
6482 ;;
6483 ;; This function might do hidden buffer changes.
6484 (when (and c-recognize-<>-arglists
6485 (looking-at "<"))
6486 (c-forward-<>-arglist t)
6487 (c-forward-syntactic-ws))
6488
6489 (let ((start (point)) pos res name-res id-start id-end id-range)
6490
6491 ;; Skip leading type modifiers. If any are found we know it's a
6492 ;; prefix of a type.
6493 (when c-opt-type-modifier-key ; e.g. "const" "volatile", but NOT "typedef"
6494 (while (looking-at c-opt-type-modifier-key)
6495 (goto-char (match-end 1))
6496 (c-forward-syntactic-ws)
6497 (setq res 'prefix)))
6498
6499 (cond
6500 ((looking-at c-typeof-key) ; e.g. C++'s "decltype".
6501 (goto-char (match-end 1))
6502 (c-forward-syntactic-ws)
6503 (setq res (and (eq (char-after) ?\()
6504 (c-safe (c-forward-sexp))
6505 'decltype))
6506 (if res
6507 (c-forward-syntactic-ws)
6508 (goto-char start)))
6509
6510 ((looking-at c-type-prefix-key) ; e.g. "struct", "class", but NOT
6511 ; "typedef".
6512 (goto-char (match-end 1))
6513 (c-forward-syntactic-ws)
6514
6515 (while (cond
6516 ((looking-at c-decl-hangon-key)
6517 (c-forward-keyword-clause 1))
6518 ((and c-opt-cpp-prefix
6519 (looking-at c-noise-macro-with-parens-name-re))
6520 (c-forward-noise-clause))))
6521
6522 (setq pos (point))
6523
6524 (setq name-res (c-forward-name))
6525 (setq res (not (null name-res)))
6526 (when (eq name-res t)
6527 ;; In many languages the name can be used without the
6528 ;; prefix, so we add it to `c-found-types'.
6529 (c-add-type pos (point))
6530 (when (and c-record-type-identifiers
6531 c-last-identifier-range)
6532 (c-record-type-id c-last-identifier-range)))
6533 (when (and brace-block-too
6534 (memq res '(t nil))
6535 (eq (char-after) ?\{)
6536 (save-excursion
6537 (c-safe
6538 (progn (c-forward-sexp)
6539 (c-forward-syntactic-ws)
6540 (setq pos (point))))))
6541 (goto-char pos)
6542 (setq res t))
6543 (unless res (goto-char start))) ; invalid syntax
6544
6545 ((progn
6546 (setq pos nil)
6547 (if (looking-at c-identifier-start)
6548 (save-excursion
6549 (setq id-start (point)
6550 name-res (c-forward-name))
6551 (when name-res
6552 (setq id-end (point)
6553 id-range c-last-identifier-range))))
6554 (and (cond ((looking-at c-primitive-type-key)
6555 (setq res t))
6556 ((c-with-syntax-table c-identifier-syntax-table
6557 (looking-at c-known-type-key))
6558 (setq res 'known)))
6559 (or (not id-end)
6560 (>= (save-excursion
6561 (save-match-data
6562 (goto-char (match-end 1))
6563 (c-forward-syntactic-ws)
6564 (setq pos (point))))
6565 id-end)
6566 (setq res nil))))
6567 ;; Looking at a primitive or known type identifier. We've
6568 ;; checked for a name first so that we don't go here if the
6569 ;; known type match only is a prefix of another name.
6570
6571 (setq id-end (match-end 1))
6572
6573 (when (and c-record-type-identifiers
6574 (or c-promote-possible-types (eq res t)))
6575 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
6576
6577 (if (and c-opt-type-component-key
6578 (save-match-data
6579 (looking-at c-opt-type-component-key)))
6580 ;; There might be more keywords for the type.
6581 (let (safe-pos)
6582 (c-forward-keyword-clause 1)
6583 (while (progn
6584 (setq safe-pos (point))
6585 (looking-at c-opt-type-component-key))
6586 (when (and c-record-type-identifiers
6587 (looking-at c-primitive-type-key))
6588 (c-record-type-id (cons (match-beginning 1)
6589 (match-end 1))))
6590 (c-forward-keyword-clause 1))
6591 (if (looking-at c-primitive-type-key)
6592 (progn
6593 (when c-record-type-identifiers
6594 (c-record-type-id (cons (match-beginning 1)
6595 (match-end 1))))
6596 (c-forward-keyword-clause 1)
6597 (setq res t))
6598 (goto-char safe-pos)
6599 (setq res 'prefix)))
6600 (unless (save-match-data (c-forward-keyword-clause 1))
6601 (if pos
6602 (goto-char pos)
6603 (goto-char (match-end 1))
6604 (c-forward-syntactic-ws)))))
6605
6606 (name-res
6607 (cond ((eq name-res t)
6608 ;; A normal identifier.
6609 (goto-char id-end)
6610 (if (or res c-promote-possible-types)
6611 (progn
6612 (c-add-type id-start id-end)
6613 (when (and c-record-type-identifiers id-range)
6614 (c-record-type-id id-range))
6615 (unless res
6616 (setq res 'found)))
6617 (setq res (if (c-check-type id-start id-end)
6618 ;; It's an identifier that has been used as
6619 ;; a type somewhere else.
6620 'found
6621 ;; It's an identifier that might be a type.
6622 'maybe))))
6623 ((eq name-res 'template)
6624 ;; A template is sometimes a type.
6625 (goto-char id-end)
6626 (c-forward-syntactic-ws)
6627 (setq res
6628 (if (eq (char-after) ?\()
6629 (if (c-check-type id-start id-end)
6630 ;; It's an identifier that has been used as
6631 ;; a type somewhere else.
6632 'found
6633 ;; It's an identifier that might be a type.
6634 'maybe)
6635 t)))
6636 (t
6637 ;; Otherwise it's an operator identifier, which is not a type.
6638 (goto-char start)
6639 (setq res nil)))))
6640
6641 (when res
6642 ;; Skip trailing type modifiers. If any are found we know it's
6643 ;; a type.
6644 (when c-opt-type-modifier-key
6645 (while (looking-at c-opt-type-modifier-key) ; e.g. "const", "volatile"
6646 (goto-char (match-end 1))
6647 (c-forward-syntactic-ws)
6648 (setq res t)))
6649
6650 ;; Step over any type suffix operator. Do not let the existence
6651 ;; of these alter the classification of the found type, since
6652 ;; these operators typically are allowed in normal expressions
6653 ;; too.
6654 (when c-opt-type-suffix-key ; e.g. "..."
6655 (while (looking-at c-opt-type-suffix-key)
6656 (goto-char (match-end 1))
6657 (c-forward-syntactic-ws)))
6658
6659 (when c-opt-type-concat-key ; Only/mainly for pike.
6660 ;; Look for a trailing operator that concatenates the type
6661 ;; with a following one, and if so step past that one through
6662 ;; a recursive call. Note that we don't record concatenated
6663 ;; types in `c-found-types' - it's the component types that
6664 ;; are recorded when appropriate.
6665 (setq pos (point))
6666 (let* ((c-promote-possible-types (or (memq res '(t known))
6667 c-promote-possible-types))
6668 ;; If we can't promote then set `c-record-found-types' so that
6669 ;; we can merge in the types from the second part afterwards if
6670 ;; it turns out to be a known type there.
6671 (c-record-found-types (and c-record-type-identifiers
6672 (not c-promote-possible-types)))
6673 subres)
6674 (if (and (looking-at c-opt-type-concat-key)
6675
6676 (progn
6677 (goto-char (match-end 1))
6678 (c-forward-syntactic-ws)
6679 (setq subres (c-forward-type))))
6680
6681 (progn
6682 ;; If either operand certainly is a type then both are, but we
6683 ;; don't let the existence of the operator itself promote two
6684 ;; uncertain types to a certain one.
6685 (cond ((eq res t))
6686 ((eq subres t)
6687 (unless (eq name-res 'template)
6688 (c-add-type id-start id-end))
6689 (when (and c-record-type-identifiers id-range)
6690 (c-record-type-id id-range))
6691 (setq res t))
6692 ((eq res 'known))
6693 ((eq subres 'known)
6694 (setq res 'known))
6695 ((eq res 'found))
6696 ((eq subres 'found)
6697 (setq res 'found))
6698 (t
6699 (setq res 'maybe)))
6700
6701 (when (and (eq res t)
6702 (consp c-record-found-types))
6703 ;; Merge in the ranges of any types found by the second
6704 ;; `c-forward-type'.
6705 (setq c-record-type-identifiers
6706 ;; `nconc' doesn't mind that the tail of
6707 ;; `c-record-found-types' is t.
6708 (nconc c-record-found-types
6709 c-record-type-identifiers))))
6710
6711 (goto-char pos))))
6712
6713 (when (and c-record-found-types (memq res '(known found)) id-range)
6714 (setq c-record-found-types
6715 (cons id-range c-record-found-types))))
6716
6717 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6718
6719 res))
6720
6721 (defun c-forward-annotation ()
6722 ;; Used for Java code only at the moment. Assumes point is on the @, moves
6723 ;; forward an annotation and returns t. Leaves point unmoved and returns
6724 ;; nil if there is no annotation at point.
6725 (let ((pos (point)))
6726 (or
6727 (and (looking-at "@")
6728 (not (looking-at c-keywords-regexp))
6729 (progn (forward-char) t)
6730 (looking-at c-symbol-key)
6731 (progn (goto-char (match-end 0))
6732 (c-forward-syntactic-ws)
6733 t)
6734 (if (looking-at "(")
6735 (c-go-list-forward)
6736 t))
6737 (progn (goto-char pos) nil))))
6738
6739 (defmacro c-pull-open-brace (ps)
6740 ;; Pull the next open brace from PS (which has the form of paren-state),
6741 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
6742 `(progn
6743 (while (consp (car ,ps))
6744 (setq ,ps (cdr ,ps)))
6745 (prog1 (car ,ps)
6746 (setq ,ps (cdr ,ps)))))
6747
6748 (defun c-back-over-member-initializer-braces ()
6749 ;; Point is just after a closing brace/parenthesis. Try to parse this as a
6750 ;; C++ member initializer list, going back to just after the introducing ":"
6751 ;; and returning t. Otherwise return nil, leaving point unchanged.
6752 (let ((here (point)) res)
6753 (setq res
6754 (catch 'done
6755 (when (not (c-go-list-backward))
6756 (throw 'done nil))
6757 (c-backward-syntactic-ws)
6758 (when (not (c-simple-skip-symbol-backward))
6759 (throw 'done nil))
6760 (c-backward-syntactic-ws)
6761
6762 (while (eq (char-before) ?,)
6763 (backward-char)
6764 (c-backward-syntactic-ws)
6765 (when (not (memq (char-before) '(?\) ?})))
6766 (throw 'done nil))
6767 (when (not (c-go-list-backward))
6768 (throw 'done nil))
6769 (c-backward-syntactic-ws)
6770 (when (not (c-simple-skip-symbol-backward))
6771 (throw 'done nil))
6772 (c-backward-syntactic-ws))
6773
6774 (eq (char-before) ?:)))
6775 (or res (goto-char here))
6776 res))
6777
6778 (defmacro c-back-over-list-of-member-inits ()
6779 ;; Go back over a list of elements, each looking like:
6780 ;; <symbol> (<expression>) ,
6781 ;; or <symbol> {<expression>} ,
6782 ;; when we are putatively immediately after a comma. Stop when we don't see
6783 ;; a comma. If either of <symbol> or bracketed <expression> is missing,
6784 ;; throw nil to 'level. If the terminating } or ) is unmatched, throw nil
6785 ;; to 'done. This is not a general purpose macro!
6786 `(while (eq (char-before) ?,)
6787 (backward-char)
6788 (c-backward-syntactic-ws)
6789 (when (not (memq (char-before) '(?\) ?})))
6790 (throw 'level nil))
6791 (when (not (c-go-list-backward))
6792 (throw 'done nil))
6793 (c-backward-syntactic-ws)
6794 (when (not (c-simple-skip-symbol-backward))
6795 (throw 'level nil))
6796 (c-backward-syntactic-ws)))
6797
6798 (defun c-back-over-member-initializers ()
6799 ;; Test whether we are in a C++ member initializer list, and if so, go back
6800 ;; to the introducing ":", returning the position of the opening paren of
6801 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6802 (let ((here (point))
6803 (paren-state (c-parse-state))
6804 pos level-plausible at-top-level res)
6805 ;; Assume tentatively that we're at the top level. Try to go back to the
6806 ;; colon we seek.
6807 (setq res
6808 (catch 'done
6809 (setq level-plausible
6810 (catch 'level
6811 (c-backward-syntactic-ws)
6812 (when (memq (char-before) '(?\) ?}))
6813 (when (not (c-go-list-backward))
6814 (throw 'done nil))
6815 (c-backward-syntactic-ws))
6816 (when (c-simple-skip-symbol-backward)
6817 (c-backward-syntactic-ws))
6818 (c-back-over-list-of-member-inits)
6819 (and (eq (char-before) ?:)
6820 (save-excursion
6821 (c-backward-token-2)
6822 (not (looking-at c-:$-multichar-token-regexp)))
6823 (c-just-after-func-arglist-p))))
6824
6825 (while (and (not (and level-plausible
6826 (setq at-top-level (c-at-toplevel-p))))
6827 (setq pos (c-pull-open-brace paren-state))) ; might be a paren.
6828 (setq level-plausible
6829 (catch 'level
6830 (goto-char pos)
6831 (c-backward-syntactic-ws)
6832 (when (not (c-simple-skip-symbol-backward))
6833 (throw 'level nil))
6834 (c-backward-syntactic-ws)
6835 (c-back-over-list-of-member-inits)
6836 (and (eq (char-before) ?:)
6837 (save-excursion
6838 (c-backward-token-2)
6839 (not (looking-at c-:$-multichar-token-regexp)))
6840 (c-just-after-func-arglist-p)))))
6841
6842 (and at-top-level level-plausible)))
6843 (or res (goto-char here))
6844 res))
6845
6846 \f
6847 ;; Handling of large scale constructs like statements and declarations.
6848
6849 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6850 ;; defsubst or perhaps even a defun, but it contains lots of free
6851 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6852 (defmacro c-fdoc-shift-type-backward (&optional short)
6853 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6854 ;; of types when parsing a declaration, which means that it
6855 ;; sometimes consumes the identifier in the declaration as a type.
6856 ;; This is used to "backtrack" and make the last type be treated as
6857 ;; an identifier instead.
6858 `(progn
6859 ,(unless short
6860 ;; These identifiers are bound only in the inner let.
6861 '(setq identifier-type at-type
6862 identifier-start type-start
6863 got-parens nil
6864 got-identifier t
6865 got-suffix t
6866 got-suffix-after-parens id-start
6867 paren-depth 0))
6868
6869 (if (setq at-type (if (eq backup-at-type 'prefix)
6870 t
6871 backup-at-type))
6872 (setq type-start backup-type-start
6873 id-start backup-id-start)
6874 (setq type-start start-pos
6875 id-start start-pos))
6876
6877 ;; When these flags already are set we've found specifiers that
6878 ;; unconditionally signal these attributes - backtracking doesn't
6879 ;; change that. So keep them set in that case.
6880 (or at-type-decl
6881 (setq at-type-decl backup-at-type-decl))
6882 (or maybe-typeless
6883 (setq maybe-typeless backup-maybe-typeless))
6884
6885 ,(unless short
6886 ;; This identifier is bound only in the inner let.
6887 '(setq start id-start))))
6888
6889 (defun c-forward-declarator (&optional limit accept-anon)
6890 ;; Assuming point is at the start of a declarator, move forward over it,
6891 ;; leaving point at the next token after it (e.g. a ) or a ; or a ,).
6892 ;;
6893 ;; Return a list (ID-START ID-END BRACKETS-AFTER-ID GOT-INIT), where ID-START and
6894 ;; ID-END are the bounds of the declarator's identifier, and
6895 ;; BRACKETS-AFTER-ID is non-nil if a [...] pair is present after the id.
6896 ;; GOT-INIT is non-nil when the declarator is followed by "=" or "(".
6897 ;;
6898 ;; If ACCEPT-ANON is non-nil, move forward over any "anonymous declarator",
6899 ;; i.e. something like the (*) in int (*), such as might be found in a
6900 ;; declaration. In such a case ID-START and ID-END in the return value are
6901 ;; both set to nil. A "null" "anonymous declarator" gives a non-nil result.
6902 ;;
6903 ;; If no declarator is found, leave point unmoved and return nil. LIMIT is
6904 ;; an optional limit for forward searching.
6905 ;;
6906 ;; Note that the global variable `c-last-identifier-range' is written to, so
6907 ;; the caller should bind it if necessary.
6908
6909 ;; Inside the following "condition form", we move forward over the
6910 ;; declarator's identifier up as far as any opening bracket (for array
6911 ;; size) or paren (for parameters of function-type) or brace (for
6912 ;; array/struct initialization) or "=" or terminating delimiter
6913 ;; (e.g. "," or ";" or "}").
6914 (let ((here (point))
6915 id-start id-end brackets-after-id paren-depth)
6916 (or limit (setq limit (point-max)))
6917 (if (and
6918 (< (point) limit)
6919
6920 ;; The following form moves forward over the declarator's
6921 ;; identifier (and what precedes it), returning t. If there
6922 ;; wasn't one, it returns nil.
6923 (let (got-identifier)
6924 (setq paren-depth 0)
6925 ;; Skip over type decl prefix operators, one for each iteration
6926 ;; of the while. These are, e.g. "*" in "int *foo" or "(" and
6927 ;; "*" in "int (*foo) (void)" (Note similar code in
6928 ;; `c-forward-decl-or-cast-1'.)
6929 (while
6930 (cond
6931 ((looking-at c-decl-hangon-key)
6932 (c-forward-keyword-clause 1))
6933 ((and c-opt-cpp-prefix
6934 (looking-at c-noise-macro-with-parens-name-re))
6935 (c-forward-noise-clause))
6936 ((and (looking-at c-type-decl-prefix-key)
6937 (if (and (c-major-mode-is 'c++-mode)
6938 (match-beginning 3))
6939 ;; If the third submatch matches in C++ then
6940 ;; we're looking at an identifier that's a
6941 ;; prefix only if it specifies a member pointer.
6942 (progn
6943 (setq id-start (point))
6944 (c-forward-name)
6945 (if (looking-at "\\(::\\)")
6946 ;; We only check for a trailing "::" and
6947 ;; let the "*" that should follow be
6948 ;; matched in the next round.
6949 t
6950 ;; It turned out to be the real identifier,
6951 ;; so flag that and stop.
6952 (setq got-identifier t)
6953 nil))
6954 t))
6955 (if (eq (char-after) ?\()
6956 (progn
6957 (setq paren-depth (1+ paren-depth))
6958 (forward-char))
6959 (goto-char (match-end 1)))
6960 (c-forward-syntactic-ws)
6961 t)))
6962
6963 ;; If we haven't passed the identifier already, do it now.
6964 (unless got-identifier
6965 (setq id-start (point)))
6966 (cond
6967 ((or got-identifier
6968 (c-forward-name))
6969 (save-excursion
6970 (c-backward-syntactic-ws)
6971 (setq id-end (point))))
6972 (accept-anon
6973 (setq id-start nil id-end nil)
6974 t)
6975 (t (/= (point) here))))
6976
6977 ;; Skip out of the parens surrounding the identifier. If closing
6978 ;; parens are missing, this form returns nil.
6979 (or (= paren-depth 0)
6980 (c-safe (goto-char (scan-lists (point) 1 paren-depth))))
6981
6982 (<= (point) limit)
6983
6984 ;; Skip over any trailing bit, such as "__attribute__".
6985 (progn
6986 (while (cond
6987 ((looking-at c-decl-hangon-key)
6988 (c-forward-keyword-clause 1))
6989 ((and c-opt-cpp-prefix
6990 (looking-at c-noise-macro-with-parens-name-re))
6991 (c-forward-noise-clause))))
6992 (<= (point) limit))
6993
6994 ;; Search syntactically to the end of the declarator (";",
6995 ;; ",", a closing paren, eob etc) or to the beginning of an
6996 ;; initializer or function prototype ("=" or "\\s\(").
6997 ;; Note that square brackets are now not also treated as
6998 ;; initializers, since this broke when there were also
6999 ;; initializing brace lists.
7000 (let (found)
7001 (while
7002 (and (setq found (c-syntactic-re-search-forward
7003 "[;,]\\|\\s)\\|\\'\\|\\(=\\|\\s(\\)" limit t t))
7004 (eq (char-before) ?\[)
7005 (c-go-up-list-forward))
7006 (setq brackets-after-id t))
7007 (backward-char)
7008 found))
7009 (list id-start id-end brackets-after-id (match-beginning 1))
7010
7011 (goto-char here)
7012 nil)))
7013
7014 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end)
7015 ;; Move forward over a declaration or a cast if at the start of one.
7016 ;; The point is assumed to be at the start of some token. Nil is
7017 ;; returned if no declaration or cast is recognized, and the point
7018 ;; is clobbered in that case.
7019 ;;
7020 ;; If a declaration is parsed:
7021 ;;
7022 ;; The point is left at the first token after the first complete
7023 ;; declarator, if there is one. The return value is a cons where
7024 ;; the car is the position of the first token in the declarator. (See
7025 ;; below for the cdr.)
7026 ;; Some examples:
7027 ;;
7028 ;; void foo (int a, char *b) stuff ...
7029 ;; car ^ ^ point
7030 ;; float (*a)[], b;
7031 ;; car ^ ^ point
7032 ;; unsigned int a = c_style_initializer, b;
7033 ;; car ^ ^ point
7034 ;; unsigned int a (cplusplus_style_initializer), b;
7035 ;; car ^ ^ point (might change)
7036 ;; class Foo : public Bar {}
7037 ;; car ^ ^ point
7038 ;; class PikeClass (int a, string b) stuff ...
7039 ;; car ^ ^ point
7040 ;; enum bool;
7041 ;; car ^ ^ point
7042 ;; enum bool flag;
7043 ;; car ^ ^ point
7044 ;; void cplusplus_function (int x) throw (Bad);
7045 ;; car ^ ^ point
7046 ;; Foo::Foo (int b) : Base (b) {}
7047 ;; car ^ ^ point
7048 ;;
7049 ;; auto foo = 5;
7050 ;; car ^ ^ point
7051 ;; auto cplusplus_11 (int a, char *b) -> decltype (bar):
7052 ;; car ^ ^ point
7053 ;;
7054 ;;
7055 ;;
7056 ;; The cdr of the return value is non-nil when a
7057 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
7058 ;; Specifically it is a dotted pair (A . B) where B is t when a
7059 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
7060 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
7061 ;; specifier is present. I.e., (some of) the declared
7062 ;; identifier(s) are types.
7063 ;;
7064 ;; If a cast is parsed:
7065 ;;
7066 ;; The point is left at the first token after the closing paren of
7067 ;; the cast. The return value is `cast'. Note that the start
7068 ;; position must be at the first token inside the cast parenthesis
7069 ;; to recognize it.
7070 ;;
7071 ;; PRECEDING-TOKEN-END is the first position after the preceding
7072 ;; token, i.e. on the other side of the syntactic ws from the point.
7073 ;; Use a value less than or equal to (point-min) if the point is at
7074 ;; the first token in (the visible part of) the buffer.
7075 ;;
7076 ;; CONTEXT is a symbol that describes the context at the point:
7077 ;; 'decl In a comma-separated declaration context (typically
7078 ;; inside a function declaration arglist).
7079 ;; '<> In an angle bracket arglist.
7080 ;; 'arglist Some other type of arglist.
7081 ;; nil Some other context or unknown context. Includes
7082 ;; within the parens of an if, for, ... construct.
7083 ;;
7084 ;; LAST-CAST-END is the first token after the closing paren of a
7085 ;; preceding cast, or nil if none is known. If
7086 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
7087 ;; the position after the closest preceding call where a cast was
7088 ;; matched. In that case it's used to discover chains of casts like
7089 ;; "(a) (b) c".
7090 ;;
7091 ;; This function records identifier ranges on
7092 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7093 ;; `c-record-type-identifiers' is non-nil.
7094 ;;
7095 ;; This function might do hidden buffer changes.
7096
7097 (let (;; `start-pos' is used below to point to the start of the
7098 ;; first type, i.e. after any leading specifiers. It might
7099 ;; also point at the beginning of the preceding syntactic
7100 ;; whitespace.
7101 (start-pos (point))
7102 ;; Set to the result of `c-forward-type'.
7103 at-type
7104 ;; The position of the first token in what we currently
7105 ;; believe is the type in the declaration or cast, after any
7106 ;; specifiers and their associated clauses.
7107 type-start
7108 ;; The position of the first token in what we currently
7109 ;; believe is the declarator for the first identifier. Set
7110 ;; when the type is found, and moved forward over any
7111 ;; `c-decl-hangon-kwds' and their associated clauses that
7112 ;; occurs after the type.
7113 id-start
7114 ;; These store `at-type', `type-start' and `id-start' of the
7115 ;; identifier before the one in those variables. The previous
7116 ;; identifier might turn out to be the real type in a
7117 ;; declaration if the last one has to be the declarator in it.
7118 ;; If `backup-at-type' is nil then the other variables have
7119 ;; undefined values.
7120 backup-at-type backup-type-start backup-id-start
7121 ;; This stores `kwd-sym' of the symbol before the current one.
7122 ;; This is needed to distinguish the C++11 version of "auto" from
7123 ;; the pre C++11 meaning.
7124 backup-kwd-sym
7125 ;; Set if we've found a specifier (apart from "typedef") that makes
7126 ;; the defined identifier(s) types.
7127 at-type-decl
7128 ;; Set if we've a "typedef" keyword.
7129 at-typedef
7130 ;; Set if we've found a specifier that can start a declaration
7131 ;; where there's no type.
7132 maybe-typeless
7133 ;; Save the value of kwd-sym between loops of the "Check for a
7134 ;; type" loop. Needed to distinguish a C++11 "auto" from a pre
7135 ;; C++11 one.
7136 prev-kwd-sym
7137 ;; If a specifier is found that also can be a type prefix,
7138 ;; these flags are set instead of those above. If we need to
7139 ;; back up an identifier, they are copied to the real flag
7140 ;; variables. Thus they only take effect if we fail to
7141 ;; interpret it as a type.
7142 backup-at-type-decl backup-maybe-typeless
7143 ;; Whether we've found a declaration or a cast. We might know
7144 ;; this before we've found the type in it. It's 'ids if we've
7145 ;; found two consecutive identifiers (usually a sure sign, but
7146 ;; we should allow that in labels too), and t if we've found a
7147 ;; specifier keyword (a 100% sure sign).
7148 at-decl-or-cast
7149 ;; Set when we need to back up to parse this as a declaration
7150 ;; but not as a cast.
7151 backup-if-not-cast
7152 ;; For casts, the return position.
7153 cast-end
7154 ;; Have we got a new-style C++11 "auto"?
7155 new-style-auto
7156 ;; Set when the symbol before `preceding-token-end' is known to
7157 ;; terminate the previous construct, or when we're at point-min.
7158 at-decl-start
7159 ;; Save `c-record-type-identifiers' and
7160 ;; `c-record-ref-identifiers' since ranges are recorded
7161 ;; speculatively and should be thrown away if it turns out
7162 ;; that it isn't a declaration or cast.
7163 (save-rec-type-ids c-record-type-identifiers)
7164 (save-rec-ref-ids c-record-ref-identifiers))
7165
7166 (save-excursion
7167 (goto-char preceding-token-end)
7168 (setq at-decl-start
7169 (or (bobp)
7170 (let ((tok-end (point)))
7171 (c-backward-token-2)
7172 (member (buffer-substring-no-properties (point) tok-end)
7173 c-pre-start-tokens)))))
7174
7175 (while (c-forward-annotation)
7176 (c-forward-syntactic-ws))
7177
7178 ;; Check for a type. Unknown symbols are treated as possible
7179 ;; types, but they could also be specifiers disguised through
7180 ;; macros like __INLINE__, so we recognize both types and known
7181 ;; specifiers after them too.
7182 (while
7183 (let* ((start (point)) kwd-sym kwd-clause-end found-type noise-start)
7184
7185 (cond
7186 ;; Look for a specifier keyword clause.
7187 ((or (looking-at c-prefix-spec-kwds-re)
7188 (and (c-major-mode-is 'java-mode)
7189 (looking-at "@[A-Za-z0-9]+")))
7190 (save-match-data
7191 (if (looking-at c-typedef-key)
7192 (setq at-typedef t)))
7193 (setq kwd-sym (c-keyword-sym (match-string 1)))
7194 (save-excursion
7195 (c-forward-keyword-clause 1)
7196 (setq kwd-clause-end (point))))
7197 ((and c-opt-cpp-prefix
7198 (looking-at c-noise-macro-with-parens-name-re))
7199 (setq noise-start (point))
7200 (c-forward-noise-clause)
7201 (setq kwd-clause-end (point))))
7202
7203 (when (setq found-type (c-forward-type t)) ; brace-block-too
7204 ;; Found a known or possible type or a prefix of a known type.
7205 (when (and (c-major-mode-is 'c++-mode) ; C++11 style "auto"?
7206 (eq prev-kwd-sym (c-keyword-sym "auto"))
7207 (looking-at "[=(]")) ; FIXME!!! proper regexp.
7208 (setq new-style-auto t)
7209 (setq found-type nil)
7210 (goto-char start)) ; position of foo in "auto foo"
7211
7212 (when at-type
7213 ;; Got two identifiers with nothing but whitespace
7214 ;; between them. That can only happen in declarations.
7215 (setq at-decl-or-cast 'ids)
7216
7217 (when (eq at-type 'found)
7218 ;; If the previous identifier is a found type we
7219 ;; record it as a real one; it might be some sort of
7220 ;; alias for a prefix like "unsigned".
7221 (save-excursion
7222 (goto-char type-start)
7223 (let ((c-promote-possible-types t))
7224 (c-forward-type)))))
7225
7226 (setq backup-at-type at-type
7227 backup-type-start type-start
7228 backup-id-start id-start
7229 backup-kwd-sym kwd-sym
7230 at-type found-type
7231 type-start start
7232 id-start (point)
7233 ;; The previous ambiguous specifier/type turned out
7234 ;; to be a type since we've parsed another one after
7235 ;; it, so clear these backup flags.
7236 backup-at-type-decl nil
7237 backup-maybe-typeless nil))
7238
7239 (if (or kwd-sym noise-start)
7240 (progn
7241 ;; Handle known specifier keywords and
7242 ;; `c-decl-hangon-kwds' which can occur after known
7243 ;; types.
7244
7245 (if (or (c-keyword-member kwd-sym 'c-decl-hangon-kwds)
7246 noise-start)
7247 ;; It's a hang-on keyword or noise clause that can occur
7248 ;; anywhere.
7249 (progn
7250 (if at-type
7251 ;; Move the identifier start position if
7252 ;; we've passed a type.
7253 (setq id-start kwd-clause-end)
7254 ;; Otherwise treat this as a specifier and
7255 ;; move the fallback position.
7256 (setq start-pos kwd-clause-end))
7257 (goto-char kwd-clause-end))
7258
7259 ;; It's an ordinary specifier so we know that
7260 ;; anything before this can't be the type.
7261 (setq backup-at-type nil
7262 start-pos kwd-clause-end)
7263
7264 (if found-type
7265 ;; It's ambiguous whether this keyword is a
7266 ;; specifier or a type prefix, so set the backup
7267 ;; flags. (It's assumed that `c-forward-type'
7268 ;; moved further than `c-forward-keyword-clause'.)
7269 (progn
7270 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
7271 (setq backup-at-type-decl t))
7272 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
7273 (setq backup-maybe-typeless t)))
7274
7275 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
7276 ;; This test only happens after we've scanned a type.
7277 ;; So, with valid syntax, kwd-sym can't be 'typedef.
7278 (setq at-type-decl t))
7279 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
7280 (setq maybe-typeless t))
7281
7282 ;; Haven't matched a type so it's an unambiguous
7283 ;; specifier keyword and we know we're in a
7284 ;; declaration.
7285 (setq at-decl-or-cast t)
7286 (setq prev-kwd-sym kwd-sym)
7287
7288 (goto-char kwd-clause-end))))
7289
7290 ;; If the type isn't known we continue so that we'll jump
7291 ;; over all specifiers and type identifiers. The reason
7292 ;; to do this for a known type prefix is to make things
7293 ;; like "unsigned INT16" work.
7294 (and found-type (not (eq found-type t))))))
7295
7296 (cond
7297 ((eq at-type t)
7298 ;; If a known type was found, we still need to skip over any
7299 ;; hangon keyword clauses after it. Otherwise it has already
7300 ;; been done in the loop above.
7301 (while
7302 (cond ((looking-at c-decl-hangon-key)
7303 (c-forward-keyword-clause 1))
7304 ((and c-opt-cpp-prefix
7305 (looking-at c-noise-macro-with-parens-name-re))
7306 (c-forward-noise-clause))))
7307 (setq id-start (point)))
7308
7309 ((eq at-type 'prefix)
7310 ;; A prefix type is itself a primitive type when it's not
7311 ;; followed by another type.
7312 (setq at-type t))
7313
7314 ((not at-type)
7315 ;; Got no type but set things up to continue anyway to handle
7316 ;; the various cases when a declaration doesn't start with a
7317 ;; type.
7318 (setq id-start start-pos))
7319
7320 ((and (eq at-type 'maybe)
7321 (c-major-mode-is 'c++-mode))
7322 ;; If it's C++ then check if the last "type" ends on the form
7323 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
7324 ;; (con|de)structor.
7325 (save-excursion
7326 (let (name end-2 end-1)
7327 (goto-char id-start)
7328 (c-backward-syntactic-ws)
7329 (setq end-2 (point))
7330 (when (and
7331 (c-simple-skip-symbol-backward)
7332 (progn
7333 (setq name
7334 (buffer-substring-no-properties (point) end-2))
7335 ;; Cheating in the handling of syntactic ws below.
7336 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
7337 (progn
7338 (setq end-1 (point))
7339 (c-simple-skip-symbol-backward))
7340 (>= (point) type-start)
7341 (equal (buffer-substring-no-properties (point) end-1)
7342 name))
7343 ;; It is a (con|de)structor name. In that case the
7344 ;; declaration is typeless so zap out any preceding
7345 ;; identifier(s) that we might have taken as types.
7346 (goto-char type-start)
7347 (setq at-type nil
7348 backup-at-type nil
7349 id-start type-start))))))
7350
7351 ;; Check for and step over a type decl expression after the thing
7352 ;; that is or might be a type. This can't be skipped since we
7353 ;; need the correct end position of the declarator for
7354 ;; `max-type-decl-end-*'.
7355 (let ((start (point)) (paren-depth 0) pos
7356 ;; True if there's a non-open-paren match of
7357 ;; `c-type-decl-prefix-key'.
7358 got-prefix
7359 ;; True if the declarator is surrounded by a parenthesis pair.
7360 got-parens
7361 ;; True if there is an identifier in the declarator.
7362 got-identifier
7363 ;; True if there's a non-close-paren match of
7364 ;; `c-type-decl-suffix-key'.
7365 got-suffix
7366 ;; True if there's a prefix match outside the outermost
7367 ;; paren pair that surrounds the declarator.
7368 got-prefix-before-parens
7369 ;; True if there's a suffix match outside the outermost
7370 ;; paren pair that surrounds the declarator. The value is
7371 ;; the position of the first suffix match.
7372 got-suffix-after-parens
7373 ;; True if we've parsed the type decl to a token that is
7374 ;; known to end declarations in this context.
7375 at-decl-end
7376 ;; The earlier values of `at-type' and `type-start' if we've
7377 ;; shifted the type backwards.
7378 identifier-type identifier-start
7379 ;; If `c-parse-and-markup-<>-arglists' is set we need to
7380 ;; turn it off during the name skipping below to avoid
7381 ;; getting `c-type' properties that might be bogus. That
7382 ;; can happen since we don't know if
7383 ;; `c-restricted-<>-arglists' will be correct inside the
7384 ;; arglist paren that gets entered.
7385 c-parse-and-markup-<>-arglists
7386 ;; Start of the identifier for which `got-identifier' was set.
7387 name-start)
7388
7389 (goto-char id-start)
7390
7391 ;; Skip over type decl prefix operators. (Note similar code in
7392 ;; `c-forward-declarator'.)
7393 (if (and c-recognize-typeless-decls
7394 (equal c-type-decl-prefix-key "\\<\\>"))
7395 (when (eq (char-after) ?\()
7396 (progn
7397 (setq paren-depth (1+ paren-depth))
7398 (forward-char)))
7399 (while (and (looking-at c-type-decl-prefix-key)
7400 (if (and (c-major-mode-is 'c++-mode)
7401 (match-beginning 3))
7402 ;; If the third submatch matches in C++ then
7403 ;; we're looking at an identifier that's a
7404 ;; prefix only if it specifies a member pointer.
7405 (when (progn (setq pos (point))
7406 (setq got-identifier (c-forward-name)))
7407 (setq name-start pos)
7408 (if (looking-at "\\(::\\)")
7409 ;; We only check for a trailing "::" and
7410 ;; let the "*" that should follow be
7411 ;; matched in the next round.
7412 (progn (setq got-identifier nil) t)
7413 ;; It turned out to be the real identifier,
7414 ;; so stop.
7415 nil))
7416 t))
7417
7418 (if (eq (char-after) ?\()
7419 (progn
7420 (setq paren-depth (1+ paren-depth))
7421 (forward-char))
7422 (unless got-prefix-before-parens
7423 (setq got-prefix-before-parens (= paren-depth 0)))
7424 (setq got-prefix t)
7425 (goto-char (match-end 1)))
7426 (c-forward-syntactic-ws)))
7427
7428 (setq got-parens (> paren-depth 0))
7429
7430 ;; Skip over an identifier.
7431 (or got-identifier
7432 (and (looking-at c-identifier-start)
7433 (setq pos (point))
7434 (setq got-identifier (c-forward-name))
7435 (setq name-start pos)))
7436
7437 ;; Skip over type decl suffix operators and trailing noise macros.
7438 (while
7439 (cond
7440 ((and c-opt-cpp-prefix
7441 (looking-at c-noise-macro-with-parens-name-re))
7442 (c-forward-noise-clause))
7443
7444 ((looking-at c-type-decl-suffix-key)
7445 (if (eq (char-after) ?\))
7446 (when (> paren-depth 0)
7447 (setq paren-depth (1- paren-depth))
7448 (forward-char)
7449 t)
7450 (when (if (save-match-data (looking-at "\\s("))
7451 (c-safe (c-forward-sexp 1) t)
7452 (goto-char (match-end 1))
7453 t)
7454 (when (and (not got-suffix-after-parens)
7455 (= paren-depth 0))
7456 (setq got-suffix-after-parens (match-beginning 0)))
7457 (setq got-suffix t))))
7458
7459 (t
7460 ;; No suffix matched. We might have matched the
7461 ;; identifier as a type and the open paren of a
7462 ;; function arglist as a type decl prefix. In that
7463 ;; case we should "backtrack": Reinterpret the last
7464 ;; type as the identifier, move out of the arglist and
7465 ;; continue searching for suffix operators.
7466 ;;
7467 ;; Do this even if there's no preceding type, to cope
7468 ;; with old style function declarations in K&R C,
7469 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
7470 ;; style declarations. That isn't applicable in an
7471 ;; arglist context, though.
7472 (when (and (= paren-depth 1)
7473 (not got-prefix-before-parens)
7474 (not (eq at-type t))
7475 (or backup-at-type
7476 maybe-typeless
7477 backup-maybe-typeless
7478 (when c-recognize-typeless-decls
7479 (not context)))
7480 (setq pos (c-up-list-forward (point)))
7481 (eq (char-before pos) ?\)))
7482 (c-fdoc-shift-type-backward)
7483 (goto-char pos)
7484 t)))
7485
7486 (c-forward-syntactic-ws))
7487
7488 (when (or (and new-style-auto
7489 (looking-at c-auto-ops-re))
7490 (and (or maybe-typeless backup-maybe-typeless)
7491 (not got-identifier)
7492 (not got-prefix)
7493 at-type))
7494 ;; Have found no identifier but `c-typeless-decl-kwds' has
7495 ;; matched so we know we're inside a declaration. The
7496 ;; preceding type must be the identifier instead.
7497 (c-fdoc-shift-type-backward))
7498
7499 ;; Prepare the "-> type;" for fontification later on.
7500 (when (and new-style-auto
7501 (looking-at c-haskell-op-re))
7502 (save-excursion
7503 (goto-char (match-end 0))
7504 (c-forward-syntactic-ws)
7505 (setq type-start (point))
7506 (setq at-type (c-forward-type))))
7507
7508 (setq
7509 at-decl-or-cast
7510 (catch 'at-decl-or-cast
7511
7512 ;; CASE 1
7513 (when (> paren-depth 0)
7514 ;; Encountered something inside parens that isn't matched by
7515 ;; the `c-type-decl-*' regexps, so it's not a type decl
7516 ;; expression. Try to skip out to the same paren depth to
7517 ;; not confuse the cast check below.
7518 (c-safe (goto-char (scan-lists (point) 1 paren-depth)))
7519 ;; If we've found a specifier keyword then it's a
7520 ;; declaration regardless.
7521 (throw 'at-decl-or-cast (eq at-decl-or-cast t)))
7522
7523 (setq at-decl-end
7524 (looking-at (cond ((eq context '<>) "[,>]")
7525 (context "[,)]")
7526 (t "[,;]"))))
7527
7528 ;; Now we've collected info about various characteristics of
7529 ;; the construct we're looking at. Below follows a decision
7530 ;; tree based on that. It's ordered to check more certain
7531 ;; signs before less certain ones.
7532
7533 (if got-identifier
7534 (progn
7535
7536 ;; CASE 2
7537 (when (and (or at-type maybe-typeless)
7538 (not (or got-prefix got-parens)))
7539 ;; Got another identifier directly after the type, so it's a
7540 ;; declaration.
7541 (throw 'at-decl-or-cast t))
7542
7543 (when (and got-parens
7544 (not got-prefix)
7545 ;; (not got-suffix-after-parens)
7546 (or backup-at-type
7547 maybe-typeless
7548 backup-maybe-typeless
7549 (eq at-decl-or-cast t)
7550 (save-excursion
7551 (goto-char name-start)
7552 (not (memq (c-forward-type) '(nil maybe))))))
7553 ;; Got a declaration of the form "foo bar (gnu);" or "bar
7554 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
7555 ;; as the declarator. In this case it's however more likely
7556 ;; that "bar" is the declarator and "gnu" a function argument
7557 ;; or initializer (if `c-recognize-paren-inits' is set),
7558 ;; since the parens around "gnu" would be superfluous if it's
7559 ;; a declarator. Shift the type one step backward.
7560 (c-fdoc-shift-type-backward)))
7561
7562 ;; Found no identifier.
7563
7564 (if backup-at-type
7565 (progn
7566
7567 ;; CASE 3
7568 (when (= (point) start)
7569 ;; Got a plain list of identifiers. If a colon follows it's
7570 ;; a valid label, or maybe a bitfield. Otherwise the last
7571 ;; one probably is the declared identifier and we should
7572 ;; back up to the previous type, providing it isn't a cast.
7573 (if (and (eq (char-after) ?:)
7574 (not (c-major-mode-is 'java-mode)))
7575 (cond
7576 ;; If we've found a specifier keyword then it's a
7577 ;; declaration regardless.
7578 ((eq at-decl-or-cast t)
7579 (throw 'at-decl-or-cast t))
7580 ((and c-has-bitfields
7581 (eq at-decl-or-cast 'ids)) ; bitfield.
7582 (setq backup-if-not-cast t)
7583 (throw 'at-decl-or-cast t)))
7584
7585 (setq backup-if-not-cast t)
7586 (throw 'at-decl-or-cast t)))
7587
7588 ;; CASE 4
7589 (when (and got-suffix
7590 (not got-prefix)
7591 (not got-parens))
7592 ;; Got a plain list of identifiers followed by some suffix.
7593 ;; If this isn't a cast then the last identifier probably is
7594 ;; the declared one and we should back up to the previous
7595 ;; type.
7596 (setq backup-if-not-cast t)
7597 (throw 'at-decl-or-cast t)))
7598
7599 ;; CASE 5
7600 (when (eq at-type t)
7601 ;; If the type is known we know that there can't be any
7602 ;; identifier somewhere else, and it's only in declarations in
7603 ;; e.g. function prototypes and in casts that the identifier may
7604 ;; be left out.
7605 (throw 'at-decl-or-cast t))
7606
7607 (when (= (point) start)
7608 ;; Only got a single identifier (parsed as a type so far).
7609 ;; CASE 6
7610 (if (and
7611 ;; Check that the identifier isn't at the start of an
7612 ;; expression.
7613 at-decl-end
7614 (cond
7615 ((eq context 'decl)
7616 ;; Inside an arglist that contains declarations. If K&R
7617 ;; style declarations and parenthesis style initializers
7618 ;; aren't allowed then the single identifier must be a
7619 ;; type, else we require that it's known or found
7620 ;; (primitive types are handled above).
7621 (or (and (not c-recognize-knr-p)
7622 (not c-recognize-paren-inits))
7623 (memq at-type '(known found))))
7624 ((eq context '<>)
7625 ;; Inside a template arglist. Accept known and found
7626 ;; types; other identifiers could just as well be
7627 ;; constants in C++.
7628 (memq at-type '(known found)))))
7629 (throw 'at-decl-or-cast t)
7630 ;; CASE 7
7631 ;; Can't be a valid declaration or cast, but if we've found a
7632 ;; specifier it can't be anything else either, so treat it as
7633 ;; an invalid/unfinished declaration or cast.
7634 (throw 'at-decl-or-cast at-decl-or-cast))))
7635
7636 (if (and got-parens
7637 (not got-prefix)
7638 (not context)
7639 (not (eq at-type t))
7640 (or backup-at-type
7641 maybe-typeless
7642 backup-maybe-typeless
7643 (when c-recognize-typeless-decls
7644 (or (not got-suffix)
7645 (not (looking-at
7646 c-after-suffixed-type-maybe-decl-key))))))
7647 ;; Got an empty paren pair and a preceding type that probably
7648 ;; really is the identifier. Shift the type backwards to make
7649 ;; the last one the identifier. This is analogous to the
7650 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7651 ;; above.
7652 ;;
7653 ;; Exception: In addition to the conditions in that
7654 ;; "backtracking" code, do not shift backward if we're not
7655 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7656 ;; Since there's no preceding type, the shift would mean that
7657 ;; the declaration is typeless. But if the regexp doesn't match
7658 ;; then we will simply fall through in the tests below and not
7659 ;; recognize it at all, so it's better to try it as an abstract
7660 ;; declarator instead.
7661 (c-fdoc-shift-type-backward)
7662
7663 ;; Still no identifier.
7664 ;; CASE 8
7665 (when (and got-prefix (or got-parens got-suffix))
7666 ;; Require `got-prefix' together with either `got-parens' or
7667 ;; `got-suffix' to recognize it as an abstract declarator:
7668 ;; `got-parens' only is probably an empty function call.
7669 ;; `got-suffix' only can build an ordinary expression together
7670 ;; with the preceding identifier which we've taken as a type.
7671 ;; We could actually accept on `got-prefix' only, but that can
7672 ;; easily occur temporarily while writing an expression so we
7673 ;; avoid that case anyway. We could do a better job if we knew
7674 ;; the point when the fontification was invoked.
7675 (throw 'at-decl-or-cast t))
7676
7677 ;; CASE 9
7678 (when (and at-type
7679 (not got-prefix)
7680 (not got-parens)
7681 got-suffix-after-parens
7682 (eq (char-after got-suffix-after-parens) ?\())
7683 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7684 ;; normal function call after all (or perhaps a C++ style object
7685 ;; instantiation expression).
7686 (throw 'at-decl-or-cast nil))))
7687
7688 ;; CASE 10
7689 (when at-decl-or-cast
7690 ;; By now we've located the type in the declaration that we know
7691 ;; we're in.
7692 (throw 'at-decl-or-cast t))
7693
7694 ;; CASE 11
7695 (when (and got-identifier
7696 (not context)
7697 (looking-at c-after-suffixed-type-decl-key)
7698 (if (and got-parens
7699 (not got-prefix)
7700 (not got-suffix)
7701 (not (eq at-type t)))
7702 ;; Shift the type backward in the case that there's a
7703 ;; single identifier inside parens. That can only
7704 ;; occur in K&R style function declarations so it's
7705 ;; more likely that it really is a function call.
7706 ;; Therefore we only do this after
7707 ;; `c-after-suffixed-type-decl-key' has matched.
7708 (progn (c-fdoc-shift-type-backward) t)
7709 got-suffix-after-parens))
7710 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7711 (throw 'at-decl-or-cast t))
7712
7713 ;; CASE 12
7714 (when (and (or got-prefix (not got-parens))
7715 (memq at-type '(t known)))
7716 ;; It's a declaration if a known type precedes it and it can't be a
7717 ;; function call.
7718 (throw 'at-decl-or-cast t))
7719
7720 ;; If we get here we can't tell if this is a type decl or a normal
7721 ;; expression by looking at it alone. (That's under the assumption
7722 ;; that normal expressions always can look like type decl expressions,
7723 ;; which isn't really true but the cases where it doesn't hold are so
7724 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7725 ;; the effort to look for them.)
7726
7727 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
7728 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
7729 ;;; as a(n almost complete) declaration, enabling it to be fontified.
7730 ;; CASE 13
7731 ;; (unless (or at-decl-end (looking-at "=[^=]"))
7732 ;; If this is a declaration it should end here or its initializer(*)
7733 ;; should start here, so check for allowed separation tokens. Note
7734 ;; that this rule doesn't work e.g. with a K&R arglist after a
7735 ;; function header.
7736 ;;
7737 ;; *) Don't check for C++ style initializers using parens
7738 ;; since those already have been matched as suffixes.
7739 ;;
7740 ;; If `at-decl-or-cast' is then we've found some other sign that
7741 ;; it's a declaration or cast, so then it's probably an
7742 ;; invalid/unfinished one.
7743 ;; (throw 'at-decl-or-cast at-decl-or-cast))
7744
7745 ;; Below are tests that only should be applied when we're certain to
7746 ;; not have parsed halfway through an expression.
7747
7748 ;; CASE 14
7749 (when (memq at-type '(t known))
7750 ;; The expression starts with a known type so treat it as a
7751 ;; declaration.
7752 (throw 'at-decl-or-cast t))
7753
7754 ;; CASE 15
7755 (when (and (c-major-mode-is 'c++-mode)
7756 ;; In C++ we check if the identifier is a known type, since
7757 ;; (con|de)structors use the class name as identifier.
7758 ;; We've always shifted over the identifier as a type and
7759 ;; then backed up again in this case.
7760 identifier-type
7761 (or (memq identifier-type '(found known))
7762 (and (eq (char-after identifier-start) ?~)
7763 ;; `at-type' probably won't be 'found for
7764 ;; destructors since the "~" is then part of the
7765 ;; type name being checked against the list of
7766 ;; known types, so do a check without that
7767 ;; operator.
7768 (or (save-excursion
7769 (goto-char (1+ identifier-start))
7770 (c-forward-syntactic-ws)
7771 (c-with-syntax-table
7772 c-identifier-syntax-table
7773 (looking-at c-known-type-key)))
7774 (save-excursion
7775 (goto-char (1+ identifier-start))
7776 ;; We have already parsed the type earlier,
7777 ;; so it'd be possible to cache the end
7778 ;; position instead of redoing it here, but
7779 ;; then we'd need to keep track of another
7780 ;; position everywhere.
7781 (c-check-type (point)
7782 (progn (c-forward-type)
7783 (point))))))))
7784 (throw 'at-decl-or-cast t))
7785
7786 (if got-identifier
7787 (progn
7788 ;; CASE 16
7789 (when (and got-prefix-before-parens
7790 at-type
7791 (or at-decl-end (looking-at "=[^=]"))
7792 (not context)
7793 (or (not got-suffix)
7794 at-decl-start))
7795 ;; Got something like "foo * bar;". Since we're not inside
7796 ;; an arglist it would be a meaningless expression because
7797 ;; the result isn't used. We therefore choose to recognize
7798 ;; it as a declaration. We only allow a suffix (which makes
7799 ;; the construct look like a function call) when
7800 ;; `at-decl-start' provides additional evidence that we do
7801 ;; have a declaration.
7802 (throw 'at-decl-or-cast t))
7803
7804 ;; CASE 17
7805 (when (and (or got-suffix-after-parens
7806 (looking-at "=[^=]"))
7807 (eq at-type 'found)
7808 (not (eq context 'arglist)))
7809 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7810 ;; be an odd expression or it could be a declaration. Treat
7811 ;; it as a declaration if "a" has been used as a type
7812 ;; somewhere else (if it's a known type we won't get here).
7813 (throw 'at-decl-or-cast t)))
7814
7815 ;; CASE 18
7816 (when (and context
7817 (or got-prefix
7818 (and (eq context 'decl)
7819 (not c-recognize-paren-inits)
7820 (or got-parens got-suffix))))
7821 ;; Got a type followed by an abstract declarator. If `got-prefix'
7822 ;; is set it's something like "a *" without anything after it. If
7823 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7824 ;; or similar, which we accept only if the context rules out
7825 ;; expressions.
7826 (throw 'at-decl-or-cast t)))
7827
7828 ;; If we had a complete symbol table here (which rules out
7829 ;; `c-found-types') we should return t due to the disambiguation rule
7830 ;; (in at least C++) that anything that can be parsed as a declaration
7831 ;; is a declaration. Now we're being more defensive and prefer to
7832 ;; highlight things like "foo (bar);" as a declaration only if we're
7833 ;; inside an arglist that contains declarations.
7834 ;; CASE 19
7835 (eq context 'decl))))
7836
7837 ;; The point is now after the type decl expression.
7838
7839 (cond
7840 ;; Check for a cast.
7841 ((save-excursion
7842 (and
7843 c-cast-parens
7844
7845 ;; Should be the first type/identifier in a cast paren.
7846 (> preceding-token-end (point-min))
7847 (memq (char-before preceding-token-end) c-cast-parens)
7848
7849 ;; The closing paren should follow.
7850 (progn
7851 (c-forward-syntactic-ws)
7852 (looking-at "\\s)"))
7853
7854 ;; There should be a primary expression after it.
7855 (let (pos)
7856 (forward-char)
7857 (c-forward-syntactic-ws)
7858 (setq cast-end (point))
7859 (and (looking-at c-primary-expr-regexp)
7860 (progn
7861 (setq pos (match-end 0))
7862 (or
7863 ;; Check if the expression begins with a prefix keyword.
7864 (match-beginning 2)
7865 (if (match-beginning 1)
7866 ;; Expression begins with an ambiguous operator. Treat
7867 ;; it as a cast if it's a type decl or if we've
7868 ;; recognized the type somewhere else.
7869 (or at-decl-or-cast
7870 (memq at-type '(t known found)))
7871 ;; Unless it's a keyword, it's the beginning of a primary
7872 ;; expression.
7873 (not (looking-at c-keywords-regexp)))))
7874 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7875 ;; that it matched a whole one so that we don't e.g. confuse
7876 ;; the operator '-' with '->'. It's ok if it matches further,
7877 ;; though, since it e.g. can match the float '.5' while the
7878 ;; operator regexp only matches '.'.
7879 (or (not (looking-at c-nonsymbol-token-regexp))
7880 (<= (match-end 0) pos))))
7881
7882 ;; There should either be a cast before it or something that isn't an
7883 ;; identifier or close paren.
7884 (> preceding-token-end (point-min))
7885 (progn
7886 (goto-char (1- preceding-token-end))
7887 (or (eq (point) last-cast-end)
7888 (progn
7889 (c-backward-syntactic-ws)
7890 (if (< (skip-syntax-backward "w_") 0)
7891 ;; It's a symbol. Accept it only if it's one of the
7892 ;; keywords that can precede an expression (without
7893 ;; surrounding parens).
7894 (looking-at c-simple-stmt-key)
7895 (and
7896 ;; Check that it isn't a close paren (block close is ok,
7897 ;; though).
7898 (not (memq (char-before) '(?\) ?\])))
7899 ;; Check that it isn't a nonsymbol identifier.
7900 (not (c-on-identifier)))))))))
7901
7902 ;; Handle the cast.
7903 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
7904 (let ((c-promote-possible-types t))
7905 (goto-char type-start)
7906 (c-forward-type)))
7907
7908 (goto-char cast-end)
7909 'cast)
7910
7911 (at-decl-or-cast
7912 ;; We're at a declaration. Highlight the type and the following
7913 ;; declarators.
7914
7915 (when backup-if-not-cast
7916 (c-fdoc-shift-type-backward t))
7917
7918 (when (and (eq context 'decl) (looking-at ","))
7919 ;; Make sure to propagate the `c-decl-arg-start' property to
7920 ;; the next argument if it's set in this one, to cope with
7921 ;; interactive refontification.
7922 (c-put-c-type-property (point) 'c-decl-arg-start))
7923
7924 ;; Record the type's coordinates in `c-record-type-identifiers' for
7925 ;; later fontification.
7926 (when (and c-record-type-identifiers at-type ;; (not (eq at-type t))
7927 ;; There seems no reason to exclude a token from
7928 ;; fontification just because it's "a known type that can't
7929 ;; be a name or other expression". 2013-09-18.
7930 )
7931 (let ((c-promote-possible-types t))
7932 (save-excursion
7933 (goto-char type-start)
7934 (c-forward-type))))
7935
7936 (cons id-start
7937 (and (or at-type-decl at-typedef)
7938 (cons at-type-decl at-typedef))))
7939
7940 (t
7941 ;; False alarm. Restore the recorded ranges.
7942 (setq c-record-type-identifiers save-rec-type-ids
7943 c-record-ref-identifiers save-rec-ref-ids)
7944 nil))))
7945
7946 (defun c-forward-label (&optional assume-markup preceding-token-end limit)
7947 ;; Assuming that point is at the beginning of a token, check if it starts a
7948 ;; label and if so move over it and return non-nil (t in default situations,
7949 ;; specific symbols (see below) for interesting situations), otherwise don't
7950 ;; move and return nil. "Label" here means "most things with a colon".
7951 ;;
7952 ;; More precisely, a "label" is regarded as one of:
7953 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7954 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7955 ;; bare "case", should the colon be missing. We return t;
7956 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7957 ;; return t;
7958 ;; (iv) One of QT's "extended" C++ variants of
7959 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7960 ;; Returns the symbol `qt-2kwds-colon'.
7961 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7962 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7963 ;; colon). Currently (2006-03), this applies only to Objective C's
7964 ;; keywords "@private", "@protected", and "@public". Returns t.
7965 ;;
7966 ;; One of the things which will NOT be recognized as a label is a bit-field
7967 ;; element of a struct, something like "int foo:5".
7968 ;;
7969 ;; The end of the label is taken to be just after the colon, or the end of
7970 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7971 ;; after the end on return. The terminating char gets marked with
7972 ;; `c-decl-end' to improve recognition of the following declaration or
7973 ;; statement.
7974 ;;
7975 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7976 ;; label, if any, has already been marked up like that.
7977 ;;
7978 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7979 ;; after the preceding token, i.e. on the other side of the
7980 ;; syntactic ws from the point. Use a value less than or equal to
7981 ;; (point-min) if the point is at the first token in (the visible
7982 ;; part of) the buffer.
7983 ;;
7984 ;; The optional LIMIT limits the forward scan for the colon.
7985 ;;
7986 ;; This function records the ranges of the label symbols on
7987 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7988 ;; non-nil.
7989 ;;
7990 ;; This function might do hidden buffer changes.
7991
7992 (let ((start (point))
7993 label-end
7994 qt-symbol-idx
7995 macro-start ; if we're in one.
7996 label-type
7997 kwd)
7998 (cond
7999 ;; "case" or "default" (Doesn't apply to AWK).
8000 ((looking-at c-label-kwds-regexp)
8001 (let ((kwd-end (match-end 1)))
8002 ;; Record only the keyword itself for fontification, since in
8003 ;; case labels the following is a constant expression and not
8004 ;; a label.
8005 (when c-record-type-identifiers
8006 (c-record-ref-id (cons (match-beginning 1) kwd-end)))
8007
8008 ;; Find the label end.
8009 (goto-char kwd-end)
8010 (setq label-type
8011 (if (and (c-syntactic-re-search-forward
8012 ;; Stop on chars that aren't allowed in expressions,
8013 ;; and on operator chars that would be meaningless
8014 ;; there. FIXME: This doesn't cope with ?: operators.
8015 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
8016 limit t t nil 1)
8017 (match-beginning 2))
8018
8019 (progn ; there's a proper :
8020 (goto-char (match-beginning 2)) ; just after the :
8021 (c-put-c-type-property (1- (point)) 'c-decl-end)
8022 t)
8023
8024 ;; It's an unfinished label. We consider the keyword enough
8025 ;; to recognize it as a label, so that it gets fontified.
8026 ;; Leave the point at the end of it, but don't put any
8027 ;; `c-decl-end' marker.
8028 (goto-char kwd-end)
8029 t))))
8030
8031 ;; @private, @protected, @public, in Objective C, or similar.
8032 ((and c-opt-extra-label-key
8033 (looking-at c-opt-extra-label-key))
8034 ;; For a `c-opt-extra-label-key' match, we record the whole
8035 ;; thing for fontification. That's to get the leading '@' in
8036 ;; Objective-C protection labels fontified.
8037 (goto-char (match-end 1))
8038 (when c-record-type-identifiers
8039 (c-record-ref-id (cons (match-beginning 1) (point))))
8040 (c-put-c-type-property (1- (point)) 'c-decl-end)
8041 (setq label-type t))
8042
8043 ;; All other cases of labels.
8044 ((and c-recognize-colon-labels ; nil for AWK and IDL, otherwise t.
8045
8046 ;; A colon label must have something before the colon.
8047 (not (eq (char-after) ?:))
8048
8049 ;; Check that we're not after a token that can't precede a label.
8050 (or
8051 ;; Trivially succeeds when there's no preceding token.
8052 ;; Succeeds when we're at a virtual semicolon.
8053 (if preceding-token-end
8054 (<= preceding-token-end (point-min))
8055 (save-excursion
8056 (c-backward-syntactic-ws)
8057 (setq preceding-token-end (point))
8058 (or (bobp)
8059 (c-at-vsemi-p))))
8060
8061 ;; Check if we're after a label, if we're after a closing
8062 ;; paren that belong to statement, and with
8063 ;; `c-label-prefix-re'. It's done in different order
8064 ;; depending on `assume-markup' since the checks have
8065 ;; different expensiveness.
8066 (if assume-markup
8067 (or
8068 (eq (c-get-char-property (1- preceding-token-end) 'c-type)
8069 'c-decl-end)
8070
8071 (save-excursion
8072 (goto-char (1- preceding-token-end))
8073 (c-beginning-of-current-token)
8074 (or (looking-at c-label-prefix-re)
8075 (looking-at c-block-stmt-1-key)))
8076
8077 (and (eq (char-before preceding-token-end) ?\))
8078 (c-after-conditional)))
8079
8080 (or
8081 (save-excursion
8082 (goto-char (1- preceding-token-end))
8083 (c-beginning-of-current-token)
8084 (or (looking-at c-label-prefix-re)
8085 (looking-at c-block-stmt-1-key)))
8086
8087 (cond
8088 ((eq (char-before preceding-token-end) ?\))
8089 (c-after-conditional))
8090
8091 ((eq (char-before preceding-token-end) ?:)
8092 ;; Might be after another label, so check it recursively.
8093 (save-restriction
8094 (save-excursion
8095 (goto-char (1- preceding-token-end))
8096 ;; Essentially the same as the
8097 ;; `c-syntactic-re-search-forward' regexp below.
8098 (setq macro-start
8099 (save-excursion (and (c-beginning-of-macro)
8100 (point))))
8101 (if macro-start (narrow-to-region macro-start (point-max)))
8102 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t)
8103 ;; Note: the following should work instead of the
8104 ;; narrow-to-region above. Investigate why not,
8105 ;; sometime. ACM, 2006-03-31.
8106 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
8107 ;; macro-start t)
8108 (let ((pte (point))
8109 ;; If the caller turned on recording for us,
8110 ;; it shouldn't apply when we check the
8111 ;; preceding label.
8112 c-record-type-identifiers)
8113 ;; A label can't start at a cpp directive. Check for
8114 ;; this, since c-forward-syntactic-ws would foul up on it.
8115 (unless (and c-opt-cpp-prefix (looking-at c-opt-cpp-prefix))
8116 (c-forward-syntactic-ws)
8117 (c-forward-label nil pte start))))))))))
8118
8119 ;; Point is still at the beginning of the possible label construct.
8120 ;;
8121 ;; Check that the next nonsymbol token is ":", or that we're in one
8122 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
8123 ;; arguments. FIXME: Should build this regexp from the language
8124 ;; constants.
8125 (cond
8126 ;; public: protected: private:
8127 ((and
8128 (c-major-mode-is 'c++-mode)
8129 (search-forward-regexp
8130 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t)
8131 (progn (backward-char)
8132 (c-forward-syntactic-ws limit)
8133 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
8134 (forward-char)
8135 (setq label-type t))
8136 ;; QT double keyword like "protected slots:" or goto target.
8137 ((progn (goto-char start) nil))
8138 ((when (c-syntactic-re-search-forward
8139 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t) ; not at EOB
8140 (backward-char)
8141 (setq label-end (point))
8142 (setq qt-symbol-idx
8143 (and (c-major-mode-is 'c++-mode)
8144 (string-match
8145 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
8146 (buffer-substring start (point)))))
8147 (c-forward-syntactic-ws limit)
8148 (cond
8149 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
8150 (forward-char)
8151 (setq label-type
8152 (if (or (string= "signals" ; Special QT macro
8153 (setq kwd (buffer-substring-no-properties start label-end)))
8154 (string= "Q_SIGNALS" kwd))
8155 'qt-1kwd-colon
8156 'goto-target)))
8157 ((and qt-symbol-idx
8158 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t)
8159 (progn (c-forward-syntactic-ws limit)
8160 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
8161 (forward-char)
8162 (setq label-type 'qt-2kwds-colon)))))))
8163
8164 (save-restriction
8165 (narrow-to-region start (point))
8166
8167 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
8168 (catch 'check-label
8169 (goto-char start)
8170 (while (progn
8171 (when (looking-at c-nonlabel-token-key)
8172 (goto-char start)
8173 (setq label-type nil)
8174 (throw 'check-label nil))
8175 (and (c-safe (c-forward-sexp)
8176 (c-forward-syntactic-ws)
8177 t)
8178 (not (eobp)))))
8179
8180 ;; Record the identifiers in the label for fontification, unless
8181 ;; it begins with `c-label-kwds' in which case the following
8182 ;; identifiers are part of a (constant) expression that
8183 ;; shouldn't be fontified.
8184 (when (and c-record-type-identifiers
8185 (progn (goto-char start)
8186 (not (looking-at c-label-kwds-regexp))))
8187 (while (c-syntactic-re-search-forward c-symbol-key nil t)
8188 (c-record-ref-id (cons (match-beginning 0)
8189 (match-end 0)))))
8190
8191 (c-put-c-type-property (1- (point-max)) 'c-decl-end)
8192 (goto-char (point-max)))))
8193
8194 (t
8195 ;; Not a label.
8196 (goto-char start)))
8197 label-type))
8198
8199 (defun c-forward-objc-directive ()
8200 ;; Assuming the point is at the beginning of a token, try to move
8201 ;; forward to the end of the Objective-C directive that starts
8202 ;; there. Return t if a directive was fully recognized, otherwise
8203 ;; the point is moved as far as one could be successfully parsed and
8204 ;; nil is returned.
8205 ;;
8206 ;; This function records identifier ranges on
8207 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
8208 ;; `c-record-type-identifiers' is non-nil.
8209 ;;
8210 ;; This function might do hidden buffer changes.
8211
8212 (let ((start (point))
8213 start-char
8214 (c-promote-possible-types t)
8215 lim
8216 ;; Turn off recognition of angle bracket arglists while parsing
8217 ;; types here since the protocol reference list might then be
8218 ;; considered part of the preceding name or superclass-name.
8219 c-recognize-<>-arglists)
8220
8221 (if (or
8222 (when (looking-at
8223 (eval-when-compile
8224 (c-make-keywords-re t
8225 (append (c-lang-const c-protection-kwds objc)
8226 '("@end"))
8227 'objc-mode)))
8228 (goto-char (match-end 1))
8229 t)
8230
8231 (and
8232 (looking-at
8233 (eval-when-compile
8234 (c-make-keywords-re t
8235 '("@interface" "@implementation" "@protocol")
8236 'objc-mode)))
8237
8238 ;; Handle the name of the class itself.
8239 (progn
8240 ;; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
8241 ;; at EOB.
8242 (goto-char (match-end 0))
8243 (setq lim (point))
8244 (c-skip-ws-forward)
8245 (c-forward-type))
8246
8247 (catch 'break
8248 ;; Look for ": superclass-name" or "( category-name )".
8249 (when (looking-at "[:(]")
8250 (setq start-char (char-after))
8251 (forward-char)
8252 (c-forward-syntactic-ws)
8253 (unless (c-forward-type) (throw 'break nil))
8254 (when (eq start-char ?\()
8255 (unless (eq (char-after) ?\)) (throw 'break nil))
8256 (forward-char)
8257 (c-forward-syntactic-ws)))
8258
8259 ;; Look for a protocol reference list.
8260 (if (eq (char-after) ?<)
8261 (let ((c-recognize-<>-arglists t)
8262 (c-parse-and-markup-<>-arglists t)
8263 c-restricted-<>-arglists)
8264 (c-forward-<>-arglist t))
8265 t))))
8266
8267 (progn
8268 (c-backward-syntactic-ws lim)
8269 (c-clear-c-type-property start (1- (point)) 'c-decl-end)
8270 (c-put-c-type-property (1- (point)) 'c-decl-end)
8271 t)
8272
8273 (c-clear-c-type-property start (point) 'c-decl-end)
8274 nil)))
8275
8276 (defun c-beginning-of-inheritance-list (&optional lim)
8277 ;; Go to the first non-whitespace after the colon that starts a
8278 ;; multiple inheritance introduction. Optional LIM is the farthest
8279 ;; back we should search.
8280 ;;
8281 ;; This function might do hidden buffer changes.
8282 (c-with-syntax-table c++-template-syntax-table
8283 (c-backward-token-2 0 t lim)
8284 (while (and (or (looking-at c-symbol-start)
8285 (looking-at "[<,]\\|::"))
8286 (zerop (c-backward-token-2 1 t lim))))))
8287
8288 (defun c-in-method-def-p ()
8289 ;; Return nil if we aren't in a method definition, otherwise the
8290 ;; position of the initial [+-].
8291 ;;
8292 ;; This function might do hidden buffer changes.
8293 (save-excursion
8294 (beginning-of-line)
8295 (and c-opt-method-key
8296 (looking-at c-opt-method-key)
8297 (point))
8298 ))
8299
8300 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
8301 (defun c-in-gcc-asm-p ()
8302 ;; Return non-nil if point is within a gcc \"asm\" block.
8303 ;;
8304 ;; This should be called with point inside an argument list.
8305 ;;
8306 ;; Only one level of enclosing parentheses is considered, so for
8307 ;; instance nil is returned when in a function call within an asm
8308 ;; operand.
8309 ;;
8310 ;; This function might do hidden buffer changes.
8311
8312 (and c-opt-asm-stmt-key
8313 (save-excursion
8314 (beginning-of-line)
8315 (backward-up-list 1)
8316 (c-beginning-of-statement-1 (point-min) nil t)
8317 (looking-at c-opt-asm-stmt-key))))
8318
8319 (defun c-at-toplevel-p ()
8320 "Return a determination as to whether point is \"at the top level\".
8321 Informally, \"at the top level\" is anywhere where you can write
8322 a function.
8323
8324 More precisely, being at the top-level means that point is either
8325 outside any enclosing block (such as a function definition), or
8326 directly inside a class, namespace or other block that contains
8327 another declaration level.
8328
8329 If point is not at the top-level (e.g. it is inside a method
8330 definition), then nil is returned. Otherwise, if point is at a
8331 top-level not enclosed within a class definition, t is returned.
8332 Otherwise, a 2-vector is returned where the zeroth element is the
8333 buffer position of the start of the class declaration, and the first
8334 element is the buffer position of the enclosing class's opening
8335 brace.
8336
8337 Note that this function might do hidden buffer changes. See the
8338 comment at the start of cc-engine.el for more info."
8339 ;; Note to maintainers: this function consumes a great mass of CPU cycles.
8340 ;; Its use should thus be minimized as far as possible.
8341 (let ((paren-state (c-parse-state)))
8342 (or (not (c-most-enclosing-brace paren-state))
8343 (c-search-uplist-for-classkey paren-state))))
8344
8345 (defun c-just-after-func-arglist-p (&optional lim)
8346 ;; Return non-nil if the point is in the region after the argument
8347 ;; list of a function and its opening brace (or semicolon in case it
8348 ;; got no body). If there are K&R style argument declarations in
8349 ;; that region, the point has to be inside the first one for this
8350 ;; function to recognize it.
8351 ;;
8352 ;; If successful, the point is moved to the first token after the
8353 ;; function header (see `c-forward-decl-or-cast-1' for details) and
8354 ;; the position of the opening paren of the function arglist is
8355 ;; returned.
8356 ;;
8357 ;; The point is clobbered if not successful.
8358 ;;
8359 ;; LIM is used as bound for backward buffer searches.
8360 ;;
8361 ;; This function might do hidden buffer changes.
8362
8363 (let ((beg (point)) id-start)
8364 (and
8365 (eq (c-beginning-of-statement-1 lim) 'same)
8366
8367 (not (and (c-major-mode-is 'objc-mode)
8368 (c-forward-objc-directive)))
8369
8370 (setq id-start
8371 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil)))
8372 (< id-start beg)
8373
8374 ;; There should not be a '=' or ',' between beg and the
8375 ;; start of the declaration since that means we were in the
8376 ;; "expression part" of the declaration.
8377 (or (> (point) beg)
8378 (not (looking-at "[=,]")))
8379
8380 (save-excursion
8381 ;; Check that there's an arglist paren in the
8382 ;; declaration.
8383 (goto-char id-start)
8384 (cond ((eq (char-after) ?\()
8385 ;; The declarator is a paren expression, so skip past it
8386 ;; so that we don't get stuck on that instead of the
8387 ;; function arglist.
8388 (c-forward-sexp))
8389 ((and c-opt-op-identifier-prefix
8390 (looking-at c-opt-op-identifier-prefix))
8391 ;; Don't trip up on "operator ()".
8392 (c-forward-token-2 2 t)))
8393 (and (< (point) beg)
8394 (c-syntactic-re-search-forward "(" beg t t)
8395 (1- (point)))))))
8396
8397 (defun c-in-knr-argdecl (&optional lim)
8398 ;; Return the position of the first argument declaration if point is
8399 ;; inside a K&R style argument declaration list, nil otherwise.
8400 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
8401 ;; position that bounds the backward search for the argument list. This
8402 ;; function doesn't move point.
8403 ;;
8404 ;; Point must be within a possible K&R region, e.g. just before a top-level
8405 ;; "{". It must be outside of parens and brackets. The test can return
8406 ;; false positives otherwise.
8407 ;;
8408 ;; This function might do hidden buffer changes.
8409 (save-excursion
8410 (save-restriction
8411 ;; If we're in a macro, our search range is restricted to it. Narrow to
8412 ;; the searchable range.
8413 (let* ((macro-start (save-excursion (and (c-beginning-of-macro) (point))))
8414 (macro-end (save-excursion (and macro-start (c-end-of-macro) (point))))
8415 (low-lim (max (or lim (point-min)) (or macro-start (point-min))))
8416 before-lparen after-rparen
8417 (here (point))
8418 (pp-count-out 20) ; Max number of paren/brace constructs before
8419 ; we give up.
8420 ids ; List of identifiers in the parenthesized list.
8421 id-start after-prec-token decl-or-cast decl-res
8422 c-last-identifier-range identifier-ok)
8423 (narrow-to-region low-lim (or macro-end (point-max)))
8424
8425 ;; Search backwards for the defun's argument list. We give up if we
8426 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
8427 ;; a knr region) or BOB.
8428 ;;
8429 ;; The criterion for a paren structure being the arg list is:
8430 ;; o - there is non-WS stuff after it but before any "{"; AND
8431 ;; o - the token after it isn't a ";" AND
8432 ;; o - it is preceded by either an identifier (the function name) or
8433 ;; a macro expansion like "DEFUN (...)"; AND
8434 ;; o - its content is a non-empty comma-separated list of identifiers
8435 ;; (an empty arg list won't have a knr region).
8436 ;;
8437 ;; The following snippet illustrates these rules:
8438 ;; int foo (bar, baz, yuk)
8439 ;; int bar [] ;
8440 ;; int (*baz) (my_type) ;
8441 ;; int (*(* yuk) (void)) (void) ;
8442 ;; {
8443 ;;
8444 ;; Additionally, for a knr list to be recognized:
8445 ;; o - The identifier of each declarator up to and including the
8446 ;; one "near" point must be contained in the arg list.
8447
8448 (catch 'knr
8449 (while (> pp-count-out 0) ; go back one paren/bracket pair each time.
8450 (setq pp-count-out (1- pp-count-out))
8451 (c-syntactic-skip-backward "^)]}=")
8452 (cond ((eq (char-before) ?\))
8453 (setq after-rparen (point)))
8454 ((eq (char-before) ?\])
8455 (setq after-rparen nil))
8456 (t ; either } (hit previous defun) or = or no more
8457 ; parens/brackets.
8458 (throw 'knr nil)))
8459
8460 (if after-rparen
8461 ;; We're inside a paren. Could it be our argument list....?
8462 (if
8463 (and
8464 (progn
8465 (goto-char after-rparen)
8466 (unless (c-go-list-backward) (throw 'knr nil)) ;
8467 ;; FIXME!!! What about macros between the parens? 2007/01/20
8468 (setq before-lparen (point)))
8469
8470 ;; It can't be the arg list if next token is ; or {
8471 (progn (goto-char after-rparen)
8472 (c-forward-syntactic-ws)
8473 (not (memq (char-after) '(?\; ?\{ ?\=))))
8474
8475 ;; Is the thing preceding the list an identifier (the
8476 ;; function name), or a macro expansion?
8477 (progn
8478 (goto-char before-lparen)
8479 (eq (c-backward-token-2) 0)
8480 (or (eq (c-on-identifier) (point))
8481 (and (eq (char-after) ?\))
8482 (c-go-up-list-backward)
8483 (eq (c-backward-token-2) 0)
8484 (eq (c-on-identifier) (point)))))
8485
8486 ;; Have we got a non-empty list of comma-separated
8487 ;; identifiers?
8488 (progn
8489 (goto-char before-lparen)
8490 (c-forward-token-2) ; to first token inside parens
8491 (and
8492 (setq id-start (c-on-identifier)) ; Must be at least one.
8493 (catch 'id-list
8494 (while
8495 (progn
8496 (forward-char)
8497 (c-end-of-current-token)
8498 (push (buffer-substring-no-properties id-start
8499 (point))
8500 ids)
8501 (c-forward-syntactic-ws)
8502 (eq (char-after) ?\,))
8503 (c-forward-token-2)
8504 (unless (setq id-start (c-on-identifier))
8505 (throw 'id-list nil)))
8506 (eq (char-after) ?\)))))
8507
8508 ;; Are all the identifiers in the k&r list up to the
8509 ;; current one also in the argument list?
8510 (progn
8511 (forward-char) ; over the )
8512 (setq after-prec-token after-rparen)
8513 (c-forward-syntactic-ws)
8514 (while (and
8515 (or (consp (setq decl-or-cast
8516 (c-forward-decl-or-cast-1
8517 after-prec-token
8518 nil ; Or 'arglist ???
8519 nil)))
8520 (progn
8521 (goto-char after-prec-token)
8522 (c-forward-syntactic-ws)
8523 (setq identifier-ok (eq (char-after) ?{))
8524 nil))
8525 (eq (char-after) ?\;)
8526 (setq after-prec-token (1+ (point)))
8527 (goto-char (car decl-or-cast))
8528 (setq decl-res (c-forward-declarator))
8529 (setq identifier-ok
8530 (member (buffer-substring-no-properties
8531 (car decl-res) (cadr decl-res))
8532 ids))
8533 (progn
8534 (goto-char after-prec-token)
8535 (prog1 (< (point) here)
8536 (c-forward-syntactic-ws))))
8537 (setq identifier-ok nil))
8538 identifier-ok))
8539 ;; ...Yes. We've identified the function's argument list.
8540 (throw 'knr
8541 (progn (goto-char after-rparen)
8542 (c-forward-syntactic-ws)
8543 (point)))
8544 ;; ...No. The current parens aren't the function's arg list.
8545 (goto-char before-lparen))
8546
8547 (or (c-go-list-backward) ; backwards over [ .... ]
8548 (throw 'knr nil)))))))))
8549
8550 (defun c-skip-conditional ()
8551 ;; skip forward over conditional at point, including any predicate
8552 ;; statements in parentheses. No error checking is performed.
8553 ;;
8554 ;; This function might do hidden buffer changes.
8555 (c-forward-sexp (cond
8556 ;; else if()
8557 ((looking-at (concat "\\<else"
8558 "\\([ \t\n]\\|\\\\\n\\)+"
8559 "if\\>\\([^_]\\|$\\)"))
8560 3)
8561 ;; do, else, try, finally
8562 ((looking-at (concat "\\<\\("
8563 "do\\|else\\|try\\|finally"
8564 "\\)\\>\\([^_]\\|$\\)"))
8565 1)
8566 ;; for, if, while, switch, catch, synchronized, foreach
8567 (t 2))))
8568
8569 (defun c-after-conditional (&optional lim)
8570 ;; If looking at the token after a conditional then return the
8571 ;; position of its start, otherwise return nil.
8572 ;;
8573 ;; This function might do hidden buffer changes.
8574 (save-excursion
8575 (and (zerop (c-backward-token-2 1 t lim))
8576 (or (looking-at c-block-stmt-1-key)
8577 (and (eq (char-after) ?\()
8578 (zerop (c-backward-token-2 1 t lim))
8579 (or (looking-at c-block-stmt-2-key)
8580 (looking-at c-block-stmt-1-2-key))))
8581 (point))))
8582
8583 (defun c-after-special-operator-id (&optional lim)
8584 ;; If the point is after an operator identifier that isn't handled
8585 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
8586 ;; position of the start of that identifier is returned. nil is
8587 ;; returned otherwise. The point may be anywhere in the syntactic
8588 ;; whitespace after the last token of the operator identifier.
8589 ;;
8590 ;; This function might do hidden buffer changes.
8591 (save-excursion
8592 (and c-overloadable-operators-regexp
8593 (zerop (c-backward-token-2 1 nil lim))
8594 (looking-at c-overloadable-operators-regexp)
8595 (or (not c-opt-op-identifier-prefix)
8596 (and
8597 (zerop (c-backward-token-2 1 nil lim))
8598 (looking-at c-opt-op-identifier-prefix)))
8599 (point))))
8600
8601 (defsubst c-backward-to-block-anchor (&optional lim)
8602 ;; Assuming point is at a brace that opens a statement block of some
8603 ;; kind, move to the proper anchor point for that block. It might
8604 ;; need to be adjusted further by c-add-stmt-syntax, but the
8605 ;; position at return is suitable as start position for that
8606 ;; function.
8607 ;;
8608 ;; This function might do hidden buffer changes.
8609 (unless (= (point) (c-point 'boi))
8610 (let ((start (c-after-conditional lim)))
8611 (if start
8612 (goto-char start)))))
8613
8614 (defsubst c-backward-to-decl-anchor (&optional lim)
8615 ;; Assuming point is at a brace that opens the block of a top level
8616 ;; declaration of some kind, move to the proper anchor point for
8617 ;; that block.
8618 ;;
8619 ;; This function might do hidden buffer changes.
8620 (unless (= (point) (c-point 'boi))
8621 (c-beginning-of-statement-1 lim)))
8622
8623 (defun c-search-decl-header-end ()
8624 ;; Search forward for the end of the "header" of the current
8625 ;; declaration. That's the position where the definition body
8626 ;; starts, or the first variable initializer, or the ending
8627 ;; semicolon. I.e. search forward for the closest following
8628 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8629 ;; _after_ the first found token, or at point-max if none is found.
8630 ;;
8631 ;; This function might do hidden buffer changes.
8632
8633 (let ((base (point)))
8634 (if (c-major-mode-is 'c++-mode)
8635
8636 ;; In C++ we need to take special care to handle operator
8637 ;; tokens and those pesky template brackets.
8638 (while (and
8639 (c-syntactic-re-search-forward "[;{<=]" nil 'move t t)
8640 (or
8641 (c-end-of-current-token base)
8642 ;; Handle operator identifiers, i.e. ignore any
8643 ;; operator token preceded by "operator".
8644 (save-excursion
8645 (and (c-safe (c-backward-sexp) t)
8646 (looking-at c-opt-op-identifier-prefix)))
8647 (and (eq (char-before) ?<)
8648 (c-with-syntax-table c++-template-syntax-table
8649 (if (c-safe (goto-char (c-up-list-forward (point))))
8650 t
8651 (goto-char (point-max))
8652 nil)))))
8653 (setq base (point)))
8654
8655 (while (and
8656 (c-syntactic-re-search-forward "[;{=]" nil 'move t t)
8657 (c-end-of-current-token base))
8658 (setq base (point))))))
8659
8660 (defun c-beginning-of-decl-1 (&optional lim)
8661 ;; Go to the beginning of the current declaration, or the beginning
8662 ;; of the previous one if already at the start of it. Point won't
8663 ;; be moved out of any surrounding paren. Return a cons cell of the
8664 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8665 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8666 ;; style argument declarations (and they are to be recognized) then
8667 ;; KNR-POS is set to the start of the first such argument
8668 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8669 ;; position that bounds the backward search.
8670 ;;
8671 ;; NB: Cases where the declaration continues after the block, as in
8672 ;; "struct foo { ... } bar;", are currently recognized as two
8673 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8674 ;;
8675 ;; This function might do hidden buffer changes.
8676 (catch 'return
8677 (let* ((start (point))
8678 (last-stmt-start (point))
8679 (move (c-beginning-of-statement-1 lim nil t)))
8680
8681 ;; `c-beginning-of-statement-1' stops at a block start, but we
8682 ;; want to continue if the block doesn't begin a top level
8683 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8684 ;; or an open paren.
8685 (let ((beg (point)) tentative-move)
8686 ;; Go back one "statement" each time round the loop until we're just
8687 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8688 ;; an ObjC method. This will move over a multiple declaration whose
8689 ;; components are comma separated.
8690 (while (and
8691 ;; Must check with c-opt-method-key in ObjC mode.
8692 (not (and c-opt-method-key
8693 (looking-at c-opt-method-key)))
8694 (/= last-stmt-start (point))
8695 (progn
8696 (c-backward-syntactic-ws lim)
8697 (not (memq (char-before) '(?\; ?} ?: nil))))
8698 (save-excursion
8699 (backward-char)
8700 (not (looking-at "\\s(")))
8701 ;; Check that we don't move from the first thing in a
8702 ;; macro to its header.
8703 (not (eq (setq tentative-move
8704 (c-beginning-of-statement-1 lim nil t))
8705 'macro)))
8706 (setq last-stmt-start beg
8707 beg (point)
8708 move tentative-move))
8709 (goto-char beg))
8710
8711 (when c-recognize-knr-p
8712 (let ((fallback-pos (point)) knr-argdecl-start)
8713 ;; Handle K&R argdecls. Back up after the "statement" jumped
8714 ;; over by `c-beginning-of-statement-1', unless it was the
8715 ;; function body, in which case we're sitting on the opening
8716 ;; brace now. Then test if we're in a K&R argdecl region and
8717 ;; that we started at the other side of the first argdecl in
8718 ;; it.
8719 (unless (eq (char-after) ?{)
8720 (goto-char last-stmt-start))
8721 (if (and (setq knr-argdecl-start (c-in-knr-argdecl lim))
8722 (< knr-argdecl-start start)
8723 (progn
8724 (goto-char knr-argdecl-start)
8725 (not (eq (c-beginning-of-statement-1 lim nil t) 'macro))))
8726 (throw 'return
8727 (cons (if (eq (char-after fallback-pos) ?{)
8728 'previous
8729 'same)
8730 knr-argdecl-start))
8731 (goto-char fallback-pos))))
8732
8733 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8734 ;; statement, so the result will be 'previous if we've moved over any.
8735 ;; So change our result back to 'same if necessary.
8736 ;;
8737 ;; If they were brace list initializers we might not have moved over a
8738 ;; declaration boundary though, so change it to 'same if we've moved
8739 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8740 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8741 ;; potentially can search over a large amount of text.). Take special
8742 ;; pains not to get mislead by C++'s "operator=", and the like.
8743 (if (and (eq move 'previous)
8744 (c-with-syntax-table (if (c-major-mode-is 'c++-mode)
8745 c++-template-syntax-table
8746 (syntax-table))
8747 (save-excursion
8748 (and
8749 (progn
8750 (while ; keep going back to "[;={"s until we either find
8751 ; no more, or get to one which isn't an "operator ="
8752 (and (c-syntactic-re-search-forward "[;={]" start t t t)
8753 (eq (char-before) ?=)
8754 c-overloadable-operators-regexp
8755 c-opt-op-identifier-prefix
8756 (save-excursion
8757 (eq (c-backward-token-2) 0)
8758 (looking-at c-overloadable-operators-regexp)
8759 (eq (c-backward-token-2) 0)
8760 (looking-at c-opt-op-identifier-prefix))))
8761 (eq (char-before) ?=))
8762 (c-syntactic-re-search-forward "[;{]" start t t)
8763 (eq (char-before) ?{)
8764 (c-safe (goto-char (c-up-list-forward (point))) t)
8765 (not (c-syntactic-re-search-forward ";" start t t))))))
8766 (cons 'same nil)
8767 (cons move nil)))))
8768
8769 (defun c-end-of-decl-1 ()
8770 ;; Assuming point is at the start of a declaration (as detected by
8771 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8772 ;; `c-beginning-of-decl-1', this function handles the case when a
8773 ;; block is followed by identifiers in e.g. struct declarations in C
8774 ;; or C++. If a proper end was found then t is returned, otherwise
8775 ;; point is moved as far as possible within the current sexp and nil
8776 ;; is returned. This function doesn't handle macros; use
8777 ;; `c-end-of-macro' instead in those cases.
8778 ;;
8779 ;; This function might do hidden buffer changes.
8780 (let ((start (point))
8781 (decl-syntax-table (if (c-major-mode-is 'c++-mode)
8782 c++-template-syntax-table
8783 (syntax-table))))
8784 (catch 'return
8785 (c-search-decl-header-end)
8786
8787 (when (and c-recognize-knr-p
8788 (eq (char-before) ?\;)
8789 (c-in-knr-argdecl start))
8790 ;; Stopped at the ';' in a K&R argdecl section which is
8791 ;; detected using the same criteria as in
8792 ;; `c-beginning-of-decl-1'. Move to the following block
8793 ;; start.
8794 (c-syntactic-re-search-forward "{" nil 'move t))
8795
8796 (when (eq (char-before) ?{)
8797 ;; Encountered a block in the declaration. Jump over it.
8798 (condition-case nil
8799 (goto-char (c-up-list-forward (point)))
8800 (error (goto-char (point-max))
8801 (throw 'return nil)))
8802 (if (or (not c-opt-block-decls-with-vars-key)
8803 (save-excursion
8804 (c-with-syntax-table decl-syntax-table
8805 (let ((lim (point)))
8806 (goto-char start)
8807 (not (and
8808 ;; Check for `c-opt-block-decls-with-vars-key'
8809 ;; before the first paren.
8810 (c-syntactic-re-search-forward
8811 (concat "[;=([{]\\|\\("
8812 c-opt-block-decls-with-vars-key
8813 "\\)")
8814 lim t t t)
8815 (match-beginning 1)
8816 (not (eq (char-before) ?_))
8817 ;; Check that the first following paren is
8818 ;; the block.
8819 (c-syntactic-re-search-forward "[;=([{]"
8820 lim t t t)
8821 (eq (char-before) ?{)))))))
8822 ;; The declaration doesn't have any of the
8823 ;; `c-opt-block-decls-with-vars' keywords in the
8824 ;; beginning, so it ends here at the end of the block.
8825 (throw 'return t)))
8826
8827 (c-with-syntax-table decl-syntax-table
8828 (while (progn
8829 (if (eq (char-before) ?\;)
8830 (throw 'return t))
8831 (c-syntactic-re-search-forward ";" nil 'move t))))
8832 nil)))
8833
8834 (defun c-looking-at-decl-block (containing-sexp goto-start &optional limit)
8835 ;; Assuming the point is at an open brace, check if it starts a
8836 ;; block that contains another declaration level, i.e. that isn't a
8837 ;; statement block or a brace list, and if so return non-nil.
8838 ;;
8839 ;; If the check is successful, the return value is the start of the
8840 ;; keyword that tells what kind of construct it is, i.e. typically
8841 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8842 ;; the point will be at the start of the construct, before any
8843 ;; leading specifiers, otherwise it's at the returned position.
8844 ;;
8845 ;; The point is clobbered if the check is unsuccessful.
8846 ;;
8847 ;; CONTAINING-SEXP is the position of the open of the surrounding
8848 ;; paren, or nil if none.
8849 ;;
8850 ;; The optional LIMIT limits the backward search for the start of
8851 ;; the construct. It's assumed to be at a syntactically relevant
8852 ;; position.
8853 ;;
8854 ;; If any template arglists are found in the searched region before
8855 ;; the open brace, they get marked with paren syntax.
8856 ;;
8857 ;; This function might do hidden buffer changes.
8858
8859 (let ((open-brace (point)) kwd-start first-specifier-pos)
8860 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8861
8862 (when (and c-recognize-<>-arglists
8863 (eq (char-before) ?>))
8864 ;; Could be at the end of a template arglist.
8865 (let ((c-parse-and-markup-<>-arglists t))
8866 (while (and
8867 (c-backward-<>-arglist nil limit)
8868 (progn
8869 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8870 (eq (char-before) ?>))))))
8871
8872 ;; Note: Can't get bogus hits inside template arglists below since they
8873 ;; have gotten paren syntax above.
8874 (when (and
8875 ;; If `goto-start' is set we begin by searching for the
8876 ;; first possible position of a leading specifier list.
8877 ;; The `c-decl-block-key' search continues from there since
8878 ;; we know it can't match earlier.
8879 (if goto-start
8880 (when (c-syntactic-re-search-forward c-symbol-start
8881 open-brace t t)
8882 (goto-char (setq first-specifier-pos (match-beginning 0)))
8883 t)
8884 t)
8885
8886 (cond
8887 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t)
8888 (goto-char (setq kwd-start (match-beginning 0)))
8889 (and
8890 ;; Exclude cases where we matched what would ordinarily
8891 ;; be a block declaration keyword, except where it's not
8892 ;; legal because it's part of a "compound keyword" like
8893 ;; "enum class". Of course, if c-after-brace-list-key
8894 ;; is nil, we can skip the test.
8895 (or (equal c-after-brace-list-key "\\<\\>")
8896 (save-match-data
8897 (save-excursion
8898 (not
8899 (and
8900 (looking-at c-after-brace-list-key)
8901 (= (c-backward-token-2 1 t) 0)
8902 (looking-at c-brace-list-key))))))
8903 (or
8904 ;; Found a keyword that can't be a type?
8905 (match-beginning 1)
8906
8907 ;; Can be a type too, in which case it's the return type of a
8908 ;; function (under the assumption that no declaration level
8909 ;; block construct starts with a type).
8910 (not (c-forward-type))
8911
8912 ;; Jumped over a type, but it could be a declaration keyword
8913 ;; followed by the declared identifier that we've jumped over
8914 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8915 ;; then we should be at the declarator now, so check for a
8916 ;; valid declarator start.
8917 ;;
8918 ;; Note: This doesn't cope with the case when a declared
8919 ;; identifier is followed by e.g. '(' in a language where '('
8920 ;; also might be part of a declarator expression. Currently
8921 ;; there's no such language.
8922 (not (or (looking-at c-symbol-start)
8923 (looking-at c-type-decl-prefix-key))))))
8924
8925 ;; In Pike a list of modifiers may be followed by a brace
8926 ;; to make them apply to many identifiers. Note that the
8927 ;; match data will be empty on return in this case.
8928 ((and (c-major-mode-is 'pike-mode)
8929 (progn
8930 (goto-char open-brace)
8931 (= (c-backward-token-2) 0))
8932 (looking-at c-specifier-key)
8933 ;; Use this variant to avoid yet another special regexp.
8934 (c-keyword-member (c-keyword-sym (match-string 1))
8935 'c-modifier-kwds))
8936 (setq kwd-start (point))
8937 t)))
8938
8939 ;; Got a match.
8940
8941 (if goto-start
8942 ;; Back up over any preceding specifiers and their clauses
8943 ;; by going forward from `first-specifier-pos', which is the
8944 ;; earliest possible position where the specifier list can
8945 ;; start.
8946 (progn
8947 (goto-char first-specifier-pos)
8948
8949 (while (< (point) kwd-start)
8950 (if (looking-at c-symbol-key)
8951 ;; Accept any plain symbol token on the ground that
8952 ;; it's a specifier masked through a macro (just
8953 ;; like `c-forward-decl-or-cast-1' skip forward over
8954 ;; such tokens).
8955 ;;
8956 ;; Could be more restrictive wrt invalid keywords,
8957 ;; but that'd only occur in invalid code so there's
8958 ;; no use spending effort on it.
8959 (let ((end (match-end 0)))
8960 (unless (c-forward-keyword-clause 0)
8961 (goto-char end)
8962 (c-forward-syntactic-ws)))
8963
8964 ;; Can't parse a declaration preamble and is still
8965 ;; before `kwd-start'. That means `first-specifier-pos'
8966 ;; was in some earlier construct. Search again.
8967 (if (c-syntactic-re-search-forward c-symbol-start
8968 kwd-start 'move t)
8969 (goto-char (setq first-specifier-pos (match-beginning 0)))
8970 ;; Got no preamble before the block declaration keyword.
8971 (setq first-specifier-pos kwd-start))))
8972
8973 (goto-char first-specifier-pos))
8974 (goto-char kwd-start))
8975
8976 kwd-start)))
8977
8978 (defun c-search-uplist-for-classkey (paren-state)
8979 ;; Check if the closest containing paren sexp is a declaration
8980 ;; block, returning a 2 element vector in that case. Aref 0
8981 ;; contains the bufpos at boi of the class key line, and aref 1
8982 ;; contains the bufpos of the open brace. This function is an
8983 ;; obsolete wrapper for `c-looking-at-decl-block'.
8984 ;;
8985 ;; This function might do hidden buffer changes.
8986 (let ((open-paren-pos (c-most-enclosing-brace paren-state)))
8987 (when open-paren-pos
8988 (save-excursion
8989 (goto-char open-paren-pos)
8990 (when (and (eq (char-after) ?{)
8991 (c-looking-at-decl-block
8992 (c-safe-position open-paren-pos paren-state)
8993 nil))
8994 (back-to-indentation)
8995 (vector (point) open-paren-pos))))))
8996
8997 (defun c-most-enclosing-decl-block (paren-state)
8998 ;; Return the buffer position of the most enclosing decl-block brace (in the
8999 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
9000 ;; none was found.
9001 (let* ((open-brace (c-pull-open-brace paren-state))
9002 (next-open-brace (c-pull-open-brace paren-state)))
9003 (while (and open-brace
9004 (save-excursion
9005 (goto-char open-brace)
9006 (not (c-looking-at-decl-block next-open-brace nil))))
9007 (setq open-brace next-open-brace
9008 next-open-brace (c-pull-open-brace paren-state)))
9009 open-brace))
9010
9011 (defun c-cheap-inside-bracelist-p (paren-state)
9012 ;; Return the position of the L-brace if point is inside a brace list
9013 ;; initialization of an array, etc. This is an approximate function,
9014 ;; designed for speed over accuracy. It will not find every bracelist, but
9015 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
9016 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
9017 ;; is everywhere else.
9018 (let (b-pos)
9019 (save-excursion
9020 (while
9021 (and (setq b-pos (c-pull-open-brace paren-state))
9022 (progn (goto-char b-pos)
9023 (c-backward-sws)
9024 (c-backward-token-2)
9025 (not (looking-at "=")))))
9026 b-pos)))
9027
9028 (defun c-backward-typed-enum-colon ()
9029 ;; We're at a "{" which might be the opening brace of a enum which is
9030 ;; strongly typed (by a ":" followed by a type). If this is the case, leave
9031 ;; point before the colon and return t. Otherwise leave point unchanged and return nil.
9032 ;; Match data will be clobbered.
9033 (let ((here (point))
9034 (colon-pos nil))
9035 (save-excursion
9036 (while
9037 (and (eql (c-backward-token-2) 0)
9038 (or (not (looking-at "\\s)"))
9039 (c-go-up-list-backward))
9040 (cond
9041 ((and (eql (char-after) ?:)
9042 (save-excursion
9043 (c-backward-syntactic-ws)
9044 (c-on-identifier)))
9045 (setq colon-pos (point))
9046 (forward-char)
9047 (c-forward-syntactic-ws)
9048 (or (and (c-forward-type)
9049 (progn (c-forward-syntactic-ws)
9050 (eq (point) here)))
9051 (setq colon-pos nil))
9052 nil)
9053 ((eql (char-after) ?\()
9054 t)
9055 ((looking-at c-symbol-key)
9056 t)
9057 (t nil)))))
9058 (when colon-pos
9059 (goto-char colon-pos)
9060 t)))
9061
9062 (defun c-backward-over-enum-header ()
9063 ;; We're at a "{". Move back to the enum-like keyword that starts this
9064 ;; declaration and return t, otherwise don't move and return nil.
9065 (let ((here (point))
9066 up-sexp-pos before-identifier)
9067 (when c-recognize-post-brace-list-type-p
9068 (c-backward-typed-enum-colon))
9069 (while
9070 (and
9071 (eq (c-backward-token-2) 0)
9072 (or (not (looking-at "\\s)"))
9073 (c-go-up-list-backward))
9074 (cond
9075 ((and (looking-at c-symbol-key) (c-on-identifier)
9076 (not before-identifier))
9077 (setq before-identifier t))
9078 ((and before-identifier
9079 (or (eql (char-after) ?,)
9080 (looking-at c-postfix-decl-spec-key)))
9081 (setq before-identifier nil)
9082 t)
9083 ((looking-at c-after-brace-list-key) t)
9084 ((looking-at c-brace-list-key) nil)
9085 ((eq (char-after) ?\()
9086 (and (eq (c-backward-token-2) 0)
9087 (or (looking-at c-decl-hangon-key)
9088 (and c-opt-cpp-prefix
9089 (looking-at c-noise-macro-with-parens-name-re)))))
9090
9091 ((and c-recognize-<>-arglists
9092 (eq (char-after) ?<)
9093 (looking-at "\\s("))
9094 t)
9095 (t nil))))
9096 (or (looking-at c-brace-list-key)
9097 (progn (goto-char here) nil))))
9098
9099 (defun c-inside-bracelist-p (containing-sexp paren-state)
9100 ;; return the buffer position of the beginning of the brace list
9101 ;; statement if we're inside a brace list, otherwise return nil.
9102 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
9103 ;; paren. PAREN-STATE is the remainder of the state of enclosing
9104 ;; braces
9105 ;;
9106 ;; N.B.: This algorithm can potentially get confused by cpp macros
9107 ;; placed in inconvenient locations. It's a trade-off we make for
9108 ;; speed.
9109 ;;
9110 ;; This function might do hidden buffer changes.
9111 (or
9112 ;; This will pick up brace list declarations.
9113 (save-excursion
9114 (goto-char containing-sexp)
9115 (c-backward-over-enum-header))
9116 ;; this will pick up array/aggregate init lists, even if they are nested.
9117 (save-excursion
9118 (let ((class-key
9119 ;; Pike can have class definitions anywhere, so we must
9120 ;; check for the class key here.
9121 (and (c-major-mode-is 'pike-mode)
9122 c-decl-block-key))
9123 bufpos braceassignp lim next-containing macro-start)
9124 (while (and (not bufpos)
9125 containing-sexp)
9126 (when paren-state
9127 (if (consp (car paren-state))
9128 (setq lim (cdr (car paren-state))
9129 paren-state (cdr paren-state))
9130 (setq lim (car paren-state)))
9131 (when paren-state
9132 (setq next-containing (car paren-state)
9133 paren-state (cdr paren-state))))
9134 (goto-char containing-sexp)
9135 (if (c-looking-at-inexpr-block next-containing next-containing)
9136 ;; We're in an in-expression block of some kind. Do not
9137 ;; check nesting. We deliberately set the limit to the
9138 ;; containing sexp, so that c-looking-at-inexpr-block
9139 ;; doesn't check for an identifier before it.
9140 (setq containing-sexp nil)
9141 ;; see if the open brace is preceded by = or [...] in
9142 ;; this statement, but watch out for operator=
9143 (setq braceassignp 'dontknow)
9144 (c-backward-token-2 1 t lim)
9145 ;; Checks to do only on the first sexp before the brace.
9146 (when (and c-opt-inexpr-brace-list-key
9147 (eq (char-after) ?\[))
9148 ;; In Java, an initialization brace list may follow
9149 ;; directly after "new Foo[]", so check for a "new"
9150 ;; earlier.
9151 (while (eq braceassignp 'dontknow)
9152 (setq braceassignp
9153 (cond ((/= (c-backward-token-2 1 t lim) 0) nil)
9154 ((looking-at c-opt-inexpr-brace-list-key) t)
9155 ((looking-at "\\sw\\|\\s_\\|[.[]")
9156 ;; Carry on looking if this is an
9157 ;; identifier (may contain "." in Java)
9158 ;; or another "[]" sexp.
9159 'dontknow)
9160 (t nil)))))
9161 ;; Checks to do on all sexps before the brace, up to the
9162 ;; beginning of the statement.
9163 (while (eq braceassignp 'dontknow)
9164 (cond ((eq (char-after) ?\;)
9165 (setq braceassignp nil))
9166 ((and class-key
9167 (looking-at class-key))
9168 (setq braceassignp nil))
9169 ((eq (char-after) ?=)
9170 ;; We've seen a =, but must check earlier tokens so
9171 ;; that it isn't something that should be ignored.
9172 (setq braceassignp 'maybe)
9173 (while (and (eq braceassignp 'maybe)
9174 (zerop (c-backward-token-2 1 t lim)))
9175 (setq braceassignp
9176 (cond
9177 ;; Check for operator =
9178 ((and c-opt-op-identifier-prefix
9179 (looking-at c-opt-op-identifier-prefix))
9180 nil)
9181 ;; Check for `<opchar>= in Pike.
9182 ((and (c-major-mode-is 'pike-mode)
9183 (or (eq (char-after) ?`)
9184 ;; Special case for Pikes
9185 ;; `[]=, since '[' is not in
9186 ;; the punctuation class.
9187 (and (eq (char-after) ?\[)
9188 (eq (char-before) ?`))))
9189 nil)
9190 ((looking-at "\\s.") 'maybe)
9191 ;; make sure we're not in a C++ template
9192 ;; argument assignment
9193 ((and
9194 (c-major-mode-is 'c++-mode)
9195 (save-excursion
9196 (let ((here (point))
9197 (pos< (progn
9198 (skip-chars-backward "^<>")
9199 (point))))
9200 (and (eq (char-before) ?<)
9201 (not (c-crosses-statement-barrier-p
9202 pos< here))
9203 (not (c-in-literal))
9204 ))))
9205 nil)
9206 (t t))))))
9207 (if (and (eq braceassignp 'dontknow)
9208 (/= (c-backward-token-2 1 t lim) 0))
9209 (setq braceassignp nil)))
9210 (cond
9211 (braceassignp
9212 ;; We've hit the beginning of the aggregate list.
9213 (c-beginning-of-statement-1
9214 (c-most-enclosing-brace paren-state))
9215 (setq bufpos (point)))
9216 ((eq (char-after) ?\;)
9217 ;; Brace lists can't contain a semicolon, so we're done.
9218 (setq containing-sexp nil))
9219 ((and (setq macro-start (point))
9220 (c-forward-to-cpp-define-body)
9221 (eq (point) containing-sexp))
9222 ;; We've a macro whose expansion starts with the '{'.
9223 ;; Heuristically, if we have a ';' in it we've not got a
9224 ;; brace list, otherwise we have.
9225 (let ((macro-end (progn (c-end-of-macro) (point))))
9226 (goto-char containing-sexp)
9227 (forward-char)
9228 (if (and (c-syntactic-re-search-forward "[;,]" macro-end t t)
9229 (eq (char-before) ?\;))
9230 (setq bufpos nil
9231 containing-sexp nil)
9232 (setq bufpos macro-start))))
9233 (t
9234 ;; Go up one level
9235 (setq containing-sexp next-containing
9236 lim nil
9237 next-containing nil)))))
9238
9239 bufpos))
9240 ))
9241
9242 (defun c-looking-at-special-brace-list (&optional lim)
9243 ;; If we're looking at the start of a pike-style list, i.e., `({ })',
9244 ;; `([ ])', `(< >)', etc., a cons of a cons of its starting and ending
9245 ;; positions and its entry in c-special-brace-lists is returned, nil
9246 ;; otherwise. The ending position is nil if the list is still open.
9247 ;; LIM is the limit for forward search. The point may either be at
9248 ;; the `(' or at the following paren character. Tries to check the
9249 ;; matching closer, but assumes it's correct if no balanced paren is
9250 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
9251 ;; a special brace list).
9252 ;;
9253 ;; This function might do hidden buffer changes.
9254 (if c-special-brace-lists
9255 (condition-case ()
9256 (save-excursion
9257 (let ((beg (point))
9258 inner-beg end type)
9259 (c-forward-syntactic-ws)
9260 (if (eq (char-after) ?\()
9261 (progn
9262 (forward-char 1)
9263 (c-forward-syntactic-ws)
9264 (setq inner-beg (point))
9265 (setq type (assq (char-after) c-special-brace-lists)))
9266 (if (setq type (assq (char-after) c-special-brace-lists))
9267 (progn
9268 (setq inner-beg (point))
9269 (c-backward-syntactic-ws)
9270 (forward-char -1)
9271 (setq beg (if (eq (char-after) ?\()
9272 (point)
9273 nil)))))
9274 (if (and beg type)
9275 (if (and (c-safe
9276 (goto-char beg)
9277 (c-forward-sexp 1)
9278 (setq end (point))
9279 (= (char-before) ?\)))
9280 (c-safe
9281 (goto-char inner-beg)
9282 (if (looking-at "\\s(")
9283 ;; Check balancing of the inner paren
9284 ;; below.
9285 (progn
9286 (c-forward-sexp 1)
9287 t)
9288 ;; If the inner char isn't a paren then
9289 ;; we can't check balancing, so just
9290 ;; check the char before the outer
9291 ;; closing paren.
9292 (goto-char end)
9293 (backward-char)
9294 (c-backward-syntactic-ws)
9295 (= (char-before) (cdr type)))))
9296 (if (or (/= (char-syntax (char-before)) ?\))
9297 (= (progn
9298 (c-forward-syntactic-ws)
9299 (point))
9300 (1- end)))
9301 (cons (cons beg end) type))
9302 (cons (list beg) type)))))
9303 (error nil))))
9304
9305 (defun c-looking-at-bos (&optional lim)
9306 ;; Return non-nil if between two statements or declarations, assuming
9307 ;; point is not inside a literal or comment.
9308 ;;
9309 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
9310 ;; are recommended instead.
9311 ;;
9312 ;; This function might do hidden buffer changes.
9313 (c-at-statement-start-p))
9314 (make-obsolete 'c-looking-at-bos 'c-at-statement-start-p "22.1")
9315
9316 (defun c-looking-at-inexpr-block (lim containing-sexp &optional check-at-end)
9317 ;; Return non-nil if we're looking at the beginning of a block
9318 ;; inside an expression. The value returned is actually a cons of
9319 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
9320 ;; position of the beginning of the construct.
9321 ;;
9322 ;; LIM limits the backward search. CONTAINING-SEXP is the start
9323 ;; position of the closest containing list. If it's nil, the
9324 ;; containing paren isn't used to decide whether we're inside an
9325 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
9326 ;; needs to be farther back.
9327 ;;
9328 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
9329 ;; brace block might be done. It should only be used when the
9330 ;; construct can be assumed to be complete, i.e. when the original
9331 ;; starting position was further down than that.
9332 ;;
9333 ;; This function might do hidden buffer changes.
9334
9335 (save-excursion
9336 (let ((res 'maybe) passed-paren
9337 (closest-lim (or containing-sexp lim (point-min)))
9338 ;; Look at the character after point only as a last resort
9339 ;; when we can't disambiguate.
9340 (block-follows (and (eq (char-after) ?{) (point))))
9341
9342 (while (and (eq res 'maybe)
9343 (progn (c-backward-syntactic-ws)
9344 (> (point) closest-lim))
9345 (not (bobp))
9346 (progn (backward-char)
9347 (looking-at "[]).]\\|\\w\\|\\s_"))
9348 (c-safe (forward-char)
9349 (goto-char (scan-sexps (point) -1))))
9350
9351 (setq res
9352 (if (looking-at c-keywords-regexp)
9353 (let ((kw-sym (c-keyword-sym (match-string 1))))
9354 (cond
9355 ((and block-follows
9356 (c-keyword-member kw-sym 'c-inexpr-class-kwds))
9357 (and (not (eq passed-paren ?\[))
9358 (or (not (looking-at c-class-key))
9359 ;; If the class definition is at the start of
9360 ;; a statement, we don't consider it an
9361 ;; in-expression class.
9362 (let ((prev (point)))
9363 (while (and
9364 (= (c-backward-token-2 1 nil closest-lim) 0)
9365 (eq (char-syntax (char-after)) ?w))
9366 (setq prev (point)))
9367 (goto-char prev)
9368 (not (c-at-statement-start-p)))
9369 ;; Also, in Pike we treat it as an
9370 ;; in-expression class if it's used in an
9371 ;; object clone expression.
9372 (save-excursion
9373 (and check-at-end
9374 (c-major-mode-is 'pike-mode)
9375 (progn (goto-char block-follows)
9376 (zerop (c-forward-token-2 1 t)))
9377 (eq (char-after) ?\())))
9378 (cons 'inexpr-class (point))))
9379 ((c-keyword-member kw-sym 'c-inexpr-block-kwds)
9380 (when (not passed-paren)
9381 (cons 'inexpr-statement (point))))
9382 ((c-keyword-member kw-sym 'c-lambda-kwds)
9383 (when (or (not passed-paren)
9384 (eq passed-paren ?\())
9385 (cons 'inlambda (point))))
9386 ((c-keyword-member kw-sym 'c-block-stmt-kwds)
9387 nil)
9388 (t
9389 'maybe)))
9390
9391 (if (looking-at "\\s(")
9392 (if passed-paren
9393 (if (and (eq passed-paren ?\[)
9394 (eq (char-after) ?\[))
9395 ;; Accept several square bracket sexps for
9396 ;; Java array initializations.
9397 'maybe)
9398 (setq passed-paren (char-after))
9399 'maybe)
9400 'maybe))))
9401
9402 (if (eq res 'maybe)
9403 (when (and c-recognize-paren-inexpr-blocks
9404 block-follows
9405 containing-sexp
9406 (eq (char-after containing-sexp) ?\())
9407 (goto-char containing-sexp)
9408 (if (or (save-excursion
9409 (c-backward-syntactic-ws lim)
9410 (while (and (eq (char-before) ?>)
9411 (c-get-char-property (1- (point))
9412 'syntax-table)
9413 (c-go-list-backward nil lim))
9414 (c-backward-syntactic-ws lim))
9415 (and (> (point) (or lim (point-min)))
9416 (c-on-identifier)))
9417 (and c-special-brace-lists
9418 (c-looking-at-special-brace-list)))
9419 nil
9420 (cons 'inexpr-statement (point))))
9421
9422 res))))
9423
9424 (defun c-looking-at-inexpr-block-backward (paren-state)
9425 ;; Returns non-nil if we're looking at the end of an in-expression
9426 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
9427 ;; PAREN-STATE is the paren state relevant at the current position.
9428 ;;
9429 ;; This function might do hidden buffer changes.
9430 (save-excursion
9431 ;; We currently only recognize a block.
9432 (let ((here (point))
9433 (elem (car-safe paren-state))
9434 containing-sexp)
9435 (when (and (consp elem)
9436 (progn (goto-char (cdr elem))
9437 (c-forward-syntactic-ws here)
9438 (= (point) here)))
9439 (goto-char (car elem))
9440 (if (setq paren-state (cdr paren-state))
9441 (setq containing-sexp (car-safe paren-state)))
9442 (c-looking-at-inexpr-block (c-safe-position containing-sexp
9443 paren-state)
9444 containing-sexp)))))
9445
9446 (defun c-at-macro-vsemi-p (&optional pos)
9447 ;; Is there a "virtual semicolon" at POS or point?
9448 ;; (See cc-defs.el for full details of "virtual semicolons".)
9449 ;;
9450 ;; This is true when point is at the last non syntactic WS position on the
9451 ;; line, there is a macro call last on the line, and this particular macro's
9452 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
9453 ;; semicolon.
9454 (save-excursion
9455 (save-restriction
9456 (widen)
9457 (if pos
9458 (goto-char pos)
9459 (setq pos (point)))
9460 (and
9461 c-macro-with-semi-re
9462 (eq (skip-chars-backward " \t") 0)
9463
9464 ;; Check we've got nothing after this except comments and empty lines
9465 ;; joined by escaped EOLs.
9466 (skip-chars-forward " \t") ; always returns non-nil.
9467 (progn
9468 (while ; go over 1 block comment per iteration.
9469 (and
9470 (looking-at "\\(\\\\[\n\r][ \t]*\\)*")
9471 (goto-char (match-end 0))
9472 (cond
9473 ((looking-at c-block-comment-start-regexp)
9474 (and (forward-comment 1)
9475 (skip-chars-forward " \t"))) ; always returns non-nil
9476 ((looking-at c-line-comment-start-regexp)
9477 (end-of-line)
9478 nil)
9479 (t nil))))
9480 (eolp))
9481
9482 (goto-char pos)
9483 (progn (c-backward-syntactic-ws)
9484 (eq (point) pos))
9485
9486 ;; Check for one of the listed macros being before point.
9487 (or (not (eq (char-before) ?\)))
9488 (when (c-go-list-backward)
9489 (c-backward-syntactic-ws)
9490 t))
9491 (c-simple-skip-symbol-backward)
9492 (looking-at c-macro-with-semi-re)
9493 (goto-char pos)
9494 (not (c-in-literal)))))) ; The most expensive check last.
9495
9496 (defun c-macro-vsemi-status-unknown-p () t) ; See cc-defs.el.
9497
9498 \f
9499 ;; `c-guess-basic-syntax' and the functions that precedes it below
9500 ;; implements the main decision tree for determining the syntactic
9501 ;; analysis of the current line of code.
9502
9503 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
9504 ;; auto newline analysis.
9505 (defvar c-auto-newline-analysis nil)
9506
9507 (defun c-brace-anchor-point (bracepos)
9508 ;; BRACEPOS is the position of a brace in a construct like "namespace
9509 ;; Bar {". Return the anchor point in this construct; this is the
9510 ;; earliest symbol on the brace's line which isn't earlier than
9511 ;; "namespace".
9512 ;;
9513 ;; Currently (2007-08-17), "like namespace" means "matches
9514 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
9515 ;; or anything like that.
9516 (save-excursion
9517 (let ((boi (c-point 'boi bracepos)))
9518 (goto-char bracepos)
9519 (while (and (> (point) boi)
9520 (not (looking-at c-other-decl-block-key)))
9521 (c-backward-token-2))
9522 (if (> (point) boi) (point) boi))))
9523
9524 (defsubst c-add-syntax (symbol &rest args)
9525 ;; A simple function to prepend a new syntax element to
9526 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
9527 ;; should always be dynamically bound but since we read it first
9528 ;; we'll fail properly anyway if this function is misused.
9529 (setq c-syntactic-context (cons (cons symbol args)
9530 c-syntactic-context)))
9531
9532 (defsubst c-append-syntax (symbol &rest args)
9533 ;; Like `c-add-syntax' but appends to the end of the syntax list.
9534 ;; (Normally not necessary.)
9535 (setq c-syntactic-context (nconc c-syntactic-context
9536 (list (cons symbol args)))))
9537
9538 (defun c-add-stmt-syntax (syntax-symbol
9539 syntax-extra-args
9540 stop-at-boi-only
9541 containing-sexp
9542 paren-state)
9543 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
9544 ;; needed with further syntax elements of the types `substatement',
9545 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
9546 ;; `defun-block-intro'.
9547 ;;
9548 ;; Do the generic processing to anchor the given syntax symbol on
9549 ;; the preceding statement: Skip over any labels and containing
9550 ;; statements on the same line, and then search backward until we
9551 ;; find a statement or block start that begins at boi without a
9552 ;; label or comment.
9553 ;;
9554 ;; Point is assumed to be at the prospective anchor point for the
9555 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
9556 ;; skip past open parens and containing statements. Most of the added
9557 ;; syntax elements will get the same anchor point - the exception is
9558 ;; for an anchor in a construct like "namespace"[*] - this is as early
9559 ;; as possible in the construct but on the same line as the {.
9560 ;;
9561 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
9562 ;;
9563 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
9564 ;; syntax symbol. They are appended after the anchor point.
9565 ;;
9566 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
9567 ;; if the current statement starts there.
9568 ;;
9569 ;; Note: It's not a problem if PAREN-STATE "overshoots"
9570 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
9571 ;;
9572 ;; This function might do hidden buffer changes.
9573
9574 (if (= (point) (c-point 'boi))
9575 ;; This is by far the most common case, so let's give it special
9576 ;; treatment.
9577 (apply 'c-add-syntax syntax-symbol (point) syntax-extra-args)
9578
9579 (let ((syntax-last c-syntactic-context)
9580 (boi (c-point 'boi))
9581 ;; Set when we're on a label, so that we don't stop there.
9582 ;; FIXME: To be complete we should check if we're on a label
9583 ;; now at the start.
9584 on-label)
9585
9586 ;; Use point as the anchor point for "namespace", "extern", etc.
9587 (apply 'c-add-syntax syntax-symbol
9588 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist)
9589 (point) nil)
9590 syntax-extra-args)
9591
9592 ;; Loop while we have to back out of containing blocks.
9593 (while
9594 (and
9595 (catch 'back-up-block
9596
9597 ;; Loop while we have to back up statements.
9598 (while (or (/= (point) boi)
9599 on-label
9600 (looking-at c-comment-start-regexp))
9601
9602 ;; Skip past any comments that stands between the
9603 ;; statement start and boi.
9604 (let ((savepos (point)))
9605 (while (and (/= savepos boi)
9606 (c-backward-single-comment))
9607 (setq savepos (point)
9608 boi (c-point 'boi)))
9609 (goto-char savepos))
9610
9611 ;; Skip to the beginning of this statement or backward
9612 ;; another one.
9613 (let ((old-pos (point))
9614 (old-boi boi)
9615 (step-type (c-beginning-of-statement-1 containing-sexp)))
9616 (setq boi (c-point 'boi)
9617 on-label (eq step-type 'label))
9618
9619 (cond ((= (point) old-pos)
9620 ;; If we didn't move we're at the start of a block and
9621 ;; have to continue outside it.
9622 (throw 'back-up-block t))
9623
9624 ((and (eq step-type 'up)
9625 (>= (point) old-boi)
9626 (looking-at "else\\>[^_]")
9627 (save-excursion
9628 (goto-char old-pos)
9629 (looking-at "if\\>[^_]")))
9630 ;; Special case to avoid deeper and deeper indentation
9631 ;; of "else if" clauses.
9632 )
9633
9634 ((and (not stop-at-boi-only)
9635 (/= old-pos old-boi)
9636 (memq step-type '(up previous)))
9637 ;; If stop-at-boi-only is nil, we shouldn't back up
9638 ;; over previous or containing statements to try to
9639 ;; reach boi, so go back to the last position and
9640 ;; exit.
9641 (goto-char old-pos)
9642 (throw 'back-up-block nil))
9643
9644 (t
9645 (if (and (not stop-at-boi-only)
9646 (memq step-type '(up previous beginning)))
9647 ;; If we've moved into another statement then we
9648 ;; should no longer try to stop in the middle of a
9649 ;; line.
9650 (setq stop-at-boi-only t))
9651
9652 ;; Record this as a substatement if we skipped up one
9653 ;; level.
9654 (when (eq step-type 'up)
9655 (c-add-syntax 'substatement nil))))
9656 )))
9657
9658 containing-sexp)
9659
9660 ;; Now we have to go out of this block.
9661 (goto-char containing-sexp)
9662
9663 ;; Don't stop in the middle of a special brace list opener
9664 ;; like "({".
9665 (when c-special-brace-lists
9666 (let ((special-list (c-looking-at-special-brace-list)))
9667 (when (and special-list
9668 (< (car (car special-list)) (point)))
9669 (setq containing-sexp (car (car special-list)))
9670 (goto-char containing-sexp))))
9671
9672 (setq paren-state (c-whack-state-after containing-sexp paren-state)
9673 containing-sexp (c-most-enclosing-brace paren-state)
9674 boi (c-point 'boi))
9675
9676 ;; Analyze the construct in front of the block we've stepped out
9677 ;; from and add the right syntactic element for it.
9678 (let ((paren-pos (point))
9679 (paren-char (char-after))
9680 step-type)
9681
9682 (if (eq paren-char ?\()
9683 ;; Stepped out of a parenthesis block, so we're in an
9684 ;; expression now.
9685 (progn
9686 (when (/= paren-pos boi)
9687 (if (and c-recognize-paren-inexpr-blocks
9688 (progn
9689 (c-backward-syntactic-ws containing-sexp)
9690 (or (not (looking-at "\\>"))
9691 (not (c-on-identifier))))
9692 (save-excursion
9693 (goto-char (1+ paren-pos))
9694 (c-forward-syntactic-ws)
9695 (eq (char-after) ?{)))
9696 ;; Stepped out of an in-expression statement. This
9697 ;; syntactic element won't get an anchor pos.
9698 (c-add-syntax 'inexpr-statement)
9699
9700 ;; A parenthesis normally belongs to an arglist.
9701 (c-add-syntax 'arglist-cont-nonempty nil paren-pos)))
9702
9703 (goto-char (max boi
9704 (if containing-sexp
9705 (1+ containing-sexp)
9706 (point-min))))
9707 (setq step-type 'same
9708 on-label nil))
9709
9710 ;; Stepped out of a brace block.
9711 (setq step-type (c-beginning-of-statement-1 containing-sexp)
9712 on-label (eq step-type 'label))
9713
9714 (if (and (eq step-type 'same)
9715 (/= paren-pos (point)))
9716 (let (inexpr)
9717 (cond
9718 ((save-excursion
9719 (goto-char paren-pos)
9720 (setq inexpr (c-looking-at-inexpr-block
9721 (c-safe-position containing-sexp paren-state)
9722 containing-sexp)))
9723 (c-add-syntax (if (eq (car inexpr) 'inlambda)
9724 'defun-block-intro
9725 'statement-block-intro)
9726 nil))
9727 ((looking-at c-other-decl-block-key)
9728 (c-add-syntax
9729 (cdr (assoc (match-string 1)
9730 c-other-decl-block-key-in-symbols-alist))
9731 (max (c-point 'boi paren-pos) (point))))
9732 (t (c-add-syntax 'defun-block-intro nil))))
9733
9734 (c-add-syntax 'statement-block-intro nil)))
9735
9736 (if (= paren-pos boi)
9737 ;; Always done if the open brace was at boi. The
9738 ;; c-beginning-of-statement-1 call above is necessary
9739 ;; anyway, to decide the type of block-intro to add.
9740 (goto-char paren-pos)
9741 (setq boi (c-point 'boi)))
9742 ))
9743
9744 ;; Fill in the current point as the anchor for all the symbols
9745 ;; added above.
9746 (let ((p c-syntactic-context) q)
9747 (while (not (eq p syntax-last))
9748 (setq q (cdr (car p))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
9749 (while q
9750 (unless (car q)
9751 (setcar q (point)))
9752 (setq q (cdr q)))
9753 (setq p (cdr p))))
9754 )))
9755
9756 (defun c-add-class-syntax (symbol
9757 containing-decl-open
9758 containing-decl-start
9759 containing-decl-kwd
9760 paren-state)
9761 ;; The inclass and class-close syntactic symbols are added in
9762 ;; several places and some work is needed to fix everything.
9763 ;; Therefore it's collected here.
9764 ;;
9765 ;; This function might do hidden buffer changes.
9766 (goto-char containing-decl-open)
9767 (if (and (eq symbol 'inclass) (= (point) (c-point 'boi)))
9768 (progn
9769 (c-add-syntax symbol containing-decl-open)
9770 containing-decl-open)
9771 (goto-char containing-decl-start)
9772 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9773 ;; here, but we have to do like this for compatibility.
9774 (back-to-indentation)
9775 (c-add-syntax symbol (point))
9776 (if (and (c-keyword-member containing-decl-kwd
9777 'c-inexpr-class-kwds)
9778 (/= containing-decl-start (c-point 'boi containing-decl-start)))
9779 (c-add-syntax 'inexpr-class))
9780 (point)))
9781
9782 (defun c-guess-continued-construct (indent-point
9783 char-after-ip
9784 beg-of-same-or-containing-stmt
9785 containing-sexp
9786 paren-state)
9787 ;; This function contains the decision tree reached through both
9788 ;; cases 18 and 10. It's a continued statement or top level
9789 ;; construct of some kind.
9790 ;;
9791 ;; This function might do hidden buffer changes.
9792
9793 (let (special-brace-list placeholder)
9794 (goto-char indent-point)
9795 (skip-chars-forward " \t")
9796
9797 (cond
9798 ;; (CASE A removed.)
9799 ;; CASE B: open braces for class or brace-lists
9800 ((setq special-brace-list
9801 (or (and c-special-brace-lists
9802 (c-looking-at-special-brace-list))
9803 (eq char-after-ip ?{)))
9804
9805 (cond
9806 ;; CASE B.1: class-open
9807 ((save-excursion
9808 (and (eq (char-after) ?{)
9809 (c-looking-at-decl-block containing-sexp t)
9810 (setq beg-of-same-or-containing-stmt (point))))
9811 (c-add-syntax 'class-open beg-of-same-or-containing-stmt))
9812
9813 ;; CASE B.2: brace-list-open
9814 ((or (consp special-brace-list)
9815 (save-excursion
9816 (goto-char beg-of-same-or-containing-stmt)
9817 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
9818 indent-point t t t)))
9819 ;; The most semantically accurate symbol here is
9820 ;; brace-list-open, but we normally report it simply as a
9821 ;; statement-cont. The reason is that one normally adjusts
9822 ;; brace-list-open for brace lists as top-level constructs,
9823 ;; and brace lists inside statements is a completely different
9824 ;; context. C.f. case 5A.3.
9825 (c-beginning-of-statement-1 containing-sexp)
9826 (c-add-stmt-syntax (if c-auto-newline-analysis
9827 ;; Turn off the dwim above when we're
9828 ;; analyzing the nature of the brace
9829 ;; for the auto newline feature.
9830 'brace-list-open
9831 'statement-cont)
9832 nil nil
9833 containing-sexp paren-state))
9834
9835 ;; CASE B.3: The body of a function declared inside a normal
9836 ;; block. Can occur e.g. in Pike and when using gcc
9837 ;; extensions, but watch out for macros followed by blocks.
9838 ;; C.f. cases E, 16F and 17G.
9839 ((and (not (c-at-statement-start-p))
9840 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9841 'same)
9842 (save-excursion
9843 (let ((c-recognize-typeless-decls nil))
9844 ;; Turn off recognition of constructs that lacks a
9845 ;; type in this case, since that's more likely to be
9846 ;; a macro followed by a block.
9847 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9848 (c-add-stmt-syntax 'defun-open nil t
9849 containing-sexp paren-state))
9850
9851 ;; CASE B.4: Continued statement with block open. The most
9852 ;; accurate analysis is perhaps `statement-cont' together with
9853 ;; `block-open' but we play DWIM and use `substatement-open'
9854 ;; instead. The rationale is that this typically is a macro
9855 ;; followed by a block which makes it very similar to a
9856 ;; statement with a substatement block.
9857 (t
9858 (c-add-stmt-syntax 'substatement-open nil nil
9859 containing-sexp paren-state))
9860 ))
9861
9862 ;; CASE C: iostream insertion or extraction operator
9863 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
9864 (save-excursion
9865 (goto-char beg-of-same-or-containing-stmt)
9866 ;; If there is no preceding streamop in the statement
9867 ;; then indent this line as a normal statement-cont.
9868 (when (c-syntactic-re-search-forward
9869 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point 'move t t)
9870 (c-add-syntax 'stream-op (c-point 'boi))
9871 t))))
9872
9873 ;; CASE E: In the "K&R region" of a function declared inside a
9874 ;; normal block. C.f. case B.3.
9875 ((and (save-excursion
9876 ;; Check that the next token is a '{'. This works as
9877 ;; long as no language that allows nested function
9878 ;; definitions allows stuff like member init lists, K&R
9879 ;; declarations or throws clauses there.
9880 ;;
9881 ;; Note that we do a forward search for something ahead
9882 ;; of the indentation line here. That's not good since
9883 ;; the user might not have typed it yet. Unfortunately
9884 ;; it's exceedingly tricky to recognize a function
9885 ;; prototype in a code block without resorting to this.
9886 (c-forward-syntactic-ws)
9887 (eq (char-after) ?{))
9888 (not (c-at-statement-start-p))
9889 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9890 'same)
9891 (save-excursion
9892 (let ((c-recognize-typeless-decls nil))
9893 ;; Turn off recognition of constructs that lacks a
9894 ;; type in this case, since that's more likely to be
9895 ;; a macro followed by a block.
9896 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9897 (c-add-stmt-syntax 'func-decl-cont nil t
9898 containing-sexp paren-state))
9899
9900 ;;CASE F: continued statement and the only preceding items are
9901 ;;annotations.
9902 ((and (c-major-mode-is 'java-mode)
9903 (setq placeholder (point))
9904 (c-beginning-of-statement-1)
9905 (progn
9906 (while (and (c-forward-annotation)
9907 (< (point) placeholder))
9908 (c-forward-syntactic-ws))
9909 t)
9910 (prog1
9911 (>= (point) placeholder)
9912 (goto-char placeholder)))
9913 (c-beginning-of-statement-1 containing-sexp)
9914 (c-add-syntax 'annotation-var-cont (point)))
9915
9916 ;; CASE G: a template list continuation?
9917 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9918 ((and (c-major-mode-is 'c++-mode)
9919 (save-excursion
9920 (goto-char indent-point)
9921 (c-with-syntax-table c++-template-syntax-table
9922 (setq placeholder (c-up-list-backward)))
9923 (and placeholder
9924 (eq (char-after placeholder) ?<)
9925 (/= (char-before placeholder) ?<)
9926 (progn
9927 (goto-char (1+ placeholder))
9928 (not (looking-at c-<-op-cont-regexp))))))
9929 (c-with-syntax-table c++-template-syntax-table
9930 (goto-char placeholder)
9931 (c-beginning-of-statement-1 containing-sexp t))
9932 (if (save-excursion
9933 (c-backward-syntactic-ws containing-sexp)
9934 (eq (char-before) ?<))
9935 ;; In a nested template arglist.
9936 (progn
9937 (goto-char placeholder)
9938 (c-syntactic-skip-backward "^,;" containing-sexp t)
9939 (c-forward-syntactic-ws))
9940 (back-to-indentation))
9941 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9942 ;; template aware.
9943 (c-add-syntax 'template-args-cont (point) placeholder))
9944
9945 ;; CASE D: continued statement.
9946 (t
9947 (c-beginning-of-statement-1 containing-sexp)
9948 (c-add-stmt-syntax 'statement-cont nil nil
9949 containing-sexp paren-state))
9950 )))
9951
9952 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9953 ;; 2005/11/29).
9954 ;;;###autoload
9955 (defun c-guess-basic-syntax ()
9956 "Return the syntactic context of the current line."
9957 (save-excursion
9958 (beginning-of-line)
9959 (c-save-buffer-state
9960 ((indent-point (point))
9961 (case-fold-search nil)
9962 ;; A whole ugly bunch of various temporary variables. Have
9963 ;; to declare them here since it's not possible to declare
9964 ;; a variable with only the scope of a cond test and the
9965 ;; following result clauses, and most of this function is a
9966 ;; single gigantic cond. :P
9967 literal char-before-ip before-ws-ip char-after-ip macro-start
9968 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9969 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9970 containing-<
9971 ;; The following record some positions for the containing
9972 ;; declaration block if we're directly within one:
9973 ;; `containing-decl-open' is the position of the open
9974 ;; brace. `containing-decl-start' is the start of the
9975 ;; declaration. `containing-decl-kwd' is the keyword
9976 ;; symbol of the keyword that tells what kind of block it
9977 ;; is.
9978 containing-decl-open
9979 containing-decl-start
9980 containing-decl-kwd
9981 ;; The open paren of the closest surrounding sexp or nil if
9982 ;; there is none.
9983 containing-sexp
9984 ;; The position after the closest preceding brace sexp
9985 ;; (nested sexps are ignored), or the position after
9986 ;; `containing-sexp' if there is none, or (point-min) if
9987 ;; `containing-sexp' is nil.
9988 lim
9989 ;; The paren state outside `containing-sexp', or at
9990 ;; `indent-point' if `containing-sexp' is nil.
9991 (paren-state (c-parse-state))
9992 ;; There's always at most one syntactic element which got
9993 ;; an anchor pos. It's stored in syntactic-relpos.
9994 syntactic-relpos
9995 (c-stmt-delim-chars c-stmt-delim-chars))
9996
9997 ;; Check if we're directly inside an enclosing declaration
9998 ;; level block.
9999 (when (and (setq containing-sexp
10000 (c-most-enclosing-brace paren-state))
10001 (progn
10002 (goto-char containing-sexp)
10003 (eq (char-after) ?{))
10004 (setq placeholder
10005 (c-looking-at-decl-block
10006 (c-most-enclosing-brace paren-state
10007 containing-sexp)
10008 t)))
10009 (setq containing-decl-open containing-sexp
10010 containing-decl-start (point)
10011 containing-sexp nil)
10012 (goto-char placeholder)
10013 (setq containing-decl-kwd (and (looking-at c-keywords-regexp)
10014 (c-keyword-sym (match-string 1)))))
10015
10016 ;; Init some position variables.
10017 (if paren-state
10018 (progn
10019 (setq containing-sexp (car paren-state)
10020 paren-state (cdr paren-state))
10021 (if (consp containing-sexp)
10022 (save-excursion
10023 (goto-char (cdr containing-sexp))
10024 (if (and (c-major-mode-is 'c++-mode)
10025 (c-back-over-member-initializer-braces))
10026 (c-syntactic-skip-backward "^}" nil t))
10027 (setq lim (point))
10028 (if paren-state
10029 ;; Ignore balanced paren. The next entry
10030 ;; can't be another one.
10031 (setq containing-sexp (car paren-state)
10032 paren-state (cdr paren-state))
10033 ;; If there is no surrounding open paren then
10034 ;; put the last balanced pair back on paren-state.
10035 (setq paren-state (cons containing-sexp paren-state)
10036 containing-sexp nil)))
10037 (setq lim (1+ containing-sexp))))
10038 (setq lim (point-min)))
10039
10040 ;; If we're in a parenthesis list then ',' delimits the
10041 ;; "statements" rather than being an operator (with the
10042 ;; exception of the "for" clause). This difference is
10043 ;; typically only noticeable when statements are used in macro
10044 ;; arglists.
10045 (when (and containing-sexp
10046 (eq (char-after containing-sexp) ?\())
10047 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma))
10048 ;; cache char before and after indent point, and move point to
10049 ;; the most likely position to perform the majority of tests
10050 (goto-char indent-point)
10051 (c-backward-syntactic-ws lim)
10052 (setq before-ws-ip (point)
10053 char-before-ip (char-before))
10054 (goto-char indent-point)
10055 (skip-chars-forward " \t")
10056 (setq char-after-ip (char-after))
10057
10058 ;; are we in a literal?
10059 (setq literal (c-in-literal lim))
10060
10061 ;; now figure out syntactic qualities of the current line
10062 (cond
10063
10064 ;; CASE 1: in a string.
10065 ((eq literal 'string)
10066 (c-add-syntax 'string (c-point 'bopl)))
10067
10068 ;; CASE 2: in a C or C++ style comment.
10069 ((and (memq literal '(c c++))
10070 ;; This is a kludge for XEmacs where we use
10071 ;; `buffer-syntactic-context', which doesn't correctly
10072 ;; recognize "\*/" to end a block comment.
10073 ;; `parse-partial-sexp' which is used by
10074 ;; `c-literal-limits' will however do that in most
10075 ;; versions, which results in that we get nil from
10076 ;; `c-literal-limits' even when `c-in-literal' claims
10077 ;; we're inside a comment.
10078 (setq placeholder (c-literal-limits lim)))
10079 (c-add-syntax literal (car placeholder)))
10080
10081 ;; CASE 3: in a cpp preprocessor macro continuation.
10082 ((and (save-excursion
10083 (when (c-beginning-of-macro)
10084 (setq macro-start (point))))
10085 (/= macro-start (c-point 'boi))
10086 (progn
10087 (setq tmpsymbol 'cpp-macro-cont)
10088 (or (not c-syntactic-indentation-in-macros)
10089 (save-excursion
10090 (goto-char macro-start)
10091 ;; If at the beginning of the body of a #define
10092 ;; directive then analyze as cpp-define-intro
10093 ;; only. Go on with the syntactic analysis
10094 ;; otherwise. in-macro-expr is set if we're in a
10095 ;; cpp expression, i.e. before the #define body
10096 ;; or anywhere in a non-#define directive.
10097 (if (c-forward-to-cpp-define-body)
10098 (let ((indent-boi (c-point 'boi indent-point)))
10099 (setq in-macro-expr (> (point) indent-boi)
10100 tmpsymbol 'cpp-define-intro)
10101 (= (point) indent-boi))
10102 (setq in-macro-expr t)
10103 nil)))))
10104 (c-add-syntax tmpsymbol macro-start)
10105 (setq macro-start nil))
10106
10107 ;; CASE 11: an else clause?
10108 ((looking-at "else\\>[^_]")
10109 (c-beginning-of-statement-1 containing-sexp)
10110 (c-add-stmt-syntax 'else-clause nil t
10111 containing-sexp paren-state))
10112
10113 ;; CASE 12: while closure of a do/while construct?
10114 ((and (looking-at "while\\>[^_]")
10115 (save-excursion
10116 (prog1 (eq (c-beginning-of-statement-1 containing-sexp)
10117 'beginning)
10118 (setq placeholder (point)))))
10119 (goto-char placeholder)
10120 (c-add-stmt-syntax 'do-while-closure nil t
10121 containing-sexp paren-state))
10122
10123 ;; CASE 13: A catch or finally clause? This case is simpler
10124 ;; than if-else and do-while, because a block is required
10125 ;; after every try, catch and finally.
10126 ((save-excursion
10127 (and (cond ((c-major-mode-is 'c++-mode)
10128 (looking-at "catch\\>[^_]"))
10129 ((c-major-mode-is 'java-mode)
10130 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
10131 (and (c-safe (c-backward-syntactic-ws)
10132 (c-backward-sexp)
10133 t)
10134 (eq (char-after) ?{)
10135 (c-safe (c-backward-syntactic-ws)
10136 (c-backward-sexp)
10137 t)
10138 (if (eq (char-after) ?\()
10139 (c-safe (c-backward-sexp) t)
10140 t))
10141 (looking-at "\\(try\\|catch\\)\\>[^_]")
10142 (setq placeholder (point))))
10143 (goto-char placeholder)
10144 (c-add-stmt-syntax 'catch-clause nil t
10145 containing-sexp paren-state))
10146
10147 ;; CASE 18: A substatement we can recognize by keyword.
10148 ((save-excursion
10149 (and c-opt-block-stmt-key
10150 (not (eq char-before-ip ?\;))
10151 (not (c-at-vsemi-p before-ws-ip))
10152 (not (memq char-after-ip '(?\) ?\] ?,)))
10153 (or (not (eq char-before-ip ?}))
10154 (c-looking-at-inexpr-block-backward c-state-cache))
10155 (> (point)
10156 (progn
10157 ;; Ought to cache the result from the
10158 ;; c-beginning-of-statement-1 calls here.
10159 (setq placeholder (point))
10160 (while (eq (setq step-type
10161 (c-beginning-of-statement-1 lim))
10162 'label))
10163 (if (eq step-type 'previous)
10164 (goto-char placeholder)
10165 (setq placeholder (point))
10166 (if (and (eq step-type 'same)
10167 (not (looking-at c-opt-block-stmt-key)))
10168 ;; Step up to the containing statement if we
10169 ;; stayed in the same one.
10170 (let (step)
10171 (while (eq
10172 (setq step
10173 (c-beginning-of-statement-1 lim))
10174 'label))
10175 (if (eq step 'up)
10176 (setq placeholder (point))
10177 ;; There was no containing statement after all.
10178 (goto-char placeholder)))))
10179 placeholder))
10180 (if (looking-at c-block-stmt-2-key)
10181 ;; Require a parenthesis after these keywords.
10182 ;; Necessary to catch e.g. synchronized in Java,
10183 ;; which can be used both as statement and
10184 ;; modifier.
10185 (and (zerop (c-forward-token-2 1 nil))
10186 (eq (char-after) ?\())
10187 (looking-at c-opt-block-stmt-key))))
10188
10189 (if (eq step-type 'up)
10190 ;; CASE 18A: Simple substatement.
10191 (progn
10192 (goto-char placeholder)
10193 (cond
10194 ((eq char-after-ip ?{)
10195 (c-add-stmt-syntax 'substatement-open nil nil
10196 containing-sexp paren-state))
10197 ((save-excursion
10198 (goto-char indent-point)
10199 (back-to-indentation)
10200 (c-forward-label))
10201 (c-add-stmt-syntax 'substatement-label nil nil
10202 containing-sexp paren-state))
10203 (t
10204 (c-add-stmt-syntax 'substatement nil nil
10205 containing-sexp paren-state))))
10206
10207 ;; CASE 18B: Some other substatement. This is shared
10208 ;; with case 10.
10209 (c-guess-continued-construct indent-point
10210 char-after-ip
10211 placeholder
10212 lim
10213 paren-state)))
10214
10215 ;; CASE 14: A case or default label
10216 ((save-excursion
10217 (and (looking-at c-label-kwds-regexp)
10218 (or (c-major-mode-is 'idl-mode)
10219 (and
10220 containing-sexp
10221 (goto-char containing-sexp)
10222 (eq (char-after) ?{)
10223 (progn (c-backward-syntactic-ws) t)
10224 (eq (char-before) ?\))
10225 (c-go-list-backward)
10226 (progn (c-backward-syntactic-ws) t)
10227 (c-simple-skip-symbol-backward)
10228 (looking-at c-block-stmt-2-key)))))
10229 (if containing-sexp
10230 (progn
10231 (goto-char containing-sexp)
10232 (setq lim (c-most-enclosing-brace c-state-cache
10233 containing-sexp))
10234 (c-backward-to-block-anchor lim)
10235 (c-add-stmt-syntax 'case-label nil t lim paren-state))
10236 ;; Got a bogus label at the top level. In lack of better
10237 ;; alternatives, anchor it on (point-min).
10238 (c-add-syntax 'case-label (point-min))))
10239
10240 ;; CASE 15: any other label
10241 ((save-excursion
10242 (back-to-indentation)
10243 (and (not (looking-at c-syntactic-ws-start))
10244 (not (looking-at c-label-kwds-regexp))
10245 (c-forward-label)))
10246 (cond (containing-decl-open
10247 (setq placeholder (c-add-class-syntax 'inclass
10248 containing-decl-open
10249 containing-decl-start
10250 containing-decl-kwd
10251 paren-state))
10252 ;; Append access-label with the same anchor point as
10253 ;; inclass gets.
10254 (c-append-syntax 'access-label placeholder))
10255
10256 (containing-sexp
10257 (goto-char containing-sexp)
10258 (setq lim (c-most-enclosing-brace c-state-cache
10259 containing-sexp))
10260 (save-excursion
10261 (setq tmpsymbol
10262 (if (and (eq (c-beginning-of-statement-1 lim) 'up)
10263 (looking-at "switch\\>[^_]"))
10264 ;; If the surrounding statement is a switch then
10265 ;; let's analyze all labels as switch labels, so
10266 ;; that they get lined up consistently.
10267 'case-label
10268 'label)))
10269 (c-backward-to-block-anchor lim)
10270 (c-add-stmt-syntax tmpsymbol nil t lim paren-state))
10271
10272 (t
10273 ;; A label on the top level. Treat it as a class
10274 ;; context. (point-min) is the closest we get to the
10275 ;; class open brace.
10276 (c-add-syntax 'access-label (point-min)))))
10277
10278 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
10279 ;; 17E.
10280 ((setq placeholder (c-looking-at-inexpr-block
10281 (c-safe-position containing-sexp paren-state)
10282 containing-sexp
10283 ;; Have to turn on the heuristics after
10284 ;; the point even though it doesn't work
10285 ;; very well. C.f. test case class-16.pike.
10286 t))
10287 (setq tmpsymbol (assq (car placeholder)
10288 '((inexpr-class . class-open)
10289 (inexpr-statement . block-open))))
10290 (if tmpsymbol
10291 ;; It's a statement block or an anonymous class.
10292 (setq tmpsymbol (cdr tmpsymbol))
10293 ;; It's a Pike lambda. Check whether we are between the
10294 ;; lambda keyword and the argument list or at the defun
10295 ;; opener.
10296 (setq tmpsymbol (if (eq char-after-ip ?{)
10297 'inline-open
10298 'lambda-intro-cont)))
10299 (goto-char (cdr placeholder))
10300 (back-to-indentation)
10301 (c-add-stmt-syntax tmpsymbol nil t
10302 (c-most-enclosing-brace c-state-cache (point))
10303 paren-state)
10304 (unless (eq (point) (cdr placeholder))
10305 (c-add-syntax (car placeholder))))
10306
10307 ;; CASE 5: Line is inside a declaration level block or at top level.
10308 ((or containing-decl-open (null containing-sexp))
10309 (cond
10310
10311 ;; CASE 5A: we are looking at a defun, brace list, class,
10312 ;; or inline-inclass method opening brace
10313 ((setq special-brace-list
10314 (or (and c-special-brace-lists
10315 (c-looking-at-special-brace-list))
10316 (eq char-after-ip ?{)))
10317 (cond
10318
10319 ;; CASE 5A.1: Non-class declaration block open.
10320 ((save-excursion
10321 (let (tmp)
10322 (and (eq char-after-ip ?{)
10323 (setq tmp (c-looking-at-decl-block containing-sexp t))
10324 (progn
10325 (setq placeholder (point))
10326 (goto-char tmp)
10327 (looking-at c-symbol-key))
10328 (c-keyword-member
10329 (c-keyword-sym (setq keyword (match-string 0)))
10330 'c-other-block-decl-kwds))))
10331 (goto-char placeholder)
10332 (c-add-stmt-syntax
10333 (if (string-equal keyword "extern")
10334 ;; Special case for extern-lang-open.
10335 'extern-lang-open
10336 (intern (concat keyword "-open")))
10337 nil t containing-sexp paren-state))
10338
10339 ;; CASE 5A.2: we are looking at a class opening brace
10340 ((save-excursion
10341 (goto-char indent-point)
10342 (skip-chars-forward " \t")
10343 (and (eq (char-after) ?{)
10344 (c-looking-at-decl-block containing-sexp t)
10345 (setq placeholder (point))))
10346 (c-add-syntax 'class-open placeholder))
10347
10348 ;; CASE 5A.3: brace list open
10349 ((save-excursion
10350 (c-beginning-of-decl-1 lim)
10351 (while (cond
10352 ((looking-at c-specifier-key)
10353 (c-forward-keyword-clause 1))
10354 ((and c-opt-cpp-prefix
10355 (looking-at c-noise-macro-with-parens-name-re))
10356 (c-forward-noise-clause))))
10357 (setq placeholder (c-point 'boi))
10358 (or (consp special-brace-list)
10359 (and (or (save-excursion
10360 (goto-char indent-point)
10361 (setq tmpsymbol nil)
10362 (while (and (> (point) placeholder)
10363 (zerop (c-backward-token-2 1 t))
10364 (not (looking-at "=\\([^=]\\|$\\)")))
10365 (and c-opt-inexpr-brace-list-key
10366 (not tmpsymbol)
10367 (looking-at c-opt-inexpr-brace-list-key)
10368 (setq tmpsymbol 'topmost-intro-cont)))
10369 (looking-at "=\\([^=]\\|$\\)"))
10370 (looking-at c-brace-list-key))
10371 (save-excursion
10372 (while (and (< (point) indent-point)
10373 (zerop (c-forward-token-2 1 t))
10374 (not (memq (char-after) '(?\; ?\()))))
10375 (not (memq (char-after) '(?\; ?\()))
10376 ))))
10377 (if (and (not c-auto-newline-analysis)
10378 (c-major-mode-is 'java-mode)
10379 (eq tmpsymbol 'topmost-intro-cont))
10380 ;; We're in Java and have found that the open brace
10381 ;; belongs to a "new Foo[]" initialization list,
10382 ;; which means the brace list is part of an
10383 ;; expression and not a top level definition. We
10384 ;; therefore treat it as any topmost continuation
10385 ;; even though the semantically correct symbol still
10386 ;; is brace-list-open, on the same grounds as in
10387 ;; case B.2.
10388 (progn
10389 (c-beginning-of-statement-1 lim)
10390 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10391 (c-add-syntax 'brace-list-open placeholder)))
10392
10393 ;; CASE 5A.4: inline defun open
10394 ((and containing-decl-open
10395 (not (c-keyword-member containing-decl-kwd
10396 'c-other-block-decl-kwds)))
10397 (c-add-syntax 'inline-open)
10398 (c-add-class-syntax 'inclass
10399 containing-decl-open
10400 containing-decl-start
10401 containing-decl-kwd
10402 paren-state))
10403
10404 ;; CASE 5A.5: ordinary defun open
10405 (t
10406 (save-excursion
10407 (c-beginning-of-decl-1 lim)
10408 (while (cond
10409 ((looking-at c-specifier-key)
10410 (c-forward-keyword-clause 1))
10411 ((and c-opt-cpp-prefix
10412 (looking-at c-noise-macro-with-parens-name-re))
10413 (c-forward-noise-clause))))
10414 (c-add-syntax 'defun-open (c-point 'boi))
10415 ;; Bogus to use bol here, but it's the legacy. (Resolved,
10416 ;; 2007-11-09)
10417 ))))
10418
10419 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
10420 ;; Note there is no limit on the backward search here, since member
10421 ;; init lists can, in practice, be very large.
10422 ((save-excursion
10423 (when (and (c-major-mode-is 'c++-mode)
10424 (setq placeholder (c-back-over-member-initializers)))
10425 (setq tmp-pos (point))))
10426 (if (= (c-point 'bosws) (1+ tmp-pos))
10427 (progn
10428 ;; There is no preceding member init clause.
10429 ;; Indent relative to the beginning of indentation
10430 ;; for the topmost-intro line that contains the
10431 ;; prototype's open paren.
10432 (goto-char placeholder)
10433 (c-add-syntax 'member-init-intro (c-point 'boi)))
10434 ;; Indent relative to the first member init clause.
10435 (goto-char (1+ tmp-pos))
10436 (c-forward-syntactic-ws)
10437 (c-add-syntax 'member-init-cont (point))))
10438
10439 ;; CASE 5B: After a function header but before the body (or
10440 ;; the ending semicolon if there's no body).
10441 ((save-excursion
10442 (when (setq placeholder (c-just-after-func-arglist-p
10443 (max lim (c-determine-limit 500))))
10444 (setq tmp-pos (point))))
10445 (cond
10446
10447 ;; CASE 5B.1: Member init list.
10448 ((eq (char-after tmp-pos) ?:)
10449 ;; There is no preceding member init clause.
10450 ;; Indent relative to the beginning of indentation
10451 ;; for the topmost-intro line that contains the
10452 ;; prototype's open paren.
10453 (goto-char placeholder)
10454 (c-add-syntax 'member-init-intro (c-point 'boi)))
10455
10456 ;; CASE 5B.2: K&R arg decl intro
10457 ((and c-recognize-knr-p
10458 (c-in-knr-argdecl lim))
10459 (c-beginning-of-statement-1 lim)
10460 (c-add-syntax 'knr-argdecl-intro (c-point 'boi))
10461 (if containing-decl-open
10462 (c-add-class-syntax 'inclass
10463 containing-decl-open
10464 containing-decl-start
10465 containing-decl-kwd
10466 paren-state)))
10467
10468 ;; CASE 5B.4: Nether region after a C++ or Java func
10469 ;; decl, which could include a `throws' declaration.
10470 (t
10471 (c-beginning-of-statement-1 lim)
10472 (c-add-syntax 'func-decl-cont (c-point 'boi))
10473 )))
10474
10475 ;; CASE 5C: inheritance line. could be first inheritance
10476 ;; line, or continuation of a multiple inheritance
10477 ((or (and (c-major-mode-is 'c++-mode)
10478 (progn
10479 (when (eq char-after-ip ?,)
10480 (skip-chars-forward " \t")
10481 (forward-char))
10482 (looking-at c-opt-postfix-decl-spec-key)))
10483 (and (or (eq char-before-ip ?:)
10484 ;; watch out for scope operator
10485 (save-excursion
10486 (and (eq char-after-ip ?:)
10487 (c-safe (forward-char 1) t)
10488 (not (eq (char-after) ?:))
10489 )))
10490 (save-excursion
10491 (c-beginning-of-statement-1 lim)
10492 (when (looking-at c-opt-<>-sexp-key)
10493 (goto-char (match-end 1))
10494 (c-forward-syntactic-ws)
10495 (c-forward-<>-arglist nil)
10496 (c-forward-syntactic-ws))
10497 (looking-at c-class-key)))
10498 ;; for Java
10499 (and (c-major-mode-is 'java-mode)
10500 (let ((fence (save-excursion
10501 (c-beginning-of-statement-1 lim)
10502 (point)))
10503 cont done)
10504 (save-excursion
10505 (while (not done)
10506 (cond ((looking-at c-opt-postfix-decl-spec-key)
10507 (setq injava-inher (cons cont (point))
10508 done t))
10509 ((or (not (c-safe (c-forward-sexp -1) t))
10510 (<= (point) fence))
10511 (setq done t))
10512 )
10513 (setq cont t)))
10514 injava-inher)
10515 (not (c-crosses-statement-barrier-p (cdr injava-inher)
10516 (point)))
10517 ))
10518 (cond
10519
10520 ;; CASE 5C.1: non-hanging colon on an inher intro
10521 ((eq char-after-ip ?:)
10522 (c-beginning-of-statement-1 lim)
10523 (c-add-syntax 'inher-intro (c-point 'boi))
10524 ;; don't add inclass symbol since relative point already
10525 ;; contains any class offset
10526 )
10527
10528 ;; CASE 5C.2: hanging colon on an inher intro
10529 ((eq char-before-ip ?:)
10530 (c-beginning-of-statement-1 lim)
10531 (c-add-syntax 'inher-intro (c-point 'boi))
10532 (if containing-decl-open
10533 (c-add-class-syntax 'inclass
10534 containing-decl-open
10535 containing-decl-start
10536 containing-decl-kwd
10537 paren-state)))
10538
10539 ;; CASE 5C.3: in a Java implements/extends
10540 (injava-inher
10541 (let ((where (cdr injava-inher))
10542 (cont (car injava-inher)))
10543 (goto-char where)
10544 (cond ((looking-at "throws\\>[^_]")
10545 (c-add-syntax 'func-decl-cont
10546 (progn (c-beginning-of-statement-1 lim)
10547 (c-point 'boi))))
10548 (cont (c-add-syntax 'inher-cont where))
10549 (t (c-add-syntax 'inher-intro
10550 (progn (goto-char (cdr injava-inher))
10551 (c-beginning-of-statement-1 lim)
10552 (point))))
10553 )))
10554
10555 ;; CASE 5C.4: a continued inheritance line
10556 (t
10557 (c-beginning-of-inheritance-list lim)
10558 (c-add-syntax 'inher-cont (point))
10559 ;; don't add inclass symbol since relative point already
10560 ;; contains any class offset
10561 )))
10562
10563 ;; CASE 5P: AWK pattern or function or continuation
10564 ;; thereof.
10565 ((c-major-mode-is 'awk-mode)
10566 (setq placeholder (point))
10567 (c-add-stmt-syntax
10568 (if (and (eq (c-beginning-of-statement-1) 'same)
10569 (/= (point) placeholder))
10570 'topmost-intro-cont
10571 'topmost-intro)
10572 nil nil
10573 containing-sexp paren-state))
10574
10575 ;; CASE 5D: this could be a top-level initialization, a
10576 ;; member init list continuation, or a template argument
10577 ;; list continuation.
10578 ((save-excursion
10579 ;; Note: We use the fact that lim is always after any
10580 ;; preceding brace sexp.
10581 (if c-recognize-<>-arglists
10582 (while (and
10583 (progn
10584 (c-syntactic-skip-backward "^;,=<>" lim t)
10585 (> (point) lim))
10586 (or
10587 (when c-overloadable-operators-regexp
10588 (when (setq placeholder (c-after-special-operator-id lim))
10589 (goto-char placeholder)
10590 t))
10591 (cond
10592 ((eq (char-before) ?>)
10593 (or (c-backward-<>-arglist nil lim)
10594 (backward-char))
10595 t)
10596 ((eq (char-before) ?<)
10597 (backward-char)
10598 (if (save-excursion
10599 (c-forward-<>-arglist nil))
10600 (progn (forward-char)
10601 nil)
10602 t))
10603 (t nil)))))
10604 ;; NB: No c-after-special-operator-id stuff in this
10605 ;; clause - we assume only C++ needs it.
10606 (c-syntactic-skip-backward "^;,=" lim t))
10607 (memq (char-before) '(?, ?= ?<)))
10608 (cond
10609
10610 ;; CASE 5D.3: perhaps a template list continuation?
10611 ((and (c-major-mode-is 'c++-mode)
10612 (save-excursion
10613 (save-restriction
10614 (c-with-syntax-table c++-template-syntax-table
10615 (goto-char indent-point)
10616 (setq placeholder (c-up-list-backward))
10617 (and placeholder
10618 (eq (char-after placeholder) ?<))))))
10619 (c-with-syntax-table c++-template-syntax-table
10620 (goto-char placeholder)
10621 (c-beginning-of-statement-1 lim t))
10622 (if (save-excursion
10623 (c-backward-syntactic-ws lim)
10624 (eq (char-before) ?<))
10625 ;; In a nested template arglist.
10626 (progn
10627 (goto-char placeholder)
10628 (c-syntactic-skip-backward "^,;" lim t)
10629 (c-forward-syntactic-ws))
10630 (back-to-indentation))
10631 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
10632 ;; template aware.
10633 (c-add-syntax 'template-args-cont (point) placeholder))
10634
10635 ;; CASE 5D.4: perhaps a multiple inheritance line?
10636 ((and (c-major-mode-is 'c++-mode)
10637 (save-excursion
10638 (c-beginning-of-statement-1 lim)
10639 (setq placeholder (point))
10640 (if (looking-at "static\\>[^_]")
10641 (c-forward-token-2 1 nil indent-point))
10642 (and (looking-at c-class-key)
10643 (zerop (c-forward-token-2 2 nil indent-point))
10644 (if (eq (char-after) ?<)
10645 (c-with-syntax-table c++-template-syntax-table
10646 (zerop (c-forward-token-2 1 t indent-point)))
10647 t)
10648 (eq (char-after) ?:))))
10649 (goto-char placeholder)
10650 (c-add-syntax 'inher-cont (c-point 'boi)))
10651
10652 ;; CASE 5D.5: Continuation of the "expression part" of a
10653 ;; top level construct. Or, perhaps, an unrecognized construct.
10654 (t
10655 (while (and (setq placeholder (point))
10656 (eq (car (c-beginning-of-decl-1 containing-sexp)) ; Can't use `lim' here.
10657 'same)
10658 (save-excursion
10659 (c-backward-syntactic-ws)
10660 (eq (char-before) ?}))
10661 (< (point) placeholder)))
10662 (c-add-stmt-syntax
10663 (cond
10664 ((eq (point) placeholder) 'statement) ; unrecognized construct
10665 ;; A preceding comma at the top level means that a
10666 ;; new variable declaration starts here. Use
10667 ;; topmost-intro-cont for it, for consistency with
10668 ;; the first variable declaration. C.f. case 5N.
10669 ((eq char-before-ip ?,) 'topmost-intro-cont)
10670 (t 'statement-cont))
10671 nil nil containing-sexp paren-state))
10672 ))
10673
10674 ;; CASE 5F: Close of a non-class declaration level block.
10675 ((and (eq char-after-ip ?})
10676 (c-keyword-member containing-decl-kwd
10677 'c-other-block-decl-kwds))
10678 ;; This is inconsistent: Should use `containing-decl-open'
10679 ;; here if it's at boi, like in case 5J.
10680 (goto-char containing-decl-start)
10681 (c-add-stmt-syntax
10682 (if (string-equal (symbol-name containing-decl-kwd) "extern")
10683 ;; Special case for compatibility with the
10684 ;; extern-lang syntactic symbols.
10685 'extern-lang-close
10686 (intern (concat (symbol-name containing-decl-kwd)
10687 "-close")))
10688 nil t
10689 (c-most-enclosing-brace paren-state (point))
10690 paren-state))
10691
10692 ;; CASE 5G: we are looking at the brace which closes the
10693 ;; enclosing nested class decl
10694 ((and containing-sexp
10695 (eq char-after-ip ?})
10696 (eq containing-decl-open containing-sexp))
10697 (c-add-class-syntax 'class-close
10698 containing-decl-open
10699 containing-decl-start
10700 containing-decl-kwd
10701 paren-state))
10702
10703 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10704 ((and c-recognize-knr-p
10705 (not containing-sexp) ; can't be knr inside braces.
10706 (not (eq char-before-ip ?}))
10707 (save-excursion
10708 (setq placeholder (cdr (c-beginning-of-decl-1 lim)))
10709 (and placeholder
10710 ;; Do an extra check to avoid tripping up on
10711 ;; statements that occur in invalid contexts
10712 ;; (e.g. in macro bodies where we don't really
10713 ;; know the context of what we're looking at).
10714 (not (and c-opt-block-stmt-key
10715 (looking-at c-opt-block-stmt-key)))))
10716 (< placeholder indent-point))
10717 (goto-char placeholder)
10718 (c-add-syntax 'knr-argdecl (point)))
10719
10720 ;; CASE 5I: ObjC method definition.
10721 ((and c-opt-method-key
10722 (looking-at c-opt-method-key))
10723 (c-beginning-of-statement-1 nil t)
10724 (if (= (point) indent-point)
10725 ;; Handle the case when it's the first (non-comment)
10726 ;; thing in the buffer. Can't look for a 'same return
10727 ;; value from cbos1 since ObjC directives currently
10728 ;; aren't recognized fully, so that we get 'same
10729 ;; instead of 'previous if it moved over a preceding
10730 ;; directive.
10731 (goto-char (point-min)))
10732 (c-add-syntax 'objc-method-intro (c-point 'boi)))
10733
10734 ;; CASE 5N: At a variable declaration that follows a class
10735 ;; definition or some other block declaration that doesn't
10736 ;; end at the closing '}'. C.f. case 5D.5.
10737 ((progn
10738 (c-backward-syntactic-ws lim)
10739 (and (eq (char-before) ?})
10740 (save-excursion
10741 (let ((start (point)))
10742 (if (and c-state-cache
10743 (consp (car c-state-cache))
10744 (eq (cdar c-state-cache) (point)))
10745 ;; Speed up the backward search a bit.
10746 (goto-char (caar c-state-cache)))
10747 (c-beginning-of-decl-1 containing-sexp) ; Can't use `lim' here.
10748 (setq placeholder (point))
10749 (if (= start (point))
10750 ;; The '}' is unbalanced.
10751 nil
10752 (c-end-of-decl-1)
10753 (>= (point) indent-point))))))
10754 (goto-char placeholder)
10755 (c-add-stmt-syntax 'topmost-intro-cont nil nil
10756 containing-sexp paren-state))
10757
10758 ;; NOTE: The point is at the end of the previous token here.
10759
10760 ;; CASE 5J: we are at the topmost level, make
10761 ;; sure we skip back past any access specifiers
10762 ((and
10763 ;; A macro continuation line is never at top level.
10764 (not (and macro-start
10765 (> indent-point macro-start)))
10766 (save-excursion
10767 (setq placeholder (point))
10768 (or (memq char-before-ip '(?\; ?{ ?} nil))
10769 (c-at-vsemi-p before-ws-ip)
10770 (when (and (eq char-before-ip ?:)
10771 (eq (c-beginning-of-statement-1 lim)
10772 'label))
10773 (c-backward-syntactic-ws lim)
10774 (setq placeholder (point)))
10775 (and (c-major-mode-is 'objc-mode)
10776 (catch 'not-in-directive
10777 (c-beginning-of-statement-1 lim)
10778 (setq placeholder (point))
10779 (while (and (c-forward-objc-directive)
10780 (< (point) indent-point))
10781 (c-forward-syntactic-ws)
10782 (if (>= (point) indent-point)
10783 (throw 'not-in-directive t))
10784 (setq placeholder (point)))
10785 nil)))))
10786 ;; For historic reasons we anchor at bol of the last
10787 ;; line of the previous declaration. That's clearly
10788 ;; highly bogus and useless, and it makes our lives hard
10789 ;; to remain compatible. :P
10790 (goto-char placeholder)
10791 (c-add-syntax 'topmost-intro (c-point 'bol))
10792 (if containing-decl-open
10793 (if (c-keyword-member containing-decl-kwd
10794 'c-other-block-decl-kwds)
10795 (progn
10796 (goto-char (c-brace-anchor-point containing-decl-open))
10797 (c-add-stmt-syntax
10798 (if (string-equal (symbol-name containing-decl-kwd)
10799 "extern")
10800 ;; Special case for compatibility with the
10801 ;; extern-lang syntactic symbols.
10802 'inextern-lang
10803 (intern (concat "in"
10804 (symbol-name containing-decl-kwd))))
10805 nil t
10806 (c-most-enclosing-brace paren-state (point))
10807 paren-state))
10808 (c-add-class-syntax 'inclass
10809 containing-decl-open
10810 containing-decl-start
10811 containing-decl-kwd
10812 paren-state)))
10813 (when (and c-syntactic-indentation-in-macros
10814 macro-start
10815 (/= macro-start (c-point 'boi indent-point)))
10816 (c-add-syntax 'cpp-define-intro)
10817 (setq macro-start nil)))
10818
10819 ;; CASE 5K: we are at an ObjC method definition
10820 ;; continuation line.
10821 ((and c-opt-method-key
10822 (save-excursion
10823 (c-beginning-of-statement-1 lim)
10824 (beginning-of-line)
10825 (when (looking-at c-opt-method-key)
10826 (setq placeholder (point)))))
10827 (c-add-syntax 'objc-method-args-cont placeholder))
10828
10829 ;; CASE 5L: we are at the first argument of a template
10830 ;; arglist that begins on the previous line.
10831 ((and c-recognize-<>-arglists
10832 (eq (char-before) ?<)
10833 (not (and c-overloadable-operators-regexp
10834 (c-after-special-operator-id lim))))
10835 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10836 (c-add-syntax 'template-args-cont (c-point 'boi)))
10837
10838 ;; CASE 5Q: we are at a statement within a macro.
10839 (macro-start
10840 (c-beginning-of-statement-1 containing-sexp)
10841 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state))
10842
10843 ;;CASE 5N: We are at a topmost continuation line and the only
10844 ;;preceding items are annotations.
10845 ((and (c-major-mode-is 'java-mode)
10846 (setq placeholder (point))
10847 (c-beginning-of-statement-1)
10848 (progn
10849 (while (and (c-forward-annotation))
10850 (c-forward-syntactic-ws))
10851 t)
10852 (prog1
10853 (>= (point) placeholder)
10854 (goto-char placeholder)))
10855 (c-add-syntax 'annotation-top-cont (c-point 'boi)))
10856
10857 ;; CASE 5M: we are at a topmost continuation line
10858 (t
10859 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10860 (when (c-major-mode-is 'objc-mode)
10861 (setq placeholder (point))
10862 (while (and (c-forward-objc-directive)
10863 (< (point) indent-point))
10864 (c-forward-syntactic-ws)
10865 (setq placeholder (point)))
10866 (goto-char placeholder))
10867 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10868 ))
10869
10870 ;; (CASE 6 has been removed.)
10871
10872 ;; CASE 7: line is an expression, not a statement. Most
10873 ;; likely we are either in a function prototype or a function
10874 ;; call argument list
10875 ((not (or (and c-special-brace-lists
10876 (save-excursion
10877 (goto-char containing-sexp)
10878 (c-looking-at-special-brace-list)))
10879 (eq (char-after containing-sexp) ?{)))
10880 (cond
10881
10882 ;; CASE 7A: we are looking at the arglist closing paren.
10883 ;; C.f. case 7F.
10884 ((memq char-after-ip '(?\) ?\]))
10885 (goto-char containing-sexp)
10886 (setq placeholder (c-point 'boi))
10887 (if (and (c-safe (backward-up-list 1) t)
10888 (>= (point) placeholder))
10889 (progn
10890 (forward-char)
10891 (skip-chars-forward " \t"))
10892 (goto-char placeholder))
10893 (c-add-stmt-syntax 'arglist-close (list containing-sexp) t
10894 (c-most-enclosing-brace paren-state (point))
10895 paren-state))
10896
10897 ;; CASE 7B: Looking at the opening brace of an
10898 ;; in-expression block or brace list. C.f. cases 4, 16A
10899 ;; and 17E.
10900 ((and (eq char-after-ip ?{)
10901 (progn
10902 (setq placeholder (c-inside-bracelist-p (point)
10903 paren-state))
10904 (if placeholder
10905 (setq tmpsymbol '(brace-list-open . inexpr-class))
10906 (setq tmpsymbol '(block-open . inexpr-statement)
10907 placeholder
10908 (cdr-safe (c-looking-at-inexpr-block
10909 (c-safe-position containing-sexp
10910 paren-state)
10911 containing-sexp)))
10912 ;; placeholder is nil if it's a block directly in
10913 ;; a function arglist. That makes us skip out of
10914 ;; this case.
10915 )))
10916 (goto-char placeholder)
10917 (back-to-indentation)
10918 (c-add-stmt-syntax (car tmpsymbol) nil t
10919 (c-most-enclosing-brace paren-state (point))
10920 paren-state)
10921 (if (/= (point) placeholder)
10922 (c-add-syntax (cdr tmpsymbol))))
10923
10924 ;; CASE 7C: we are looking at the first argument in an empty
10925 ;; argument list. Use arglist-close if we're actually
10926 ;; looking at a close paren or bracket.
10927 ((memq char-before-ip '(?\( ?\[))
10928 (goto-char containing-sexp)
10929 (setq placeholder (c-point 'boi))
10930 (if (and (c-safe (backward-up-list 1) t)
10931 (>= (point) placeholder))
10932 (progn
10933 (forward-char)
10934 (skip-chars-forward " \t"))
10935 (goto-char placeholder))
10936 (c-add-stmt-syntax 'arglist-intro (list containing-sexp) t
10937 (c-most-enclosing-brace paren-state (point))
10938 paren-state))
10939
10940 ;; CASE 7D: we are inside a conditional test clause. treat
10941 ;; these things as statements
10942 ((progn
10943 (goto-char containing-sexp)
10944 (and (c-safe (c-forward-sexp -1) t)
10945 (looking-at "\\<for\\>[^_]")))
10946 (goto-char (1+ containing-sexp))
10947 (c-forward-syntactic-ws indent-point)
10948 (if (eq char-before-ip ?\;)
10949 (c-add-syntax 'statement (point))
10950 (c-add-syntax 'statement-cont (point))
10951 ))
10952
10953 ;; CASE 7E: maybe a continued ObjC method call. This is the
10954 ;; case when we are inside a [] bracketed exp, and what
10955 ;; precede the opening bracket is not an identifier.
10956 ((and c-opt-method-key
10957 (eq (char-after containing-sexp) ?\[)
10958 (progn
10959 (goto-char (1- containing-sexp))
10960 (c-backward-syntactic-ws (c-point 'bod))
10961 (if (not (looking-at c-symbol-key))
10962 (c-add-syntax 'objc-method-call-cont containing-sexp))
10963 )))
10964
10965 ;; CASE 7F: we are looking at an arglist continuation line,
10966 ;; but the preceding argument is on the same line as the
10967 ;; opening paren. This case includes multi-line
10968 ;; mathematical paren groupings, but we could be on a
10969 ;; for-list continuation line. C.f. case 7A.
10970 ((progn
10971 (goto-char (1+ containing-sexp))
10972 (< (save-excursion
10973 (c-forward-syntactic-ws)
10974 (point))
10975 (c-point 'bonl)))
10976 (goto-char containing-sexp) ; paren opening the arglist
10977 (setq placeholder (c-point 'boi))
10978 (if (and (c-safe (backward-up-list 1) t)
10979 (>= (point) placeholder))
10980 (progn
10981 (forward-char)
10982 (skip-chars-forward " \t"))
10983 (goto-char placeholder))
10984 (c-add-stmt-syntax 'arglist-cont-nonempty (list containing-sexp) t
10985 (c-most-enclosing-brace c-state-cache (point))
10986 paren-state))
10987
10988 ;; CASE 7G: we are looking at just a normal arglist
10989 ;; continuation line
10990 (t (c-forward-syntactic-ws indent-point)
10991 (c-add-syntax 'arglist-cont (c-point 'boi)))
10992 ))
10993
10994 ;; CASE 8: func-local multi-inheritance line
10995 ((and (c-major-mode-is 'c++-mode)
10996 (save-excursion
10997 (goto-char indent-point)
10998 (skip-chars-forward " \t")
10999 (looking-at c-opt-postfix-decl-spec-key)))
11000 (goto-char indent-point)
11001 (skip-chars-forward " \t")
11002 (cond
11003
11004 ;; CASE 8A: non-hanging colon on an inher intro
11005 ((eq char-after-ip ?:)
11006 (c-backward-syntactic-ws lim)
11007 (c-add-syntax 'inher-intro (c-point 'boi)))
11008
11009 ;; CASE 8B: hanging colon on an inher intro
11010 ((eq char-before-ip ?:)
11011 (c-add-syntax 'inher-intro (c-point 'boi)))
11012
11013 ;; CASE 8C: a continued inheritance line
11014 (t
11015 (c-beginning-of-inheritance-list lim)
11016 (c-add-syntax 'inher-cont (point))
11017 )))
11018
11019 ;; CASE 9: we are inside a brace-list
11020 ((and (not (c-major-mode-is 'awk-mode)) ; Maybe this isn't needed (ACM, 2002/3/29)
11021 (setq special-brace-list
11022 (or (and c-special-brace-lists ;;;; ALWAYS NIL FOR AWK!!
11023 (save-excursion
11024 (goto-char containing-sexp)
11025 (c-looking-at-special-brace-list)))
11026 (c-inside-bracelist-p containing-sexp paren-state))))
11027 (cond
11028
11029 ;; CASE 9A: In the middle of a special brace list opener.
11030 ((and (consp special-brace-list)
11031 (save-excursion
11032 (goto-char containing-sexp)
11033 (eq (char-after) ?\())
11034 (eq char-after-ip (car (cdr special-brace-list))))
11035 (goto-char (car (car special-brace-list)))
11036 (skip-chars-backward " \t")
11037 (if (and (bolp)
11038 (assoc 'statement-cont
11039 (setq placeholder (c-guess-basic-syntax))))
11040 (setq c-syntactic-context placeholder)
11041 (c-beginning-of-statement-1
11042 (c-safe-position (1- containing-sexp) paren-state))
11043 (c-forward-token-2 0)
11044 (while (cond
11045 ((looking-at c-specifier-key)
11046 (c-forward-keyword-clause 1))
11047 ((and c-opt-cpp-prefix
11048 (looking-at c-noise-macro-with-parens-name-re))
11049 (c-forward-noise-clause))))
11050 (c-add-syntax 'brace-list-open (c-point 'boi))))
11051
11052 ;; CASE 9B: brace-list-close brace
11053 ((if (consp special-brace-list)
11054 ;; Check special brace list closer.
11055 (progn
11056 (goto-char (car (car special-brace-list)))
11057 (save-excursion
11058 (goto-char indent-point)
11059 (back-to-indentation)
11060 (or
11061 ;; We were between the special close char and the `)'.
11062 (and (eq (char-after) ?\))
11063 (eq (1+ (point)) (cdr (car special-brace-list))))
11064 ;; We were before the special close char.
11065 (and (eq (char-after) (cdr (cdr special-brace-list)))
11066 (zerop (c-forward-token-2))
11067 (eq (1+ (point)) (cdr (car special-brace-list)))))))
11068 ;; Normal brace list check.
11069 (and (eq char-after-ip ?})
11070 (c-safe (goto-char (c-up-list-backward (point))) t)
11071 (= (point) containing-sexp)))
11072 (if (eq (point) (c-point 'boi))
11073 (c-add-syntax 'brace-list-close (point))
11074 (setq lim (c-most-enclosing-brace c-state-cache (point)))
11075 (c-beginning-of-statement-1 lim nil nil t)
11076 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state)))
11077
11078 (t
11079 ;; Prepare for the rest of the cases below by going to the
11080 ;; token following the opening brace
11081 (if (consp special-brace-list)
11082 (progn
11083 (goto-char (car (car special-brace-list)))
11084 (c-forward-token-2 1 nil indent-point))
11085 (goto-char containing-sexp))
11086 (forward-char)
11087 (let ((start (point)))
11088 (c-forward-syntactic-ws indent-point)
11089 (goto-char (max start (c-point 'bol))))
11090 (c-skip-ws-forward indent-point)
11091 (cond
11092
11093 ;; CASE 9C: we're looking at the first line in a brace-list
11094 ((= (point) indent-point)
11095 (if (consp special-brace-list)
11096 (goto-char (car (car special-brace-list)))
11097 (goto-char containing-sexp))
11098 (if (eq (point) (c-point 'boi))
11099 (c-add-syntax 'brace-list-intro (point))
11100 (setq lim (c-most-enclosing-brace c-state-cache (point)))
11101 (c-beginning-of-statement-1 lim)
11102 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state)))
11103
11104 ;; CASE 9D: this is just a later brace-list-entry or
11105 ;; brace-entry-open
11106 (t (if (or (eq char-after-ip ?{)
11107 (and c-special-brace-lists
11108 (save-excursion
11109 (goto-char indent-point)
11110 (c-forward-syntactic-ws (c-point 'eol))
11111 (c-looking-at-special-brace-list (point)))))
11112 (c-add-syntax 'brace-entry-open (point))
11113 (c-add-syntax 'brace-list-entry (point))
11114 ))
11115 ))))
11116
11117 ;; CASE 10: A continued statement or top level construct.
11118 ((and (not (memq char-before-ip '(?\; ?:)))
11119 (not (c-at-vsemi-p before-ws-ip))
11120 (or (not (eq char-before-ip ?}))
11121 (c-looking-at-inexpr-block-backward c-state-cache))
11122 (> (point)
11123 (save-excursion
11124 (c-beginning-of-statement-1 containing-sexp)
11125 (setq placeholder (point))))
11126 (/= placeholder containing-sexp))
11127 ;; This is shared with case 18.
11128 (c-guess-continued-construct indent-point
11129 char-after-ip
11130 placeholder
11131 containing-sexp
11132 paren-state))
11133
11134 ;; CASE 16: block close brace, possibly closing the defun or
11135 ;; the class
11136 ((eq char-after-ip ?})
11137 ;; From here on we have the next containing sexp in lim.
11138 (setq lim (c-most-enclosing-brace paren-state))
11139 (goto-char containing-sexp)
11140 (cond
11141
11142 ;; CASE 16E: Closing a statement block? This catches
11143 ;; cases where it's preceded by a statement keyword,
11144 ;; which works even when used in an "invalid" context,
11145 ;; e.g. a macro argument.
11146 ((c-after-conditional)
11147 (c-backward-to-block-anchor lim)
11148 (c-add-stmt-syntax 'block-close nil t lim paren-state))
11149
11150 ;; CASE 16A: closing a lambda defun or an in-expression
11151 ;; block? C.f. cases 4, 7B and 17E.
11152 ((setq placeholder (c-looking-at-inexpr-block
11153 (c-safe-position containing-sexp paren-state)
11154 nil))
11155 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
11156 'inline-close
11157 'block-close))
11158 (goto-char containing-sexp)
11159 (back-to-indentation)
11160 (if (= containing-sexp (point))
11161 (c-add-syntax tmpsymbol (point))
11162 (goto-char (cdr placeholder))
11163 (back-to-indentation)
11164 (c-add-stmt-syntax tmpsymbol nil t
11165 (c-most-enclosing-brace paren-state (point))
11166 paren-state)
11167 (if (/= (point) (cdr placeholder))
11168 (c-add-syntax (car placeholder)))))
11169
11170 ;; CASE 16B: does this close an inline or a function in
11171 ;; a non-class declaration level block?
11172 ((save-excursion
11173 (and lim
11174 (progn
11175 (goto-char lim)
11176 (c-looking-at-decl-block
11177 (c-most-enclosing-brace paren-state lim)
11178 nil))
11179 (setq placeholder (point))))
11180 (c-backward-to-decl-anchor lim)
11181 (back-to-indentation)
11182 (if (save-excursion
11183 (goto-char placeholder)
11184 (looking-at c-other-decl-block-key))
11185 (c-add-syntax 'defun-close (point))
11186 (c-add-syntax 'inline-close (point))))
11187
11188 ;; CASE 16F: Can be a defun-close of a function declared
11189 ;; in a statement block, e.g. in Pike or when using gcc
11190 ;; extensions, but watch out for macros followed by
11191 ;; blocks. Let it through to be handled below.
11192 ;; C.f. cases B.3 and 17G.
11193 ((save-excursion
11194 (and (not (c-at-statement-start-p))
11195 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
11196 (setq placeholder (point))
11197 (let ((c-recognize-typeless-decls nil))
11198 ;; Turn off recognition of constructs that
11199 ;; lacks a type in this case, since that's more
11200 ;; likely to be a macro followed by a block.
11201 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
11202 (back-to-indentation)
11203 (if (/= (point) containing-sexp)
11204 (goto-char placeholder))
11205 (c-add-stmt-syntax 'defun-close nil t lim paren-state))
11206
11207 ;; CASE 16C: If there is an enclosing brace then this is
11208 ;; a block close since defun closes inside declaration
11209 ;; level blocks have been handled above.
11210 (lim
11211 ;; If the block is preceded by a case/switch label on
11212 ;; the same line, we anchor at the first preceding label
11213 ;; at boi. The default handling in c-add-stmt-syntax
11214 ;; really fixes it better, but we do like this to keep
11215 ;; the indentation compatible with version 5.28 and
11216 ;; earlier. C.f. case 17H.
11217 (while (and (/= (setq placeholder (point)) (c-point 'boi))
11218 (eq (c-beginning-of-statement-1 lim) 'label)))
11219 (goto-char placeholder)
11220 (if (looking-at c-label-kwds-regexp)
11221 (c-add-syntax 'block-close (point))
11222 (goto-char containing-sexp)
11223 ;; c-backward-to-block-anchor not necessary here; those
11224 ;; situations are handled in case 16E above.
11225 (c-add-stmt-syntax 'block-close nil t lim paren-state)))
11226
11227 ;; CASE 16D: Only top level defun close left.
11228 (t
11229 (goto-char containing-sexp)
11230 (c-backward-to-decl-anchor lim)
11231 (c-add-stmt-syntax 'defun-close nil nil
11232 (c-most-enclosing-brace paren-state)
11233 paren-state))
11234 ))
11235
11236 ;; CASE 19: line is an expression, not a statement, and is directly
11237 ;; contained by a template delimiter. Most likely, we are in a
11238 ;; template arglist within a statement. This case is based on CASE
11239 ;; 7. At some point in the future, we may wish to create more
11240 ;; syntactic symbols such as `template-intro',
11241 ;; `template-cont-nonempty', etc., and distinguish between them as we
11242 ;; do for `arglist-intro' etc. (2009-12-07).
11243 ((and c-recognize-<>-arglists
11244 (setq containing-< (c-up-list-backward indent-point containing-sexp))
11245 (eq (char-after containing-<) ?\<))
11246 (setq placeholder (c-point 'boi containing-<))
11247 (goto-char containing-sexp) ; Most nested Lbrace/Lparen (but not
11248 ; '<') before indent-point.
11249 (if (>= (point) placeholder)
11250 (progn
11251 (forward-char)
11252 (skip-chars-forward " \t"))
11253 (goto-char placeholder))
11254 (c-add-stmt-syntax 'template-args-cont (list containing-<) t
11255 (c-most-enclosing-brace c-state-cache (point))
11256 paren-state))
11257
11258 ;; CASE 17: Statement or defun catchall.
11259 (t
11260 (goto-char indent-point)
11261 ;; Back up statements until we find one that starts at boi.
11262 (while (let* ((prev-point (point))
11263 (last-step-type (c-beginning-of-statement-1
11264 containing-sexp)))
11265 (if (= (point) prev-point)
11266 (progn
11267 (setq step-type (or step-type last-step-type))
11268 nil)
11269 (setq step-type last-step-type)
11270 (/= (point) (c-point 'boi)))))
11271 (cond
11272
11273 ;; CASE 17B: continued statement
11274 ((and (eq step-type 'same)
11275 (/= (point) indent-point))
11276 (c-add-stmt-syntax 'statement-cont nil nil
11277 containing-sexp paren-state))
11278
11279 ;; CASE 17A: After a case/default label?
11280 ((progn
11281 (while (and (eq step-type 'label)
11282 (not (looking-at c-label-kwds-regexp)))
11283 (setq step-type
11284 (c-beginning-of-statement-1 containing-sexp)))
11285 (eq step-type 'label))
11286 (c-add-stmt-syntax (if (eq char-after-ip ?{)
11287 'statement-case-open
11288 'statement-case-intro)
11289 nil t containing-sexp paren-state))
11290
11291 ;; CASE 17D: any old statement
11292 ((progn
11293 (while (eq step-type 'label)
11294 (setq step-type
11295 (c-beginning-of-statement-1 containing-sexp)))
11296 (eq step-type 'previous))
11297 (c-add-stmt-syntax 'statement nil t
11298 containing-sexp paren-state)
11299 (if (eq char-after-ip ?{)
11300 (c-add-syntax 'block-open)))
11301
11302 ;; CASE 17I: Inside a substatement block.
11303 ((progn
11304 ;; The following tests are all based on containing-sexp.
11305 (goto-char containing-sexp)
11306 ;; From here on we have the next containing sexp in lim.
11307 (setq lim (c-most-enclosing-brace paren-state containing-sexp))
11308 (c-after-conditional))
11309 (c-backward-to-block-anchor lim)
11310 (c-add-stmt-syntax 'statement-block-intro nil t
11311 lim paren-state)
11312 (if (eq char-after-ip ?{)
11313 (c-add-syntax 'block-open)))
11314
11315 ;; CASE 17E: first statement in an in-expression block.
11316 ;; C.f. cases 4, 7B and 16A.
11317 ((setq placeholder (c-looking-at-inexpr-block
11318 (c-safe-position containing-sexp paren-state)
11319 nil))
11320 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
11321 'defun-block-intro
11322 'statement-block-intro))
11323 (back-to-indentation)
11324 (if (= containing-sexp (point))
11325 (c-add-syntax tmpsymbol (point))
11326 (goto-char (cdr placeholder))
11327 (back-to-indentation)
11328 (c-add-stmt-syntax tmpsymbol nil t
11329 (c-most-enclosing-brace c-state-cache (point))
11330 paren-state)
11331 (if (/= (point) (cdr placeholder))
11332 (c-add-syntax (car placeholder))))
11333 (if (eq char-after-ip ?{)
11334 (c-add-syntax 'block-open)))
11335
11336 ;; CASE 17F: first statement in an inline, or first
11337 ;; statement in a top-level defun. we can tell this is it
11338 ;; if there are no enclosing braces that haven't been
11339 ;; narrowed out by a class (i.e. don't use bod here).
11340 ((save-excursion
11341 (or (not (setq placeholder (c-most-enclosing-brace
11342 paren-state)))
11343 (and (progn
11344 (goto-char placeholder)
11345 (eq (char-after) ?{))
11346 (c-looking-at-decl-block (c-most-enclosing-brace
11347 paren-state (point))
11348 nil))))
11349 (c-backward-to-decl-anchor lim)
11350 (back-to-indentation)
11351 (c-add-syntax 'defun-block-intro (point)))
11352
11353 ;; CASE 17G: First statement in a function declared inside
11354 ;; a normal block. This can occur in Pike and with
11355 ;; e.g. the gcc extensions, but watch out for macros
11356 ;; followed by blocks. C.f. cases B.3 and 16F.
11357 ((save-excursion
11358 (and (not (c-at-statement-start-p))
11359 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
11360 (setq placeholder (point))
11361 (let ((c-recognize-typeless-decls nil))
11362 ;; Turn off recognition of constructs that lacks
11363 ;; a type in this case, since that's more likely
11364 ;; to be a macro followed by a block.
11365 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
11366 (back-to-indentation)
11367 (if (/= (point) containing-sexp)
11368 (goto-char placeholder))
11369 (c-add-stmt-syntax 'defun-block-intro nil t
11370 lim paren-state))
11371
11372 ;; CASE 17H: First statement in a block.
11373 (t
11374 ;; If the block is preceded by a case/switch label on the
11375 ;; same line, we anchor at the first preceding label at
11376 ;; boi. The default handling in c-add-stmt-syntax is
11377 ;; really fixes it better, but we do like this to keep the
11378 ;; indentation compatible with version 5.28 and earlier.
11379 ;; C.f. case 16C.
11380 (while (and (/= (setq placeholder (point)) (c-point 'boi))
11381 (eq (c-beginning-of-statement-1 lim) 'label)))
11382 (goto-char placeholder)
11383 (if (looking-at c-label-kwds-regexp)
11384 (c-add-syntax 'statement-block-intro (point))
11385 (goto-char containing-sexp)
11386 ;; c-backward-to-block-anchor not necessary here; those
11387 ;; situations are handled in case 17I above.
11388 (c-add-stmt-syntax 'statement-block-intro nil t
11389 lim paren-state))
11390 (if (eq char-after-ip ?{)
11391 (c-add-syntax 'block-open)))
11392 ))
11393 )
11394
11395 ;; now we need to look at any modifiers
11396 (goto-char indent-point)
11397 (skip-chars-forward " \t")
11398
11399 ;; are we looking at a comment only line?
11400 (when (and (looking-at c-comment-start-regexp)
11401 (/= (c-forward-token-2 0 nil (c-point 'eol)) 0))
11402 (c-append-syntax 'comment-intro))
11403
11404 ;; we might want to give additional offset to friends (in C++).
11405 (when (and c-opt-friend-key
11406 (looking-at c-opt-friend-key))
11407 (c-append-syntax 'friend))
11408
11409 ;; Set syntactic-relpos.
11410 (let ((p c-syntactic-context))
11411 (while (and p
11412 (if (integerp (c-langelem-pos (car p)))
11413 (progn
11414 (setq syntactic-relpos (c-langelem-pos (car p)))
11415 nil)
11416 t))
11417 (setq p (cdr p))))
11418
11419 ;; Start of or a continuation of a preprocessor directive?
11420 (if (and macro-start
11421 (eq macro-start (c-point 'boi))
11422 (not (and (c-major-mode-is 'pike-mode)
11423 (eq (char-after (1+ macro-start)) ?\"))))
11424 (c-append-syntax 'cpp-macro)
11425 (when (and c-syntactic-indentation-in-macros macro-start)
11426 (if in-macro-expr
11427 (when (or
11428 (< syntactic-relpos macro-start)
11429 (not (or
11430 (assq 'arglist-intro c-syntactic-context)
11431 (assq 'arglist-cont c-syntactic-context)
11432 (assq 'arglist-cont-nonempty c-syntactic-context)
11433 (assq 'arglist-close c-syntactic-context))))
11434 ;; If inside a cpp expression, i.e. anywhere in a
11435 ;; cpp directive except a #define body, we only let
11436 ;; through the syntactic analysis that is internal
11437 ;; in the expression. That means the arglist
11438 ;; elements, if they are anchored inside the cpp
11439 ;; expression.
11440 (setq c-syntactic-context nil)
11441 (c-add-syntax 'cpp-macro-cont macro-start))
11442 (when (and (eq macro-start syntactic-relpos)
11443 (not (assq 'cpp-define-intro c-syntactic-context))
11444 (save-excursion
11445 (goto-char macro-start)
11446 (or (not (c-forward-to-cpp-define-body))
11447 (<= (point) (c-point 'boi indent-point)))))
11448 ;; Inside a #define body and the syntactic analysis is
11449 ;; anchored on the start of the #define. In this case
11450 ;; we add cpp-define-intro to get the extra
11451 ;; indentation of the #define body.
11452 (c-add-syntax 'cpp-define-intro)))))
11453
11454 ;; return the syntax
11455 c-syntactic-context)))
11456
11457 \f
11458 ;; Indentation calculation.
11459
11460 (defun c-evaluate-offset (offset langelem symbol)
11461 ;; offset can be a number, a function, a variable, a list, or one of
11462 ;; the symbols + or -
11463 ;;
11464 ;; This function might do hidden buffer changes.
11465 (let ((res
11466 (cond
11467 ((numberp offset) offset)
11468 ((vectorp offset) offset)
11469 ((null offset) nil)
11470
11471 ((eq offset '+) c-basic-offset)
11472 ((eq offset '-) (- c-basic-offset))
11473 ((eq offset '++) (* 2 c-basic-offset))
11474 ((eq offset '--) (* 2 (- c-basic-offset)))
11475 ((eq offset '*) (/ c-basic-offset 2))
11476 ((eq offset '/) (/ (- c-basic-offset) 2))
11477
11478 ((functionp offset)
11479 (c-evaluate-offset
11480 (funcall offset
11481 (cons (c-langelem-sym langelem)
11482 (c-langelem-pos langelem)))
11483 langelem symbol))
11484
11485 ((listp offset)
11486 (cond
11487 ((eq (car offset) 'quote)
11488 (c-benign-error "The offset %S for %s was mistakenly quoted"
11489 offset symbol)
11490 nil)
11491
11492 ((memq (car offset) '(min max))
11493 (let (res val (method (car offset)))
11494 (setq offset (cdr offset))
11495 (while offset
11496 (setq val (c-evaluate-offset (car offset) langelem symbol))
11497 (cond
11498 ((not val))
11499 ((not res)
11500 (setq res val))
11501 ((integerp val)
11502 (if (vectorp res)
11503 (c-benign-error "\
11504 Error evaluating offset %S for %s: \
11505 Cannot combine absolute offset %S with relative %S in `%s' method"
11506 (car offset) symbol res val method)
11507 (setq res (funcall method res val))))
11508 (t
11509 (if (integerp res)
11510 (c-benign-error "\
11511 Error evaluating offset %S for %s: \
11512 Cannot combine relative offset %S with absolute %S in `%s' method"
11513 (car offset) symbol res val method)
11514 (setq res (vector (funcall method (aref res 0)
11515 (aref val 0)))))))
11516 (setq offset (cdr offset)))
11517 res))
11518
11519 ((eq (car offset) 'add)
11520 (let (res val)
11521 (setq offset (cdr offset))
11522 (while offset
11523 (setq val (c-evaluate-offset (car offset) langelem symbol))
11524 (cond
11525 ((not val))
11526 ((not res)
11527 (setq res val))
11528 ((integerp val)
11529 (if (vectorp res)
11530 (setq res (vector (+ (aref res 0) val)))
11531 (setq res (+ res val))))
11532 (t
11533 (if (vectorp res)
11534 (c-benign-error "\
11535 Error evaluating offset %S for %s: \
11536 Cannot combine absolute offsets %S and %S in `add' method"
11537 (car offset) symbol res val)
11538 (setq res val)))) ; Override.
11539 (setq offset (cdr offset)))
11540 res))
11541
11542 (t
11543 (let (res)
11544 (when (eq (car offset) 'first)
11545 (setq offset (cdr offset)))
11546 (while (and (not res) offset)
11547 (setq res (c-evaluate-offset (car offset) langelem symbol)
11548 offset (cdr offset)))
11549 res))))
11550
11551 ((and (symbolp offset) (boundp offset))
11552 (symbol-value offset))
11553
11554 (t
11555 (c-benign-error "Unknown offset format %S for %s" offset symbol)
11556 nil))))
11557
11558 (if (or (null res) (integerp res)
11559 (and (vectorp res) (= (length res) 1) (integerp (aref res 0))))
11560 res
11561 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
11562 offset symbol res)
11563 nil)))
11564
11565 (defun c-calc-offset (langelem)
11566 ;; Get offset from LANGELEM which is a list beginning with the
11567 ;; syntactic symbol and followed by any analysis data it provides.
11568 ;; That data may be zero or more elements, but if at least one is
11569 ;; given then the first is the anchor position (or nil). The symbol
11570 ;; is matched against `c-offsets-alist' and the offset calculated
11571 ;; from that is returned.
11572 ;;
11573 ;; This function might do hidden buffer changes.
11574 (let* ((symbol (c-langelem-sym langelem))
11575 (match (assq symbol c-offsets-alist))
11576 (offset (cdr-safe match)))
11577 (if match
11578 (setq offset (c-evaluate-offset offset langelem symbol))
11579 (if c-strict-syntax-p
11580 (c-benign-error "No offset found for syntactic symbol %s" symbol))
11581 (setq offset 0))
11582 (if (vectorp offset)
11583 offset
11584 (or (and (numberp offset) offset)
11585 (and (symbolp offset) (symbol-value offset))
11586 0))
11587 ))
11588
11589 (defun c-get-offset (langelem)
11590 ;; This is a compatibility wrapper for `c-calc-offset' in case
11591 ;; someone is calling it directly. It takes an old style syntactic
11592 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
11593 ;; new list form.
11594 ;;
11595 ;; This function might do hidden buffer changes.
11596 (if (c-langelem-pos langelem)
11597 (c-calc-offset (list (c-langelem-sym langelem)
11598 (c-langelem-pos langelem)))
11599 (c-calc-offset langelem)))
11600
11601 (defun c-get-syntactic-indentation (langelems)
11602 ;; Calculate the syntactic indentation from a syntactic description
11603 ;; as returned by `c-guess-syntax'.
11604 ;;
11605 ;; Note that topmost-intro always has an anchor position at bol, for
11606 ;; historical reasons. It's often used together with other symbols
11607 ;; that has more sane positions. Since we always use the first
11608 ;; found anchor position, we rely on that these other symbols always
11609 ;; precede topmost-intro in the LANGELEMS list.
11610 ;;
11611 ;; This function might do hidden buffer changes.
11612 (let ((indent 0) anchor)
11613
11614 (while langelems
11615 (let* ((c-syntactic-element (car langelems))
11616 (res (c-calc-offset c-syntactic-element)))
11617
11618 (if (vectorp res)
11619 ;; Got an absolute column that overrides any indentation
11620 ;; we've collected so far, but not the relative
11621 ;; indentation we might get for the nested structures
11622 ;; further down the langelems list.
11623 (setq indent (elt res 0)
11624 anchor (point-min)) ; A position at column 0.
11625
11626 ;; Got a relative change of the current calculated
11627 ;; indentation.
11628 (setq indent (+ indent res))
11629
11630 ;; Use the anchor position from the first syntactic
11631 ;; element with one.
11632 (unless anchor
11633 (setq anchor (c-langelem-pos (car langelems)))))
11634
11635 (setq langelems (cdr langelems))))
11636
11637 (if anchor
11638 (+ indent (save-excursion
11639 (goto-char anchor)
11640 (current-column)))
11641 indent)))
11642
11643 \f
11644 (cc-provide 'cc-engine)
11645
11646 ;; Local Variables:
11647 ;; indent-tabs-mode: t
11648 ;; tab-width: 8
11649 ;; End:
11650 ;;; cc-engine.el ends here