]> code.delx.au - gnu-emacs/blob - lisp/progmodes/cc-engine.el
Merge from emacs-24; up to 117698
[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-2014 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 ,@(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 (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 "No matching `%s' found for `%s' on line %d"
622 (elt saved-pos 1)
623 (elt saved-pos 2)
624 (1+ (count-lines (point-min)
625 (c-point 'bol (elt saved-pos 0))))))))
626
627 (defun c-beginning-of-statement-1 (&optional lim ignore-labels
628 noerror comma-delim)
629 "Move to the start of the current statement or declaration, or to
630 the previous one if already at the beginning of one. Only
631 statements/declarations on the same level are considered, i.e. don't
632 move into or out of sexps (not even normal expression parentheses).
633
634 If point is already at the earliest statement within braces or parens,
635 this function doesn't move back into any whitespace preceding it; it
636 returns 'same in this case.
637
638 Stop at statement continuation tokens like \"else\", \"catch\",
639 \"finally\" and the \"while\" in \"do ... while\" if the start point
640 is within the continuation. If starting at such a token, move to the
641 corresponding statement start. If at the beginning of a statement,
642 move to the closest containing statement if there is any. This might
643 also stop at a continuation clause.
644
645 Labels are treated as part of the following statements if
646 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
647 statement start keyword.) Otherwise, each label is treated as a
648 separate statement.
649
650 Macros are ignored \(i.e. skipped over) unless point is within one, in
651 which case the content of the macro is treated as normal code. Aside
652 from any normal statement starts found in it, stop at the first token
653 of the content in the macro, i.e. the expression of an \"#if\" or the
654 start of the definition in a \"#define\". Also stop at start of
655 macros before leaving them.
656
657 Return:
658 'label if stopped at a label or \"case...:\" or \"default:\";
659 'same if stopped at the beginning of the current statement;
660 'up if stepped to a containing statement;
661 'previous if stepped to a preceding statement;
662 'beginning if stepped from a statement continuation clause to
663 its start clause; or
664 'macro if stepped to a macro start.
665 Note that 'same and not 'label is returned if stopped at the same
666 label without crossing the colon character.
667
668 LIM may be given to limit the search. If the search hits the limit,
669 point will be left at the closest following token, or at the start
670 position if that is less ('same is returned in this case).
671
672 NOERROR turns off error logging to `c-parsing-error'.
673
674 Normally only ';' and virtual semicolons are considered to delimit
675 statements, but if COMMA-DELIM is non-nil then ',' is treated
676 as a delimiter too.
677
678 Note that this function might do hidden buffer changes. See the
679 comment at the start of cc-engine.el for more info."
680
681 ;; The bulk of this function is a pushdown automaton that looks at statement
682 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
683 ;; purpose is to keep track of nested statements, ensuring that such
684 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
685 ;; does with nested braces/brackets/parentheses).
686 ;;
687 ;; Note: The position of a boundary is the following token.
688 ;;
689 ;; Beginning with the current token (the one following point), move back one
690 ;; sexp at a time (where a sexp is, more or less, either a token or the
691 ;; entire contents of a brace/bracket/paren pair). Each time a statement
692 ;; boundary is crossed or a "while"-like token is found, update the state of
693 ;; the PDA. Stop at the beginning of a statement when the stack (holding
694 ;; nested statement info) is empty and the position has been moved.
695 ;;
696 ;; The following variables constitute the PDA:
697 ;;
698 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
699 ;; scanned back over, 'boundary if we've just gone back over a
700 ;; statement boundary, or nil otherwise.
701 ;; state: takes one of the values (nil else else-boundary while
702 ;; while-boundary catch catch-boundary).
703 ;; nil means "no "while"-like token yet scanned".
704 ;; 'else, for example, means "just gone back over an else".
705 ;; 'else-boundary means "just gone back over a statement boundary
706 ;; immediately after having gone back over an else".
707 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
708 ;; of error reporting information.
709 ;; stack: The stack onto which the PDA pushes its state. Each entry
710 ;; consists of a saved value of state and saved-pos. An entry is
711 ;; pushed when we move back over a "continuation" token (e.g. else)
712 ;; and popped when we encounter the corresponding opening token
713 ;; (e.g. if).
714 ;;
715 ;;
716 ;; The following diagram briefly outlines the PDA.
717 ;;
718 ;; Common state:
719 ;; "else": Push state, goto state `else'.
720 ;; "while": Push state, goto state `while'.
721 ;; "catch" or "finally": Push state, goto state `catch'.
722 ;; boundary: Pop state.
723 ;; other: Do nothing special.
724 ;;
725 ;; State `else':
726 ;; boundary: Goto state `else-boundary'.
727 ;; other: Error, pop state, retry token.
728 ;;
729 ;; State `else-boundary':
730 ;; "if": Pop state.
731 ;; boundary: Error, pop state.
732 ;; other: See common state.
733 ;;
734 ;; State `while':
735 ;; boundary: Save position, goto state `while-boundary'.
736 ;; other: Pop state, retry token.
737 ;;
738 ;; State `while-boundary':
739 ;; "do": Pop state.
740 ;; boundary: Restore position if it's not at start, pop state. [*see below]
741 ;; other: See common state.
742 ;;
743 ;; State `catch':
744 ;; boundary: Goto state `catch-boundary'.
745 ;; other: Error, pop state, retry token.
746 ;;
747 ;; State `catch-boundary':
748 ;; "try": Pop state.
749 ;; "catch": Goto state `catch'.
750 ;; boundary: Error, pop state.
751 ;; other: See common state.
752 ;;
753 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
754 ;; searching for a "do" which would have opened a do-while. If we didn't
755 ;; find it, we discard the analysis done since the "while", go back to this
756 ;; token in the buffer and restart the scanning there, this time WITHOUT
757 ;; pushing the 'while state onto the stack.
758 ;;
759 ;; In addition to the above there is some special handling of labels
760 ;; and macros.
761
762 (let ((case-fold-search nil)
763 (start (point))
764 macro-start
765 (delims (if comma-delim '(?\; ?,) '(?\;)))
766 (c-stmt-delim-chars (if comma-delim
767 c-stmt-delim-chars-with-comma
768 c-stmt-delim-chars))
769 c-in-literal-cache c-maybe-labelp after-case:-pos saved
770 ;; Current position.
771 pos
772 ;; Position of last stmt boundary character (e.g. ;).
773 boundary-pos
774 ;; The position of the last sexp or bound that follows the
775 ;; first found colon, i.e. the start of the nonlabel part of
776 ;; the statement. It's `start' if a colon is found just after
777 ;; the start.
778 after-labels-pos
779 ;; Like `after-labels-pos', but the first such position inside
780 ;; a label, i.e. the start of the last label before the start
781 ;; of the nonlabel part of the statement.
782 last-label-pos
783 ;; The last position where a label is possible provided the
784 ;; statement started there. It's nil as long as no invalid
785 ;; label content has been found (according to
786 ;; `c-nonlabel-token-key'). It's `start' if no valid label
787 ;; content was found in the label. Note that we might still
788 ;; regard it a label if it starts with `c-label-kwds'.
789 label-good-pos
790 ;; Putative positions of the components of a bitfield declaration,
791 ;; e.g. "int foo : NUM_FOO_BITS ;"
792 bitfield-type-pos bitfield-id-pos bitfield-size-pos
793 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
794 ;; See above.
795 sym
796 ;; Current state in the automaton. See above.
797 state
798 ;; Current saved positions. See above.
799 saved-pos
800 ;; Stack of conses (state . saved-pos).
801 stack
802 ;; Regexp which matches "for", "if", etc.
803 (cond-key (or c-opt-block-stmt-key
804 "\\<\\>")) ; Matches nothing.
805 ;; Return value.
806 (ret 'same)
807 ;; Positions of the last three sexps or bounds we've stopped at.
808 tok ptok pptok)
809
810 (save-restriction
811 (if lim (narrow-to-region lim (point-max)))
812
813 (if (save-excursion
814 (and (c-beginning-of-macro)
815 (/= (point) start)))
816 (setq macro-start (point)))
817
818 ;; Try to skip back over unary operator characters, to register
819 ;; that we've moved.
820 (while (progn
821 (setq pos (point))
822 (c-backward-syntactic-ws)
823 ;; Protect post-++/-- operators just before a virtual semicolon.
824 (and (not (c-at-vsemi-p))
825 (/= (skip-chars-backward "-+!*&~@`#") 0))))
826
827 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
828 ;; done. Later on we ignore the boundaries for statements that don't
829 ;; contain any sexp. The only thing that is affected is that the error
830 ;; checking is a little less strict, and we really don't bother.
831 (if (and (memq (char-before) delims)
832 (progn (forward-char -1)
833 (setq saved (point))
834 (c-backward-syntactic-ws)
835 (or (memq (char-before) delims)
836 (memq (char-before) '(?: nil))
837 (eq (char-syntax (char-before)) ?\()
838 (c-at-vsemi-p))))
839 (setq ret 'previous
840 pos saved)
841
842 ;; Begin at start and not pos to detect macros if we stand
843 ;; directly after the #.
844 (goto-char start)
845 (if (looking-at "\\<\\|\\W")
846 ;; Record this as the first token if not starting inside it.
847 (setq tok start))
848
849 ;; The following while loop goes back one sexp (balanced parens,
850 ;; etc. with contents, or symbol or suchlike) each iteration. This
851 ;; movement is accomplished with a call to c-backward-sexp approx 170
852 ;; lines below.
853 ;;
854 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
855 ;; 1. On reaching the start of a macro;
856 ;; 2. On having passed a stmt boundary with the PDA stack empty;
857 ;; 3. On reaching the start of an Objective C method def;
858 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
859 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
860 (while
861 (catch 'loop ;; Throw nil to break, non-nil to continue.
862 (cond
863 ;; Are we in a macro, just after the opening #?
864 ((save-excursion
865 (and macro-start ; Always NIL for AWK.
866 (progn (skip-chars-backward " \t")
867 (eq (char-before) ?#))
868 (progn (setq saved (1- (point)))
869 (beginning-of-line)
870 (not (eq (char-before (1- (point))) ?\\)))
871 (looking-at c-opt-cpp-start)
872 (progn (skip-chars-forward " \t")
873 (eq (point) saved))))
874 (goto-char saved)
875 (if (and (c-forward-to-cpp-define-body)
876 (progn (c-forward-syntactic-ws start)
877 (< (point) start)))
878 ;; Stop at the first token in the content of the macro.
879 (setq pos (point)
880 ignore-labels t) ; Avoid the label check on exit.
881 (setq pos saved
882 ret 'macro
883 ignore-labels t))
884 (throw 'loop nil)) ; 1. Start of macro.
885
886 ;; Do a round through the automaton if we've just passed a
887 ;; statement boundary or passed a "while"-like token.
888 ((or sym
889 (and (looking-at cond-key)
890 (setq sym (intern (match-string 1)))))
891
892 (when (and (< pos start) (null stack))
893 (throw 'loop nil)) ; 2. Statement boundary.
894
895 ;; The PDA state handling.
896 ;;
897 ;; Refer to the description of the PDA in the opening
898 ;; comments. In the following OR form, the first leaf
899 ;; attempts to handles one of the specific actions detailed
900 ;; (e.g., finding token "if" whilst in state `else-boundary').
901 ;; We drop through to the second leaf (which handles common
902 ;; state) if no specific handler is found in the first cond.
903 ;; If a parsing error is detected (e.g. an "else" with no
904 ;; preceding "if"), we throw to the enclosing catch.
905 ;;
906 ;; Note that the (eq state 'else) means
907 ;; "we've just passed an else", NOT "we're looking for an
908 ;; else".
909 (or (cond
910 ((eq state 'else)
911 (if (eq sym 'boundary)
912 (setq state 'else-boundary)
913 (c-bos-report-error)
914 (c-bos-pop-state-and-retry)))
915
916 ((eq state 'else-boundary)
917 (cond ((eq sym 'if)
918 (c-bos-pop-state (setq ret 'beginning)))
919 ((eq sym 'boundary)
920 (c-bos-report-error)
921 (c-bos-pop-state))))
922
923 ((eq state 'while)
924 (if (and (eq sym 'boundary)
925 ;; Since this can cause backtracking we do a
926 ;; little more careful analysis to avoid it:
927 ;; If there's a label in front of the while
928 ;; it can't be part of a do-while.
929 (not after-labels-pos))
930 (progn (c-bos-save-pos)
931 (setq state 'while-boundary))
932 (c-bos-pop-state-and-retry))) ; Can't be a do-while
933
934 ((eq state 'while-boundary)
935 (cond ((eq sym 'do)
936 (c-bos-pop-state (setq ret 'beginning)))
937 ((eq sym 'boundary) ; isn't a do-while
938 (c-bos-restore-pos) ; the position of the while
939 (c-bos-pop-state)))) ; no longer searching for do.
940
941 ((eq state 'catch)
942 (if (eq sym 'boundary)
943 (setq state 'catch-boundary)
944 (c-bos-report-error)
945 (c-bos-pop-state-and-retry)))
946
947 ((eq state 'catch-boundary)
948 (cond
949 ((eq sym 'try)
950 (c-bos-pop-state (setq ret 'beginning)))
951 ((eq sym 'catch)
952 (setq state 'catch))
953 ((eq sym 'boundary)
954 (c-bos-report-error)
955 (c-bos-pop-state)))))
956
957 ;; This is state common. We get here when the previous
958 ;; cond statement found no particular state handler.
959 (cond ((eq sym 'boundary)
960 ;; If we have a boundary at the start
961 ;; position we push a frame to go to the
962 ;; previous statement.
963 (if (>= pos start)
964 (c-bos-push-state)
965 (c-bos-pop-state)))
966 ((eq sym 'else)
967 (c-bos-push-state)
968 (c-bos-save-error-info 'if 'else)
969 (setq state 'else))
970 ((eq sym 'while)
971 ;; Is this a real while, or a do-while?
972 ;; The next `when' triggers unless we are SURE that
973 ;; the `while' is not the tail end of a `do-while'.
974 (when (or (not pptok)
975 (memq (char-after pptok) delims)
976 ;; The following kludge is to prevent
977 ;; infinite recursion when called from
978 ;; c-awk-after-if-for-while-condition-p,
979 ;; or the like.
980 (and (eq (point) start)
981 (c-vsemi-status-unknown-p))
982 (c-at-vsemi-p pptok))
983 ;; Since this can cause backtracking we do a
984 ;; little more careful analysis to avoid it: If
985 ;; the while isn't followed by a (possibly
986 ;; virtual) semicolon it can't be a do-while.
987 (c-bos-push-state)
988 (setq state 'while)))
989 ((memq sym '(catch finally))
990 (c-bos-push-state)
991 (c-bos-save-error-info 'try sym)
992 (setq state 'catch))))
993
994 (when c-maybe-labelp
995 ;; We're either past a statement boundary or at the
996 ;; start of a statement, so throw away any label data
997 ;; for the previous one.
998 (setq after-labels-pos nil
999 last-label-pos nil
1000 c-maybe-labelp nil))))
1001
1002 ;; Step to the previous sexp, but not if we crossed a
1003 ;; boundary, since that doesn't consume an sexp.
1004 (if (eq sym 'boundary)
1005 (setq ret 'previous)
1006
1007 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
1008 ;; BACKWARDS THROUGH THE SOURCE.
1009
1010 (c-backward-syntactic-ws)
1011 (let ((before-sws-pos (point))
1012 ;; The end position of the area to search for statement
1013 ;; barriers in this round.
1014 (maybe-after-boundary-pos pos))
1015
1016 ;; Go back over exactly one logical sexp, taking proper
1017 ;; account of macros and escaped EOLs.
1018 (while
1019 (progn
1020 (unless (c-safe (c-backward-sexp) t)
1021 ;; Give up if we hit an unbalanced block. Since the
1022 ;; stack won't be empty the code below will report a
1023 ;; suitable error.
1024 (throw 'loop nil))
1025 (cond
1026 ;; Have we moved into a macro?
1027 ((and (not macro-start)
1028 (c-beginning-of-macro))
1029 ;; Have we crossed a statement boundary? If not,
1030 ;; keep going back until we find one or a "real" sexp.
1031 (and
1032 (save-excursion
1033 (c-end-of-macro)
1034 (not (c-crosses-statement-barrier-p
1035 (point) maybe-after-boundary-pos)))
1036 (setq maybe-after-boundary-pos (point))))
1037 ;; Have we just gone back over an escaped NL? This
1038 ;; doesn't count as a sexp.
1039 ((looking-at "\\\\$")))))
1040
1041 ;; Have we crossed a statement boundary?
1042 (setq boundary-pos
1043 (cond
1044 ;; Are we at a macro beginning?
1045 ((and (not macro-start)
1046 c-opt-cpp-prefix
1047 (looking-at c-opt-cpp-prefix))
1048 (save-excursion
1049 (c-end-of-macro)
1050 (c-crosses-statement-barrier-p
1051 (point) maybe-after-boundary-pos)))
1052 ;; Just gone back over a brace block?
1053 ((and
1054 (eq (char-after) ?{)
1055 (not (c-looking-at-inexpr-block lim nil t))
1056 (save-excursion
1057 (c-backward-token-2 1 t nil)
1058 (not (looking-at "=\\([^=]\\|$\\)"))))
1059 (save-excursion
1060 (c-forward-sexp) (point)))
1061 ;; Just gone back over some paren block?
1062 ((looking-at "\\s\(")
1063 (save-excursion
1064 (goto-char (1+ (c-down-list-backward
1065 before-sws-pos)))
1066 (c-crosses-statement-barrier-p
1067 (point) maybe-after-boundary-pos)))
1068 ;; Just gone back over an ordinary symbol of some sort?
1069 (t (c-crosses-statement-barrier-p
1070 (point) maybe-after-boundary-pos))))
1071
1072 (when boundary-pos
1073 (setq pptok ptok
1074 ptok tok
1075 tok boundary-pos
1076 sym 'boundary)
1077 ;; Like a C "continue". Analyze the next sexp.
1078 (throw 'loop t))))
1079
1080 ;; ObjC method def?
1081 (when (and c-opt-method-key
1082 (setq saved (c-in-method-def-p)))
1083 (setq pos saved
1084 ignore-labels t) ; Avoid the label check on exit.
1085 (throw 'loop nil)) ; 3. ObjC method def.
1086
1087 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1088 (if c-has-bitfields
1089 (cond
1090 ;; The : <size> and <id> fields?
1091 ((and (numberp c-maybe-labelp)
1092 (not bitfield-size-pos)
1093 (save-excursion
1094 (goto-char (or tok start))
1095 (not (looking-at c-keywords-regexp)))
1096 (not (looking-at c-keywords-regexp))
1097 (not (c-punctuation-in (point) c-maybe-labelp)))
1098 (setq bitfield-size-pos (or tok start)
1099 bitfield-id-pos (point)))
1100 ;; The <type> field?
1101 ((and bitfield-id-pos
1102 (not bitfield-type-pos))
1103 (if (and (looking-at c-symbol-key) ; Can only be an integer type. :-)
1104 (not (looking-at c-not-primitive-type-keywords-regexp))
1105 (not (c-punctuation-in (point) tok)))
1106 (setq bitfield-type-pos (point))
1107 (setq bitfield-size-pos nil
1108 bitfield-id-pos nil)))))
1109
1110 ;; Handle labels.
1111 (unless (eq ignore-labels t)
1112 (when (numberp c-maybe-labelp)
1113 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1114 ;; might be in a label now. Have we got a real label
1115 ;; (including a case label) or something like C++'s "public:"?
1116 ;; A case label might use an expression rather than a token.
1117 (setq after-case:-pos (or tok start))
1118 (if (or (looking-at c-nonlabel-token-key) ; e.g. "while" or "'a'"
1119 ;; Catch C++'s inheritance construct "class foo : bar".
1120 (save-excursion
1121 (and
1122 (c-safe (c-backward-sexp) t)
1123 (looking-at c-nonlabel-token-2-key))))
1124 (setq c-maybe-labelp nil)
1125 (if after-labels-pos ; Have we already encountered a label?
1126 (if (not last-label-pos)
1127 (setq last-label-pos (or tok start)))
1128 (setq after-labels-pos (or tok start)))
1129 (setq c-maybe-labelp t
1130 label-good-pos nil))) ; bogus "label"
1131
1132 (when (and (not label-good-pos) ; i.e. no invalid "label"'s yet
1133 ; been found.
1134 (looking-at c-nonlabel-token-key)) ; e.g. "while :"
1135 ;; We're in a potential label and it's the first
1136 ;; time we've found something that isn't allowed in
1137 ;; one.
1138 (setq label-good-pos (or tok start))))
1139
1140 ;; We've moved back by a sexp, so update the token positions.
1141 (setq sym nil
1142 pptok ptok
1143 ptok tok
1144 tok (point)
1145 pos tok) ; always non-nil
1146 ) ; end of (catch loop ....)
1147 ) ; end of sexp-at-a-time (while ....)
1148
1149 ;; If the stack isn't empty there might be errors to report.
1150 (while stack
1151 (if (and (vectorp saved-pos) (eq (length saved-pos) 3))
1152 (c-bos-report-error))
1153 (setq saved-pos (cdr (car stack))
1154 stack (cdr stack)))
1155
1156 (when (and (eq ret 'same)
1157 (not (memq sym '(boundary ignore nil))))
1158 ;; Need to investigate closer whether we've crossed
1159 ;; between a substatement and its containing statement.
1160 (if (setq saved
1161 (cond ((and (looking-at c-block-stmt-1-2-key)
1162 (eq (char-after ptok) ?\())
1163 pptok)
1164 ((looking-at c-block-stmt-1-key)
1165 ptok)
1166 (t pptok)))
1167 (cond ((> start saved) (setq pos saved))
1168 ((= start saved) (setq ret 'up)))))
1169
1170 (when (and (not ignore-labels)
1171 (eq c-maybe-labelp t)
1172 (not (eq ret 'beginning))
1173 after-labels-pos
1174 (not bitfield-type-pos) ; Bitfields take precedence over labels.
1175 (or (not label-good-pos)
1176 (<= label-good-pos pos)
1177 (progn
1178 (goto-char (if (and last-label-pos
1179 (< last-label-pos start))
1180 last-label-pos
1181 pos))
1182 (looking-at c-label-kwds-regexp))))
1183 ;; We're in a label. Maybe we should step to the statement
1184 ;; after it.
1185 (if (< after-labels-pos start)
1186 (setq pos after-labels-pos)
1187 (setq ret 'label)
1188 (if (and last-label-pos (< last-label-pos start))
1189 ;; Might have jumped over several labels. Go to the last one.
1190 (setq pos last-label-pos)))))
1191
1192 ;; Have we got "case <expression>:"?
1193 (goto-char pos)
1194 (when (and after-case:-pos
1195 (not (eq ret 'beginning))
1196 (looking-at c-case-kwds-regexp))
1197 (if (< after-case:-pos start)
1198 (setq pos after-case:-pos))
1199 (if (eq ret 'same)
1200 (setq ret 'label)))
1201
1202 ;; Skip over the unary operators that can start the statement.
1203 (while (progn
1204 (c-backward-syntactic-ws)
1205 ;; protect AWK post-inc/decrement operators, etc.
1206 (and (not (c-at-vsemi-p (point)))
1207 (/= (skip-chars-backward "-+!*&~@`#") 0)))
1208 (setq pos (point)))
1209 (goto-char pos)
1210 ret)))
1211
1212 (defun c-punctuation-in (from to)
1213 "Return non-nil if there is a non-comment non-macro punctuation character
1214 between FROM and TO. FROM must not be in a string or comment. The returned
1215 value is the position of the first such character."
1216 (save-excursion
1217 (goto-char from)
1218 (let ((pos (point)))
1219 (while (progn (skip-chars-forward c-symbol-chars to)
1220 (c-forward-syntactic-ws to)
1221 (> (point) pos))
1222 (setq pos (point))))
1223 (and (< (point) to) (point))))
1224
1225 (defun c-crosses-statement-barrier-p (from to)
1226 "Return non-nil if buffer positions FROM to TO cross one or more
1227 statement or declaration boundaries. The returned value is actually
1228 the position of the earliest boundary char. FROM must not be within
1229 a string or comment.
1230
1231 The variable `c-maybe-labelp' is set to the position of the first `:' that
1232 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1233 single `?' is found, then `c-maybe-labelp' is cleared.
1234
1235 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1236 regarded as having a \"virtual semicolon\" immediately after the last token on
1237 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1238
1239 Note that this function might do hidden buffer changes. See the
1240 comment at the start of cc-engine.el for more info."
1241 (let* ((skip-chars
1242 ;; If the current language has CPP macros, insert # into skip-chars.
1243 (if c-opt-cpp-symbol
1244 (concat (substring c-stmt-delim-chars 0 1) ; "^"
1245 c-opt-cpp-symbol ; usually "#"
1246 (substring c-stmt-delim-chars 1)) ; e.g. ";{}?:"
1247 c-stmt-delim-chars))
1248 (non-skip-list
1249 (append (substring skip-chars 1) nil)) ; e.g. (?# ?\; ?{ ?} ?? ?:)
1250 lit-range vsemi-pos)
1251 (save-restriction
1252 (widen)
1253 (save-excursion
1254 (catch 'done
1255 (goto-char from)
1256 (while (progn (skip-chars-forward
1257 skip-chars
1258 (min to (c-point 'bonl)))
1259 (< (point) to))
1260 (cond
1261 ;; Virtual semicolon?
1262 ((and (bolp)
1263 (save-excursion
1264 (progn
1265 (if (setq lit-range (c-literal-limits from)) ; Have we landed in a string/comment?
1266 (goto-char (car lit-range)))
1267 (c-backward-syntactic-ws) ; ? put a limit here, maybe?
1268 (setq vsemi-pos (point))
1269 (c-at-vsemi-p))))
1270 (throw 'done vsemi-pos))
1271 ;; In a string/comment?
1272 ((setq lit-range (c-literal-limits from))
1273 (goto-char (cdr lit-range)))
1274 ((eq (char-after) ?:)
1275 (forward-char)
1276 (if (and (eq (char-after) ?:)
1277 (< (point) to))
1278 ;; Ignore scope operators.
1279 (forward-char)
1280 (setq c-maybe-labelp (1- (point)))))
1281 ((eq (char-after) ??)
1282 ;; A question mark. Can't be a label, so stop
1283 ;; looking for more : and ?.
1284 (setq c-maybe-labelp nil
1285 skip-chars (substring c-stmt-delim-chars 0 -2)))
1286 ;; At a CPP construct or a "#" or "##" operator?
1287 ((and c-opt-cpp-symbol (looking-at c-opt-cpp-symbol))
1288 (if (save-excursion
1289 (skip-chars-backward " \t")
1290 (and (bolp)
1291 (or (bobp)
1292 (not (eq (char-before (1- (point))) ?\\)))))
1293 (c-end-of-macro)
1294 (skip-chars-forward c-opt-cpp-symbol)))
1295 ((memq (char-after) non-skip-list)
1296 (throw 'done (point)))))
1297 ;; In trailing space after an as yet undetected virtual semicolon?
1298 (c-backward-syntactic-ws from)
1299 (when (and (bolp) (not (bobp))) ; Can happen in AWK Mode with an
1300 ; unterminated string/regexp.
1301 (backward-char))
1302 (if (and (< (point) to)
1303 (c-at-vsemi-p))
1304 (point)
1305 nil))))))
1306
1307 (defun c-at-statement-start-p ()
1308 "Return non-nil if the point is at the first token in a statement
1309 or somewhere in the syntactic whitespace before it.
1310
1311 A \"statement\" here is not restricted to those inside code blocks.
1312 Any kind of declaration-like construct that occur outside function
1313 bodies is also considered a \"statement\".
1314
1315 Note that this function might do hidden buffer changes. See the
1316 comment at the start of cc-engine.el for more info."
1317
1318 (save-excursion
1319 (let ((end (point))
1320 c-maybe-labelp)
1321 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1322 (or (bobp)
1323 (eq (char-before) ?})
1324 (and (eq (char-before) ?{)
1325 (not (and c-special-brace-lists
1326 (progn (backward-char)
1327 (c-looking-at-special-brace-list)))))
1328 (c-crosses-statement-barrier-p (point) end)))))
1329
1330 (defun c-at-expression-start-p ()
1331 "Return non-nil if the point is at the first token in an expression or
1332 statement, or somewhere in the syntactic whitespace before it.
1333
1334 An \"expression\" here is a bit different from the normal language
1335 grammar sense: It's any sequence of expression tokens except commas,
1336 unless they are enclosed inside parentheses of some kind. Also, an
1337 expression never continues past an enclosing parenthesis, but it might
1338 contain parenthesis pairs of any sort except braces.
1339
1340 Since expressions never cross statement boundaries, this function also
1341 recognizes statement beginnings, just like `c-at-statement-start-p'.
1342
1343 Note that this function might do hidden buffer changes. See the
1344 comment at the start of cc-engine.el for more info."
1345
1346 (save-excursion
1347 (let ((end (point))
1348 (c-stmt-delim-chars c-stmt-delim-chars-with-comma)
1349 c-maybe-labelp)
1350 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1351 (or (bobp)
1352 (memq (char-before) '(?{ ?}))
1353 (save-excursion (backward-char)
1354 (looking-at "\\s("))
1355 (c-crosses-statement-barrier-p (point) end)))))
1356
1357 \f
1358 ;; A set of functions that covers various idiosyncrasies in
1359 ;; implementations of `forward-comment'.
1360
1361 ;; Note: Some emacsen considers incorrectly that any line comment
1362 ;; ending with a backslash continues to the next line. I can't think
1363 ;; of any way to work around that in a reliable way without changing
1364 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1365 ;; changing the syntax for backslash doesn't work since we must treat
1366 ;; escapes in string literals correctly.)
1367
1368 (defun c-forward-single-comment ()
1369 "Move forward past whitespace and the closest following comment, if any.
1370 Return t if a comment was found, nil otherwise. In either case, the
1371 point is moved past the following whitespace. Line continuations,
1372 i.e. a backslashes followed by line breaks, are treated as whitespace.
1373 The line breaks that end line comments are considered to be the
1374 comment enders, so the point will be put on the beginning of the next
1375 line if it moved past a line comment.
1376
1377 This function does not do any hidden buffer changes."
1378
1379 (let ((start (point)))
1380 (when (looking-at "\\([ \t\n\r\f\v]\\|\\\\[\n\r]\\)+")
1381 (goto-char (match-end 0)))
1382
1383 (when (forward-comment 1)
1384 (if (eobp)
1385 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1386 ;; forwards at eob.
1387 nil
1388
1389 ;; Emacs includes the ending newline in a b-style (c++)
1390 ;; comment, but XEmacs doesn't. We depend on the Emacs
1391 ;; behavior (which also is symmetric).
1392 (if (and (eolp) (elt (parse-partial-sexp start (point)) 7))
1393 (condition-case nil (forward-char 1)))
1394
1395 t))))
1396
1397 (defsubst c-forward-comments ()
1398 "Move forward past all following whitespace and comments.
1399 Line continuations, i.e. a backslashes followed by line breaks, are
1400 treated as whitespace.
1401
1402 Note that this function might do hidden buffer changes. See the
1403 comment at the start of cc-engine.el for more info."
1404
1405 (while (or
1406 ;; If forward-comment in at least XEmacs 21 is given a large
1407 ;; positive value, it'll loop all the way through if it hits
1408 ;; eob.
1409 (and (forward-comment 5)
1410 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1411 ;; forwards at eob.
1412 (not (eobp)))
1413
1414 (when (looking-at "\\\\[\n\r]")
1415 (forward-char 2)
1416 t))))
1417
1418 (defun c-backward-single-comment ()
1419 "Move backward past whitespace and the closest preceding comment, if any.
1420 Return t if a comment was found, nil otherwise. In either case, the
1421 point is moved past the preceding whitespace. Line continuations,
1422 i.e. a backslashes followed by line breaks, are treated as whitespace.
1423 The line breaks that end line comments are considered to be the
1424 comment enders, so the point cannot be at the end of the same line to
1425 move over a line comment.
1426
1427 This function does not do any hidden buffer changes."
1428
1429 (let ((start (point)))
1430 ;; When we got newline terminated comments, forward-comment in all
1431 ;; supported emacsen so far will stop at eol of each line not
1432 ;; ending with a comment when moving backwards. This corrects for
1433 ;; that, and at the same time handles line continuations.
1434 (while (progn
1435 (skip-chars-backward " \t\n\r\f\v")
1436 (and (looking-at "[\n\r]")
1437 (eq (char-before) ?\\)))
1438 (backward-char))
1439
1440 (if (bobp)
1441 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1442 ;; backwards at bob.
1443 nil
1444
1445 ;; Leave point after the closest following newline if we've
1446 ;; backed up over any above, since forward-comment won't move
1447 ;; backward over a line comment if point is at the end of the
1448 ;; same line.
1449 (re-search-forward "\\=\\s *[\n\r]" start t)
1450
1451 (if (if (let (open-paren-in-column-0-is-defun-start) (forward-comment -1))
1452 (if (eolp)
1453 ;; If forward-comment above succeeded and we're at eol
1454 ;; then the newline we moved over above didn't end a
1455 ;; line comment, so we give it another go.
1456 (let (open-paren-in-column-0-is-defun-start)
1457 (forward-comment -1))
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 (open-paren-in-column-0-is-defun-start 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 doesn't have any ordinary whitespace. If
1547 ;; `c-is-sws' is put on a token character it does not have
1548 ;; `c-in-sws' set simultaneously. That's the only case when that
1549 ;; can occur, and the reason for not extending the `c-in-sws'
1550 ;; region to cover it is that the `c-in-sws' region could then be
1551 ;; accidentally merged with a following one if the token is only
1552 ;; one character long.
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 (looking-at c-syntactic-ws-start)
1718
1719 (setq rung-end-pos (min (1+ (point)) (point-max)))
1720 (if (setq rung-is-marked (text-property-any rung-pos rung-end-pos
1721 'c-is-sws t))
1722 ;; Find the last rung position to avoid setting properties in all
1723 ;; the cases when the marked rung is complete.
1724 ;; (`next-single-property-change' is certain to move at least one
1725 ;; step forward.)
1726 (setq rung-pos (1- (next-single-property-change
1727 rung-is-marked 'c-is-sws nil rung-end-pos)))
1728 ;; Got no marked rung here. Since the simple ws might have started
1729 ;; inside a line comment or cpp directive we must set `rung-pos' as
1730 ;; high as possible.
1731 (setq rung-pos (point)))
1732
1733 (with-silent-modifications
1734 (while
1735 (progn
1736 (while
1737 (when (and rung-is-marked
1738 (get-text-property (point) 'c-in-sws))
1739
1740 ;; The following search is the main reason that `c-in-sws'
1741 ;; and `c-is-sws' aren't combined to one property.
1742 (goto-char (next-single-property-change
1743 (point) 'c-in-sws nil (point-max)))
1744 (unless (get-text-property (point) 'c-is-sws)
1745 ;; If the `c-in-sws' region extended past the last
1746 ;; `c-is-sws' char we have to go back a bit.
1747 (or (get-text-property (1- (point)) 'c-is-sws)
1748 (goto-char (previous-single-property-change
1749 (point) 'c-is-sws)))
1750 (backward-char))
1751
1752 (c-debug-sws-msg
1753 "c-forward-sws cached move %s -> %s (max %s)"
1754 rung-pos (point) (point-max))
1755
1756 (setq rung-pos (point))
1757 (and (> (skip-chars-forward " \t\n\r\f\v") 0)
1758 (not (eobp))))
1759
1760 ;; We'll loop here if there is simple ws after the last rung.
1761 ;; That means that there's been some change in it and it's
1762 ;; possible that we've stepped into another ladder, so extend
1763 ;; the previous one to join with it if there is one, and try to
1764 ;; use the cache again.
1765 (c-debug-sws-msg
1766 "c-forward-sws extending rung with [%s..%s] (max %s)"
1767 (1+ rung-pos) (1+ (point)) (point-max))
1768 (unless (get-text-property (point) 'c-is-sws)
1769 ;; Remove any `c-in-sws' property from the last char of
1770 ;; the rung before we mark it with `c-is-sws', so that we
1771 ;; won't connect with the remains of a broken "ladder".
1772 (c-remove-in-sws (point) (1+ (point))))
1773 (c-put-is-sws (1+ rung-pos)
1774 (1+ (point)))
1775 (c-put-in-sws rung-pos
1776 (setq rung-pos (point)
1777 last-put-in-sws-pos rung-pos)))
1778
1779 (setq simple-ws-end (point))
1780 (c-forward-comments)
1781
1782 (cond
1783 ((/= (point) simple-ws-end)
1784 ;; Skipped over comments. Don't cache at eob in case the buffer
1785 ;; is narrowed.
1786 (not (eobp)))
1787
1788 ((save-excursion
1789 (and c-opt-cpp-prefix
1790 (looking-at c-opt-cpp-start)
1791 (progn (skip-chars-backward " \t")
1792 (bolp))
1793 (or (bobp)
1794 (progn (backward-char)
1795 (not (eq (char-before) ?\\))))))
1796 ;; Skip a preprocessor directive.
1797 (end-of-line)
1798 (while (and (eq (char-before) ?\\)
1799 (= (forward-line 1) 0))
1800 (end-of-line))
1801 (forward-line 1)
1802 (setq safe-start t)
1803 ;; Don't cache at eob in case the buffer is narrowed.
1804 (not (eobp)))))
1805
1806 ;; We've searched over a piece of non-white syntactic ws. See if this
1807 ;; can be cached.
1808 (setq next-rung-pos (point))
1809 (skip-chars-forward " \t\n\r\f\v")
1810 (setq rung-end-pos (min (1+ (point)) (point-max)))
1811
1812 (if (or
1813 ;; Cache if we haven't skipped comments only, and if we started
1814 ;; either from a marked rung or from a completely uncached
1815 ;; position.
1816 (and safe-start
1817 (or rung-is-marked
1818 (not (get-text-property simple-ws-end 'c-in-sws))))
1819
1820 ;; See if there's a marked rung in the encountered simple ws. If
1821 ;; so then we can cache, unless `safe-start' is nil. Even then
1822 ;; we need to do this to check if the cache can be used for the
1823 ;; next step.
1824 (and (setq next-rung-is-marked
1825 (text-property-any next-rung-pos rung-end-pos
1826 'c-is-sws t))
1827 safe-start))
1828
1829 (progn
1830 (c-debug-sws-msg
1831 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1832 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1833 (point-max))
1834
1835 ;; Remove the properties for any nested ws that might be cached.
1836 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1837 ;; anyway.
1838 (c-remove-is-sws (1+ simple-ws-end) next-rung-pos)
1839 (unless (and rung-is-marked (= rung-pos simple-ws-end))
1840 (c-put-is-sws rung-pos
1841 (1+ simple-ws-end))
1842 (setq rung-is-marked t))
1843 (c-put-in-sws rung-pos
1844 (setq rung-pos (point)
1845 last-put-in-sws-pos rung-pos))
1846 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
1847 ;; Remove any `c-in-sws' property from the last char of
1848 ;; the rung before we mark it with `c-is-sws', so that we
1849 ;; won't connect with the remains of a broken "ladder".
1850 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
1851 (c-put-is-sws next-rung-pos
1852 rung-end-pos))
1853
1854 (c-debug-sws-msg
1855 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1856 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1857 (point-max))
1858
1859 ;; Set `rung-pos' for the next rung. It's the same thing here as
1860 ;; initially, except that the rung position is set as early as
1861 ;; possible since we can't be in the ending ws of a line comment or
1862 ;; cpp directive now.
1863 (if (setq rung-is-marked next-rung-is-marked)
1864 (setq rung-pos (1- (next-single-property-change
1865 rung-is-marked 'c-is-sws nil rung-end-pos)))
1866 (setq rung-pos next-rung-pos))
1867 (setq safe-start t)))
1868
1869 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1870 ;; another one after the point (which might occur when editing inside a
1871 ;; comment or macro).
1872 (when (eq last-put-in-sws-pos (point))
1873 (cond ((< last-put-in-sws-pos (point-max))
1874 (c-debug-sws-msg
1875 "c-forward-sws clearing at %s for cache separation"
1876 last-put-in-sws-pos)
1877 (c-remove-in-sws last-put-in-sws-pos
1878 (1+ last-put-in-sws-pos)))
1879 (t
1880 ;; If at eob we have to clear the last character before the end
1881 ;; instead since the buffer might be narrowed and there might
1882 ;; be a `c-in-sws' after (point-max). In this case it's
1883 ;; necessary to clear both properties.
1884 (c-debug-sws-msg
1885 "c-forward-sws clearing thoroughly at %s for cache separation"
1886 (1- last-put-in-sws-pos))
1887 (c-remove-is-and-in-sws (1- last-put-in-sws-pos)
1888 last-put-in-sws-pos))))
1889 ))))
1890
1891 (defun c-backward-sws ()
1892 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1893 ;;
1894 ;; This function might do hidden buffer changes.
1895
1896 (let (;; `rung-pos' is set to a position as late as possible in the unmarked
1897 ;; part of the simple ws region.
1898 (rung-pos (point)) next-rung-pos last-put-in-sws-pos
1899 rung-is-marked simple-ws-beg cmt-skip-pos)
1900
1901 ;; Skip simple horizontal ws and do a quick check on the preceding
1902 ;; character to see if it's anything that can't end syntactic ws, so we can
1903 ;; bail out early in the majority of cases when there just are a few ws
1904 ;; chars. Newlines are complicated in the backward direction, so we can't
1905 ;; skip over them.
1906 (skip-chars-backward " \t\f")
1907 (when (and (not (bobp))
1908 (save-excursion
1909 (backward-char)
1910 (looking-at c-syntactic-ws-end)))
1911
1912 ;; Try to find a rung position in the simple ws preceding point, so that
1913 ;; we can get a cache hit even if the last bit of the simple ws has
1914 ;; changed recently.
1915 (setq simple-ws-beg (point))
1916 (skip-chars-backward " \t\n\r\f\v")
1917 (if (setq rung-is-marked (text-property-any
1918 (point) (min (1+ rung-pos) (point-max))
1919 'c-is-sws t))
1920 ;; `rung-pos' will be the earliest marked position, which means that
1921 ;; there might be later unmarked parts in the simple ws region.
1922 ;; It's not worth the effort to fix that; the last part of the
1923 ;; simple ws is also typically edited often, so it could be wasted.
1924 (goto-char (setq rung-pos rung-is-marked))
1925 (goto-char simple-ws-beg))
1926
1927 (with-silent-modifications
1928 (while
1929 (progn
1930 (while
1931 (when (and rung-is-marked
1932 (not (bobp))
1933 (get-text-property (1- (point)) 'c-in-sws))
1934
1935 ;; The following search is the main reason that `c-in-sws'
1936 ;; and `c-is-sws' aren't combined to one property.
1937 (goto-char (previous-single-property-change
1938 (point) 'c-in-sws nil (point-min)))
1939 (unless (get-text-property (point) 'c-is-sws)
1940 ;; If the `c-in-sws' region extended past the first
1941 ;; `c-is-sws' char we have to go forward a bit.
1942 (goto-char (next-single-property-change
1943 (point) 'c-is-sws)))
1944
1945 (c-debug-sws-msg
1946 "c-backward-sws cached move %s <- %s (min %s)"
1947 (point) rung-pos (point-min))
1948
1949 (setq rung-pos (point))
1950 (if (and (< (min (skip-chars-backward " \t\f\v")
1951 (progn
1952 (setq simple-ws-beg (point))
1953 (skip-chars-backward " \t\n\r\f\v")))
1954 0)
1955 (setq rung-is-marked
1956 (text-property-any (point) rung-pos
1957 'c-is-sws t)))
1958 t
1959 (goto-char simple-ws-beg)
1960 nil))
1961
1962 ;; We'll loop here if there is simple ws before the first rung.
1963 ;; That means that there's been some change in it and it's
1964 ;; possible that we've stepped into another ladder, so extend
1965 ;; the previous one to join with it if there is one, and try to
1966 ;; use the cache again.
1967 (c-debug-sws-msg
1968 "c-backward-sws extending rung with [%s..%s] (min %s)"
1969 rung-is-marked rung-pos (point-min))
1970 (unless (get-text-property (1- rung-pos) 'c-is-sws)
1971 ;; Remove any `c-in-sws' property from the last char of
1972 ;; the rung before we mark it with `c-is-sws', so that we
1973 ;; won't connect with the remains of a broken "ladder".
1974 (c-remove-in-sws (1- rung-pos) rung-pos))
1975 (c-put-is-sws rung-is-marked
1976 rung-pos)
1977 (c-put-in-sws rung-is-marked
1978 (1- rung-pos))
1979 (setq rung-pos rung-is-marked
1980 last-put-in-sws-pos rung-pos))
1981
1982 (c-backward-comments)
1983 (setq cmt-skip-pos (point))
1984
1985 (cond
1986 ((and c-opt-cpp-prefix
1987 (/= cmt-skip-pos simple-ws-beg)
1988 (c-beginning-of-macro))
1989 ;; Inside a cpp directive. See if it should be skipped over.
1990 (let ((cpp-beg (point)))
1991
1992 ;; Move back over all line continuations in the region skipped
1993 ;; over by `c-backward-comments'. If we go past it then we
1994 ;; started inside the cpp directive.
1995 (goto-char simple-ws-beg)
1996 (beginning-of-line)
1997 (while (and (> (point) cmt-skip-pos)
1998 (progn (backward-char)
1999 (eq (char-before) ?\\)))
2000 (beginning-of-line))
2001
2002 (if (< (point) cmt-skip-pos)
2003 ;; Don't move past the cpp directive if we began inside
2004 ;; it. Note that the position at the end of the last line
2005 ;; of the macro is also considered to be within it.
2006 (progn (goto-char cmt-skip-pos)
2007 nil)
2008
2009 ;; It's worthwhile to spend a little bit of effort on finding
2010 ;; the end of the macro, to get a good `simple-ws-beg'
2011 ;; position for the cache. Note that `c-backward-comments'
2012 ;; could have stepped over some comments before going into
2013 ;; the macro, and then `simple-ws-beg' must be kept on the
2014 ;; same side of those comments.
2015 (goto-char simple-ws-beg)
2016 (skip-chars-backward " \t\n\r\f\v")
2017 (if (eq (char-before) ?\\)
2018 (forward-char))
2019 (forward-line 1)
2020 (if (< (point) simple-ws-beg)
2021 ;; Might happen if comments after the macro were skipped
2022 ;; over.
2023 (setq simple-ws-beg (point)))
2024
2025 (goto-char cpp-beg)
2026 t)))
2027
2028 ((/= (save-excursion
2029 (skip-chars-forward " \t\n\r\f\v" simple-ws-beg)
2030 (setq next-rung-pos (point)))
2031 simple-ws-beg)
2032 ;; Skipped over comments. Must put point at the end of
2033 ;; the simple ws at point since we might be after a line
2034 ;; comment or cpp directive that's been partially
2035 ;; narrowed out, and we can't risk marking the simple ws
2036 ;; at the end of it.
2037 (goto-char next-rung-pos)
2038 t)))
2039
2040 ;; We've searched over a piece of non-white syntactic ws. See if this
2041 ;; can be cached.
2042 (setq next-rung-pos (point))
2043 (skip-chars-backward " \t\f\v")
2044
2045 (if (or
2046 ;; Cache if we started either from a marked rung or from a
2047 ;; completely uncached position.
2048 rung-is-marked
2049 (not (get-text-property (1- simple-ws-beg) 'c-in-sws))
2050
2051 ;; Cache if there's a marked rung in the encountered simple ws.
2052 (save-excursion
2053 (skip-chars-backward " \t\n\r\f\v")
2054 (text-property-any (point) (min (1+ next-rung-pos) (point-max))
2055 'c-is-sws t)))
2056
2057 (progn
2058 (c-debug-sws-msg
2059 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2060 (point) (1+ next-rung-pos)
2061 simple-ws-beg (min (1+ rung-pos) (point-max))
2062 (point-min))
2063
2064 ;; Remove the properties for any nested ws that might be cached.
2065 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2066 ;; anyway.
2067 (c-remove-is-sws (1+ next-rung-pos) simple-ws-beg)
2068 (unless (and rung-is-marked (= simple-ws-beg rung-pos))
2069 (let ((rung-end-pos (min (1+ rung-pos) (point-max))))
2070 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
2071 ;; Remove any `c-in-sws' property from the last char of
2072 ;; the rung before we mark it with `c-is-sws', so that we
2073 ;; won't connect with the remains of a broken "ladder".
2074 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
2075 (c-put-is-sws simple-ws-beg
2076 rung-end-pos)
2077 (setq rung-is-marked t)))
2078 (c-put-in-sws (setq simple-ws-beg (point)
2079 last-put-in-sws-pos simple-ws-beg)
2080 rung-pos)
2081 (c-put-is-sws (setq rung-pos simple-ws-beg)
2082 (1+ next-rung-pos)))
2083
2084 (c-debug-sws-msg
2085 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2086 (point) (1+ next-rung-pos)
2087 simple-ws-beg (min (1+ rung-pos) (point-max))
2088 (point-min))
2089 (setq rung-pos next-rung-pos
2090 simple-ws-beg (point))
2091 ))
2092
2093 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2094 ;; another one before the point (which might occur when editing inside a
2095 ;; comment or macro).
2096 (when (eq last-put-in-sws-pos (point))
2097 (cond ((< (point-min) last-put-in-sws-pos)
2098 (c-debug-sws-msg
2099 "c-backward-sws clearing at %s for cache separation"
2100 (1- last-put-in-sws-pos))
2101 (c-remove-in-sws (1- last-put-in-sws-pos)
2102 last-put-in-sws-pos))
2103 ((> (point-min) 1)
2104 ;; If at bob and the buffer is narrowed, we have to clear the
2105 ;; character we're standing on instead since there might be a
2106 ;; `c-in-sws' before (point-min). In this case it's necessary
2107 ;; to clear both properties.
2108 (c-debug-sws-msg
2109 "c-backward-sws clearing thoroughly at %s for cache separation"
2110 last-put-in-sws-pos)
2111 (c-remove-is-and-in-sws last-put-in-sws-pos
2112 (1+ last-put-in-sws-pos)))))
2113 ))))
2114
2115 \f
2116 ;; Other whitespace tools
2117 (defun c-partial-ws-p (beg end)
2118 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2119 ;; region? This is a "heuristic" function. .....
2120 ;;
2121 ;; The motivation for the second bit is to check whether removing this
2122 ;; region would coalesce two symbols.
2123 ;;
2124 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2125 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2126 (save-excursion
2127 (let ((end+1 (min (1+ end) (point-max))))
2128 (or (progn (goto-char (max (point-min) (1- beg)))
2129 (c-skip-ws-forward end)
2130 (eq (point) end))
2131 (progn (goto-char beg)
2132 (c-skip-ws-forward end+1)
2133 (eq (point) end+1))))))
2134 \f
2135 ;; A system for finding noteworthy parens before the point.
2136
2137 (defconst c-state-cache-too-far 5000)
2138 ;; A maximum comfortable scanning distance, e.g. between
2139 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2140 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2141 ;; the cache and starting again from point-min or a beginning of defun. This
2142 ;; value can be tuned for efficiency or set to a lower value for testing.
2143
2144 (defvar c-state-cache nil)
2145 (make-variable-buffer-local 'c-state-cache)
2146 ;; The state cache used by `c-parse-state' to cut down the amount of
2147 ;; searching. It's the result from some earlier `c-parse-state' call. See
2148 ;; `c-parse-state''s doc string for details of its structure.
2149 ;;
2150 ;; The use of the cached info is more effective if the next
2151 ;; `c-parse-state' call is on a line close by the one the cached state
2152 ;; was made at; the cache can actually slow down a little if the
2153 ;; cached state was made very far back in the buffer. The cache is
2154 ;; most effective if `c-parse-state' is used on each line while moving
2155 ;; forward.
2156
2157 (defvar c-state-cache-good-pos 1)
2158 (make-variable-buffer-local 'c-state-cache-good-pos)
2159 ;; This is a position where `c-state-cache' is known to be correct, or
2160 ;; nil (see below). It's a position inside one of the recorded unclosed
2161 ;; parens or the top level, but not further nested inside any literal or
2162 ;; subparen that is closed before the last recorded position.
2163 ;;
2164 ;; The exact position is chosen to try to be close to yet earlier than
2165 ;; the position where `c-state-cache' will be called next. Right now
2166 ;; the heuristic is to set it to the position after the last found
2167 ;; closing paren (of any type) before the line on which
2168 ;; `c-parse-state' was called. That is chosen primarily to work well
2169 ;; with refontification of the current line.
2170 ;;
2171 ;; 2009-07-28: When `c-state-point-min' and the last position where
2172 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2173 ;; both in the same literal, there is no such "good position", and
2174 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2175 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2176 ;;
2177 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2178 ;; the middle of the desert, as long as it is not within a brace pair
2179 ;; recorded in `c-state-cache' or a paren/bracket pair.
2180
2181 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2182 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2183 ;; speed up testing for non-literality.
2184 (defconst c-state-nonlit-pos-interval 3000)
2185 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2186
2187 (defvar c-state-nonlit-pos-cache nil)
2188 (make-variable-buffer-local 'c-state-nonlit-pos-cache)
2189 ;; A list of buffer positions which are known not to be in a literal or a cpp
2190 ;; construct. This is ordered with higher positions at the front of the list.
2191 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2192
2193 (defvar c-state-nonlit-pos-cache-limit 1)
2194 (make-variable-buffer-local 'c-state-nonlit-pos-cache-limit)
2195 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2196 ;; reduced by buffer changes, and increased by invocations of
2197 ;; `c-state-literal-at'.
2198
2199 (defvar c-state-semi-nonlit-pos-cache nil)
2200 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache)
2201 ;; A list of buffer positions which are known not to be in a literal. This is
2202 ;; ordered with higher positions at the front of the list. Only those which
2203 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2204
2205 (defvar c-state-semi-nonlit-pos-cache-limit 1)
2206 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache-limit)
2207 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2208 ;; reduced by buffer changes, and increased by invocations of
2209 ;; `c-state-literal-at'. FIXME!!!
2210
2211 (defsubst c-state-pp-to-literal (from to &optional not-in-delimiter)
2212 ;; Do a parse-partial-sexp from FROM to TO, returning either
2213 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2214 ;; (STATE) otherwise,
2215 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2216 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2217 ;;
2218 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2219 ;; comment opener, this is recognized as being in a comment literal.
2220 ;;
2221 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2222 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2223 ;; STATE are valid.
2224 (save-excursion
2225 (let ((s (parse-partial-sexp from to))
2226 ty co-st)
2227 (cond
2228 ((or (nth 3 s) (nth 4 s)) ; in a string or comment
2229 (setq ty (cond
2230 ((nth 3 s) 'string)
2231 ((nth 7 s) 'c++)
2232 (t 'c)))
2233 (parse-partial-sexp (point) (point-max)
2234 nil ; TARGETDEPTH
2235 nil ; STOPBEFORE
2236 s ; OLDSTATE
2237 'syntax-table) ; stop at end of literal
2238 `(,s ,ty (,(nth 8 s) . ,(point))))
2239
2240 ((and (not not-in-delimiter) ; inside a comment starter
2241 (not (bobp))
2242 (progn (backward-char)
2243 (and (not (and (memq 'category-properties c-emacs-features)
2244 (looking-at "\\s!")))
2245 (looking-at c-comment-start-regexp))))
2246 (setq ty (if (looking-at c-block-comment-start-regexp) 'c 'c++)
2247 co-st (point))
2248 (forward-comment 1)
2249 `(,s ,ty (,co-st . ,(point))))
2250
2251 (t `(,s))))))
2252
2253 (defun c-state-safe-place (here)
2254 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2255 ;; string, comment, or macro.
2256 ;;
2257 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2258 ;; MAY NOT contain any positions within macros, since macros are frequently
2259 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2260 ;; We cannot rely on this mechanism whilst determining a cache pos since
2261 ;; this function is also called from outwith `c-parse-state'.
2262 (save-restriction
2263 (widen)
2264 (save-excursion
2265 (let ((c c-state-nonlit-pos-cache)
2266 pos npos high-pos lit macro-beg macro-end)
2267 ;; Trim the cache to take account of buffer changes.
2268 (while (and c (> (car c) c-state-nonlit-pos-cache-limit))
2269 (setq c (cdr c)))
2270 (setq c-state-nonlit-pos-cache c)
2271
2272 (while (and c (> (car c) here))
2273 (setq high-pos (car c))
2274 (setq c (cdr c)))
2275 (setq pos (or (car c) (point-min)))
2276
2277 (unless high-pos
2278 (while
2279 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2280 (and
2281 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2282
2283 ;; Test for being in a literal. If so, go to after it.
2284 (progn
2285 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2286 (or (null lit)
2287 (prog1 (<= (cdr lit) here)
2288 (setq npos (cdr lit)))))
2289
2290 ;; Test for being in a macro. If so, go to after it.
2291 (progn
2292 (goto-char npos)
2293 (setq macro-beg
2294 (and (c-beginning-of-macro) (/= (point) npos) (point)))
2295 (when macro-beg
2296 (c-syntactic-end-of-macro)
2297 (or (eobp) (forward-char))
2298 (setq macro-end (point)))
2299 (or (null macro-beg)
2300 (prog1 (<= macro-end here)
2301 (setq npos macro-end)))))
2302
2303 (setq pos npos)
2304 (setq c-state-nonlit-pos-cache (cons pos c-state-nonlit-pos-cache)))
2305 ;; Add one extra element above HERE so as to to avoid the previous
2306 ;; expensive calculation when the next call is close to the current
2307 ;; one. This is especially useful when inside a large macro.
2308 (setq c-state-nonlit-pos-cache (cons npos c-state-nonlit-pos-cache)))
2309
2310 (if (> pos c-state-nonlit-pos-cache-limit)
2311 (setq c-state-nonlit-pos-cache-limit pos))
2312 pos))))
2313
2314 (defun c-state-semi-safe-place (here)
2315 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2316 ;; string or comment. It may be in a macro.
2317 (save-restriction
2318 (widen)
2319 (save-excursion
2320 (let ((c c-state-semi-nonlit-pos-cache)
2321 pos npos high-pos lit macro-beg macro-end)
2322 ;; Trim the cache to take account of buffer changes.
2323 (while (and c (> (car c) c-state-semi-nonlit-pos-cache-limit))
2324 (setq c (cdr c)))
2325 (setq c-state-semi-nonlit-pos-cache c)
2326
2327 (while (and c (> (car c) here))
2328 (setq high-pos (car c))
2329 (setq c (cdr c)))
2330 (setq pos (or (car c) (point-min)))
2331
2332 (unless high-pos
2333 (while
2334 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2335 (and
2336 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2337
2338 ;; Test for being in a literal. If so, go to after it.
2339 (progn
2340 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2341 (or (null lit)
2342 (prog1 (<= (cdr lit) here)
2343 (setq npos (cdr lit))))))
2344
2345 (setq pos npos)
2346 (setq c-state-semi-nonlit-pos-cache
2347 (cons pos c-state-semi-nonlit-pos-cache))))
2348
2349 (if (> pos c-state-semi-nonlit-pos-cache-limit)
2350 (setq c-state-semi-nonlit-pos-cache-limit pos))
2351 pos))))
2352
2353 (defun c-state-literal-at (here)
2354 ;; If position HERE is inside a literal, return (START . END), the
2355 ;; boundaries of the literal (which may be outside the accessible bit of the
2356 ;; buffer). Otherwise, return nil.
2357 ;;
2358 ;; This function is almost the same as `c-literal-limits'. Previously, it
2359 ;; differed in that it was a lower level function, and that it rigorously
2360 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2361 ;; virtually identical to this function.
2362 (save-restriction
2363 (widen)
2364 (save-excursion
2365 (let ((pos (c-state-safe-place here)))
2366 (car (cddr (c-state-pp-to-literal pos here)))))))
2367
2368 (defsubst c-state-lit-beg (pos)
2369 ;; Return the start of the literal containing POS, or POS itself.
2370 (or (car (c-state-literal-at pos))
2371 pos))
2372
2373 (defsubst c-state-cache-non-literal-place (pos state)
2374 ;; Return a position outside of a string/comment/macro at or before POS.
2375 ;; STATE is the parse-partial-sexp state at POS.
2376 (let ((res (if (or (nth 3 state) ; in a string?
2377 (nth 4 state)) ; in a comment?
2378 (nth 8 state)
2379 pos)))
2380 (save-excursion
2381 (goto-char res)
2382 (if (c-beginning-of-macro)
2383 (point)
2384 res))))
2385
2386 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2387 ;; Stuff to do with point-min, and coping with any literal there.
2388 (defvar c-state-point-min 1)
2389 (make-variable-buffer-local 'c-state-point-min)
2390 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2391 ;; narrowing is likely to affect the parens that are visible before the point.
2392
2393 (defvar c-state-point-min-lit-type nil)
2394 (make-variable-buffer-local 'c-state-point-min-lit-type)
2395 (defvar c-state-point-min-lit-start nil)
2396 (make-variable-buffer-local 'c-state-point-min-lit-start)
2397 ;; These two variables define the literal, if any, containing point-min.
2398 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2399 ;; literal. If there's no literal there, they're both nil.
2400
2401 (defvar c-state-min-scan-pos 1)
2402 (make-variable-buffer-local 'c-state-min-scan-pos)
2403 ;; This is the earliest buffer-pos from which scanning can be done. It is
2404 ;; either the end of the literal containing point-min, or point-min itself.
2405 ;; It becomes nil if the buffer is changed earlier than this point.
2406 (defun c-state-get-min-scan-pos ()
2407 ;; Return the lowest valid scanning pos. This will be the end of the
2408 ;; literal enclosing point-min, or point-min itself.
2409 (or c-state-min-scan-pos
2410 (save-restriction
2411 (save-excursion
2412 (widen)
2413 (goto-char c-state-point-min-lit-start)
2414 (if (eq c-state-point-min-lit-type 'string)
2415 (forward-sexp)
2416 (forward-comment 1))
2417 (setq c-state-min-scan-pos (point))))))
2418
2419 (defun c-state-mark-point-min-literal ()
2420 ;; Determine the properties of any literal containing POINT-MIN, setting the
2421 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2422 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2423 (let ((p-min (point-min))
2424 lit)
2425 (save-restriction
2426 (widen)
2427 (setq lit (c-state-literal-at p-min))
2428 (if lit
2429 (setq c-state-point-min-lit-type
2430 (save-excursion
2431 (goto-char (car lit))
2432 (cond
2433 ((looking-at c-block-comment-start-regexp) 'c)
2434 ((looking-at c-line-comment-starter) 'c++)
2435 (t 'string)))
2436 c-state-point-min-lit-start (car lit)
2437 c-state-min-scan-pos (cdr lit))
2438 (setq c-state-point-min-lit-type nil
2439 c-state-point-min-lit-start nil
2440 c-state-min-scan-pos p-min)))))
2441
2442
2443 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2444 ;; A variable which signals a brace dessert - helpful for reducing the number
2445 ;; of fruitless backward scans.
2446 (defvar c-state-brace-pair-desert nil)
2447 (make-variable-buffer-local 'c-state-brace-pair-desert)
2448 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2449 ;; that defun has searched backwards for a brace pair and not found one. Its
2450 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2451 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2452 ;; nil when at top level) and FROM is where the backward search started. It
2453 ;; is reset to nil in `c-invalidate-state-cache'.
2454
2455
2456 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2457 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2458 ;; list of like structure.
2459 (defmacro c-state-cache-top-lparen (&optional cache)
2460 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2461 ;; (default `c-state-cache') (or nil).
2462 (let ((cash (or cache 'c-state-cache)))
2463 `(if (consp (car ,cash))
2464 (caar ,cash)
2465 (car ,cash))))
2466
2467 (defmacro c-state-cache-top-paren (&optional cache)
2468 ;; Return the address of the latest brace/bracket/paren (whether left or
2469 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2470 (let ((cash (or cache 'c-state-cache)))
2471 `(if (consp (car ,cash))
2472 (cdar ,cash)
2473 (car ,cash))))
2474
2475 (defmacro c-state-cache-after-top-paren (&optional cache)
2476 ;; Return the position just after the latest brace/bracket/paren (whether
2477 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2478 (let ((cash (or cache 'c-state-cache)))
2479 `(if (consp (car ,cash))
2480 (cdar ,cash)
2481 (and (car ,cash)
2482 (1+ (car ,cash))))))
2483
2484 (defun c-get-cache-scan-pos (here)
2485 ;; From the state-cache, determine the buffer position from which we might
2486 ;; scan forward to HERE to update this cache. This position will be just
2487 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2488 ;; return the earliest position in the accessible region which isn't within
2489 ;; a literal. If the visible portion of the buffer is entirely within a
2490 ;; literal, return NIL.
2491 (let ((c c-state-cache) elt)
2492 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2493 (while (and c
2494 (>= (c-state-cache-top-lparen c) here))
2495 (setq c (cdr c)))
2496
2497 (setq elt (car c))
2498 (cond
2499 ((consp elt)
2500 (if (> (cdr elt) here)
2501 (1+ (car elt))
2502 (cdr elt)))
2503 (elt (1+ elt))
2504 ((<= (c-state-get-min-scan-pos) here)
2505 (c-state-get-min-scan-pos))
2506 (t nil))))
2507
2508 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2509 ;; Variables which keep track of preprocessor constructs.
2510 (defvar c-state-old-cpp-beg-marker nil)
2511 (make-variable-buffer-local 'c-state-old-cpp-beg-marker)
2512 (defvar c-state-old-cpp-beg nil)
2513 (make-variable-buffer-local 'c-state-old-cpp-beg)
2514 (defvar c-state-old-cpp-end-marker nil)
2515 (make-variable-buffer-local 'c-state-old-cpp-end-marker)
2516 (defvar c-state-old-cpp-end nil)
2517 (make-variable-buffer-local 'c-state-old-cpp-end)
2518 ;; These are the limits of the macro containing point at the previous call of
2519 ;; `c-parse-state', or nil.
2520
2521 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2522 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2523 (defun c-state-balance-parens-backwards (here- here+ top)
2524 ;; Return the position of the opening paren/brace/bracket before HERE- which
2525 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2526 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2527 ;;
2528 ;; ............................................
2529 ;; | |
2530 ;; ( [ ( .........#macro.. ) ( ) ] )
2531 ;; ^ ^ ^ ^
2532 ;; | | | |
2533 ;; return HERE- HERE+ TOP
2534 ;;
2535 ;; If there aren't enough opening paren/brace/brackets, return the position
2536 ;; of the outermost one found, or HERE- if there are none. If there are no
2537 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2538 ;; must not be inside literals. Only the accessible portion of the buffer
2539 ;; will be scanned.
2540
2541 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2542 ;; `here'. Go round the next loop each time we pass over such a ")". These
2543 ;; probably match "("s before `here-'.
2544 (let (pos pa ren+1 lonely-rens)
2545 (save-excursion
2546 (save-restriction
2547 (narrow-to-region (point-min) top) ; This can move point, sometimes.
2548 (setq pos here+)
2549 (c-safe
2550 (while
2551 (setq ren+1 (scan-lists pos 1 1)) ; might signal
2552 (setq lonely-rens (cons ren+1 lonely-rens)
2553 pos ren+1)))))
2554
2555 ;; PART 2: Scan back before `here-' searching for the "("s
2556 ;; matching/mismatching the ")"s found above. We only need to direct the
2557 ;; caller to scan when we've encountered unmatched right parens.
2558 (setq pos here-)
2559 (when lonely-rens
2560 (c-safe
2561 (while
2562 (and lonely-rens ; actual values aren't used.
2563 (setq pa (scan-lists pos -1 1)))
2564 (setq pos pa)
2565 (setq lonely-rens (cdr lonely-rens)))))
2566 pos))
2567
2568 (defun c-parse-state-get-strategy (here good-pos)
2569 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2570 ;; to minimize the amount of scanning. HERE is the pertinent position in
2571 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2572 ;; its head trimmed) is known to be good, or nil if there is no such
2573 ;; position.
2574 ;;
2575 ;; The return value is a list, one of the following:
2576 ;;
2577 ;; o - ('forward START-POINT) - scan forward from START-POINT,
2578 ;; which is not less than the highest position in `c-state-cache' below HERE,
2579 ;; which is after GOOD-POS.
2580 ;; o - ('backward nil) - scan backwards (from HERE).
2581 ;; o - ('back-and-forward START-POINT) - like 'forward, but when HERE is earlier
2582 ;; than GOOD-POS.
2583 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
2584 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
2585 strategy ; 'forward, 'backward, or 'IN-LIT.
2586 start-point)
2587 (setq good-pos (or good-pos (c-state-get-min-scan-pos)))
2588 (cond
2589 ((< here (c-state-get-min-scan-pos))
2590 (setq strategy 'IN-LIT))
2591 ((<= good-pos here)
2592 (setq strategy 'forward
2593 start-point (max good-pos cache-pos)))
2594 ((< (- good-pos here) (- here cache-pos)) ; FIXME!!! ; apply some sort of weighting.
2595 (setq strategy 'backward))
2596 (t
2597 (setq strategy 'back-and-forward
2598 start-point cache-pos)))
2599 (list strategy start-point)))
2600
2601
2602 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2603 ;; Routines which change `c-state-cache' and associated values.
2604 (defun c-renarrow-state-cache ()
2605 ;; The region (more precisely, point-min) has changed since we
2606 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2607 (if (< (point-min) c-state-point-min)
2608 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2609 ;; It would be possible to do a better job here and recalculate the top
2610 ;; only.
2611 (progn
2612 (c-state-mark-point-min-literal)
2613 (setq c-state-cache nil
2614 c-state-cache-good-pos c-state-min-scan-pos
2615 c-state-brace-pair-desert nil))
2616
2617 ;; point-min has MOVED FORWARD.
2618
2619 ;; Is the new point-min inside a (different) literal?
2620 (unless (and c-state-point-min-lit-start ; at prev. point-min
2621 (< (point-min) (c-state-get-min-scan-pos)))
2622 (c-state-mark-point-min-literal))
2623
2624 ;; Cut off a bit of the tail from `c-state-cache'.
2625 (let ((ptr (cons nil c-state-cache))
2626 pa)
2627 (while (and (setq pa (c-state-cache-top-lparen (cdr ptr)))
2628 (>= pa (point-min)))
2629 (setq ptr (cdr ptr)))
2630
2631 (when (consp ptr)
2632 (if (eq (cdr ptr) c-state-cache)
2633 (setq c-state-cache nil
2634 c-state-cache-good-pos c-state-min-scan-pos)
2635 (setcdr ptr nil)
2636 (setq c-state-cache-good-pos (1+ (c-state-cache-top-lparen))))
2637 )))
2638
2639 (setq c-state-point-min (point-min)))
2640
2641 (defun c-append-lower-brace-pair-to-state-cache (from here &optional upper-lim)
2642 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2643 ;; of nesting (not necessarily immediately preceding), push a cons onto
2644 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2645 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2646 ;; UPPER-LIM.
2647 ;;
2648 ;; Return non-nil when this has been done.
2649 ;;
2650 ;; The situation it copes with is this transformation:
2651 ;;
2652 ;; OLD: { (.) {...........}
2653 ;; ^ ^
2654 ;; FROM HERE
2655 ;;
2656 ;; NEW: { {....} (.) {.........
2657 ;; ^ ^ ^
2658 ;; LOWER BRACE PAIR HERE or HERE
2659 ;;
2660 ;; This routine should be fast. Since it can get called a LOT, we maintain
2661 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2662 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2663 (save-excursion
2664 (save-restriction
2665 (let* (new-cons
2666 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2667 (macro-start-or-from
2668 (progn (goto-char from)
2669 (c-beginning-of-macro)
2670 (point)))
2671 (bra ; Position of "{".
2672 ;; Don't start scanning in the middle of a CPP construct unless
2673 ;; it contains HERE - these constructs, in Emacs, are "commented
2674 ;; out" with category properties.
2675 (if (eq (c-get-char-property macro-start-or-from 'category)
2676 'c-cpp-delimiter)
2677 macro-start-or-from
2678 from))
2679 ce) ; Position of "}"
2680 (or upper-lim (setq upper-lim from))
2681
2682 ;; If we're essentially repeating a fruitless search, just give up.
2683 (unless (and c-state-brace-pair-desert
2684 (eq cache-pos (car c-state-brace-pair-desert))
2685 (or (null (car c-state-brace-pair-desert))
2686 (> from (car c-state-brace-pair-desert)))
2687 (<= from (cdr c-state-brace-pair-desert)))
2688 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2689 (let ((desert-lim
2690 (and c-state-brace-pair-desert
2691 (eq cache-pos (car c-state-brace-pair-desert))
2692 (>= from (cdr c-state-brace-pair-desert))
2693 (cdr c-state-brace-pair-desert)))
2694 ;; CACHE-LIM. This limit will be necessary when an opening
2695 ;; paren at `cache-pos' has just had its matching close paren
2696 ;; inserted into the buffer. `cache-pos' continues to be a
2697 ;; search bound, even though the algorithm below would skip
2698 ;; over the new paren pair.
2699 (cache-lim (and cache-pos (< cache-pos from) cache-pos)))
2700 (narrow-to-region
2701 (cond
2702 ((and desert-lim cache-lim)
2703 (max desert-lim cache-lim))
2704 (desert-lim)
2705 (cache-lim)
2706 ((point-min)))
2707 ;; The top limit is EOB to ensure that `bra' is inside the
2708 ;; accessible part of the buffer at the next scan operation.
2709 (1+ (buffer-size))))
2710
2711 ;; In the next pair of nested loops, the inner one moves back past a
2712 ;; pair of (mis-)matching parens or brackets; the outer one moves
2713 ;; back over a sequence of unmatched close brace/paren/bracket each
2714 ;; time round.
2715 (while
2716 (progn
2717 (c-safe
2718 (while
2719 (and (setq ce (scan-lists bra -1 -1)) ; back past )/]/}; might signal
2720 (setq bra (scan-lists ce -1 1)) ; back past (/[/{; might signal
2721 (or (> bra here) ;(> ce here)
2722 (and
2723 (< ce here)
2724 (or (not (eq (char-after bra) ?\{))
2725 (and (goto-char bra)
2726 (c-beginning-of-macro)
2727 (< (point) macro-start-or-from))))))))
2728 (and ce (< ce bra)))
2729 (setq bra ce)) ; If we just backed over an unbalanced closing
2730 ; brace, ignore it.
2731
2732 (if (and ce (< ce here) (< bra ce) (eq (char-after bra) ?\{))
2733 ;; We've found the desired brace-pair.
2734 (progn
2735 (setq new-cons (cons bra (1+ ce)))
2736 (cond
2737 ((consp (car c-state-cache))
2738 (setcar c-state-cache new-cons))
2739 ((and (numberp (car c-state-cache)) ; probably never happens
2740 (< ce (car c-state-cache)))
2741 (setcdr c-state-cache
2742 (cons new-cons (cdr c-state-cache))))
2743 (t (setq c-state-cache (cons new-cons c-state-cache)))))
2744
2745 ;; We haven't found a brace pair. Record this in the cache.
2746 (setq c-state-brace-pair-desert
2747 (cons (if (and ce (< bra ce) (> ce here)) ; {..} straddling HERE?
2748 bra
2749 (point-min))
2750 (min here from)))))))))
2751
2752 (defsubst c-state-push-any-brace-pair (bra+1 macro-start-or-here)
2753 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2754 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2755 ;; "push" "a" brace pair onto `c-state-cache'.
2756 ;;
2757 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2758 ;; otherwise push it normally.
2759 ;;
2760 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2761 ;; latter is inside a macro, not being a macro containing
2762 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2763 ;; base pair. This latter case is assumed to be rare.
2764 ;;
2765 ;; Note: POINT is not preserved in this routine.
2766 (if bra+1
2767 (if (or (> bra+1 macro-start-or-here)
2768 (progn (goto-char bra+1)
2769 (not (c-beginning-of-macro))))
2770 (setq c-state-cache
2771 (cons (cons (1- bra+1)
2772 (scan-lists bra+1 1 1))
2773 (if (consp (car c-state-cache))
2774 (cdr c-state-cache)
2775 c-state-cache)))
2776 ;; N.B. This defsubst codes one method for the simple, normal case,
2777 ;; and a more sophisticated, slower way for the general case. Don't
2778 ;; eliminate this defsubst - it's a speed optimization.
2779 (c-append-lower-brace-pair-to-state-cache (1- bra+1) (point-max)))))
2780
2781 (defun c-append-to-state-cache (from here)
2782 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
2783 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
2784 ;;
2785 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2786 ;; any. Typically, it is immediately after it. It must not be inside a
2787 ;; literal.
2788 (let ((here-bol (c-point 'bol here))
2789 (macro-start-or-here
2790 (save-excursion (goto-char here)
2791 (if (c-beginning-of-macro)
2792 (point)
2793 here)))
2794 pa+1 ; pos just after an opening PAren (or brace).
2795 (ren+1 from) ; usually a pos just after an closing paREN etc.
2796 ; Is actually the pos. to scan for a (/{/[ from,
2797 ; which sometimes is after a silly )/}/].
2798 paren+1 ; Pos after some opening or closing paren.
2799 paren+1s ; A list of `paren+1's; used to determine a
2800 ; good-pos.
2801 bra+1 ; just after L bra-ce.
2802 bra+1s ; list of OLD values of bra+1.
2803 mstart) ; start of a macro.
2804
2805 (save-excursion
2806 (save-restriction
2807 (narrow-to-region (point-min) here)
2808 ;; Each time round the following loop, we enter a successively deeper
2809 ;; level of brace/paren nesting. (Except sometimes we "continue at
2810 ;; the existing level".) `pa+1' is a pos inside an opening
2811 ;; brace/paren/bracket, usually just after it.
2812 (while
2813 (progn
2814 ;; Each time round the next loop moves forward over an opening then
2815 ;; a closing brace/bracket/paren. This loop is white hot, so it
2816 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2817 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2818 ;; call of `scan-lists' signals an error, which happens when there
2819 ;; are no more b/b/p's to scan.
2820 (c-safe
2821 (while t
2822 (setq pa+1 (scan-lists ren+1 1 -1) ; Into (/{/[; might signal
2823 paren+1s (cons pa+1 paren+1s))
2824 (setq ren+1 (scan-lists pa+1 1 1)) ; Out of )/}/]; might signal
2825 (if (and (eq (char-before pa+1) ?{)) ; Check for a macro later.
2826 (setq bra+1 pa+1))
2827 (setcar paren+1s ren+1)))
2828
2829 (if (and pa+1 (> pa+1 ren+1))
2830 ;; We've just entered a deeper nesting level.
2831 (progn
2832 ;; Insert the brace pair (if present) and the single open
2833 ;; paren/brace/bracket into `c-state-cache' It cannot be
2834 ;; inside a macro, except one around point, because of what
2835 ;; `c-neutralize-syntax-in-CPP' has done.
2836 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2837 ;; Insert the opening brace/bracket/paren position.
2838 (setq c-state-cache (cons (1- pa+1) c-state-cache))
2839 ;; Clear admin stuff for the next more nested part of the scan.
2840 (setq ren+1 pa+1 pa+1 nil bra+1 nil bra+1s nil)
2841 t) ; Carry on the loop
2842
2843 ;; All open p/b/b's at this nesting level, if any, have probably
2844 ;; been closed by matching/mismatching ones. We're probably
2845 ;; finished - we just need to check for having found an
2846 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2847 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2848 (c-safe (setq ren+1 (scan-lists ren+1 1 1)))))) ; acts as loop control.
2849
2850 ;; Record the final, innermost, brace-pair if there is one.
2851 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2852
2853 ;; Determine a good pos
2854 (while (and (setq paren+1 (car paren+1s))
2855 (> (if (> paren+1 macro-start-or-here)
2856 paren+1
2857 (goto-char paren+1)
2858 (setq mstart (and (c-beginning-of-macro)
2859 (point)))
2860 (or mstart paren+1))
2861 here-bol))
2862 (setq paren+1s (cdr paren+1s)))
2863 (cond
2864 ((and paren+1 mstart)
2865 (min paren+1 mstart))
2866 (paren+1)
2867 (t from))))))
2868
2869 (defun c-remove-stale-state-cache (start-point here pps-point)
2870 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2871 ;; not be in it when it is amended for position HERE. This may involve
2872 ;; replacing a CONS element for a brace pair containing HERE with its car.
2873 ;; Additionally, the "outermost" open-brace entry before HERE will be
2874 ;; converted to a cons if the matching close-brace is below HERE.
2875 ;;
2876 ;; START-POINT is a "maximal" "safe position" - there must be no open
2877 ;; parens/braces/brackets between START-POINT and HERE.
2878 ;;
2879 ;; As a second thing, calculate the result of parse-partial-sexp at
2880 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
2881 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2882 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2883 ;; needs to be FAST).
2884 ;;
2885 ;; Return a list (GOOD-POS SCAN-BACK-POS CONS-SEPARATED PPS-STATE), where
2886 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2887 ;; to be good (we aim for this to be as high as possible);
2888 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2889 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2890 ;; position to scan backwards from. It is the position of the "{" of the
2891 ;; last element to be removed from `c-state-cache', when that elt is a
2892 ;; cons, otherwise nil.
2893 ;; o - CONS-SEPARATED is t when a cons element in `c-state-cache' has been
2894 ;; replaced by its car because HERE lies inside the brace pair represented
2895 ;; by the cons.
2896 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2897 (save-excursion
2898 (save-restriction
2899 (narrow-to-region 1 (point-max))
2900 (let* ((in-macro-start ; start of macro containing HERE or nil.
2901 (save-excursion
2902 (goto-char here)
2903 (and (c-beginning-of-macro)
2904 (point))))
2905 (start-point-actual-macro-start ; Start of macro containing
2906 ; start-point or nil
2907 (and (< start-point here)
2908 (save-excursion
2909 (goto-char start-point)
2910 (and (c-beginning-of-macro)
2911 (point)))))
2912 (start-point-actual-macro-end ; End of this macro, (maybe
2913 ; HERE), or nil.
2914 (and start-point-actual-macro-start
2915 (save-excursion
2916 (goto-char start-point-actual-macro-start)
2917 (c-end-of-macro)
2918 (point))))
2919 pps-state ; Will be 9 or 10 elements long.
2920 pos
2921 upper-lim ; ,beyond which `c-state-cache' entries are removed
2922 scan-back-pos
2923 cons-separated
2924 pair-beg pps-point-state target-depth)
2925
2926 ;; Remove entries beyond HERE. Also remove any entries inside
2927 ;; a macro, unless HERE is in the same macro.
2928 (setq upper-lim
2929 (if (or (null c-state-old-cpp-beg)
2930 (and (> here c-state-old-cpp-beg)
2931 (< here c-state-old-cpp-end)))
2932 here
2933 (min here c-state-old-cpp-beg)))
2934 (while (and c-state-cache (>= (c-state-cache-top-lparen) upper-lim))
2935 (setq scan-back-pos (car-safe (car c-state-cache)))
2936 (setq c-state-cache (cdr c-state-cache)))
2937
2938 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2939 ;; RBrace and indicate we'll need to search backwards for a previous
2940 ;; brace pair.
2941 (when (and c-state-cache
2942 (consp (car c-state-cache))
2943 (> (cdar c-state-cache) upper-lim))
2944 (setcar c-state-cache (caar c-state-cache))
2945 (setq scan-back-pos (car c-state-cache)
2946 cons-separated t))
2947
2948 ;; The next loop jumps forward out of a nested level of parens each
2949 ;; time round; the corresponding elements in `c-state-cache' are
2950 ;; removed. `pos' is just after the brace-pair or the open paren at
2951 ;; (car c-state-cache). There can be no open parens/braces/brackets
2952 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
2953 ;; due to the interface spec to this function.
2954 (setq pos (if (and start-point-actual-macro-end
2955 (not (eq start-point-actual-macro-start
2956 in-macro-start)))
2957 (1+ start-point-actual-macro-end) ; get outside the macro as
2958 ; marked by a `category' text property.
2959 start-point))
2960 (goto-char pos)
2961 (while (and c-state-cache
2962 (or (numberp (car c-state-cache)) ; Have we a { at all?
2963 (cdr c-state-cache))
2964 (< (point) here))
2965 (cond
2966 ((null pps-state) ; first time through
2967 (setq target-depth -1))
2968 ((eq (car pps-state) target-depth) ; found closing ),},]
2969 (setq target-depth (1- (car pps-state))))
2970 ;; Do nothing when we've merely reached pps-point.
2971 )
2972
2973 ;; Scan!
2974 (setq pps-state
2975 (parse-partial-sexp
2976 (point) (if (< (point) pps-point) pps-point here)
2977 target-depth
2978 nil pps-state))
2979
2980 (if (= (point) pps-point)
2981 (setq pps-point-state pps-state))
2982
2983 (when (eq (car pps-state) target-depth)
2984 (setq pos (point)) ; POS is now just after an R-paren/brace.
2985 (cond
2986 ((and (consp (car c-state-cache))
2987 (eq (point) (cdar c-state-cache)))
2988 ;; We've just moved out of the paren pair containing the brace-pair
2989 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
2990 ;; and is potentially where the open brace of a cons in
2991 ;; c-state-cache will be.
2992 (setq pair-beg (car-safe (cdr c-state-cache))
2993 c-state-cache (cdr-safe (cdr c-state-cache)))) ; remove {}pair + containing Lparen.
2994 ((numberp (car c-state-cache))
2995 (setq pair-beg (car c-state-cache)
2996 c-state-cache (cdr c-state-cache))) ; remove this
2997 ; containing Lparen
2998 ((numberp (cadr c-state-cache))
2999 (setq pair-beg (cadr c-state-cache)
3000 c-state-cache (cddr c-state-cache))) ; Remove a paren pair
3001 ; together with enclosed brace pair.
3002 ;; (t nil) ; Ignore an unmated Rparen.
3003 )))
3004
3005 (if (< (point) pps-point)
3006 (setq pps-state (parse-partial-sexp (point) pps-point
3007 nil nil ; TARGETDEPTH, STOPBEFORE
3008 pps-state)))
3009
3010 ;; If the last paren pair we moved out of was actually a brace pair,
3011 ;; insert it into `c-state-cache'.
3012 (when (and pair-beg (eq (char-after pair-beg) ?{))
3013 (if (consp (car-safe c-state-cache))
3014 (setq c-state-cache (cdr c-state-cache)))
3015 (setq c-state-cache (cons (cons pair-beg pos)
3016 c-state-cache)))
3017
3018 (list pos scan-back-pos cons-separated pps-state)))))
3019
3020 (defun c-remove-stale-state-cache-backwards (here)
3021 ;; Strip stale elements of `c-state-cache' by moving backwards through the
3022 ;; buffer, and inform the caller of the scenario detected.
3023 ;;
3024 ;; HERE is the position we're setting `c-state-cache' for.
3025 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
3026 ;; position in `c-state-cache' before HERE, or a position at or near
3027 ;; point-min which isn't in a literal.
3028 ;;
3029 ;; This function must only be called only when (> `c-state-cache-good-pos'
3030 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
3031 ;; optimized to eliminate (or minimize) scanning between these two
3032 ;; positions.
3033 ;;
3034 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3035 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3036 ;; could become so after missing elements are inserted into
3037 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3038 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3039 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3040 ;; before `here''s line, or the start of the literal containing it.
3041 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3042 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3043 ;; to scan backwards from.
3044 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3045 ;; POS and HERE which aren't recorded in `c-state-cache'.
3046 ;;
3047 ;; The comments in this defun use "paren" to mean parenthesis or square
3048 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3049 ;;
3050 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3051 ;; | | | | | |
3052 ;; CP E here D C good
3053 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
3054 (pos c-state-cache-good-pos)
3055 pa ren ; positions of "(" and ")"
3056 dropped-cons ; whether the last element dropped from `c-state-cache'
3057 ; was a cons (representing a brace-pair)
3058 good-pos ; see above.
3059 lit ; (START . END) of a literal containing some point.
3060 here-lit-start here-lit-end ; bounds of literal containing `here'
3061 ; or `here' itself.
3062 here- here+ ; start/end of macro around HERE, or HERE
3063 (here-bol (c-point 'bol here))
3064 (too-far-back (max (- here c-state-cache-too-far) (point-min))))
3065
3066 ;; Remove completely irrelevant entries from `c-state-cache'.
3067 (while (and c-state-cache
3068 (>= (setq pa (c-state-cache-top-lparen)) here))
3069 (setq dropped-cons (consp (car c-state-cache)))
3070 (setq c-state-cache (cdr c-state-cache))
3071 (setq pos pa))
3072 ;; At this stage, (> pos here);
3073 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3074
3075 (cond
3076 ((and (consp (car c-state-cache))
3077 (> (cdar c-state-cache) here))
3078 ;; CASE 1: The top of the cache is a brace pair which now encloses
3079 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3080 ;; knowledge of what's inside these braces, we have no alternative but
3081 ;; to direct the caller to scan the buffer from the opening brace.
3082 (setq pos (caar c-state-cache))
3083 (setcar c-state-cache pos)
3084 (list (1+ pos) pos t)) ; return value. We've just converted a brace pair
3085 ; entry into a { entry, so the caller needs to
3086 ; search for a brace pair before the {.
3087
3088 ;; `here' might be inside a literal. Check for this.
3089 ((progn
3090 (setq lit (c-state-literal-at here)
3091 here-lit-start (or (car lit) here)
3092 here-lit-end (or (cdr lit) here))
3093 ;; Has `here' just "newly entered" a macro?
3094 (save-excursion
3095 (goto-char here-lit-start)
3096 (if (and (c-beginning-of-macro)
3097 (or (null c-state-old-cpp-beg)
3098 (not (= (point) c-state-old-cpp-beg))))
3099 (progn
3100 (setq here- (point))
3101 (c-end-of-macro)
3102 (setq here+ (point)))
3103 (setq here- here-lit-start
3104 here+ here-lit-end)))
3105
3106 ;; `here' might be nested inside any depth of parens (or brackets but
3107 ;; not braces). Scan backwards to find the outermost such opening
3108 ;; paren, if there is one. This will be the scan position to return.
3109 (save-restriction
3110 (narrow-to-region cache-pos (point-max))
3111 (setq pos (c-state-balance-parens-backwards here- here+ pos)))
3112 nil)) ; for the cond
3113
3114 ((< pos here-lit-start)
3115 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3116 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3117 ;; a brace pair preceding this, it will already be in `c-state-cache',
3118 ;; unless there was a brace pair after it, i.e. there'll only be one to
3119 ;; scan for if we've just deleted one.
3120 (list pos (and dropped-cons pos) t)) ; Return value.
3121
3122 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3123 ;; Further forward scanning isn't needed, but we still need to find a
3124 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3125 ((progn
3126 (save-restriction
3127 (narrow-to-region here-bol (point-max))
3128 (setq pos here-lit-start)
3129 (c-safe (while (setq pa (scan-lists pos -1 1))
3130 (setq pos pa)))) ; might signal
3131 nil)) ; for the cond
3132
3133 ((setq ren (c-safe-scan-lists pos -1 -1 too-far-back))
3134 ;; CASE 3: After a }/)/] before `here''s BOL.
3135 (list (1+ ren) (and dropped-cons pos) nil)) ; Return value
3136
3137 (t
3138 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3139 ;; literal containing it.
3140 (setq good-pos (c-state-lit-beg (c-point 'bopl here-bol)))
3141 (list good-pos (and dropped-cons good-pos) nil)))))
3142
3143
3144 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3145 ;; Externally visible routines.
3146
3147 (defun c-state-cache-init ()
3148 (setq c-state-cache nil
3149 c-state-cache-good-pos 1
3150 c-state-nonlit-pos-cache nil
3151 c-state-nonlit-pos-cache-limit 1
3152 c-state-semi-nonlit-pos-cache nil
3153 c-state-semi-nonlit-pos-cache-limit 1
3154 c-state-brace-pair-desert nil
3155 c-state-point-min 1
3156 c-state-point-min-lit-type nil
3157 c-state-point-min-lit-start nil
3158 c-state-min-scan-pos 1
3159 c-state-old-cpp-beg nil
3160 c-state-old-cpp-end nil)
3161 (c-state-mark-point-min-literal))
3162
3163 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3164 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3165 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3166 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3167 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3168 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3169 ;; (defun c-state-dump ()
3170 ;; ;; For debugging.
3171 ;; ;(message
3172 ;; (concat
3173 ;; (c-sc-qde c-state-cache)
3174 ;; (c-sc-de c-state-cache-good-pos)
3175 ;; (c-sc-qde c-state-nonlit-pos-cache)
3176 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3177 ;; (c-sc-qde c-state-brace-pair-desert)
3178 ;; (c-sc-de c-state-point-min)
3179 ;; (c-sc-de c-state-point-min-lit-type)
3180 ;; (c-sc-de c-state-point-min-lit-start)
3181 ;; (c-sc-de c-state-min-scan-pos)
3182 ;; (c-sc-de c-state-old-cpp-beg)
3183 ;; (c-sc-de c-state-old-cpp-end)))
3184 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3185
3186 (defun c-invalidate-state-cache-1 (here)
3187 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3188 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3189 ;; left in a consistent state.
3190 ;;
3191 ;; This is much like `c-whack-state-after', but it never changes a paren
3192 ;; pair element into an open paren element. Doing that would mean that the
3193 ;; new open paren wouldn't have the required preceding paren pair element.
3194 ;;
3195 ;; This function is called from c-after-change.
3196
3197 ;; The caches of non-literals:
3198 ;; Note that we use "<=" for the possibility of the second char of a two-char
3199 ;; comment opener being typed; this would invalidate any cache position at
3200 ;; HERE.
3201 (if (<= here c-state-nonlit-pos-cache-limit)
3202 (setq c-state-nonlit-pos-cache-limit (1- here)))
3203 (if (<= here c-state-semi-nonlit-pos-cache-limit)
3204 (setq c-state-semi-nonlit-pos-cache-limit (1- here)))
3205
3206 ;; `c-state-cache':
3207 ;; Case 1: if `here' is in a literal containing point-min, everything
3208 ;; becomes (or is already) nil.
3209 (if (or (null c-state-cache-good-pos)
3210 (< here (c-state-get-min-scan-pos)))
3211 (setq c-state-cache nil
3212 c-state-cache-good-pos nil
3213 c-state-min-scan-pos nil)
3214
3215 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3216 ;; below `here'. To maintain its consistency, we may need to insert a new
3217 ;; brace pair.
3218 (let (open-paren-in-column-0-is-defun-start
3219 (here-bol (c-point 'bol here))
3220 too-high-pa ; recorded {/(/[ next above here, or nil.
3221 dropped-cons ; was the last removed element a brace pair?
3222 pa)
3223 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3224 (while (and c-state-cache
3225 (>= (setq pa (c-state-cache-top-paren)) here))
3226 (setq dropped-cons (consp (car c-state-cache))
3227 too-high-pa (c-state-cache-top-lparen)
3228 c-state-cache (cdr c-state-cache)))
3229
3230 ;; Do we need to add in an earlier brace pair, having lopped one off?
3231 (if (and dropped-cons
3232 (< too-high-pa (+ here c-state-cache-too-far)))
3233 (c-append-lower-brace-pair-to-state-cache too-high-pa here here-bol))
3234 (setq c-state-cache-good-pos (or (c-state-cache-after-top-paren)
3235 (c-state-get-min-scan-pos)))))
3236
3237 ;; The brace-pair desert marker:
3238 (when (car c-state-brace-pair-desert)
3239 (if (< here (car c-state-brace-pair-desert))
3240 (setq c-state-brace-pair-desert nil)
3241 (if (< here (cdr c-state-brace-pair-desert))
3242 (setcdr c-state-brace-pair-desert here)))))
3243
3244 (defun c-parse-state-1 ()
3245 ;; Find and record all noteworthy parens between some good point earlier in
3246 ;; the file and point. That good point is at least the beginning of the
3247 ;; top-level construct we are in, or the beginning of the preceding
3248 ;; top-level construct if we aren't in one.
3249 ;;
3250 ;; The returned value is a list of the noteworthy parens with the last one
3251 ;; first. If an element in the list is an integer, it's the position of an
3252 ;; open paren (of any type) which has not been closed before the point. If
3253 ;; an element is a cons, it gives the position of a closed BRACE paren
3254 ;; pair[*]; the car is the start brace position and the cdr is the position
3255 ;; following the closing brace. Only the last closed brace paren pair
3256 ;; before each open paren and before the point is recorded, and thus the
3257 ;; state never contains two cons elements in succession. When a close brace
3258 ;; has no matching open brace (e.g., the matching brace is outside the
3259 ;; visible region), it is not represented in the returned value.
3260 ;;
3261 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3262 ;; This defun explicitly treats mismatching parens/braces/brackets as
3263 ;; matching. It is the open brace which makes it a "brace" pair.
3264 ;;
3265 ;; If POINT is within a macro, open parens and brace pairs within
3266 ;; THIS macro MIGHT be recorded. This depends on whether their
3267 ;; syntactic properties have been suppressed by
3268 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3269 ;;
3270 ;; Currently no characters which are given paren syntax with the
3271 ;; syntax-table property are recorded, i.e. angle bracket arglist
3272 ;; parens are never present here. Note that this might change.
3273 ;;
3274 ;; BUG: This function doesn't cope entirely well with unbalanced
3275 ;; parens in macros. (2008-12-11: this has probably been resolved
3276 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3277 ;; following case the brace before the macro isn't balanced with the
3278 ;; one after it:
3279 ;;
3280 ;; {
3281 ;; #define X {
3282 ;; }
3283 ;;
3284 ;; Note to maintainers: this function DOES get called with point
3285 ;; within comments and strings, so don't assume it doesn't!
3286 ;;
3287 ;; This function might do hidden buffer changes.
3288 (let* ((here (point))
3289 (here-bopl (c-point 'bopl))
3290 open-paren-in-column-0-is-defun-start
3291 strategy ; 'forward, 'backward etc..
3292 ;; Candidate positions to start scanning from:
3293 cache-pos ; highest position below HERE already existing in
3294 ; cache (or 1).
3295 good-pos
3296 start-point ; (when scanning forward) a place below HERE where there
3297 ; are no open parens/braces between it and HERE.
3298 bopl-state
3299 res
3300 cons-separated
3301 scan-backward-pos scan-forward-p) ; used for 'backward.
3302 ;; If POINT-MIN has changed, adjust the cache
3303 (unless (= (point-min) c-state-point-min)
3304 (c-renarrow-state-cache))
3305
3306 ;; Strategy?
3307 (setq res (c-parse-state-get-strategy here c-state-cache-good-pos)
3308 strategy (car res)
3309 start-point (cadr res))
3310
3311 ;; SCAN!
3312 (cond
3313 ((memq strategy '(forward back-and-forward))
3314 (setq res (c-remove-stale-state-cache start-point here here-bopl))
3315 (setq cache-pos (car res)
3316 scan-backward-pos (cadr res)
3317 cons-separated (car (cddr res))
3318 bopl-state (cadr (cddr res))) ; will be nil if (< here-bopl
3319 ; start-point)
3320 (if (and scan-backward-pos
3321 (or cons-separated (eq strategy 'forward))) ;scan-backward-pos
3322 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3323 (setq good-pos
3324 (c-append-to-state-cache cache-pos here))
3325 (setq c-state-cache-good-pos
3326 (if (and bopl-state
3327 (< good-pos (- here c-state-cache-too-far)))
3328 (c-state-cache-non-literal-place here-bopl bopl-state)
3329 good-pos)))
3330
3331 ((eq strategy 'backward)
3332 (setq res (c-remove-stale-state-cache-backwards here)
3333 good-pos (car res)
3334 scan-backward-pos (cadr res)
3335 scan-forward-p (car (cddr res)))
3336 (if scan-backward-pos
3337 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3338 (setq c-state-cache-good-pos
3339 (if scan-forward-p
3340 (c-append-to-state-cache good-pos here)
3341 good-pos)))
3342
3343 (t ; (eq strategy 'IN-LIT)
3344 (setq c-state-cache nil
3345 c-state-cache-good-pos nil))))
3346
3347 c-state-cache)
3348
3349 (defun c-invalidate-state-cache (here)
3350 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3351 ;;
3352 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3353 ;; of all parens in preprocessor constructs, except for any such construct
3354 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3355 ;; worrying further about macros and template delimiters.
3356 (c-with-<->-as-parens-suppressed
3357 (if (and c-state-old-cpp-beg
3358 (< c-state-old-cpp-beg here))
3359 (c-with-all-but-one-cpps-commented-out
3360 c-state-old-cpp-beg
3361 (min c-state-old-cpp-end here)
3362 (c-invalidate-state-cache-1 here))
3363 (c-with-cpps-commented-out
3364 (c-invalidate-state-cache-1 here)))))
3365
3366 (defmacro c-state-maybe-marker (place marker)
3367 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3368 ;; We (re)use MARKER.
3369 `(and ,place
3370 (or ,marker (setq ,marker (make-marker)))
3371 (set-marker ,marker ,place)))
3372
3373 (defun c-parse-state ()
3374 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3375 ;; description of the functionality and return value.
3376 ;;
3377 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3378 ;; of all parens in preprocessor constructs, except for any such construct
3379 ;; containing point. We can then call `c-parse-state-1' without worrying
3380 ;; further about macros and template delimiters.
3381 (let (here-cpp-beg here-cpp-end)
3382 (save-excursion
3383 (when (c-beginning-of-macro)
3384 (setq here-cpp-beg (point))
3385 (unless
3386 (> (setq here-cpp-end (c-syntactic-end-of-macro))
3387 here-cpp-beg)
3388 (setq here-cpp-beg nil here-cpp-end nil))))
3389 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3390 ;; subsystem.
3391 (prog1
3392 (c-with-<->-as-parens-suppressed
3393 (if (and here-cpp-beg (> here-cpp-end here-cpp-beg))
3394 (c-with-all-but-one-cpps-commented-out
3395 here-cpp-beg here-cpp-end
3396 (c-parse-state-1))
3397 (c-with-cpps-commented-out
3398 (c-parse-state-1))))
3399 (setq c-state-old-cpp-beg
3400 (c-state-maybe-marker here-cpp-beg c-state-old-cpp-beg-marker)
3401 c-state-old-cpp-end
3402 (c-state-maybe-marker here-cpp-end c-state-old-cpp-end-marker)))))
3403
3404 ;; Debug tool to catch cache inconsistencies. This is called from
3405 ;; 000tests.el.
3406 (defvar c-debug-parse-state nil)
3407 (unless (fboundp 'c-real-parse-state)
3408 (fset 'c-real-parse-state (symbol-function 'c-parse-state)))
3409 (cc-bytecomp-defun c-real-parse-state)
3410
3411 (defvar c-parse-state-point nil)
3412 (defvar c-parse-state-state nil)
3413 (make-variable-buffer-local 'c-parse-state-state)
3414 (defun c-record-parse-state-state ()
3415 (setq c-parse-state-point (point))
3416 (setq c-parse-state-state
3417 (mapcar
3418 (lambda (arg)
3419 (let ((val (symbol-value arg)))
3420 (cons arg
3421 (if (consp val)
3422 (copy-tree val)
3423 val))))
3424 '(c-state-cache
3425 c-state-cache-good-pos
3426 c-state-nonlit-pos-cache
3427 c-state-nonlit-pos-cache-limit
3428 c-state-semi-nonlit-pos-cache
3429 c-state-semi-nonlit-pos-cache-limit
3430 c-state-brace-pair-desert
3431 c-state-point-min
3432 c-state-point-min-lit-type
3433 c-state-point-min-lit-start
3434 c-state-min-scan-pos
3435 c-state-old-cpp-beg
3436 c-state-old-cpp-end
3437 c-parse-state-point))))
3438 (defun c-replay-parse-state-state ()
3439 (message
3440 (concat "(setq "
3441 (mapconcat
3442 (lambda (arg)
3443 (format "%s %s%s" (car arg) (if (atom (cdr arg)) "" "'") (cdr arg)))
3444 c-parse-state-state " ")
3445 ")")))
3446
3447 (defun c-debug-parse-state-double-cons (state)
3448 (let (state-car conses-not-ok)
3449 (while state
3450 (setq state-car (car state)
3451 state (cdr state))
3452 (if (and (consp state-car)
3453 (consp (car state)))
3454 (setq conses-not-ok t)))
3455 conses-not-ok))
3456
3457 (defun c-debug-parse-state ()
3458 (let ((here (point)) (res1 (c-real-parse-state)) res2)
3459 (let ((c-state-cache nil)
3460 (c-state-cache-good-pos 1)
3461 (c-state-nonlit-pos-cache nil)
3462 (c-state-nonlit-pos-cache-limit 1)
3463 (c-state-brace-pair-desert nil)
3464 (c-state-point-min 1)
3465 (c-state-point-min-lit-type nil)
3466 (c-state-point-min-lit-start nil)
3467 (c-state-min-scan-pos 1)
3468 (c-state-old-cpp-beg nil)
3469 (c-state-old-cpp-end nil))
3470 (setq res2 (c-real-parse-state)))
3471 (unless (equal res1 res2)
3472 ;; The cache can actually go further back due to the ad-hoc way
3473 ;; the first paren is found, so try to whack off a bit of its
3474 ;; start before complaining.
3475 ;; (save-excursion
3476 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3477 ;; (c-beginning-of-defun-1)
3478 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3479 ;; (c-beginning-of-defun-1))
3480 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3481 ;; (message (concat "c-parse-state inconsistency at %s: "
3482 ;; "using cache: %s, from scratch: %s")
3483 ;; here res1 res2)))
3484 (message (concat "c-parse-state inconsistency at %s: "
3485 "using cache: %s, from scratch: %s")
3486 here res1 res2)
3487 (message "Old state:")
3488 (c-replay-parse-state-state))
3489
3490 (when (c-debug-parse-state-double-cons res1)
3491 (message "c-parse-state INVALIDITY at %s: %s"
3492 here res1)
3493 (message "Old state:")
3494 (c-replay-parse-state-state))
3495
3496 (c-record-parse-state-state)
3497 res2 ; res1 correct a cascading series of errors ASAP
3498 ))
3499
3500 (defun c-toggle-parse-state-debug (&optional arg)
3501 (interactive "P")
3502 (setq c-debug-parse-state (c-calculate-state arg c-debug-parse-state))
3503 (fset 'c-parse-state (symbol-function (if c-debug-parse-state
3504 'c-debug-parse-state
3505 'c-real-parse-state)))
3506 (c-keep-region-active)
3507 (message "c-debug-parse-state %sabled"
3508 (if c-debug-parse-state "en" "dis")))
3509 (when c-debug-parse-state
3510 (c-toggle-parse-state-debug 1))
3511
3512 \f
3513 (defun c-whack-state-before (bufpos paren-state)
3514 ;; Whack off any state information from PAREN-STATE which lies
3515 ;; before BUFPOS. Not destructive on PAREN-STATE.
3516 (let* ((newstate (list nil))
3517 (ptr newstate)
3518 car)
3519 (while paren-state
3520 (setq car (car paren-state)
3521 paren-state (cdr paren-state))
3522 (if (< (if (consp car) (car car) car) bufpos)
3523 (setq paren-state nil)
3524 (setcdr ptr (list car))
3525 (setq ptr (cdr ptr))))
3526 (cdr newstate)))
3527
3528 (defun c-whack-state-after (bufpos paren-state)
3529 ;; Whack off any state information from PAREN-STATE which lies at or
3530 ;; after BUFPOS. Not destructive on PAREN-STATE.
3531 (catch 'done
3532 (while paren-state
3533 (let ((car (car paren-state)))
3534 (if (consp car)
3535 ;; just check the car, because in a balanced brace
3536 ;; expression, it must be impossible for the corresponding
3537 ;; close brace to be before point, but the open brace to
3538 ;; be after.
3539 (if (<= bufpos (car car))
3540 nil ; whack it off
3541 (if (< bufpos (cdr car))
3542 ;; its possible that the open brace is before
3543 ;; bufpos, but the close brace is after. In that
3544 ;; case, convert this to a non-cons element. The
3545 ;; rest of the state is before bufpos, so we're
3546 ;; done.
3547 (throw 'done (cons (car car) (cdr paren-state)))
3548 ;; we know that both the open and close braces are
3549 ;; before bufpos, so we also know that everything else
3550 ;; on state is before bufpos.
3551 (throw 'done paren-state)))
3552 (if (<= bufpos car)
3553 nil ; whack it off
3554 ;; it's before bufpos, so everything else should too.
3555 (throw 'done paren-state)))
3556 (setq paren-state (cdr paren-state)))
3557 nil)))
3558
3559 (defun c-most-enclosing-brace (paren-state &optional bufpos)
3560 ;; Return the bufpos of the innermost enclosing open paren before
3561 ;; bufpos, or nil if none was found.
3562 (let (enclosingp)
3563 (or bufpos (setq bufpos 134217727))
3564 (while paren-state
3565 (setq enclosingp (car paren-state)
3566 paren-state (cdr paren-state))
3567 (if (or (consp enclosingp)
3568 (>= enclosingp bufpos))
3569 (setq enclosingp nil)
3570 (setq paren-state nil)))
3571 enclosingp))
3572
3573 (defun c-least-enclosing-brace (paren-state)
3574 ;; Return the bufpos of the outermost enclosing open paren, or nil
3575 ;; if none was found.
3576 (let (pos elem)
3577 (while paren-state
3578 (setq elem (car paren-state)
3579 paren-state (cdr paren-state))
3580 (if (integerp elem)
3581 (setq pos elem)))
3582 pos))
3583
3584 (defun c-safe-position (bufpos paren-state)
3585 ;; Return the closest "safe" position recorded on PAREN-STATE that
3586 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3587 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3588 ;; find the closest limit before a given limit that might be nil.
3589 ;;
3590 ;; A "safe" position is a position at or after a recorded open
3591 ;; paren, or after a recorded close paren. The returned position is
3592 ;; thus either the first position after a close brace, or the first
3593 ;; position after an enclosing paren, or at the enclosing paren in
3594 ;; case BUFPOS is immediately after it.
3595 (when bufpos
3596 (let (elem)
3597 (catch 'done
3598 (while paren-state
3599 (setq elem (car paren-state))
3600 (if (consp elem)
3601 (cond ((< (cdr elem) bufpos)
3602 (throw 'done (cdr elem)))
3603 ((< (car elem) bufpos)
3604 ;; See below.
3605 (throw 'done (min (1+ (car elem)) bufpos))))
3606 (if (< elem bufpos)
3607 ;; elem is the position at and not after the opening paren, so
3608 ;; we can go forward one more step unless it's equal to
3609 ;; bufpos. This is useful in some cases avoid an extra paren
3610 ;; level between the safe position and bufpos.
3611 (throw 'done (min (1+ elem) bufpos))))
3612 (setq paren-state (cdr paren-state)))))))
3613
3614 (defun c-beginning-of-syntax ()
3615 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3616 ;; goes to the closest previous point that is known to be outside
3617 ;; any string literal or comment. `c-state-cache' is used if it has
3618 ;; a position in the vicinity.
3619 (let* ((paren-state c-state-cache)
3620 elem
3621
3622 (pos (catch 'done
3623 ;; Note: Similar code in `c-safe-position'. The
3624 ;; difference is that we accept a safe position at
3625 ;; the point and don't bother to go forward past open
3626 ;; parens.
3627 (while paren-state
3628 (setq elem (car paren-state))
3629 (if (consp elem)
3630 (cond ((<= (cdr elem) (point))
3631 (throw 'done (cdr elem)))
3632 ((<= (car elem) (point))
3633 (throw 'done (car elem))))
3634 (if (<= elem (point))
3635 (throw 'done elem)))
3636 (setq paren-state (cdr paren-state)))
3637 (point-min))))
3638
3639 (if (> pos (- (point) 4000))
3640 (goto-char pos)
3641 ;; The position is far back. Try `c-beginning-of-defun-1'
3642 ;; (although we can't be entirely sure it will go to a position
3643 ;; outside a comment or string in current emacsen). FIXME:
3644 ;; Consult `syntax-ppss' here.
3645 (c-beginning-of-defun-1)
3646 (if (< (point) pos)
3647 (goto-char pos)))))
3648
3649 \f
3650 ;; Tools for scanning identifiers and other tokens.
3651
3652 (defun c-on-identifier ()
3653 "Return non-nil if the point is on or directly after an identifier.
3654 Keywords are recognized and not considered identifiers. If an
3655 identifier is detected, the returned value is its starting position.
3656 If an identifier ends at the point and another begins at it \(can only
3657 happen in Pike) then the point for the preceding one is returned.
3658
3659 Note that this function might do hidden buffer changes. See the
3660 comment at the start of cc-engine.el for more info."
3661
3662 ;; FIXME: Shouldn't this function handle "operator" in C++?
3663
3664 (save-excursion
3665 (skip-syntax-backward "w_")
3666
3667 (or
3668
3669 ;; Check for a normal (non-keyword) identifier.
3670 (and (looking-at c-symbol-start)
3671 (not (looking-at c-keywords-regexp))
3672 (point))
3673
3674 (when (c-major-mode-is 'pike-mode)
3675 ;; Handle the `<operator> syntax in Pike.
3676 (let ((pos (point)))
3677 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3678 (and (if (< (skip-chars-backward "`") 0)
3679 t
3680 (goto-char pos)
3681 (eq (char-after) ?\`))
3682 (looking-at c-symbol-key)
3683 (>= (match-end 0) pos)
3684 (point))))
3685
3686 ;; Handle the "operator +" syntax in C++.
3687 (when (and c-overloadable-operators-regexp
3688 (= (c-backward-token-2 0) 0))
3689
3690 (cond ((and (looking-at c-overloadable-operators-regexp)
3691 (or (not c-opt-op-identifier-prefix)
3692 (and (= (c-backward-token-2 1) 0)
3693 (looking-at c-opt-op-identifier-prefix))))
3694 (point))
3695
3696 ((save-excursion
3697 (and c-opt-op-identifier-prefix
3698 (looking-at c-opt-op-identifier-prefix)
3699 (= (c-forward-token-2 1) 0)
3700 (looking-at c-overloadable-operators-regexp)))
3701 (point))))
3702
3703 )))
3704
3705 (defsubst c-simple-skip-symbol-backward ()
3706 ;; If the point is at the end of a symbol then skip backward to the
3707 ;; beginning of it. Don't move otherwise. Return non-nil if point
3708 ;; moved.
3709 ;;
3710 ;; This function might do hidden buffer changes.
3711 (or (< (skip-syntax-backward "w_") 0)
3712 (and (c-major-mode-is 'pike-mode)
3713 ;; Handle the `<operator> syntax in Pike.
3714 (let ((pos (point)))
3715 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3716 (< (skip-chars-backward "`") 0)
3717 (looking-at c-symbol-key)
3718 (>= (match-end 0) pos))
3719 t
3720 (goto-char pos)
3721 nil)))))
3722
3723 (defun c-beginning-of-current-token (&optional back-limit)
3724 ;; Move to the beginning of the current token. Do not move if not
3725 ;; in the middle of one. BACK-LIMIT may be used to bound the
3726 ;; backward search; if given it's assumed to be at the boundary
3727 ;; between two tokens. Return non-nil if the point is moved, nil
3728 ;; otherwise.
3729 ;;
3730 ;; This function might do hidden buffer changes.
3731 (let ((start (point)))
3732 (if (looking-at "\\w\\|\\s_")
3733 (skip-syntax-backward "w_" back-limit)
3734 (when (< (skip-syntax-backward ".()" back-limit) 0)
3735 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp)
3736 (match-end 0))
3737 ;; `c-nonsymbol-token-regexp' should always match
3738 ;; since we've skipped backward over punctuation
3739 ;; or paren syntax, but consume one char in case
3740 ;; it doesn't so that we don't leave point before
3741 ;; some earlier incorrect token.
3742 (1+ (point)))))
3743 (if (<= pos start)
3744 (goto-char pos))))))
3745 (< (point) start)))
3746
3747 (defun c-end-of-current-token (&optional back-limit)
3748 ;; Move to the end of the current token. Do not move if not in the
3749 ;; middle of one. BACK-LIMIT may be used to bound the backward
3750 ;; search; if given it's assumed to be at the boundary between two
3751 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3752 ;;
3753 ;; This function might do hidden buffer changes.
3754 (let ((start (point)))
3755 (cond ((< (skip-syntax-backward "w_" (1- start)) 0)
3756 (skip-syntax-forward "w_"))
3757 ((< (skip-syntax-backward ".()" back-limit) 0)
3758 (while (progn
3759 (if (looking-at c-nonsymbol-token-regexp)
3760 (goto-char (match-end 0))
3761 ;; `c-nonsymbol-token-regexp' should always match since
3762 ;; we've skipped backward over punctuation or paren
3763 ;; syntax, but move forward in case it doesn't so that
3764 ;; we don't leave point earlier than we started with.
3765 (forward-char))
3766 (< (point) start)))))
3767 (> (point) start)))
3768
3769 (defconst c-jump-syntax-balanced
3770 (if (memq 'gen-string-delim c-emacs-features)
3771 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\"\\|\\s|"
3772 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\""))
3773
3774 (defconst c-jump-syntax-unbalanced
3775 (if (memq 'gen-string-delim c-emacs-features)
3776 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3777 "\\w\\|\\s_\\|\\s\""))
3778
3779 (defun c-forward-token-2 (&optional count balanced limit)
3780 "Move forward by tokens.
3781 A token is defined as all symbols and identifiers which aren't
3782 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3783 treated properly). Point is always either left at the beginning of a
3784 token or not moved at all. COUNT specifies the number of tokens to
3785 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3786 moves to the next token beginning only if not already at one. If
3787 BALANCED is true, move over balanced parens, otherwise move into them.
3788 Also, if BALANCED is true, never move out of an enclosing paren.
3789
3790 LIMIT sets the limit for the movement and defaults to the point limit.
3791 The case when LIMIT is set in the middle of a token, comment or macro
3792 is handled correctly, i.e. the point won't be left there.
3793
3794 Return the number of tokens left to move \(positive or negative). If
3795 BALANCED is true, a move over a balanced paren counts as one. Note
3796 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3797 be returned. Thus, a return value of 0 guarantees that point is at
3798 the requested position and a return value less \(without signs) than
3799 COUNT guarantees that point is at the beginning of some token.
3800
3801 Note that this function might do hidden buffer changes. See the
3802 comment at the start of cc-engine.el for more info."
3803
3804 (or count (setq count 1))
3805 (if (< count 0)
3806 (- (c-backward-token-2 (- count) balanced limit))
3807
3808 (let ((jump-syntax (if balanced
3809 c-jump-syntax-balanced
3810 c-jump-syntax-unbalanced))
3811 (last (point))
3812 (prev (point)))
3813
3814 (if (zerop count)
3815 ;; If count is zero we should jump if in the middle of a token.
3816 (c-end-of-current-token))
3817
3818 (save-restriction
3819 (if limit (narrow-to-region (point-min) limit))
3820 (if (/= (point)
3821 (progn (c-forward-syntactic-ws) (point)))
3822 ;; Skip whitespace. Count this as a move if we did in
3823 ;; fact move.
3824 (setq count (max (1- count) 0)))
3825
3826 (if (eobp)
3827 ;; Moved out of bounds. Make sure the returned count isn't zero.
3828 (progn
3829 (if (zerop count) (setq count 1))
3830 (goto-char last))
3831
3832 ;; Use `condition-case' to avoid having the limit tests
3833 ;; inside the loop.
3834 (condition-case nil
3835 (while (and
3836 (> count 0)
3837 (progn
3838 (setq last (point))
3839 (cond ((looking-at jump-syntax)
3840 (goto-char (scan-sexps (point) 1))
3841 t)
3842 ((looking-at c-nonsymbol-token-regexp)
3843 (goto-char (match-end 0))
3844 t)
3845 ;; `c-nonsymbol-token-regexp' above should always
3846 ;; match if there are correct tokens. Try to
3847 ;; widen to see if the limit was set in the
3848 ;; middle of one, else fall back to treating
3849 ;; the offending thing as a one character token.
3850 ((and limit
3851 (save-restriction
3852 (widen)
3853 (looking-at c-nonsymbol-token-regexp)))
3854 nil)
3855 (t
3856 (forward-char)
3857 t))))
3858 (c-forward-syntactic-ws)
3859 (setq prev last
3860 count (1- count)))
3861 (error (goto-char last)))
3862
3863 (when (eobp)
3864 (goto-char prev)
3865 (setq count (1+ count)))))
3866
3867 count)))
3868
3869 (defun c-backward-token-2 (&optional count balanced limit)
3870 "Move backward by tokens.
3871 See `c-forward-token-2' for details."
3872
3873 (or count (setq count 1))
3874 (if (< count 0)
3875 (- (c-forward-token-2 (- count) balanced limit))
3876
3877 (or limit (setq limit (point-min)))
3878 (let ((jump-syntax (if balanced
3879 c-jump-syntax-balanced
3880 c-jump-syntax-unbalanced))
3881 (last (point)))
3882
3883 (if (zerop count)
3884 ;; The count is zero so try to skip to the beginning of the
3885 ;; current token.
3886 (if (> (point)
3887 (progn (c-beginning-of-current-token) (point)))
3888 (if (< (point) limit)
3889 ;; The limit is inside the same token, so return 1.
3890 (setq count 1))
3891
3892 ;; We're not in the middle of a token. If there's
3893 ;; whitespace after the point then we must move backward,
3894 ;; so set count to 1 in that case.
3895 (and (looking-at c-syntactic-ws-start)
3896 ;; If we're looking at a '#' that might start a cpp
3897 ;; directive then we have to do a more elaborate check.
3898 (or (/= (char-after) ?#)
3899 (not c-opt-cpp-prefix)
3900 (save-excursion
3901 (and (= (point)
3902 (progn (beginning-of-line)
3903 (looking-at "[ \t]*")
3904 (match-end 0)))
3905 (or (bobp)
3906 (progn (backward-char)
3907 (not (eq (char-before) ?\\)))))))
3908 (setq count 1))))
3909
3910 ;; Use `condition-case' to avoid having to check for buffer
3911 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3912 (condition-case nil
3913 (while (and
3914 (> count 0)
3915 (progn
3916 (c-backward-syntactic-ws)
3917 (backward-char)
3918 (if (looking-at jump-syntax)
3919 (goto-char (scan-sexps (1+ (point)) -1))
3920 ;; This can be very inefficient if there's a long
3921 ;; sequence of operator tokens without any separation.
3922 ;; That doesn't happen in practice, anyway.
3923 (c-beginning-of-current-token))
3924 (>= (point) limit)))
3925 (setq last (point)
3926 count (1- count)))
3927 (error (goto-char last)))
3928
3929 (if (< (point) limit)
3930 (goto-char last))
3931
3932 count)))
3933
3934 (defun c-forward-token-1 (&optional count balanced limit)
3935 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3936 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3937 characters are jumped over character by character. This function is
3938 for compatibility only; it's only a wrapper over `c-forward-token-2'."
3939 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3940 (c-forward-token-2 count balanced limit)))
3941
3942 (defun c-backward-token-1 (&optional count balanced limit)
3943 "Like `c-backward-token-2' but doesn't treat multicharacter operator
3944 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3945 characters are jumped over character by character. This function is
3946 for compatibility only; it's only a wrapper over `c-backward-token-2'."
3947 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3948 (c-backward-token-2 count balanced limit)))
3949
3950 \f
3951 ;; Tools for doing searches restricted to syntactically relevant text.
3952
3953 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
3954 paren-level not-inside-token
3955 lookbehind-submatch)
3956 "Like `re-search-forward', but only report matches that are found
3957 in syntactically significant text. I.e. matches in comments, macros
3958 or string literals are ignored. The start point is assumed to be
3959 outside any comment, macro or string literal, or else the content of
3960 that region is taken as syntactically significant text.
3961
3962 If PAREN-LEVEL is non-nil, an additional restriction is added to
3963 ignore matches in nested paren sexps. The search will also not go
3964 outside the current list sexp, which has the effect that if the point
3965 should be moved to BOUND when no match is found \(i.e. NOERROR is
3966 neither nil nor t), then it will be at the closing paren if the end of
3967 the current list sexp is encountered first.
3968
3969 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
3970 ignored. Things like multicharacter operators and special symbols
3971 \(e.g. \"`()\" in Pike) are handled but currently not floating point
3972 constants.
3973
3974 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
3975 subexpression in REGEXP. The end of that submatch is used as the
3976 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
3977 isn't used or if that subexpression didn't match then the start
3978 position of the whole match is used instead. The \"look behind\"
3979 subexpression is never tested before the starting position, so it
3980 might be a good idea to include \\=\\= as a match alternative in it.
3981
3982 Optimization note: Matches might be missed if the \"look behind\"
3983 subexpression can match the end of nonwhite syntactic whitespace,
3984 i.e. the end of comments or cpp directives. This since the function
3985 skips over such things before resuming the search. It's on the other
3986 hand not safe to assume that the \"look behind\" subexpression never
3987 matches syntactic whitespace.
3988
3989 Bug: Unbalanced parens inside cpp directives are currently not handled
3990 correctly \(i.e. they don't get ignored as they should) when
3991 PAREN-LEVEL is set.
3992
3993 Note that this function might do hidden buffer changes. See the
3994 comment at the start of cc-engine.el for more info."
3995
3996 (or bound (setq bound (point-max)))
3997 (if paren-level (setq paren-level -1))
3998
3999 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
4000
4001 (let ((start (point))
4002 tmp
4003 ;; Start position for the last search.
4004 search-pos
4005 ;; The `parse-partial-sexp' state between the start position
4006 ;; and the point.
4007 state
4008 ;; The current position after the last state update. The next
4009 ;; `parse-partial-sexp' continues from here.
4010 (state-pos (point))
4011 ;; The position at which to check the state and the state
4012 ;; there. This is separate from `state-pos' since we might
4013 ;; need to back up before doing the next search round.
4014 check-pos check-state
4015 ;; Last position known to end a token.
4016 (last-token-end-pos (point-min))
4017 ;; Set when a valid match is found.
4018 found)
4019
4020 (condition-case err
4021 (while
4022 (and
4023 (progn
4024 (setq search-pos (point))
4025 (re-search-forward regexp bound noerror))
4026
4027 (progn
4028 (setq state (parse-partial-sexp
4029 state-pos (match-beginning 0) paren-level nil state)
4030 state-pos (point))
4031 (if (setq check-pos (and lookbehind-submatch
4032 (or (not paren-level)
4033 (>= (car state) 0))
4034 (match-end lookbehind-submatch)))
4035 (setq check-state (parse-partial-sexp
4036 state-pos check-pos paren-level nil state))
4037 (setq check-pos state-pos
4038 check-state state))
4039
4040 ;; NOTE: If we got a look behind subexpression and get
4041 ;; an insignificant match in something that isn't
4042 ;; syntactic whitespace (i.e. strings or in nested
4043 ;; parentheses), then we can never skip more than a
4044 ;; single character from the match start position
4045 ;; (i.e. `state-pos' here) before continuing the
4046 ;; search. That since the look behind subexpression
4047 ;; might match the end of the insignificant region in
4048 ;; the next search.
4049
4050 (cond
4051 ((elt check-state 7)
4052 ;; Match inside a line comment. Skip to eol. Use
4053 ;; `re-search-forward' instead of `skip-chars-forward' to get
4054 ;; the right bound behavior.
4055 (re-search-forward "[\n\r]" bound noerror))
4056
4057 ((elt check-state 4)
4058 ;; Match inside a block comment. Skip to the '*/'.
4059 (search-forward "*/" bound noerror))
4060
4061 ((and (not (elt check-state 5))
4062 (eq (char-before check-pos) ?/)
4063 (not (c-get-char-property (1- check-pos) 'syntax-table))
4064 (memq (char-after check-pos) '(?/ ?*)))
4065 ;; Match in the middle of the opener of a block or line
4066 ;; comment.
4067 (if (= (char-after check-pos) ?/)
4068 (re-search-forward "[\n\r]" bound noerror)
4069 (search-forward "*/" bound noerror)))
4070
4071 ;; The last `parse-partial-sexp' above might have
4072 ;; stopped short of the real check position if the end
4073 ;; of the current sexp was encountered in paren-level
4074 ;; mode. The checks above are always false in that
4075 ;; case, and since they can do better skipping in
4076 ;; lookbehind-submatch mode, we do them before
4077 ;; checking the paren level.
4078
4079 ((and paren-level
4080 (/= (setq tmp (car check-state)) 0))
4081 ;; Check the paren level first since we're short of the
4082 ;; syntactic checking position if the end of the
4083 ;; current sexp was encountered by `parse-partial-sexp'.
4084 (if (> tmp 0)
4085
4086 ;; Inside a nested paren sexp.
4087 (if lookbehind-submatch
4088 ;; See the NOTE above.
4089 (progn (goto-char state-pos) t)
4090 ;; Skip out of the paren quickly.
4091 (setq state (parse-partial-sexp state-pos bound 0 nil state)
4092 state-pos (point)))
4093
4094 ;; Have exited the current paren sexp.
4095 (if noerror
4096 (progn
4097 ;; The last `parse-partial-sexp' call above
4098 ;; has left us just after the closing paren
4099 ;; in this case, so we can modify the bound
4100 ;; to leave the point at the right position
4101 ;; upon return.
4102 (setq bound (1- (point)))
4103 nil)
4104 (signal 'search-failed (list regexp)))))
4105
4106 ((setq tmp (elt check-state 3))
4107 ;; Match inside a string.
4108 (if (or lookbehind-submatch
4109 (not (integerp tmp)))
4110 ;; See the NOTE above.
4111 (progn (goto-char state-pos) t)
4112 ;; Skip to the end of the string before continuing.
4113 (let ((ender (make-string 1 tmp)) (continue t))
4114 (while (if (search-forward ender bound noerror)
4115 (progn
4116 (setq state (parse-partial-sexp
4117 state-pos (point) nil nil state)
4118 state-pos (point))
4119 (elt state 3))
4120 (setq continue nil)))
4121 continue)))
4122
4123 ((save-excursion
4124 (save-match-data
4125 (c-beginning-of-macro start)))
4126 ;; Match inside a macro. Skip to the end of it.
4127 (c-end-of-macro)
4128 (cond ((<= (point) bound) t)
4129 (noerror nil)
4130 (t (signal 'search-failed (list regexp)))))
4131
4132 ((and not-inside-token
4133 (or (< check-pos last-token-end-pos)
4134 (< check-pos
4135 (save-excursion
4136 (goto-char check-pos)
4137 (save-match-data
4138 (c-end-of-current-token last-token-end-pos))
4139 (setq last-token-end-pos (point))))))
4140 ;; Inside a token.
4141 (if lookbehind-submatch
4142 ;; See the NOTE above.
4143 (goto-char state-pos)
4144 (goto-char (min last-token-end-pos bound))))
4145
4146 (t
4147 ;; A real match.
4148 (setq found t)
4149 nil)))
4150
4151 ;; Should loop to search again, but take care to avoid
4152 ;; looping on the same spot.
4153 (or (/= search-pos (point))
4154 (if (= (point) bound)
4155 (if noerror
4156 nil
4157 (signal 'search-failed (list regexp)))
4158 (forward-char)
4159 t))))
4160
4161 (error
4162 (goto-char start)
4163 (signal (car err) (cdr err))))
4164
4165 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4166
4167 (if found
4168 (progn
4169 (goto-char (match-end 0))
4170 (match-end 0))
4171
4172 ;; Search failed. Set point as appropriate.
4173 (if (eq noerror t)
4174 (goto-char start)
4175 (goto-char bound))
4176 nil)))
4177
4178 (defvar safe-pos-list) ; bound in c-syntactic-skip-backward
4179
4180 (defsubst c-ssb-lit-begin ()
4181 ;; Return the start of the literal point is in, or nil.
4182 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4183 ;; bound in the caller.
4184
4185 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4186 ;; if it's outside comments and strings.
4187 (save-excursion
4188 (let ((pos (point)) safe-pos state)
4189 ;; Pick a safe position as close to the point as possible.
4190 ;;
4191 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4192 ;; position.
4193
4194 (while (and safe-pos-list
4195 (> (car safe-pos-list) (point)))
4196 (setq safe-pos-list (cdr safe-pos-list)))
4197 (unless (setq safe-pos (car-safe safe-pos-list))
4198 (setq safe-pos (max (or (c-safe-position
4199 (point) (or c-state-cache
4200 (c-parse-state)))
4201 0)
4202 (point-min))
4203 safe-pos-list (list safe-pos)))
4204
4205 ;; Cache positions along the way to use if we have to back up more. We
4206 ;; cache every closing paren on the same level. If the paren cache is
4207 ;; relevant in this region then we're typically already on the same
4208 ;; level as the target position. Note that we might cache positions
4209 ;; after opening parens in case safe-pos is in a nested list. That's
4210 ;; both uncommon and harmless.
4211 (while (progn
4212 (setq state (parse-partial-sexp
4213 safe-pos pos 0))
4214 (< (point) pos))
4215 (setq safe-pos (point)
4216 safe-pos-list (cons safe-pos safe-pos-list)))
4217
4218 ;; If the state contains the start of the containing sexp we cache that
4219 ;; position too, so that parse-partial-sexp in the next run has a bigger
4220 ;; chance of starting at the same level as the target position and thus
4221 ;; will get more good safe positions into the list.
4222 (if (elt state 1)
4223 (setq safe-pos (1+ (elt state 1))
4224 safe-pos-list (cons safe-pos safe-pos-list)))
4225
4226 (if (or (elt state 3) (elt state 4))
4227 ;; Inside string or comment. Continue search at the
4228 ;; beginning of it.
4229 (elt state 8)))))
4230
4231 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4232 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4233 i.e. don't stop at positions inside syntactic whitespace or string
4234 literals. Preprocessor directives are also ignored, with the exception
4235 of the one that the point starts within, if any. If LIMIT is given,
4236 it's assumed to be at a syntactically relevant position.
4237
4238 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4239 sexps, and the search will also not go outside the current paren sexp.
4240 However, if LIMIT or the buffer limit is reached inside a nested paren
4241 then the point will be left at the limit.
4242
4243 Non-nil is returned if the point moved, nil otherwise.
4244
4245 Note that this function might do hidden buffer changes. See the
4246 comment at the start of cc-engine.el for more info."
4247
4248 (let ((start (point))
4249 state-2
4250 ;; A list of syntactically relevant positions in descending
4251 ;; order. It's used to avoid scanning repeatedly over
4252 ;; potentially large regions with `parse-partial-sexp' to verify
4253 ;; each position. Used in `c-ssb-lit-begin'
4254 safe-pos-list
4255 ;; The result from `c-beginning-of-macro' at the start position or the
4256 ;; start position itself if it isn't within a macro. Evaluated on
4257 ;; demand.
4258 start-macro-beg
4259 ;; The earliest position after the current one with the same paren
4260 ;; level. Used only when `paren-level' is set.
4261 lit-beg
4262 (paren-level-pos (point)))
4263
4264 (while
4265 (progn
4266 ;; The next loop "tries" to find the end point each time round,
4267 ;; loops when it hasn't succeeded.
4268 (while
4269 (and
4270 (let ((pos (point)))
4271 (while (and
4272 (< (skip-chars-backward skip-chars limit) 0)
4273 ;; Don't stop inside a literal.
4274 (when (setq lit-beg (c-ssb-lit-begin))
4275 (goto-char lit-beg)
4276 t)))
4277 (< (point) pos))
4278
4279 (let ((pos (point)) state-2 pps-end-pos)
4280
4281 (cond
4282 ((and paren-level
4283 (save-excursion
4284 (setq state-2 (parse-partial-sexp
4285 pos paren-level-pos -1)
4286 pps-end-pos (point))
4287 (/= (car state-2) 0)))
4288 ;; Not at the right level.
4289
4290 (if (and (< (car state-2) 0)
4291 ;; We stop above if we go out of a paren.
4292 ;; Now check whether it precedes or is
4293 ;; nested in the starting sexp.
4294 (save-excursion
4295 (setq state-2
4296 (parse-partial-sexp
4297 pps-end-pos paren-level-pos
4298 nil nil state-2))
4299 (< (car state-2) 0)))
4300
4301 ;; We've stopped short of the starting position
4302 ;; so the hit was inside a nested list. Go up
4303 ;; until we are at the right level.
4304 (condition-case nil
4305 (progn
4306 (goto-char (scan-lists pos -1
4307 (- (car state-2))))
4308 (setq paren-level-pos (point))
4309 (if (and limit (>= limit paren-level-pos))
4310 (progn
4311 (goto-char limit)
4312 nil)
4313 t))
4314 (error
4315 (goto-char (or limit (point-min)))
4316 nil))
4317
4318 ;; The hit was outside the list at the start
4319 ;; position. Go to the start of the list and exit.
4320 (goto-char (1+ (elt state-2 1)))
4321 nil))
4322
4323 ((c-beginning-of-macro limit)
4324 ;; Inside a macro.
4325 (if (< (point)
4326 (or start-macro-beg
4327 (setq start-macro-beg
4328 (save-excursion
4329 (goto-char start)
4330 (c-beginning-of-macro limit)
4331 (point)))))
4332 t
4333
4334 ;; It's inside the same macro we started in so it's
4335 ;; a relevant match.
4336 (goto-char pos)
4337 nil))))))
4338
4339 (> (point)
4340 (progn
4341 ;; Skip syntactic ws afterwards so that we don't stop at the
4342 ;; end of a comment if `skip-chars' is something like "^/".
4343 (c-backward-syntactic-ws)
4344 (point)))))
4345
4346 ;; We might want to extend this with more useful return values in
4347 ;; the future.
4348 (/= (point) start)))
4349
4350 ;; The following is an alternative implementation of
4351 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4352 ;; track of the syntactic context. It turned out to be generally
4353 ;; slower than the one above which uses forward checks from earlier
4354 ;; safe positions.
4355 ;;
4356 ;;(defconst c-ssb-stop-re
4357 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4358 ;; ;; stop at to avoid going into comments and literals.
4359 ;; (concat
4360 ;; ;; Match comment end syntax and string literal syntax. Also match
4361 ;; ;; '/' for block comment endings (not covered by comment end
4362 ;; ;; syntax).
4363 ;; "\\s>\\|/\\|\\s\""
4364 ;; (if (memq 'gen-string-delim c-emacs-features)
4365 ;; "\\|\\s|"
4366 ;; "")
4367 ;; (if (memq 'gen-comment-delim c-emacs-features)
4368 ;; "\\|\\s!"
4369 ;; "")))
4370 ;;
4371 ;;(defconst c-ssb-stop-paren-re
4372 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4373 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4374 ;;
4375 ;;(defconst c-ssb-sexp-end-re
4376 ;; ;; Regexp matching the ending syntax of a complex sexp.
4377 ;; (concat c-string-limit-regexp "\\|\\s)"))
4378 ;;
4379 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4380 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4381 ;;i.e. don't stop at positions inside syntactic whitespace or string
4382 ;;literals. Preprocessor directives are also ignored. However, if the
4383 ;;point is within a comment, string literal or preprocessor directory to
4384 ;;begin with, its contents is treated as syntactically relevant chars.
4385 ;;If LIMIT is given, it limits the backward search and the point will be
4386 ;;left there if no earlier position is found.
4387 ;;
4388 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4389 ;;sexps, and the search will also not go outside the current paren sexp.
4390 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4391 ;;then the point will be left at the limit.
4392 ;;
4393 ;;Non-nil is returned if the point moved, nil otherwise.
4394 ;;
4395 ;;Note that this function might do hidden buffer changes. See the
4396 ;;comment at the start of cc-engine.el for more info."
4397 ;;
4398 ;; (save-restriction
4399 ;; (when limit
4400 ;; (narrow-to-region limit (point-max)))
4401 ;;
4402 ;; (let ((start (point)))
4403 ;; (catch 'done
4404 ;; (while (let ((last-pos (point))
4405 ;; (stop-pos (progn
4406 ;; (skip-chars-backward skip-chars)
4407 ;; (point))))
4408 ;;
4409 ;; ;; Skip back over the same region as
4410 ;; ;; `skip-chars-backward' above, but keep to
4411 ;; ;; syntactically relevant positions.
4412 ;; (goto-char last-pos)
4413 ;; (while (and
4414 ;; ;; `re-search-backward' with a single char regexp
4415 ;; ;; should be fast.
4416 ;; (re-search-backward
4417 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4418 ;; stop-pos 'move)
4419 ;;
4420 ;; (progn
4421 ;; (cond
4422 ;; ((looking-at "\\s(")
4423 ;; ;; `paren-level' is set and we've found the
4424 ;; ;; start of the containing paren.
4425 ;; (forward-char)
4426 ;; (throw 'done t))
4427 ;;
4428 ;; ((looking-at c-ssb-sexp-end-re)
4429 ;; ;; We're at the end of a string literal or paren
4430 ;; ;; sexp (if `paren-level' is set).
4431 ;; (forward-char)
4432 ;; (condition-case nil
4433 ;; (c-backward-sexp)
4434 ;; (error
4435 ;; (goto-char limit)
4436 ;; (throw 'done t))))
4437 ;;
4438 ;; (t
4439 ;; (forward-char)
4440 ;; ;; At the end of some syntactic ws or possibly
4441 ;; ;; after a plain '/' operator.
4442 ;; (let ((pos (point)))
4443 ;; (c-backward-syntactic-ws)
4444 ;; (if (= pos (point))
4445 ;; ;; Was a plain '/' operator. Go past it.
4446 ;; (backward-char)))))
4447 ;;
4448 ;; (> (point) stop-pos))))
4449 ;;
4450 ;; ;; Now the point is either at `stop-pos' or at some
4451 ;; ;; position further back if `stop-pos' was at a
4452 ;; ;; syntactically irrelevant place.
4453 ;;
4454 ;; ;; Skip additional syntactic ws so that we don't stop
4455 ;; ;; at the end of a comment if `skip-chars' is
4456 ;; ;; something like "^/".
4457 ;; (c-backward-syntactic-ws)
4458 ;;
4459 ;; (< (point) stop-pos))))
4460 ;;
4461 ;; ;; We might want to extend this with more useful return values
4462 ;; ;; in the future.
4463 ;; (/= (point) start))))
4464
4465 \f
4466 ;; Tools for handling comments and string literals.
4467
4468 (defun c-in-literal (&optional lim detect-cpp)
4469 "Return the type of literal point is in, if any.
4470 The return value is `c' if in a C-style comment, `c++' if in a C++
4471 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4472 is non-nil and in a preprocessor line, or nil if somewhere else.
4473 Optional LIM is used as the backward limit of the search. If omitted,
4474 or nil, `c-beginning-of-defun' is used.
4475
4476 The last point calculated is cached if the cache is enabled, i.e. if
4477 `c-in-literal-cache' is bound to a two element vector.
4478
4479 Note that this function might do hidden buffer changes. See the
4480 comment at the start of cc-engine.el for more info."
4481 (save-restriction
4482 (widen)
4483 (let* ((safe-place (c-state-semi-safe-place (point)))
4484 (lit (c-state-pp-to-literal safe-place (point))))
4485 (or (cadr lit)
4486 (and detect-cpp
4487 (save-excursion (c-beginning-of-macro))
4488 'pound)))))
4489
4490 (defun c-literal-limits (&optional lim near not-in-delimiter)
4491 "Return a cons of the beginning and end positions of the comment or
4492 string surrounding point (including both delimiters), or nil if point
4493 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4494 to start parsing from. If NEAR is non-nil, then the limits of any
4495 literal next to point is returned. \"Next to\" means there's only
4496 spaces and tabs between point and the literal. The search for such a
4497 literal is done first in forward direction. If NOT-IN-DELIMITER is
4498 non-nil, the case when point is inside a starting delimiter won't be
4499 recognized. This only has effect for comments which have starting
4500 delimiters with more than one character.
4501
4502 Note that this function might do hidden buffer changes. See the
4503 comment at the start of cc-engine.el for more info."
4504
4505 (save-excursion
4506 (let* ((pos (point))
4507 (lim (or lim (c-state-semi-safe-place pos)))
4508 (pp-to-lit (save-restriction
4509 (widen)
4510 (c-state-pp-to-literal lim pos not-in-delimiter)))
4511 (state (car pp-to-lit))
4512 (lit-limits (car (cddr pp-to-lit))))
4513
4514 (cond
4515 (lit-limits)
4516
4517 (near
4518 (goto-char pos)
4519 ;; Search forward for a literal.
4520 (skip-chars-forward " \t")
4521 (cond
4522 ((looking-at c-string-limit-regexp) ; String.
4523 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4524 (point-max))))
4525
4526 ((looking-at c-comment-start-regexp) ; Line or block comment.
4527 (cons (point) (progn (c-forward-single-comment) (point))))
4528
4529 (t
4530 ;; Search backward.
4531 (skip-chars-backward " \t")
4532
4533 (let ((end (point)) beg)
4534 (cond
4535 ((save-excursion
4536 (< (skip-syntax-backward c-string-syntax) 0)) ; String.
4537 (setq beg (c-safe (c-backward-sexp 1) (point))))
4538
4539 ((and (c-safe (forward-char -2) t)
4540 (looking-at "*/"))
4541 ;; Block comment. Due to the nature of line
4542 ;; comments, they will always be covered by the
4543 ;; normal case above.
4544 (goto-char end)
4545 (c-backward-single-comment)
4546 ;; If LIM is bogus, beg will be bogus.
4547 (setq beg (point))))
4548
4549 (if beg (cons beg end))))))
4550 ))))
4551
4552 ;; In case external callers use this; it did have a docstring.
4553 (defalias 'c-literal-limits-fast 'c-literal-limits)
4554
4555 (defun c-collect-line-comments (range)
4556 "If the argument is a cons of two buffer positions (such as returned by
4557 `c-literal-limits'), and that range contains a C++ style line comment,
4558 then an extended range is returned that contains all adjacent line
4559 comments (i.e. all comments that starts in the same column with no
4560 empty lines or non-whitespace characters between them). Otherwise the
4561 argument is returned.
4562
4563 Note that this function might do hidden buffer changes. See the
4564 comment at the start of cc-engine.el for more info."
4565
4566 (save-excursion
4567 (condition-case nil
4568 (if (and (consp range) (progn
4569 (goto-char (car range))
4570 (looking-at c-line-comment-starter)))
4571 (let ((col (current-column))
4572 (beg (point))
4573 (bopl (c-point 'bopl))
4574 (end (cdr range)))
4575 ;; Got to take care in the backward direction to handle
4576 ;; comments which are preceded by code.
4577 (while (and (c-backward-single-comment)
4578 (>= (point) bopl)
4579 (looking-at c-line-comment-starter)
4580 (= col (current-column)))
4581 (setq beg (point)
4582 bopl (c-point 'bopl)))
4583 (goto-char end)
4584 (while (and (progn (skip-chars-forward " \t")
4585 (looking-at c-line-comment-starter))
4586 (= col (current-column))
4587 (prog1 (zerop (forward-line 1))
4588 (setq end (point)))))
4589 (cons beg end))
4590 range)
4591 (error range))))
4592
4593 (defun c-literal-type (range)
4594 "Convenience function that given the result of `c-literal-limits',
4595 returns nil or the type of literal that the range surrounds, one
4596 of the symbols 'c, 'c++ or 'string. It's much faster than using
4597 `c-in-literal' and is intended to be used when you need both the
4598 type of a literal and its limits.
4599
4600 Note that this function might do hidden buffer changes. See the
4601 comment at the start of cc-engine.el for more info."
4602
4603 (if (consp range)
4604 (save-excursion
4605 (goto-char (car range))
4606 (cond ((looking-at c-string-limit-regexp) 'string)
4607 ((or (looking-at "//") ; c++ line comment
4608 (and (looking-at "\\s<") ; comment starter
4609 (looking-at "#"))) ; awk comment.
4610 'c++)
4611 (t 'c))) ; Assuming the range is valid.
4612 range))
4613
4614 (defsubst c-determine-limit-get-base (start try-size)
4615 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4616 ;; This doesn't preserve point.
4617 (let* ((pos (max (- start try-size) (point-min)))
4618 (base (c-state-semi-safe-place pos))
4619 (s (parse-partial-sexp base pos)))
4620 (if (or (nth 4 s) (nth 3 s)) ; comment or string
4621 (nth 8 s)
4622 (point))))
4623
4624 (defun c-determine-limit (how-far-back &optional start try-size)
4625 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4626 ;; (default point). This is done by going back further in the buffer then
4627 ;; searching forward for literals. The position found won't be in a
4628 ;; literal. We start searching for the sought position TRY-SIZE (default
4629 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4630 ;; :-)
4631 (save-excursion
4632 (let* ((start (or start (point)))
4633 (try-size (or try-size (* 2 how-far-back)))
4634 (base (c-determine-limit-get-base start try-size))
4635 (pos base)
4636
4637 (s (parse-partial-sexp pos pos)) ; null state.
4638 stack elt size
4639 (count 0))
4640 (while (< pos start)
4641 ;; Move forward one literal each time round this loop.
4642 ;; Move forward to the start of a comment or string.
4643 (setq s (parse-partial-sexp
4644 pos
4645 start
4646 nil ; target-depth
4647 nil ; stop-before
4648 s ; state
4649 'syntax-table)) ; stop-comment
4650
4651 ;; Gather details of the non-literal-bit - starting pos and size.
4652 (setq size (- (if (or (nth 4 s) (nth 3 s))
4653 (nth 8 s)
4654 (point))
4655 pos))
4656 (if (> size 0)
4657 (setq stack (cons (cons pos size) stack)))
4658
4659 ;; Move forward to the end of the comment/string.
4660 (if (or (nth 4 s) (nth 3 s))
4661 (setq s (parse-partial-sexp
4662 (point)
4663 start
4664 nil ; target-depth
4665 nil ; stop-before
4666 s ; state
4667 'syntax-table))) ; stop-comment
4668 (setq pos (point)))
4669
4670 ;; Now try and find enough non-literal characters recorded on the stack.
4671 ;; Go back one recorded literal each time round this loop.
4672 (while (and (< count how-far-back)
4673 stack)
4674 (setq elt (car stack)
4675 stack (cdr stack))
4676 (setq count (+ count (cdr elt))))
4677
4678 ;; Have we found enough yet?
4679 (cond
4680 ((>= count how-far-back)
4681 (+ (car elt) (- count how-far-back)))
4682 ((eq base (point-min))
4683 (point-min))
4684 (t
4685 (c-determine-limit (- how-far-back count) base try-size))))))
4686
4687 (defun c-determine-+ve-limit (how-far &optional start-pos)
4688 ;; Return a buffer position about HOW-FAR non-literal characters forward
4689 ;; from START-POS (default point), which must not be inside a literal.
4690 (save-excursion
4691 (let ((pos (or start-pos (point)))
4692 (count how-far)
4693 (s (parse-partial-sexp (point) (point)))) ; null state
4694 (while (and (not (eobp))
4695 (> count 0))
4696 ;; Scan over counted characters.
4697 (setq s (parse-partial-sexp
4698 pos
4699 (min (+ pos count) (point-max))
4700 nil ; target-depth
4701 nil ; stop-before
4702 s ; state
4703 'syntax-table)) ; stop-comment
4704 (setq count (- count (- (point) pos) 1)
4705 pos (point))
4706 ;; Scan over literal characters.
4707 (if (nth 8 s)
4708 (setq s (parse-partial-sexp
4709 pos
4710 (point-max)
4711 nil ; target-depth
4712 nil ; stop-before
4713 s ; state
4714 'syntax-table) ; stop-comment
4715 pos (point))))
4716 (point))))
4717
4718 \f
4719 ;; `c-find-decl-spots' and accompanying stuff.
4720
4721 ;; Variables used in `c-find-decl-spots' to cache the search done for
4722 ;; the first declaration in the last call. When that function starts,
4723 ;; it needs to back up over syntactic whitespace to look at the last
4724 ;; token before the region being searched. That can sometimes cause
4725 ;; moves back and forth over a quite large region of comments and
4726 ;; macros, which would be repeated for each changed character when
4727 ;; we're called during fontification, since font-lock refontifies the
4728 ;; current line for each change. Thus it's worthwhile to cache the
4729 ;; first match.
4730 ;;
4731 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4732 ;; the syntactic whitespace less or equal to some start position.
4733 ;; There's no cached value if it's nil.
4734 ;;
4735 ;; `c-find-decl-match-pos' is the match position if
4736 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4737 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4738 (defvar c-find-decl-syntactic-pos nil)
4739 (make-variable-buffer-local 'c-find-decl-syntactic-pos)
4740 (defvar c-find-decl-match-pos nil)
4741 (make-variable-buffer-local 'c-find-decl-match-pos)
4742
4743 (defsubst c-invalidate-find-decl-cache (change-min-pos)
4744 (and c-find-decl-syntactic-pos
4745 (< change-min-pos c-find-decl-syntactic-pos)
4746 (setq c-find-decl-syntactic-pos nil)))
4747
4748 ; (defface c-debug-decl-spot-face
4749 ; '((t (:background "Turquoise")))
4750 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4751 ; (defface c-debug-decl-sws-face
4752 ; '((t (:background "Khaki")))
4753 ; "Debug face to mark the syntactic whitespace between the declaration
4754 ; spots and the preceding token end.")
4755
4756 (defmacro c-debug-put-decl-spot-faces (match-pos decl-pos)
4757 (when (facep 'c-debug-decl-spot-face)
4758 `(c-save-buffer-state ((match-pos ,match-pos) (decl-pos ,decl-pos))
4759 (c-debug-add-face (max match-pos (point-min)) decl-pos
4760 'c-debug-decl-sws-face)
4761 (c-debug-add-face decl-pos (min (1+ decl-pos) (point-max))
4762 'c-debug-decl-spot-face))))
4763 (defmacro c-debug-remove-decl-spot-faces (beg end)
4764 (when (facep 'c-debug-decl-spot-face)
4765 `(c-save-buffer-state ()
4766 (c-debug-remove-face ,beg ,end 'c-debug-decl-spot-face)
4767 (c-debug-remove-face ,beg ,end 'c-debug-decl-sws-face))))
4768
4769 (defmacro c-find-decl-prefix-search ()
4770 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4771 ;; but it contains lots of free variables that refer to things
4772 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4773 ;; if there is a match, otherwise at `cfd-limit'.
4774 ;;
4775 ;; The macro moves point forward to the next putative start of a declaration
4776 ;; or cfd-limit. This decl start is the next token after a "declaration
4777 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
4778 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
4779 ;;
4780 ;; This macro might do hidden buffer changes.
4781
4782 '(progn
4783 ;; Find the next property match position if we haven't got one already.
4784 (unless cfd-prop-match
4785 (save-excursion
4786 (while (progn
4787 (goto-char (next-single-property-change
4788 (point) 'c-type nil cfd-limit))
4789 (and (< (point) cfd-limit)
4790 (not (eq (c-get-char-property (1- (point)) 'c-type)
4791 'c-decl-end)))))
4792 (setq cfd-prop-match (point))))
4793
4794 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4795 ;; got one already.
4796 (unless cfd-re-match
4797
4798 (if (> cfd-re-match-end (point))
4799 (goto-char cfd-re-match-end))
4800
4801 ;; Each time round, the next `while' moves forward over a pseudo match
4802 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
4803 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
4804 ;; `cfd-re-match-end' get set.
4805 (while
4806 (progn
4807 (setq cfd-re-match-end (re-search-forward c-decl-prefix-or-start-re
4808 cfd-limit 'move))
4809 (cond
4810 ((null cfd-re-match-end)
4811 ;; No match. Finish up and exit the loop.
4812 (setq cfd-re-match cfd-limit)
4813 nil)
4814 ((c-got-face-at
4815 (if (setq cfd-re-match (match-end 1))
4816 ;; Matched the end of a token preceding a decl spot.
4817 (progn
4818 (goto-char cfd-re-match)
4819 (1- cfd-re-match))
4820 ;; Matched a token that start a decl spot.
4821 (goto-char (match-beginning 0))
4822 (point))
4823 c-literal-faces)
4824 ;; Pseudo match inside a comment or string literal. Skip out
4825 ;; of comments and string literals.
4826 (while (progn
4827 (goto-char (next-single-property-change
4828 (point) 'face nil cfd-limit))
4829 (and (< (point) cfd-limit)
4830 (c-got-face-at (point) c-literal-faces))))
4831 t) ; Continue the loop over pseudo matches.
4832 ((and (match-string 1)
4833 (string= (match-string 1) ":")
4834 (save-excursion
4835 (or (/= (c-backward-token-2 2) 0) ; no search limit. :-(
4836 (not (looking-at c-decl-start-colon-kwd-re)))))
4837 ;; Found a ":" which isn't part of "public:", etc.
4838 t)
4839 (t nil)))) ;; Found a real match. Exit the pseudo-match loop.
4840
4841 ;; If our match was at the decl start, we have to back up over the
4842 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4843 ;; any decl spots in the syntactic ws.
4844 (unless cfd-re-match
4845 (c-backward-syntactic-ws)
4846 (setq cfd-re-match (point))))
4847
4848 ;; Choose whichever match is closer to the start.
4849 (if (< cfd-re-match cfd-prop-match)
4850 (setq cfd-match-pos cfd-re-match
4851 cfd-re-match nil)
4852 (setq cfd-match-pos cfd-prop-match
4853 cfd-prop-match nil))
4854
4855 (goto-char cfd-match-pos)
4856
4857 (when (< cfd-match-pos cfd-limit)
4858 ;; Skip forward past comments only so we don't skip macros.
4859 (c-forward-comments)
4860 ;; Set the position to continue at. We can avoid going over
4861 ;; the comments skipped above a second time, but it's possible
4862 ;; that the comment skipping has taken us past `cfd-prop-match'
4863 ;; since the property might be used inside comments.
4864 (setq cfd-continue-pos (if cfd-prop-match
4865 (min cfd-prop-match (point))
4866 (point))))))
4867
4868 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun)
4869 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4870 ;; label from the point to CFD-LIMIT.
4871 ;;
4872 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4873 ;; arguments: The first is the end position of the token preceding the spot,
4874 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4875 ;; the match is inside a macro. Point should be moved forward by at least
4876 ;; one token.
4877 ;;
4878 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4879 ;; it should return non-nil to ensure that the next search will find them.
4880 ;;
4881 ;; Such a spot is:
4882 ;; o The first token after bob.
4883 ;; o The first token after the end of submatch 1 in
4884 ;; `c-decl-prefix-or-start-re' when that submatch matches. This
4885 ;; submatch is typically a (L or R) brace or paren, a ;, or a ,.
4886 ;; o The start of each `c-decl-prefix-or-start-re' match when
4887 ;; submatch 1 doesn't match. This is, for example, the keyword
4888 ;; "class" in Pike.
4889 ;; o The start of a previously recognized declaration; "recognized"
4890 ;; means that the last char of the previous token has a `c-type'
4891 ;; text property with the value `c-decl-end'; this only holds
4892 ;; when `c-type-decl-end-used' is set.
4893 ;;
4894 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4895 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4896 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4897 ;;
4898 ;; If the match is inside a macro then the buffer is narrowed to the
4899 ;; end of it, so that CFD-FUN can investigate the following tokens
4900 ;; without matching something that begins inside a macro and ends
4901 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4902 ;; CFD-FACE-CHECKLIST checks exist.
4903 ;;
4904 ;; The spots are visited approximately in order from top to bottom.
4905 ;; It's however the positions where `c-decl-prefix-or-start-re'
4906 ;; matches and where `c-decl-end' properties are found that are in
4907 ;; order. Since the spots often are at the following token, they
4908 ;; might be visited out of order insofar as more spots are reported
4909 ;; later on within the syntactic whitespace between the match
4910 ;; positions and their spots.
4911 ;;
4912 ;; It's assumed that comments and strings are fontified in the
4913 ;; searched range.
4914 ;;
4915 ;; This is mainly used in fontification, and so has an elaborate
4916 ;; cache to handle repeated calls from the same start position; see
4917 ;; the variables above.
4918 ;;
4919 ;; All variables in this function begin with `cfd-' to avoid name
4920 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4921 ;;
4922 ;; This function might do hidden buffer changes.
4923
4924 (let ((cfd-start-pos (point)) ; never changed
4925 (cfd-buffer-end (point-max))
4926 ;; The end of the token preceding the decl spot last found
4927 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4928 ;; no match.
4929 cfd-re-match
4930 ;; The end position of the last `c-decl-prefix-or-start-re'
4931 ;; match. If this is greater than `cfd-continue-pos', the
4932 ;; next regexp search is started here instead.
4933 (cfd-re-match-end (point-min))
4934 ;; The end of the last `c-decl-end' found by
4935 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4936 ;; match. If searching for the property isn't needed then we
4937 ;; disable it by setting it to `cfd-limit' directly.
4938 (cfd-prop-match (unless c-type-decl-end-used cfd-limit))
4939 ;; The end of the token preceding the decl spot last found by
4940 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
4941 ;; bob. `cfd-limit' if there's no match. In other words,
4942 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
4943 (cfd-match-pos cfd-limit)
4944 ;; The position to continue searching at.
4945 cfd-continue-pos
4946 ;; The position of the last "real" token we've stopped at.
4947 ;; This can be greater than `cfd-continue-pos' when we get
4948 ;; hits inside macros or at `c-decl-end' positions inside
4949 ;; comments.
4950 (cfd-token-pos 0)
4951 ;; The end position of the last entered macro.
4952 (cfd-macro-end 0))
4953
4954 ;; Initialize by finding a syntactically relevant start position
4955 ;; before the point, and do the first `c-decl-prefix-or-start-re'
4956 ;; search unless we're at bob.
4957
4958 (let (start-in-literal start-in-macro syntactic-pos)
4959 ;; Must back up a bit since we look for the end of the previous
4960 ;; statement or declaration, which is earlier than the first
4961 ;; returned match.
4962
4963 ;; This `cond' moves back over any literals or macros. It has special
4964 ;; handling for when the region being searched is entirely within a
4965 ;; macro. It sets `cfd-continue-pos' (unless we've reached
4966 ;; `cfd-limit').
4967 (cond
4968 ;; First we need to move to a syntactically relevant position.
4969 ;; Begin by backing out of comment or string literals.
4970 ;;
4971 ;; This arm of the cond actually triggers if we're in a literal,
4972 ;; and cfd-limit is at most at BONL.
4973 ((and
4974 ;; This arm of the `and' moves backwards out of a literal when
4975 ;; the face at point is a literal face. In this case, its value
4976 ;; is always non-nil.
4977 (when (c-got-face-at (point) c-literal-faces)
4978 ;; Try to use the faces to back up to the start of the
4979 ;; literal. FIXME: What if the point is on a declaration
4980 ;; inside a comment?
4981 (while (and (not (bobp))
4982 (c-got-face-at (1- (point)) c-literal-faces))
4983 (goto-char (previous-single-property-change
4984 (point) 'face nil (point-min))))
4985
4986 ;; XEmacs doesn't fontify the quotes surrounding string
4987 ;; literals.
4988 (and (featurep 'xemacs)
4989 (eq (get-text-property (point) 'face)
4990 'font-lock-string-face)
4991 (not (bobp))
4992 (progn (backward-char)
4993 (not (looking-at c-string-limit-regexp)))
4994 (forward-char))
4995
4996 ;; Don't trust the literal to contain only literal faces
4997 ;; (the font lock package might not have fontified the
4998 ;; start of it at all, for instance) so check that we have
4999 ;; arrived at something that looks like a start or else
5000 ;; resort to `c-literal-limits'.
5001 (unless (looking-at c-literal-start-regexp)
5002 (let ((range (c-literal-limits)))
5003 (if range (goto-char (car range)))))
5004
5005 (setq start-in-literal (point))) ; end of `and' arm.
5006
5007 ;; The start is in a literal. If the limit is in the same
5008 ;; one we don't have to find a syntactic position etc. We
5009 ;; only check that if the limit is at or before bonl to save
5010 ;; time; it covers the by far most common case when font-lock
5011 ;; refontifies the current line only.
5012 (<= cfd-limit (c-point 'bonl cfd-start-pos))
5013 (save-excursion
5014 (goto-char cfd-start-pos)
5015 (while (progn
5016 (goto-char (next-single-property-change
5017 (point) 'face nil cfd-limit))
5018 (and (< (point) cfd-limit)
5019 (c-got-face-at (point) c-literal-faces))))
5020 (= (point) cfd-limit))) ; end of `cond' arm condition
5021
5022 ;; Completely inside a literal. Set up variables to trig the
5023 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5024 ;; find a suitable start position.
5025 (setq cfd-continue-pos start-in-literal)) ; end of `cond' arm
5026
5027 ;; Check if the region might be completely inside a macro, to
5028 ;; optimize that like the completely-inside-literal above.
5029 ((save-excursion
5030 (and (= (forward-line 1) 0)
5031 (bolp) ; forward-line has funny behavior at eob.
5032 (>= (point) cfd-limit)
5033 (progn (backward-char)
5034 (eq (char-before) ?\\))))
5035 ;; (Maybe) completely inside a macro. Only need to trig the
5036 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5037 ;; set things up.
5038 (setq cfd-continue-pos (1- cfd-start-pos)
5039 start-in-macro t))
5040
5041 ;; The default arm of the `cond' moves back over any macro we're in
5042 ;; and over any syntactic WS. It sets `c-find-decl-syntactic-pos'.
5043 (t
5044 ;; Back out of any macro so we don't miss any declaration
5045 ;; that could follow after it.
5046 (when (c-beginning-of-macro)
5047 (setq start-in-macro t))
5048
5049 ;; Now we're at a proper syntactically relevant position so we
5050 ;; can use the cache. But first clear it if it applied
5051 ;; further down.
5052 (c-invalidate-find-decl-cache cfd-start-pos)
5053
5054 (setq syntactic-pos (point))
5055 (unless (eq syntactic-pos c-find-decl-syntactic-pos)
5056 ;; Don't have to do this if the cache is relevant here,
5057 ;; typically if the same line is refontified again. If
5058 ;; we're just some syntactic whitespace further down we can
5059 ;; still use the cache to limit the skipping.
5060 (c-backward-syntactic-ws c-find-decl-syntactic-pos))
5061
5062 ;; If we hit `c-find-decl-syntactic-pos' and
5063 ;; `c-find-decl-match-pos' is set then we install the cached
5064 ;; values. If we hit `c-find-decl-syntactic-pos' and
5065 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5066 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5067 ;; and so we can continue the search from this point. If we
5068 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5069 ;; the right spot to begin searching anyway.
5070 (if (and (eq (point) c-find-decl-syntactic-pos)
5071 c-find-decl-match-pos)
5072 (setq cfd-match-pos c-find-decl-match-pos
5073 cfd-continue-pos syntactic-pos)
5074
5075 (setq c-find-decl-syntactic-pos syntactic-pos)
5076
5077 (when (if (bobp)
5078 ;; Always consider bob a match to get the first
5079 ;; declaration in the file. Do this separately instead of
5080 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5081 ;; regexp always can consume at least one character to
5082 ;; ensure that we won't get stuck in an infinite loop.
5083 (setq cfd-re-match 0)
5084 (backward-char)
5085 (c-beginning-of-current-token)
5086 (< (point) cfd-limit))
5087 ;; Do an initial search now. In the bob case above it's
5088 ;; only done to search for a `c-decl-end' spot.
5089 (c-find-decl-prefix-search)) ; sets cfd-continue-pos
5090
5091 (setq c-find-decl-match-pos (and (< cfd-match-pos cfd-start-pos)
5092 cfd-match-pos))))) ; end of `cond'
5093
5094 ;; Advance `cfd-continue-pos' if it's before the start position.
5095 ;; The closest continue position that might have effect at or
5096 ;; after the start depends on what we started in. This also
5097 ;; finds a suitable start position in the special cases when the
5098 ;; region is completely within a literal or macro.
5099 (when (and cfd-continue-pos (< cfd-continue-pos cfd-start-pos))
5100
5101 (cond
5102 (start-in-macro
5103 ;; If we're in a macro then it's the closest preceding token
5104 ;; in the macro. Check this before `start-in-literal',
5105 ;; since if we're inside a literal in a macro, the preceding
5106 ;; token is earlier than any `c-decl-end' spot inside the
5107 ;; literal (comment).
5108 (goto-char (or start-in-literal cfd-start-pos))
5109 ;; The only syntactic ws in macros are comments.
5110 (c-backward-comments)
5111 (backward-char)
5112 (c-beginning-of-current-token))
5113
5114 (start-in-literal
5115 ;; If we're in a comment it can only be the closest
5116 ;; preceding `c-decl-end' position within that comment, if
5117 ;; any. Go back to the beginning of such a property so that
5118 ;; `c-find-decl-prefix-search' will find the end of it.
5119 ;; (Can't stop at the end and install it directly on
5120 ;; `cfd-prop-match' since that variable might be cleared
5121 ;; after `cfd-fun' below.)
5122 ;;
5123 ;; Note that if the literal is a string then the property
5124 ;; search will simply skip to the beginning of it right
5125 ;; away.
5126 (if (not c-type-decl-end-used)
5127 (goto-char start-in-literal)
5128 (goto-char cfd-start-pos)
5129 (while (progn
5130 (goto-char (previous-single-property-change
5131 (point) 'c-type nil start-in-literal))
5132 (and (> (point) start-in-literal)
5133 (not (eq (c-get-char-property (point) 'c-type)
5134 'c-decl-end))))))
5135
5136 (when (= (point) start-in-literal)
5137 ;; Didn't find any property inside the comment, so we can
5138 ;; skip it entirely. (This won't skip past a string, but
5139 ;; that'll be handled quickly by the next
5140 ;; `c-find-decl-prefix-search' anyway.)
5141 (c-forward-single-comment)
5142 (if (> (point) cfd-limit)
5143 (goto-char cfd-limit))))
5144
5145 (t
5146 ;; If we started in normal code, the only match that might
5147 ;; apply before the start is what we already got in
5148 ;; `cfd-match-pos' so we can continue at the start position.
5149 ;; (Note that we don't get here if the first match is below
5150 ;; it.)
5151 (goto-char cfd-start-pos))) ; end of `cond'
5152
5153 ;; Delete found matches if they are before our new continue
5154 ;; position, so that `c-find-decl-prefix-search' won't back up
5155 ;; to them later on.
5156 (setq cfd-continue-pos (point))
5157 (when (and cfd-re-match (< cfd-re-match cfd-continue-pos))
5158 (setq cfd-re-match nil))
5159 (when (and cfd-prop-match (< cfd-prop-match cfd-continue-pos))
5160 (setq cfd-prop-match nil))) ; end of `when'
5161
5162 (if syntactic-pos
5163 ;; This is the normal case and we got a proper syntactic
5164 ;; position. If there's a match then it's always outside
5165 ;; macros and comments, so advance to the next token and set
5166 ;; `cfd-token-pos'. The loop below will later go back using
5167 ;; `cfd-continue-pos' to fix declarations inside the
5168 ;; syntactic ws.
5169 (when (and cfd-match-pos (< cfd-match-pos syntactic-pos))
5170 (goto-char syntactic-pos)
5171 (c-forward-syntactic-ws)
5172 (and cfd-continue-pos
5173 (< cfd-continue-pos (point))
5174 (setq cfd-token-pos (point))))
5175
5176 ;; Have one of the special cases when the region is completely
5177 ;; within a literal or macro. `cfd-continue-pos' is set to a
5178 ;; good start position for the search, so do it.
5179 (c-find-decl-prefix-search)))
5180
5181 ;; Now loop, one decl spot per iteration. We already have the first
5182 ;; match in `cfd-match-pos'.
5183 (while (progn
5184 ;; Go forward over "false matches", one per iteration.
5185 (while (and
5186 (< cfd-match-pos cfd-limit)
5187
5188 (or
5189 ;; Kludge to filter out matches on the "<" that
5190 ;; aren't open parens, for the sake of languages
5191 ;; that got `c-recognize-<>-arglists' set.
5192 (and (eq (char-before cfd-match-pos) ?<)
5193 (not (c-get-char-property (1- cfd-match-pos)
5194 'syntax-table)))
5195
5196 ;; If `cfd-continue-pos' is less or equal to
5197 ;; `cfd-token-pos', we've got a hit inside a macro
5198 ;; that's in the syntactic whitespace before the last
5199 ;; "real" declaration we've checked. If they're equal
5200 ;; we've arrived at the declaration a second time, so
5201 ;; there's nothing to do.
5202 (= cfd-continue-pos cfd-token-pos)
5203
5204 (progn
5205 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5206 ;; we're still searching for declarations embedded in
5207 ;; the syntactic whitespace. In that case we need
5208 ;; only to skip comments and not macros, since they
5209 ;; can't be nested, and that's already been done in
5210 ;; `c-find-decl-prefix-search'.
5211 (when (> cfd-continue-pos cfd-token-pos)
5212 (c-forward-syntactic-ws)
5213 (setq cfd-token-pos (point)))
5214
5215 ;; Continue if the following token fails the
5216 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5217 (when (or (>= (point) cfd-limit)
5218 (not (looking-at cfd-decl-re))
5219 (and cfd-face-checklist
5220 (not (c-got-face-at
5221 (point) cfd-face-checklist))))
5222 (goto-char cfd-continue-pos)
5223 t)))
5224
5225 (< (point) cfd-limit)) ; end of "false matches" condition
5226 (c-find-decl-prefix-search)) ; end of "false matches" loop
5227
5228 (< (point) cfd-limit)) ; end of condition for "decl-spot" while
5229
5230 (when (and
5231 (>= (point) cfd-start-pos)
5232
5233 (progn
5234 ;; Narrow to the end of the macro if we got a hit inside
5235 ;; one, to avoid recognizing things that start inside the
5236 ;; macro and end outside it.
5237 (when (> cfd-match-pos cfd-macro-end)
5238 ;; Not in the same macro as in the previous round.
5239 (save-excursion
5240 (goto-char cfd-match-pos)
5241 (setq cfd-macro-end
5242 (if (save-excursion (and (c-beginning-of-macro)
5243 (< (point) cfd-match-pos)))
5244 (progn (c-end-of-macro)
5245 (point))
5246 0))))
5247
5248 (if (zerop cfd-macro-end)
5249 t
5250 (if (> cfd-macro-end (point))
5251 (progn (narrow-to-region (point-min) cfd-macro-end)
5252 t)
5253 ;; The matched token was the last thing in the macro,
5254 ;; so the whole match is bogus.
5255 (setq cfd-macro-end 0)
5256 nil)))) ; end of when condition
5257
5258 (c-debug-put-decl-spot-faces cfd-match-pos (point))
5259 (if (funcall cfd-fun cfd-match-pos (/= cfd-macro-end 0))
5260 (setq cfd-prop-match nil))
5261
5262 (when (/= cfd-macro-end 0)
5263 ;; Restore limits if we did macro narrowing above.
5264 (narrow-to-region (point-min) cfd-buffer-end)))
5265
5266 (goto-char cfd-continue-pos)
5267 (if (= cfd-continue-pos cfd-limit)
5268 (setq cfd-match-pos cfd-limit)
5269 (c-find-decl-prefix-search))))) ; Moves point, sets cfd-continue-pos,
5270 ; cfd-match-pos, etc.
5271
5272 \f
5273 ;; A cache for found types.
5274
5275 ;; Buffer local variable that contains an obarray with the types we've
5276 ;; found. If a declaration is recognized somewhere we record the
5277 ;; fully qualified identifier in it to recognize it as a type
5278 ;; elsewhere in the file too. This is not accurate since we do not
5279 ;; bother with the scoping rules of the languages, but in practice the
5280 ;; same name is seldom used as both a type and something else in a
5281 ;; file, and we only use this as a last resort in ambiguous cases (see
5282 ;; `c-forward-decl-or-cast-1').
5283 ;;
5284 ;; Not every type need be in this cache. However, things which have
5285 ;; ceased to be types must be removed from it.
5286 ;;
5287 ;; Template types in C++ are added here too but with the template
5288 ;; arglist replaced with "<>" in references or "<" for the one in the
5289 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5290 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5291 ;; template specs can be fairly sized programs in themselves) and
5292 ;; improves the hit ratio (it's a type regardless of the template
5293 ;; args; it's just not the same type, but we're only interested in
5294 ;; recognizing types, not telling distinct types apart). Note that
5295 ;; template types in references are added here too; from the example
5296 ;; above there will also be an entry "Foo<".
5297 (defvar c-found-types nil)
5298 (make-variable-buffer-local 'c-found-types)
5299
5300 (defsubst c-clear-found-types ()
5301 ;; Clears `c-found-types'.
5302 (setq c-found-types (make-vector 53 0)))
5303
5304 (defun c-add-type (from to)
5305 ;; Add the given region as a type in `c-found-types'. If the region
5306 ;; doesn't match an existing type but there is a type which is equal
5307 ;; to the given one except that the last character is missing, then
5308 ;; the shorter type is removed. That's done to avoid adding all
5309 ;; prefixes of a type as it's being entered and font locked. This
5310 ;; doesn't cover cases like when characters are removed from a type
5311 ;; or added in the middle. We'd need the position of point when the
5312 ;; font locking is invoked to solve this well.
5313 ;;
5314 ;; This function might do hidden buffer changes.
5315 (let ((type (c-syntactic-content from to c-recognize-<>-arglists)))
5316 (unless (intern-soft type c-found-types)
5317 (unintern (substring type 0 -1) c-found-types)
5318 (intern type c-found-types))))
5319
5320 (defun c-unfind-type (name)
5321 ;; Remove the "NAME" from c-found-types, if present.
5322 (unintern name c-found-types))
5323
5324 (defsubst c-check-type (from to)
5325 ;; Return non-nil if the given region contains a type in
5326 ;; `c-found-types'.
5327 ;;
5328 ;; This function might do hidden buffer changes.
5329 (intern-soft (c-syntactic-content from to c-recognize-<>-arglists)
5330 c-found-types))
5331
5332 (defun c-list-found-types ()
5333 ;; Return all the types in `c-found-types' as a sorted list of
5334 ;; strings.
5335 (let (type-list)
5336 (mapatoms (lambda (type)
5337 (setq type-list (cons (symbol-name type)
5338 type-list)))
5339 c-found-types)
5340 (sort type-list 'string-lessp)))
5341
5342 ;; Shut up the byte compiler.
5343 (defvar c-maybe-stale-found-type)
5344
5345 (defun c-trim-found-types (beg end old-len)
5346 ;; An after change function which, in conjunction with the info in
5347 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5348 ;; from `c-found-types', should this type have become stale. For
5349 ;; example, this happens to "foo" when "foo \n bar();" becomes
5350 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5351 ;; the fontification.
5352 ;;
5353 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5354 ;; type?
5355 (when (> end beg)
5356 (save-excursion
5357 (when (< end (point-max))
5358 (goto-char end)
5359 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
5360 (progn (goto-char end)
5361 (c-end-of-current-token)))
5362 (c-unfind-type (buffer-substring-no-properties
5363 end (point)))))
5364 (when (> beg (point-min))
5365 (goto-char beg)
5366 (if (and (c-end-of-current-token) ; only moves when we started in the middle
5367 (progn (goto-char beg)
5368 (c-beginning-of-current-token)))
5369 (c-unfind-type (buffer-substring-no-properties
5370 (point) beg))))))
5371
5372 (if c-maybe-stale-found-type ; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
5373 (cond
5374 ;; Changing the amount of (already existing) whitespace - don't do anything.
5375 ((and (c-partial-ws-p beg end)
5376 (or (= beg end) ; removal of WS
5377 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type)))))
5378
5379 ;; The syntactic relationship which defined a "found type" has been
5380 ;; destroyed.
5381 ((eq (car c-maybe-stale-found-type) 'c-decl-id-start)
5382 (c-unfind-type (cadr c-maybe-stale-found-type)))
5383 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5384 )))
5385
5386 \f
5387 ;; Setting and removing syntax properties on < and > in languages (C++
5388 ;; and Java) where they can be template/generic delimiters as well as
5389 ;; their normal meaning of "less/greater than".
5390
5391 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5392 ;; be delimiters, they are marked as such with the category properties
5393 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5394
5395 ;; STRATEGY:
5396 ;;
5397 ;; It is impossible to determine with certainty whether a <..> pair in
5398 ;; C++ is two comparison operators or is template delimiters, unless
5399 ;; one duplicates a lot of a C++ compiler. For example, the following
5400 ;; code fragment:
5401 ;;
5402 ;; foo (a < b, c > d) ;
5403 ;;
5404 ;; could be a function call with two integer parameters (each a
5405 ;; relational expression), or it could be a constructor for class foo
5406 ;; taking one parameter d of templated type "a < b, c >". They are
5407 ;; somewhat easier to distinguish in Java.
5408 ;;
5409 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5410 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5411 ;; individually when their context so indicated. This gave rise to
5412 ;; intractable problems when one of a matching pair was deleted, or
5413 ;; pulled into a literal.]
5414 ;;
5415 ;; At each buffer change, the syntax-table properties are removed in a
5416 ;; before-change function and reapplied, when needed, in an
5417 ;; after-change function. It is far more important that the
5418 ;; properties get removed when they they are spurious than that they
5419 ;; be present when wanted.
5420 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5421 (defun c-clear-<-pair-props (&optional pos)
5422 ;; POS (default point) is at a < character. If it is marked with
5423 ;; open paren syntax-table text property, remove the property,
5424 ;; together with the close paren property on the matching > (if
5425 ;; any).
5426 (save-excursion
5427 (if pos
5428 (goto-char pos)
5429 (setq pos (point)))
5430 (when (equal (c-get-char-property (point) 'syntax-table)
5431 c-<-as-paren-syntax)
5432 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5433 (c-go-list-forward))
5434 (when (equal (c-get-char-property (1- (point)) 'syntax-table)
5435 c->-as-paren-syntax) ; should always be true.
5436 (c-clear-char-property (1- (point)) 'category))
5437 (c-clear-char-property pos 'category))))
5438
5439 (defun c-clear->-pair-props (&optional pos)
5440 ;; POS (default point) is at a > character. If it is marked with
5441 ;; close paren syntax-table property, remove the property, together
5442 ;; with the open paren property on the matching < (if any).
5443 (save-excursion
5444 (if pos
5445 (goto-char pos)
5446 (setq pos (point)))
5447 (when (equal (c-get-char-property (point) 'syntax-table)
5448 c->-as-paren-syntax)
5449 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5450 (c-go-up-list-backward))
5451 (when (equal (c-get-char-property (point) 'syntax-table)
5452 c-<-as-paren-syntax) ; should always be true.
5453 (c-clear-char-property (point) 'category))
5454 (c-clear-char-property pos 'category))))
5455
5456 (defun c-clear-<>-pair-props (&optional pos)
5457 ;; POS (default point) is at a < or > character. If it has an
5458 ;; open/close paren syntax-table property, remove this property both
5459 ;; from the current character and its partner (which will also be
5460 ;; thusly marked).
5461 (cond
5462 ((eq (char-after) ?\<)
5463 (c-clear-<-pair-props pos))
5464 ((eq (char-after) ?\>)
5465 (c-clear->-pair-props pos))
5466 (t (c-benign-error
5467 "c-clear-<>-pair-props called from wrong position"))))
5468
5469 (defun c-clear-<-pair-props-if-match-after (lim &optional pos)
5470 ;; POS (default point) is at a < character. If it is both marked
5471 ;; with open/close paren syntax-table property, and has a matching >
5472 ;; (also marked) which is after LIM, remove the property both from
5473 ;; the current > and its partner. Return t when this happens, nil
5474 ;; when it doesn't.
5475 (save-excursion
5476 (if pos
5477 (goto-char pos)
5478 (setq pos (point)))
5479 (when (equal (c-get-char-property (point) 'syntax-table)
5480 c-<-as-paren-syntax)
5481 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5482 (c-go-list-forward))
5483 (when (and (>= (point) lim)
5484 (equal (c-get-char-property (1- (point)) 'syntax-table)
5485 c->-as-paren-syntax)) ; should always be true.
5486 (c-unmark-<->-as-paren (1- (point)))
5487 (c-unmark-<->-as-paren pos))
5488 t)))
5489
5490 (defun c-clear->-pair-props-if-match-before (lim &optional pos)
5491 ;; POS (default point) is at a > character. If it is both marked
5492 ;; with open/close paren syntax-table property, and has a matching <
5493 ;; (also marked) which is before LIM, remove the property both from
5494 ;; the current < and its partner. Return t when this happens, nil
5495 ;; when it doesn't.
5496 (save-excursion
5497 (if pos
5498 (goto-char pos)
5499 (setq pos (point)))
5500 (when (equal (c-get-char-property (point) 'syntax-table)
5501 c->-as-paren-syntax)
5502 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5503 (c-go-up-list-backward))
5504 (when (and (<= (point) lim)
5505 (equal (c-get-char-property (point) 'syntax-table)
5506 c-<-as-paren-syntax)) ; should always be true.
5507 (c-unmark-<->-as-paren (point))
5508 (c-unmark-<->-as-paren pos))
5509 t)))
5510
5511 ;; Set by c-common-init in cc-mode.el.
5512 (defvar c-new-BEG)
5513 (defvar c-new-END)
5514
5515 (defun c-before-change-check-<>-operators (beg end)
5516 ;; Unmark certain pairs of "< .... >" which are currently marked as
5517 ;; template/generic delimiters. (This marking is via syntax-table
5518 ;; text properties).
5519 ;;
5520 ;; These pairs are those which are in the current "statement" (i.e.,
5521 ;; the region between the {, }, or ; before BEG and the one after
5522 ;; END), and which enclose any part of the interval (BEG END).
5523 ;;
5524 ;; Note that in C++ (?and Java), template/generic parens cannot
5525 ;; enclose a brace or semicolon, so we use these as bounds on the
5526 ;; region we must work on.
5527 ;;
5528 ;; This function is called from before-change-functions (via
5529 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5530 ;; and point is undefined, both at entry and exit.
5531 ;;
5532 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5533 ;; 2010-01-29.
5534 (save-excursion
5535 (let ((beg-lit-limits (progn (goto-char beg) (c-literal-limits)))
5536 (end-lit-limits (progn (goto-char end) (c-literal-limits)))
5537 new-beg new-end need-new-beg need-new-end)
5538 ;; Locate the barrier before the changed region
5539 (goto-char (if beg-lit-limits (car beg-lit-limits) beg))
5540 (c-syntactic-skip-backward "^;{}" (c-determine-limit 512))
5541 (setq new-beg (point))
5542
5543 ;; Remove the syntax-table properties from each pertinent <...> pair.
5544 ;; Firsly, the ones with the < before beg and > after beg.
5545 (while (c-search-forward-char-property 'category 'c-<-as-paren-syntax beg)
5546 (if (c-clear-<-pair-props-if-match-after beg (1- (point)))
5547 (setq need-new-beg t)))
5548
5549 ;; Locate the barrier after END.
5550 (goto-char (if end-lit-limits (cdr end-lit-limits) end))
5551 (c-syntactic-re-search-forward "[;{}]" (c-determine-+ve-limit 512) 'end)
5552 (setq new-end (point))
5553
5554 ;; Remove syntax-table properties from the remaining pertinent <...>
5555 ;; pairs, those with a > after end and < before end.
5556 (while (c-search-backward-char-property 'category 'c->-as-paren-syntax end)
5557 (if (c-clear->-pair-props-if-match-before end)
5558 (setq need-new-end t)))
5559
5560 ;; Extend the fontification region, if needed.
5561 (when need-new-beg
5562 (goto-char new-beg)
5563 (c-forward-syntactic-ws)
5564 (and (< (point) c-new-BEG) (setq c-new-BEG (point))))
5565
5566 (when need-new-end
5567 (and (> new-end c-new-END) (setq c-new-END new-end))))))
5568
5569 (defun c-after-change-check-<>-operators (beg end)
5570 ;; This is called from `after-change-functions' when
5571 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5572 ;; chars with paren syntax become part of another operator like "<<"
5573 ;; or ">=".
5574 ;;
5575 ;; This function might do hidden buffer changes.
5576
5577 (save-excursion
5578 (goto-char beg)
5579 (when (or (looking-at "[<>]")
5580 (< (skip-chars-backward "<>") 0))
5581
5582 (goto-char beg)
5583 (c-beginning-of-current-token)
5584 (when (and (< (point) beg)
5585 (looking-at c-<>-multichar-token-regexp)
5586 (< beg (setq beg (match-end 0))))
5587 (while (progn (skip-chars-forward "^<>" beg)
5588 (< (point) beg))
5589 (c-clear-<>-pair-props)
5590 (forward-char))))
5591
5592 (when (< beg end)
5593 (goto-char end)
5594 (when (or (looking-at "[<>]")
5595 (< (skip-chars-backward "<>") 0))
5596
5597 (goto-char end)
5598 (c-beginning-of-current-token)
5599 (when (and (< (point) end)
5600 (looking-at c-<>-multichar-token-regexp)
5601 (< end (setq end (match-end 0))))
5602 (while (progn (skip-chars-forward "^<>" end)
5603 (< (point) end))
5604 (c-clear-<>-pair-props)
5605 (forward-char)))))))
5606
5607
5608 \f
5609 ;; Handling of small scale constructs like types and names.
5610
5611 ;; Dynamically bound variable that instructs `c-forward-type' to also
5612 ;; treat possible types (i.e. those that it normally returns 'maybe or
5613 ;; 'found for) as actual types (and always return 'found for them).
5614 ;; This means that it records them in `c-record-type-identifiers' if
5615 ;; that is set, and that it adds them to `c-found-types'.
5616 (defvar c-promote-possible-types nil)
5617
5618 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5619 ;; mark up successfully parsed arglists with paren syntax properties on
5620 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5621 ;; `c-type' property of each argument separating comma.
5622 ;;
5623 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5624 ;; all arglists for side effects (i.e. recording types), otherwise it
5625 ;; exploits any existing paren syntax properties to quickly jump to the
5626 ;; end of already parsed arglists.
5627 ;;
5628 ;; Marking up the arglists is not the default since doing that correctly
5629 ;; depends on a proper value for `c-restricted-<>-arglists'.
5630 (defvar c-parse-and-markup-<>-arglists nil)
5631
5632 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5633 ;; not accept arglists that contain binary operators.
5634 ;;
5635 ;; This is primarily used to handle C++ template arglists. C++
5636 ;; disambiguates them by checking whether the preceding name is a
5637 ;; template or not. We can't do that, so we assume it is a template
5638 ;; if it can be parsed as one. That usually works well since
5639 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5640 ;; in almost all cases would be pointless.
5641 ;;
5642 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5643 ;; should let the comma separate the function arguments instead. And
5644 ;; in a context where the value of the expression is taken, e.g. in
5645 ;; "if (a < b || c > d)", it's probably not a template.
5646 (defvar c-restricted-<>-arglists nil)
5647
5648 ;; Dynamically bound variables that instructs
5649 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5650 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5651 ;; `c-forward-label' to record the ranges of all the type and
5652 ;; reference identifiers they encounter. They will build lists on
5653 ;; these variables where each element is a cons of the buffer
5654 ;; positions surrounding each identifier. This recording is only
5655 ;; activated when `c-record-type-identifiers' is non-nil.
5656 ;;
5657 ;; All known types that can't be identifiers are recorded, and also
5658 ;; other possible types if `c-promote-possible-types' is set.
5659 ;; Recording is however disabled inside angle bracket arglists that
5660 ;; are encountered inside names and other angle bracket arglists.
5661 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5662 ;; instead.
5663 ;;
5664 ;; Only the names in C++ template style references (e.g. "tmpl" in
5665 ;; "tmpl<a,b>::foo") are recorded as references, other references
5666 ;; aren't handled here.
5667 ;;
5668 ;; `c-forward-label' records the label identifier(s) on
5669 ;; `c-record-ref-identifiers'.
5670 (defvar c-record-type-identifiers nil)
5671 (defvar c-record-ref-identifiers nil)
5672
5673 ;; This variable will receive a cons cell of the range of the last
5674 ;; single identifier symbol stepped over by `c-forward-name' if it's
5675 ;; successful. This is the range that should be put on one of the
5676 ;; record lists above by the caller. It's assigned nil if there's no
5677 ;; such symbol in the name.
5678 (defvar c-last-identifier-range nil)
5679
5680 (defmacro c-record-type-id (range)
5681 (if (eq (car-safe range) 'cons)
5682 ;; Always true.
5683 `(setq c-record-type-identifiers
5684 (cons ,range c-record-type-identifiers))
5685 `(let ((range ,range))
5686 (if range
5687 (setq c-record-type-identifiers
5688 (cons range c-record-type-identifiers))))))
5689
5690 (defmacro c-record-ref-id (range)
5691 (if (eq (car-safe range) 'cons)
5692 ;; Always true.
5693 `(setq c-record-ref-identifiers
5694 (cons ,range c-record-ref-identifiers))
5695 `(let ((range ,range))
5696 (if range
5697 (setq c-record-ref-identifiers
5698 (cons range c-record-ref-identifiers))))))
5699
5700 ;; Dynamically bound variable that instructs `c-forward-type' to
5701 ;; record the ranges of types that only are found. Behaves otherwise
5702 ;; like `c-record-type-identifiers'.
5703 (defvar c-record-found-types nil)
5704
5705 (defmacro c-forward-keyword-prefixed-id (type)
5706 ;; Used internally in `c-forward-keyword-clause' to move forward
5707 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5708 ;; possibly is prefixed by keywords and their associated clauses.
5709 ;; Try with a type/name first to not trip up on those that begin
5710 ;; with a keyword. Return t if a known or found type is moved
5711 ;; over. The point is clobbered if nil is returned. If range
5712 ;; recording is enabled, the identifier is recorded on as a type
5713 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5714 ;;
5715 ;; This macro might do hidden buffer changes.
5716 `(let (res)
5717 (while (if (setq res ,(if (eq type 'type)
5718 `(c-forward-type)
5719 `(c-forward-name)))
5720 nil
5721 (and (looking-at c-keywords-regexp)
5722 (c-forward-keyword-clause 1))))
5723 (when (memq res '(t known found prefix))
5724 ,(when (eq type 'ref)
5725 `(when c-record-type-identifiers
5726 (c-record-ref-id c-last-identifier-range)))
5727 t)))
5728
5729 (defmacro c-forward-id-comma-list (type update-safe-pos)
5730 ;; Used internally in `c-forward-keyword-clause' to move forward
5731 ;; over a comma separated list of types or names using
5732 ;; `c-forward-keyword-prefixed-id'.
5733 ;;
5734 ;; This macro might do hidden buffer changes.
5735 `(while (and (progn
5736 ,(when update-safe-pos
5737 `(setq safe-pos (point)))
5738 (eq (char-after) ?,))
5739 (progn
5740 (forward-char)
5741 (c-forward-syntactic-ws)
5742 (c-forward-keyword-prefixed-id ,type)))))
5743
5744 (defun c-forward-keyword-clause (match)
5745 ;; Submatch MATCH in the current match data is assumed to surround a
5746 ;; token. If it's a keyword, move over it and any immediately
5747 ;; following clauses associated with it, stopping at the start of
5748 ;; the next token. t is returned in that case, otherwise the point
5749 ;; stays and nil is returned. The kind of clauses that are
5750 ;; recognized are those specified by `c-type-list-kwds',
5751 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5752 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5753 ;; and `c-<>-arglist-kwds'.
5754 ;;
5755 ;; This function records identifier ranges on
5756 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5757 ;; `c-record-type-identifiers' is non-nil.
5758 ;;
5759 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5760 ;; apply directly after the keyword, the type list is moved over
5761 ;; only when there is no unaccounted token before it (i.e. a token
5762 ;; that isn't moved over due to some other keyword list). The
5763 ;; identifier ranges in the list are still recorded if that should
5764 ;; be done, though.
5765 ;;
5766 ;; This function might do hidden buffer changes.
5767
5768 (let ((kwd-sym (c-keyword-sym (match-string match))) safe-pos pos
5769 ;; The call to `c-forward-<>-arglist' below is made after
5770 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5771 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5772 ;; should therefore be nil.
5773 (c-parse-and-markup-<>-arglists t)
5774 c-restricted-<>-arglists)
5775
5776 (when kwd-sym
5777 (goto-char (match-end match))
5778 (c-forward-syntactic-ws)
5779 (setq safe-pos (point))
5780
5781 (cond
5782 ((and (c-keyword-member kwd-sym 'c-type-list-kwds)
5783 (c-forward-keyword-prefixed-id type))
5784 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5785 (c-forward-id-comma-list type t))
5786
5787 ((and (c-keyword-member kwd-sym 'c-ref-list-kwds)
5788 (c-forward-keyword-prefixed-id ref))
5789 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5790 (c-forward-id-comma-list ref t))
5791
5792 ((and (c-keyword-member kwd-sym 'c-paren-any-kwds)
5793 (eq (char-after) ?\())
5794 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5795
5796 (forward-char)
5797 (when (and (setq pos (c-up-list-forward))
5798 (eq (char-before pos) ?\)))
5799 (when (and c-record-type-identifiers
5800 (c-keyword-member kwd-sym 'c-paren-type-kwds))
5801 ;; Use `c-forward-type' on every identifier we can find
5802 ;; inside the paren, to record the types.
5803 (while (c-syntactic-re-search-forward c-symbol-start pos t)
5804 (goto-char (match-beginning 0))
5805 (unless (c-forward-type)
5806 (looking-at c-symbol-key) ; Always matches.
5807 (goto-char (match-end 0)))))
5808
5809 (goto-char pos)
5810 (c-forward-syntactic-ws)
5811 (setq safe-pos (point))))
5812
5813 ((and (c-keyword-member kwd-sym 'c-<>-sexp-kwds)
5814 (eq (char-after) ?<)
5815 (c-forward-<>-arglist (c-keyword-member kwd-sym 'c-<>-type-kwds)))
5816 (c-forward-syntactic-ws)
5817 (setq safe-pos (point)))
5818
5819 ((and (c-keyword-member kwd-sym 'c-nonsymbol-sexp-kwds)
5820 (not (looking-at c-symbol-start))
5821 (c-safe (c-forward-sexp) t))
5822 (c-forward-syntactic-ws)
5823 (setq safe-pos (point))))
5824
5825 (when (c-keyword-member kwd-sym 'c-colon-type-list-kwds)
5826 (if (eq (char-after) ?:)
5827 ;; If we are at the colon already, we move over the type
5828 ;; list after it.
5829 (progn
5830 (forward-char)
5831 (c-forward-syntactic-ws)
5832 (when (c-forward-keyword-prefixed-id type)
5833 (c-forward-id-comma-list type t)))
5834 ;; Not at the colon, so stop here. But the identifier
5835 ;; ranges in the type list later on should still be
5836 ;; recorded.
5837 (and c-record-type-identifiers
5838 (progn
5839 ;; If a keyword matched both one of the types above and
5840 ;; this one, we match `c-colon-type-list-re' after the
5841 ;; clause matched above.
5842 (goto-char safe-pos)
5843 (looking-at c-colon-type-list-re))
5844 (progn
5845 (goto-char (match-end 0))
5846 (c-forward-syntactic-ws)
5847 (c-forward-keyword-prefixed-id type))
5848 ;; There's a type after the `c-colon-type-list-re' match
5849 ;; after a keyword in `c-colon-type-list-kwds'.
5850 (c-forward-id-comma-list type nil))))
5851
5852 (goto-char safe-pos)
5853 t)))
5854
5855 ;; cc-mode requires cc-fonts.
5856 (declare-function c-fontify-recorded-types-and-refs "cc-fonts" ())
5857
5858 (defun c-forward-<>-arglist (all-types)
5859 ;; The point is assumed to be at a "<". Try to treat it as the open
5860 ;; paren of an angle bracket arglist and move forward to the
5861 ;; corresponding ">". If successful, the point is left after the
5862 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5863 ;; returned. If ALL-TYPES is t then all encountered arguments in
5864 ;; the arglist that might be types are treated as found types.
5865 ;;
5866 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5867 ;; function handles text properties on the angle brackets and argument
5868 ;; separating commas.
5869 ;;
5870 ;; `c-restricted-<>-arglists' controls how lenient the template
5871 ;; arglist recognition should be.
5872 ;;
5873 ;; This function records identifier ranges on
5874 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5875 ;; `c-record-type-identifiers' is non-nil.
5876 ;;
5877 ;; This function might do hidden buffer changes.
5878
5879 (let ((start (point))
5880 ;; If `c-record-type-identifiers' is set then activate
5881 ;; recording of any found types that constitute an argument in
5882 ;; the arglist.
5883 (c-record-found-types (if c-record-type-identifiers t)))
5884 (if (catch 'angle-bracket-arglist-escape
5885 (setq c-record-found-types
5886 (c-forward-<>-arglist-recur all-types)))
5887 (progn
5888 (when (consp c-record-found-types)
5889 (setq c-record-type-identifiers
5890 ;; `nconc' doesn't mind that the tail of
5891 ;; `c-record-found-types' is t.
5892 (nconc c-record-found-types c-record-type-identifiers)))
5893 (if (c-major-mode-is 'java-mode) (c-fontify-recorded-types-and-refs))
5894 t)
5895
5896 (goto-char start)
5897 nil)))
5898
5899 (defun c-forward-<>-arglist-recur (all-types)
5900 ;; Recursive part of `c-forward-<>-arglist'.
5901 ;;
5902 ;; This function might do hidden buffer changes.
5903 (let ((start (point)) res pos tmp
5904 ;; Cover this so that any recorded found type ranges are
5905 ;; automatically lost if it turns out to not be an angle
5906 ;; bracket arglist. It's propagated through the return value
5907 ;; on successful completion.
5908 (c-record-found-types c-record-found-types)
5909 ;; List that collects the positions after the argument
5910 ;; separating ',' in the arglist.
5911 arg-start-pos)
5912 ;; If the '<' has paren open syntax then we've marked it as an angle
5913 ;; bracket arglist before, so skip to the end.
5914 (if (and (not c-parse-and-markup-<>-arglists)
5915 (c-get-char-property (point) 'syntax-table))
5916
5917 (progn
5918 (forward-char)
5919 (if (and (c-go-up-list-forward)
5920 (eq (char-before) ?>))
5921 t
5922 ;; Got unmatched paren angle brackets. We don't clear the paren
5923 ;; syntax properties and retry, on the basis that it's very
5924 ;; unlikely that paren angle brackets become operators by code
5925 ;; manipulation. It's far more likely that it doesn't match due
5926 ;; to narrowing or some temporary change.
5927 (goto-char start)
5928 nil))
5929
5930 (forward-char) ; Forward over the opening '<'.
5931
5932 (unless (looking-at c-<-op-cont-regexp)
5933 ;; go forward one non-alphanumeric character (group) per iteration of
5934 ;; this loop.
5935 (while (and
5936 (progn
5937 (c-forward-syntactic-ws)
5938 (let ((orig-record-found-types c-record-found-types))
5939 (when (or (and c-record-type-identifiers all-types)
5940 (c-major-mode-is 'java-mode))
5941 ;; All encountered identifiers are types, so set the
5942 ;; promote flag and parse the type.
5943 (progn
5944 (c-forward-syntactic-ws)
5945 (if (looking-at "\\?")
5946 (forward-char)
5947 (when (looking-at c-identifier-start)
5948 (let ((c-promote-possible-types t)
5949 (c-record-found-types t))
5950 (c-forward-type))))
5951
5952 (c-forward-syntactic-ws)
5953
5954 (when (or (looking-at "extends")
5955 (looking-at "super"))
5956 (forward-word)
5957 (c-forward-syntactic-ws)
5958 (let ((c-promote-possible-types t)
5959 (c-record-found-types t))
5960 (c-forward-type)
5961 (c-forward-syntactic-ws))))))
5962
5963 (setq pos (point)) ; e.g. first token inside the '<'
5964
5965 ;; Note: These regexps exploit the match order in \| so
5966 ;; that "<>" is matched by "<" rather than "[^>:-]>".
5967 (c-syntactic-re-search-forward
5968 ;; Stop on ',', '|', '&', '+' and '-' to catch
5969 ;; common binary operators that could be between
5970 ;; two comparison expressions "a<b" and "c>d".
5971 "[<;{},|+&-]\\|[>)]"
5972 nil t t))
5973
5974 (cond
5975 ((eq (char-before) ?>)
5976 ;; Either an operator starting with '>' or the end of
5977 ;; the angle bracket arglist.
5978
5979 (if (looking-at c->-op-without->-cont-regexp)
5980 (progn
5981 (goto-char (match-end 0))
5982 t) ; Continue the loop.
5983
5984 ;; The angle bracket arglist is finished.
5985 (when c-parse-and-markup-<>-arglists
5986 (while arg-start-pos
5987 (c-put-c-type-property (1- (car arg-start-pos))
5988 'c-<>-arg-sep)
5989 (setq arg-start-pos (cdr arg-start-pos)))
5990 (c-mark-<-as-paren start)
5991 (c-mark->-as-paren (1- (point))))
5992 (setq res t)
5993 nil)) ; Exit the loop.
5994
5995 ((eq (char-before) ?<)
5996 ;; Either an operator starting with '<' or a nested arglist.
5997 (setq pos (point))
5998 (let (id-start id-end subres keyword-match)
5999 (cond
6000 ;; The '<' begins a multi-char operator.
6001 ((looking-at c-<-op-cont-regexp)
6002 (setq tmp (match-end 0))
6003 (goto-char (match-end 0)))
6004 ;; We're at a nested <.....>
6005 ((progn
6006 (setq tmp pos)
6007 (backward-char) ; to the '<'
6008 (and
6009 (save-excursion
6010 ;; There's always an identifier before an angle
6011 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
6012 ;; or `c-<>-arglist-kwds'.
6013 (c-backward-syntactic-ws)
6014 (setq id-end (point))
6015 (c-simple-skip-symbol-backward)
6016 (when (or (setq keyword-match
6017 (looking-at c-opt-<>-sexp-key))
6018 (not (looking-at c-keywords-regexp)))
6019 (setq id-start (point))))
6020 (setq subres
6021 (let ((c-promote-possible-types t)
6022 (c-record-found-types t))
6023 (c-forward-<>-arglist-recur
6024 (and keyword-match
6025 (c-keyword-member
6026 (c-keyword-sym (match-string 1))
6027 'c-<>-type-kwds)))))))
6028 ;; It was an angle bracket arglist.
6029 (setq c-record-found-types subres)
6030
6031 ;; Record the identifier before the template as a type
6032 ;; or reference depending on whether the arglist is last
6033 ;; in a qualified identifier.
6034 (when (and c-record-type-identifiers
6035 (not keyword-match))
6036 (if (and c-opt-identifier-concat-key
6037 (progn
6038 (c-forward-syntactic-ws)
6039 (looking-at c-opt-identifier-concat-key)))
6040 (c-record-ref-id (cons id-start id-end))
6041 (c-record-type-id (cons id-start id-end)))))
6042
6043 ;; At a "less than" operator.
6044 (t
6045 (forward-char)
6046 )))
6047 t) ; carry on looping.
6048
6049 ((and (not c-restricted-<>-arglists)
6050 (or (and (eq (char-before) ?&)
6051 (not (eq (char-after) ?&)))
6052 (eq (char-before) ?,)))
6053 ;; Just another argument. Record the position. The
6054 ;; type check stuff that made us stop at it is at
6055 ;; the top of the loop.
6056 (setq arg-start-pos (cons (point) arg-start-pos)))
6057
6058 (t
6059 ;; Got a character that can't be in an angle bracket
6060 ;; arglist argument. Abort using `throw', since
6061 ;; it's useless to try to find a surrounding arglist
6062 ;; if we're nested.
6063 (throw 'angle-bracket-arglist-escape nil))))))
6064 (if res
6065 (or c-record-found-types t)))))
6066
6067 (defun c-backward-<>-arglist (all-types &optional limit)
6068 ;; The point is assumed to be directly after a ">". Try to treat it
6069 ;; as the close paren of an angle bracket arglist and move back to
6070 ;; the corresponding "<". If successful, the point is left at
6071 ;; the "<" and t is returned, otherwise the point isn't moved and
6072 ;; nil is returned. ALL-TYPES is passed on to
6073 ;; `c-forward-<>-arglist'.
6074 ;;
6075 ;; If the optional LIMIT is given, it bounds the backward search.
6076 ;; It's then assumed to be at a syntactically relevant position.
6077 ;;
6078 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6079 ;; function for more details.
6080
6081 (let ((start (point)))
6082 (backward-char)
6083 (if (and (not c-parse-and-markup-<>-arglists)
6084 (c-get-char-property (point) 'syntax-table))
6085
6086 (if (and (c-go-up-list-backward)
6087 (eq (char-after) ?<))
6088 t
6089 ;; See corresponding note in `c-forward-<>-arglist'.
6090 (goto-char start)
6091 nil)
6092
6093 (while (progn
6094 (c-syntactic-skip-backward "^<;{}" limit t)
6095
6096 (and
6097 (if (eq (char-before) ?<)
6098 t
6099 ;; Stopped at bob or a char that isn't allowed in an
6100 ;; arglist, so we've failed.
6101 (goto-char start)
6102 nil)
6103
6104 (if (> (point)
6105 (progn (c-beginning-of-current-token)
6106 (point)))
6107 ;; If we moved then the "<" was part of some
6108 ;; multicharacter token.
6109 t
6110
6111 (backward-char)
6112 (let ((beg-pos (point)))
6113 (if (c-forward-<>-arglist all-types)
6114 (cond ((= (point) start)
6115 ;; Matched the arglist. Break the while.
6116 (goto-char beg-pos)
6117 nil)
6118 ((> (point) start)
6119 ;; We started from a non-paren ">" inside an
6120 ;; arglist.
6121 (goto-char start)
6122 nil)
6123 (t
6124 ;; Matched a shorter arglist. Can be a nested
6125 ;; one so continue looking.
6126 (goto-char beg-pos)
6127 t))
6128 t))))))
6129
6130 (/= (point) start))))
6131
6132 (defun c-forward-name ()
6133 ;; Move forward over a complete name if at the beginning of one,
6134 ;; stopping at the next following token. A keyword, as such,
6135 ;; doesn't count as a name. If the point is not at something that
6136 ;; is recognized as a name then it stays put.
6137 ;;
6138 ;; A name could be something as simple as "foo" in C or something as
6139 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6140 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6141 ;; int>::*volatile const" in C++ (this function is actually little
6142 ;; more than a `looking-at' call in all modes except those that,
6143 ;; like C++, have `c-recognize-<>-arglists' set).
6144 ;;
6145 ;; Return
6146 ;; o - nil if no name is found;
6147 ;; o - 'template if it's an identifier ending with an angle bracket
6148 ;; arglist;
6149 ;; o - 'operator of it's an operator identifier;
6150 ;; o - t if it's some other kind of name.
6151 ;;
6152 ;; This function records identifier ranges on
6153 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6154 ;; `c-record-type-identifiers' is non-nil.
6155 ;;
6156 ;; This function might do hidden buffer changes.
6157
6158 (let ((pos (point)) (start (point)) res id-start id-end
6159 ;; Turn off `c-promote-possible-types' here since we might
6160 ;; call `c-forward-<>-arglist' and we don't want it to promote
6161 ;; every suspect thing in the arglist to a type. We're
6162 ;; typically called from `c-forward-type' in this case, and
6163 ;; the caller only wants the top level type that it finds to
6164 ;; be promoted.
6165 c-promote-possible-types)
6166 (while
6167 (and
6168 (looking-at c-identifier-key)
6169
6170 (progn
6171 ;; Check for keyword. We go to the last symbol in
6172 ;; `c-identifier-key' first.
6173 (goto-char (setq id-end (match-end 0)))
6174 (c-simple-skip-symbol-backward)
6175 (setq id-start (point))
6176
6177 (if (looking-at c-keywords-regexp)
6178 (when (and (c-major-mode-is 'c++-mode)
6179 (looking-at
6180 (cc-eval-when-compile
6181 (concat "\\(operator\\|\\(template\\)\\)"
6182 "\\(" (c-lang-const c-nonsymbol-key c++)
6183 "\\|$\\)")))
6184 (if (match-beginning 2)
6185 ;; "template" is only valid inside an
6186 ;; identifier if preceded by "::".
6187 (save-excursion
6188 (c-backward-syntactic-ws)
6189 (and (c-safe (backward-char 2) t)
6190 (looking-at "::")))
6191 t))
6192
6193 ;; Handle a C++ operator or template identifier.
6194 (goto-char id-end)
6195 (c-forward-syntactic-ws)
6196 (cond ((eq (char-before id-end) ?e)
6197 ;; Got "... ::template".
6198 (let ((subres (c-forward-name)))
6199 (when subres
6200 (setq pos (point)
6201 res subres))))
6202
6203 ((looking-at c-identifier-start)
6204 ;; Got a cast operator.
6205 (when (c-forward-type)
6206 (setq pos (point)
6207 res 'operator)
6208 ;; Now we should match a sequence of either
6209 ;; '*', '&' or a name followed by ":: *",
6210 ;; where each can be followed by a sequence
6211 ;; of `c-opt-type-modifier-key'.
6212 (while (cond ((looking-at "[*&]")
6213 (goto-char (match-end 0))
6214 t)
6215 ((looking-at c-identifier-start)
6216 (and (c-forward-name)
6217 (looking-at "::")
6218 (progn
6219 (goto-char (match-end 0))
6220 (c-forward-syntactic-ws)
6221 (eq (char-after) ?*))
6222 (progn
6223 (forward-char)
6224 t))))
6225 (while (progn
6226 (c-forward-syntactic-ws)
6227 (setq pos (point))
6228 (looking-at c-opt-type-modifier-key))
6229 (goto-char (match-end 1))))))
6230
6231 ((looking-at c-overloadable-operators-regexp)
6232 ;; Got some other operator.
6233 (setq c-last-identifier-range
6234 (cons (point) (match-end 0)))
6235 (goto-char (match-end 0))
6236 (c-forward-syntactic-ws)
6237 (setq pos (point)
6238 res 'operator)))
6239
6240 nil)
6241
6242 ;; `id-start' is equal to `id-end' if we've jumped over
6243 ;; an identifier that doesn't end with a symbol token.
6244 ;; That can occur e.g. for Java import directives on the
6245 ;; form "foo.bar.*".
6246 (when (and id-start (/= id-start id-end))
6247 (setq c-last-identifier-range
6248 (cons id-start id-end)))
6249 (goto-char id-end)
6250 (c-forward-syntactic-ws)
6251 (setq pos (point)
6252 res t)))
6253
6254 (progn
6255 (goto-char pos)
6256 (when (or c-opt-identifier-concat-key
6257 c-recognize-<>-arglists)
6258
6259 (cond
6260 ((and c-opt-identifier-concat-key
6261 (looking-at c-opt-identifier-concat-key))
6262 ;; Got a concatenated identifier. This handles the
6263 ;; cases with tricky syntactic whitespace that aren't
6264 ;; covered in `c-identifier-key'.
6265 (goto-char (match-end 0))
6266 (c-forward-syntactic-ws)
6267 t)
6268
6269 ((and c-recognize-<>-arglists
6270 (eq (char-after) ?<))
6271 ;; Maybe an angle bracket arglist.
6272 (when (let ((c-record-type-identifiers t)
6273 (c-record-found-types t))
6274 (c-forward-<>-arglist nil))
6275
6276 (c-add-type start (1+ pos))
6277 (c-forward-syntactic-ws)
6278 (setq pos (point)
6279 c-last-identifier-range nil)
6280
6281 (if (and c-opt-identifier-concat-key
6282 (looking-at c-opt-identifier-concat-key))
6283
6284 ;; Continue if there's an identifier concatenation
6285 ;; operator after the template argument.
6286 (progn
6287 (when (and c-record-type-identifiers id-start)
6288 (c-record-ref-id (cons id-start id-end)))
6289 (forward-char 2)
6290 (c-forward-syntactic-ws)
6291 t)
6292
6293 (when (and c-record-type-identifiers id-start)
6294 (c-record-type-id (cons id-start id-end)))
6295 (setq res 'template)
6296 nil)))
6297 )))))
6298
6299 (goto-char pos)
6300 res))
6301
6302 (defun c-forward-type (&optional brace-block-too)
6303 ;; Move forward over a type spec if at the beginning of one,
6304 ;; stopping at the next following token. The keyword "typedef"
6305 ;; isn't part of a type spec here.
6306 ;;
6307 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6308 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6309 ;; The current (2009-03-10) intention is to convert all uses of
6310 ;; `c-forward-type' to call with this parameter set, then to
6311 ;; eliminate it.
6312 ;;
6313 ;; Return
6314 ;; o - t if it's a known type that can't be a name or other
6315 ;; expression;
6316 ;; o - 'known if it's an otherwise known type (according to
6317 ;; `*-font-lock-extra-types');
6318 ;; o - 'prefix if it's a known prefix of a type;
6319 ;; o - 'found if it's a type that matches one in `c-found-types';
6320 ;; o - 'maybe if it's an identifier that might be a type;
6321 ;; o - 'decltype if it's a decltype(variable) declaration; - or
6322 ;; o - nil if it can't be a type (the point isn't moved then).
6323 ;;
6324 ;; The point is assumed to be at the beginning of a token.
6325 ;;
6326 ;; Note that this function doesn't skip past the brace definition
6327 ;; that might be considered part of the type, e.g.
6328 ;; "enum {a, b, c} foo".
6329 ;;
6330 ;; This function records identifier ranges on
6331 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6332 ;; `c-record-type-identifiers' is non-nil.
6333 ;;
6334 ;; This function might do hidden buffer changes.
6335 (when (and c-recognize-<>-arglists
6336 (looking-at "<"))
6337 (c-forward-<>-arglist t)
6338 (c-forward-syntactic-ws))
6339
6340 (let ((start (point)) pos res name-res id-start id-end id-range)
6341
6342 ;; Skip leading type modifiers. If any are found we know it's a
6343 ;; prefix of a type.
6344 (when c-opt-type-modifier-key ; e.g. "const" "volatile", but NOT "typedef"
6345 (while (looking-at c-opt-type-modifier-key)
6346 (goto-char (match-end 1))
6347 (c-forward-syntactic-ws)
6348 (setq res 'prefix)))
6349
6350 (cond
6351 ((looking-at c-typeof-key) ; e.g. C++'s "decltype".
6352 (goto-char (match-end 1))
6353 (c-forward-syntactic-ws)
6354 (setq res (and (eq (char-after) ?\()
6355 (c-safe (c-forward-sexp))
6356 'decltype))
6357 (if res
6358 (c-forward-syntactic-ws)
6359 (goto-char start)))
6360
6361 ((looking-at c-type-prefix-key) ; e.g. "struct", "class", but NOT
6362 ; "typedef".
6363 (goto-char (match-end 1))
6364 (c-forward-syntactic-ws)
6365 (setq pos (point))
6366
6367 (setq name-res (c-forward-name))
6368 (setq res (not (null name-res)))
6369 (when (eq name-res t)
6370 ;; In many languages the name can be used without the
6371 ;; prefix, so we add it to `c-found-types'.
6372 (c-add-type pos (point))
6373 (when (and c-record-type-identifiers
6374 c-last-identifier-range)
6375 (c-record-type-id c-last-identifier-range)))
6376 (when (and brace-block-too
6377 (memq res '(t nil))
6378 (eq (char-after) ?\{)
6379 (save-excursion
6380 (c-safe
6381 (progn (c-forward-sexp)
6382 (c-forward-syntactic-ws)
6383 (setq pos (point))))))
6384 (goto-char pos)
6385 (setq res t))
6386 (unless res (goto-char start))) ; invalid syntax
6387
6388 ((progn
6389 (setq pos nil)
6390 (if (looking-at c-identifier-start)
6391 (save-excursion
6392 (setq id-start (point)
6393 name-res (c-forward-name))
6394 (when name-res
6395 (setq id-end (point)
6396 id-range c-last-identifier-range))))
6397 (and (cond ((looking-at c-primitive-type-key)
6398 (setq res t))
6399 ((c-with-syntax-table c-identifier-syntax-table
6400 (looking-at c-known-type-key))
6401 (setq res 'known)))
6402 (or (not id-end)
6403 (>= (save-excursion
6404 (save-match-data
6405 (goto-char (match-end 1))
6406 (c-forward-syntactic-ws)
6407 (setq pos (point))))
6408 id-end)
6409 (setq res nil))))
6410 ;; Looking at a primitive or known type identifier. We've
6411 ;; checked for a name first so that we don't go here if the
6412 ;; known type match only is a prefix of another name.
6413
6414 (setq id-end (match-end 1))
6415
6416 (when (and c-record-type-identifiers
6417 (or c-promote-possible-types (eq res t)))
6418 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
6419
6420 (if (and c-opt-type-component-key
6421 (save-match-data
6422 (looking-at c-opt-type-component-key)))
6423 ;; There might be more keywords for the type.
6424 (let (safe-pos)
6425 (c-forward-keyword-clause 1)
6426 (while (progn
6427 (setq safe-pos (point))
6428 (looking-at c-opt-type-component-key))
6429 (when (and c-record-type-identifiers
6430 (looking-at c-primitive-type-key))
6431 (c-record-type-id (cons (match-beginning 1)
6432 (match-end 1))))
6433 (c-forward-keyword-clause 1))
6434 (if (looking-at c-primitive-type-key)
6435 (progn
6436 (when c-record-type-identifiers
6437 (c-record-type-id (cons (match-beginning 1)
6438 (match-end 1))))
6439 (c-forward-keyword-clause 1)
6440 (setq res t))
6441 (goto-char safe-pos)
6442 (setq res 'prefix)))
6443 (unless (save-match-data (c-forward-keyword-clause 1))
6444 (if pos
6445 (goto-char pos)
6446 (goto-char (match-end 1))
6447 (c-forward-syntactic-ws)))))
6448
6449 (name-res
6450 (cond ((eq name-res t)
6451 ;; A normal identifier.
6452 (goto-char id-end)
6453 (if (or res c-promote-possible-types)
6454 (progn
6455 (c-add-type id-start id-end)
6456 (when (and c-record-type-identifiers id-range)
6457 (c-record-type-id id-range))
6458 (unless res
6459 (setq res 'found)))
6460 (setq res (if (c-check-type id-start id-end)
6461 ;; It's an identifier that has been used as
6462 ;; a type somewhere else.
6463 'found
6464 ;; It's an identifier that might be a type.
6465 'maybe))))
6466 ((eq name-res 'template)
6467 ;; A template is a type.
6468 (goto-char id-end)
6469 (setq res t))
6470 (t
6471 ;; Otherwise it's an operator identifier, which is not a type.
6472 (goto-char start)
6473 (setq res nil)))))
6474
6475 (when res
6476 ;; Skip trailing type modifiers. If any are found we know it's
6477 ;; a type.
6478 (when c-opt-type-modifier-key
6479 (while (looking-at c-opt-type-modifier-key) ; e.g. "const", "volatile"
6480 (goto-char (match-end 1))
6481 (c-forward-syntactic-ws)
6482 (setq res t)))
6483 ;; Step over any type suffix operator. Do not let the existence
6484 ;; of these alter the classification of the found type, since
6485 ;; these operators typically are allowed in normal expressions
6486 ;; too.
6487 (when c-opt-type-suffix-key ; e.g. "..."
6488 (while (looking-at c-opt-type-suffix-key)
6489 (goto-char (match-end 1))
6490 (c-forward-syntactic-ws)))
6491
6492 (when c-opt-type-concat-key ; Only/mainly for pike.
6493 ;; Look for a trailing operator that concatenates the type
6494 ;; with a following one, and if so step past that one through
6495 ;; a recursive call. Note that we don't record concatenated
6496 ;; types in `c-found-types' - it's the component types that
6497 ;; are recorded when appropriate.
6498 (setq pos (point))
6499 (let* ((c-promote-possible-types (or (memq res '(t known))
6500 c-promote-possible-types))
6501 ;; If we can't promote then set `c-record-found-types' so that
6502 ;; we can merge in the types from the second part afterwards if
6503 ;; it turns out to be a known type there.
6504 (c-record-found-types (and c-record-type-identifiers
6505 (not c-promote-possible-types)))
6506 subres)
6507 (if (and (looking-at c-opt-type-concat-key)
6508
6509 (progn
6510 (goto-char (match-end 1))
6511 (c-forward-syntactic-ws)
6512 (setq subres (c-forward-type))))
6513
6514 (progn
6515 ;; If either operand certainly is a type then both are, but we
6516 ;; don't let the existence of the operator itself promote two
6517 ;; uncertain types to a certain one.
6518 (cond ((eq res t))
6519 ((eq subres t)
6520 (unless (eq name-res 'template)
6521 (c-add-type id-start id-end))
6522 (when (and c-record-type-identifiers id-range)
6523 (c-record-type-id id-range))
6524 (setq res t))
6525 ((eq res 'known))
6526 ((eq subres 'known)
6527 (setq res 'known))
6528 ((eq res 'found))
6529 ((eq subres 'found)
6530 (setq res 'found))
6531 (t
6532 (setq res 'maybe)))
6533
6534 (when (and (eq res t)
6535 (consp c-record-found-types))
6536 ;; Merge in the ranges of any types found by the second
6537 ;; `c-forward-type'.
6538 (setq c-record-type-identifiers
6539 ;; `nconc' doesn't mind that the tail of
6540 ;; `c-record-found-types' is t.
6541 (nconc c-record-found-types
6542 c-record-type-identifiers))))
6543
6544 (goto-char pos))))
6545
6546 (when (and c-record-found-types (memq res '(known found)) id-range)
6547 (setq c-record-found-types
6548 (cons id-range c-record-found-types))))
6549
6550 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6551
6552 res))
6553
6554 (defun c-forward-annotation ()
6555 ;; Used for Java code only at the moment. Assumes point is on the
6556 ;; @, moves forward an annotation. returns nil if there is no
6557 ;; annotation at point.
6558 (and (looking-at "@")
6559 (progn (forward-char) t)
6560 (c-forward-type)
6561 (progn (c-forward-syntactic-ws) t)
6562 (if (looking-at "(")
6563 (c-go-list-forward)
6564 t)))
6565
6566 (defmacro c-pull-open-brace (ps)
6567 ;; Pull the next open brace from PS (which has the form of paren-state),
6568 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
6569 `(progn
6570 (while (consp (car ,ps))
6571 (setq ,ps (cdr ,ps)))
6572 (prog1 (car ,ps)
6573 (setq ,ps (cdr ,ps)))))
6574
6575 (defun c-back-over-member-initializers ()
6576 ;; Test whether we are in a C++ member initializer list, and if so, go back
6577 ;; to the introducing ":", returning the position of the opening paren of
6578 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6579 (let ((here (point))
6580 (paren-state (c-parse-state))
6581 res)
6582
6583 (setq res
6584 (catch 'done
6585 (if (not (c-at-toplevel-p))
6586 (progn
6587 (while (not (c-at-toplevel-p))
6588 (goto-char (c-pull-open-brace paren-state)))
6589 (c-backward-syntactic-ws)
6590 (when (not (c-simple-skip-symbol-backward))
6591 (throw 'done nil))
6592 (c-backward-syntactic-ws))
6593 (c-backward-syntactic-ws)
6594 (when (memq (char-before) '(?\) ?}))
6595 (when (not (c-go-list-backward))
6596 (throw 'done nil))
6597 (c-backward-syntactic-ws))
6598 (when (c-simple-skip-symbol-backward)
6599 (c-backward-syntactic-ws)))
6600
6601 (while (eq (char-before) ?,)
6602 (backward-char)
6603 (c-backward-syntactic-ws)
6604
6605 (when (not (memq (char-before) '(?\) ?})))
6606 (throw 'done nil))
6607 (when (not (c-go-list-backward))
6608 (throw 'done nil))
6609 (c-backward-syntactic-ws)
6610 (when (not (c-simple-skip-symbol-backward))
6611 (throw 'done nil))
6612 (c-backward-syntactic-ws))
6613
6614 (and
6615 (eq (char-before) ?:)
6616 (c-just-after-func-arglist-p))))
6617
6618 (or res (goto-char here))
6619 res))
6620
6621 \f
6622 ;; Handling of large scale constructs like statements and declarations.
6623
6624 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6625 ;; defsubst or perhaps even a defun, but it contains lots of free
6626 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6627 (defmacro c-fdoc-shift-type-backward (&optional short)
6628 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6629 ;; of types when parsing a declaration, which means that it
6630 ;; sometimes consumes the identifier in the declaration as a type.
6631 ;; This is used to "backtrack" and make the last type be treated as
6632 ;; an identifier instead.
6633 `(progn
6634 ,(unless short
6635 ;; These identifiers are bound only in the inner let.
6636 '(setq identifier-type at-type
6637 identifier-start type-start
6638 got-parens nil
6639 got-identifier t
6640 got-suffix t
6641 got-suffix-after-parens id-start
6642 paren-depth 0))
6643
6644 (if (setq at-type (if (eq backup-at-type 'prefix)
6645 t
6646 backup-at-type))
6647 (setq type-start backup-type-start
6648 id-start backup-id-start)
6649 (setq type-start start-pos
6650 id-start start-pos))
6651
6652 ;; When these flags already are set we've found specifiers that
6653 ;; unconditionally signal these attributes - backtracking doesn't
6654 ;; change that. So keep them set in that case.
6655 (or at-type-decl
6656 (setq at-type-decl backup-at-type-decl))
6657 (or maybe-typeless
6658 (setq maybe-typeless backup-maybe-typeless))
6659
6660 ,(unless short
6661 ;; This identifier is bound only in the inner let.
6662 '(setq start id-start))))
6663
6664 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end)
6665 ;; Move forward over a declaration or a cast if at the start of one.
6666 ;; The point is assumed to be at the start of some token. Nil is
6667 ;; returned if no declaration or cast is recognized, and the point
6668 ;; is clobbered in that case.
6669 ;;
6670 ;; If a declaration is parsed:
6671 ;;
6672 ;; The point is left at the first token after the first complete
6673 ;; declarator, if there is one. The return value is a cons where
6674 ;; the car is the position of the first token in the declarator. (See
6675 ;; below for the cdr.)
6676 ;; Some examples:
6677 ;;
6678 ;; void foo (int a, char *b) stuff ...
6679 ;; car ^ ^ point
6680 ;; float (*a)[], b;
6681 ;; car ^ ^ point
6682 ;; unsigned int a = c_style_initializer, b;
6683 ;; car ^ ^ point
6684 ;; unsigned int a (cplusplus_style_initializer), b;
6685 ;; car ^ ^ point (might change)
6686 ;; class Foo : public Bar {}
6687 ;; car ^ ^ point
6688 ;; class PikeClass (int a, string b) stuff ...
6689 ;; car ^ ^ point
6690 ;; enum bool;
6691 ;; car ^ ^ point
6692 ;; enum bool flag;
6693 ;; car ^ ^ point
6694 ;; void cplusplus_function (int x) throw (Bad);
6695 ;; car ^ ^ point
6696 ;; Foo::Foo (int b) : Base (b) {}
6697 ;; car ^ ^ point
6698 ;;
6699 ;; auto foo = 5;
6700 ;; car ^ ^ point
6701 ;; auto cplusplus_11 (int a, char *b) -> decltype (bar):
6702 ;; car ^ ^ point
6703 ;;
6704 ;;
6705 ;;
6706 ;; The cdr of the return value is non-nil when a
6707 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6708 ;; Specifically it is a dotted pair (A . B) where B is t when a
6709 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6710 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6711 ;; specifier is present. I.e., (some of) the declared
6712 ;; identifier(s) are types.
6713 ;;
6714 ;; If a cast is parsed:
6715 ;;
6716 ;; The point is left at the first token after the closing paren of
6717 ;; the cast. The return value is `cast'. Note that the start
6718 ;; position must be at the first token inside the cast parenthesis
6719 ;; to recognize it.
6720 ;;
6721 ;; PRECEDING-TOKEN-END is the first position after the preceding
6722 ;; token, i.e. on the other side of the syntactic ws from the point.
6723 ;; Use a value less than or equal to (point-min) if the point is at
6724 ;; the first token in (the visible part of) the buffer.
6725 ;;
6726 ;; CONTEXT is a symbol that describes the context at the point:
6727 ;; 'decl In a comma-separated declaration context (typically
6728 ;; inside a function declaration arglist).
6729 ;; '<> In an angle bracket arglist.
6730 ;; 'arglist Some other type of arglist.
6731 ;; nil Some other context or unknown context. Includes
6732 ;; within the parens of an if, for, ... construct.
6733 ;;
6734 ;; LAST-CAST-END is the first token after the closing paren of a
6735 ;; preceding cast, or nil if none is known. If
6736 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
6737 ;; the position after the closest preceding call where a cast was
6738 ;; matched. In that case it's used to discover chains of casts like
6739 ;; "(a) (b) c".
6740 ;;
6741 ;; This function records identifier ranges on
6742 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6743 ;; `c-record-type-identifiers' is non-nil.
6744 ;;
6745 ;; This function might do hidden buffer changes.
6746
6747 (let (;; `start-pos' is used below to point to the start of the
6748 ;; first type, i.e. after any leading specifiers. It might
6749 ;; also point at the beginning of the preceding syntactic
6750 ;; whitespace.
6751 (start-pos (point))
6752 ;; Set to the result of `c-forward-type'.
6753 at-type
6754 ;; The position of the first token in what we currently
6755 ;; believe is the type in the declaration or cast, after any
6756 ;; specifiers and their associated clauses.
6757 type-start
6758 ;; The position of the first token in what we currently
6759 ;; believe is the declarator for the first identifier. Set
6760 ;; when the type is found, and moved forward over any
6761 ;; `c-decl-hangon-kwds' and their associated clauses that
6762 ;; occurs after the type.
6763 id-start
6764 ;; These store `at-type', `type-start' and `id-start' of the
6765 ;; identifier before the one in those variables. The previous
6766 ;; identifier might turn out to be the real type in a
6767 ;; declaration if the last one has to be the declarator in it.
6768 ;; If `backup-at-type' is nil then the other variables have
6769 ;; undefined values.
6770 backup-at-type backup-type-start backup-id-start
6771 ;; This stores `kwd-sym' of the symbol before the current one.
6772 ;; This is needed to distinguish the C++11 version of "auto" from
6773 ;; the pre C++11 meaning.
6774 backup-kwd-sym
6775 ;; Set if we've found a specifier (apart from "typedef") that makes
6776 ;; the defined identifier(s) types.
6777 at-type-decl
6778 ;; Set if we've a "typedef" keyword.
6779 at-typedef
6780 ;; Set if we've found a specifier that can start a declaration
6781 ;; where there's no type.
6782 maybe-typeless
6783 ;; Save the value of kwd-sym between loops of the "Check for a
6784 ;; type" loop. Needed to distinguish a C++11 "auto" from a pre
6785 ;; C++11 one.
6786 prev-kwd-sym
6787 ;; If a specifier is found that also can be a type prefix,
6788 ;; these flags are set instead of those above. If we need to
6789 ;; back up an identifier, they are copied to the real flag
6790 ;; variables. Thus they only take effect if we fail to
6791 ;; interpret it as a type.
6792 backup-at-type-decl backup-maybe-typeless
6793 ;; Whether we've found a declaration or a cast. We might know
6794 ;; this before we've found the type in it. It's 'ids if we've
6795 ;; found two consecutive identifiers (usually a sure sign, but
6796 ;; we should allow that in labels too), and t if we've found a
6797 ;; specifier keyword (a 100% sure sign).
6798 at-decl-or-cast
6799 ;; Set when we need to back up to parse this as a declaration
6800 ;; but not as a cast.
6801 backup-if-not-cast
6802 ;; For casts, the return position.
6803 cast-end
6804 ;; Have we got a new-style C++11 "auto"?
6805 new-style-auto
6806 ;; Save `c-record-type-identifiers' and
6807 ;; `c-record-ref-identifiers' since ranges are recorded
6808 ;; speculatively and should be thrown away if it turns out
6809 ;; that it isn't a declaration or cast.
6810 (save-rec-type-ids c-record-type-identifiers)
6811 (save-rec-ref-ids c-record-ref-identifiers))
6812
6813 (while (c-forward-annotation)
6814 (c-forward-syntactic-ws))
6815
6816 ;; Check for a type. Unknown symbols are treated as possible
6817 ;; types, but they could also be specifiers disguised through
6818 ;; macros like __INLINE__, so we recognize both types and known
6819 ;; specifiers after them too.
6820 (while
6821 (let* ((start (point)) kwd-sym kwd-clause-end found-type)
6822
6823 ;; Look for a specifier keyword clause.
6824 (when (or (looking-at c-prefix-spec-kwds-re) ;FIXME!!! includes auto
6825 (and (c-major-mode-is 'java-mode)
6826 (looking-at "@[A-Za-z0-9]+")))
6827 (save-match-data
6828 (if (looking-at c-typedef-key)
6829 (setq at-typedef t)))
6830 (setq kwd-sym (c-keyword-sym (match-string 1)))
6831 (save-excursion
6832 (c-forward-keyword-clause 1)
6833 (setq kwd-clause-end (point))))
6834
6835 (when (setq found-type (c-forward-type t)) ; brace-block-too
6836 ;; Found a known or possible type or a prefix of a known type.
6837 (when (and (c-major-mode-is 'c++-mode) ; C++11 style "auto"?
6838 (eq prev-kwd-sym (c-keyword-sym "auto"))
6839 (looking-at "[=(]")) ; FIXME!!! proper regexp.
6840 (setq new-style-auto t)
6841 (setq found-type nil)
6842 (goto-char start)) ; position of foo in "auto foo"
6843
6844 (when at-type
6845 ;; Got two identifiers with nothing but whitespace
6846 ;; between them. That can only happen in declarations.
6847 (setq at-decl-or-cast 'ids)
6848
6849 (when (eq at-type 'found)
6850 ;; If the previous identifier is a found type we
6851 ;; record it as a real one; it might be some sort of
6852 ;; alias for a prefix like "unsigned".
6853 (save-excursion
6854 (goto-char type-start)
6855 (let ((c-promote-possible-types t))
6856 (c-forward-type)))))
6857
6858 (setq backup-at-type at-type
6859 backup-type-start type-start
6860 backup-id-start id-start
6861 backup-kwd-sym kwd-sym
6862 at-type found-type
6863 type-start start
6864 id-start (point)
6865 ;; The previous ambiguous specifier/type turned out
6866 ;; to be a type since we've parsed another one after
6867 ;; it, so clear these backup flags.
6868 backup-at-type-decl nil
6869 backup-maybe-typeless nil))
6870
6871 (if kwd-sym
6872 (progn
6873 ;; Handle known specifier keywords and
6874 ;; `c-decl-hangon-kwds' which can occur after known
6875 ;; types.
6876
6877 (if (c-keyword-member kwd-sym 'c-decl-hangon-kwds)
6878 ;; It's a hang-on keyword that can occur anywhere.
6879 (progn
6880 (setq at-decl-or-cast t)
6881 (if at-type
6882 ;; Move the identifier start position if
6883 ;; we've passed a type.
6884 (setq id-start kwd-clause-end)
6885 ;; Otherwise treat this as a specifier and
6886 ;; move the fallback position.
6887 (setq start-pos kwd-clause-end))
6888 (goto-char kwd-clause-end))
6889
6890 ;; It's an ordinary specifier so we know that
6891 ;; anything before this can't be the type.
6892 (setq backup-at-type nil
6893 start-pos kwd-clause-end)
6894
6895 (if found-type
6896 ;; It's ambiguous whether this keyword is a
6897 ;; specifier or a type prefix, so set the backup
6898 ;; flags. (It's assumed that `c-forward-type'
6899 ;; moved further than `c-forward-keyword-clause'.)
6900 (progn
6901 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
6902 (setq backup-at-type-decl t))
6903 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
6904 (setq backup-maybe-typeless t)))
6905
6906 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
6907 ;; This test only happens after we've scanned a type.
6908 ;; So, with valid syntax, kwd-sym can't be 'typedef.
6909 (setq at-type-decl t))
6910 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
6911 (setq maybe-typeless t))
6912
6913 ;; Haven't matched a type so it's an unambiguous
6914 ;; specifier keyword and we know we're in a
6915 ;; declaration.
6916 (setq at-decl-or-cast t)
6917 (setq prev-kwd-sym kwd-sym)
6918
6919 (goto-char kwd-clause-end))))
6920
6921 ;; If the type isn't known we continue so that we'll jump
6922 ;; over all specifiers and type identifiers. The reason
6923 ;; to do this for a known type prefix is to make things
6924 ;; like "unsigned INT16" work.
6925 (and found-type (not (eq found-type t))))))
6926
6927 (cond
6928 ((eq at-type t)
6929 ;; If a known type was found, we still need to skip over any
6930 ;; hangon keyword clauses after it. Otherwise it has already
6931 ;; been done in the loop above.
6932 (while (looking-at c-decl-hangon-key)
6933 (c-forward-keyword-clause 1))
6934 (setq id-start (point)))
6935
6936 ((eq at-type 'prefix)
6937 ;; A prefix type is itself a primitive type when it's not
6938 ;; followed by another type.
6939 (setq at-type t))
6940
6941 ((not at-type)
6942 ;; Got no type but set things up to continue anyway to handle
6943 ;; the various cases when a declaration doesn't start with a
6944 ;; type.
6945 (setq id-start start-pos))
6946
6947 ((and (eq at-type 'maybe)
6948 (c-major-mode-is 'c++-mode))
6949 ;; If it's C++ then check if the last "type" ends on the form
6950 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
6951 ;; (con|de)structor.
6952 (save-excursion
6953 (let (name end-2 end-1)
6954 (goto-char id-start)
6955 (c-backward-syntactic-ws)
6956 (setq end-2 (point))
6957 (when (and
6958 (c-simple-skip-symbol-backward)
6959 (progn
6960 (setq name
6961 (buffer-substring-no-properties (point) end-2))
6962 ;; Cheating in the handling of syntactic ws below.
6963 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
6964 (progn
6965 (setq end-1 (point))
6966 (c-simple-skip-symbol-backward))
6967 (>= (point) type-start)
6968 (equal (buffer-substring-no-properties (point) end-1)
6969 name))
6970 ;; It is a (con|de)structor name. In that case the
6971 ;; declaration is typeless so zap out any preceding
6972 ;; identifier(s) that we might have taken as types.
6973 (goto-char type-start)
6974 (setq at-type nil
6975 backup-at-type nil
6976 id-start type-start))))))
6977
6978 ;; Check for and step over a type decl expression after the thing
6979 ;; that is or might be a type. This can't be skipped since we
6980 ;; need the correct end position of the declarator for
6981 ;; `max-type-decl-end-*'.
6982 (let ((start (point)) (paren-depth 0) pos
6983 ;; True if there's a non-open-paren match of
6984 ;; `c-type-decl-prefix-key'.
6985 got-prefix
6986 ;; True if the declarator is surrounded by a parenthesis pair.
6987 got-parens
6988 ;; True if there is an identifier in the declarator.
6989 got-identifier
6990 ;; True if there's a non-close-paren match of
6991 ;; `c-type-decl-suffix-key'.
6992 got-suffix
6993 ;; True if there's a prefix match outside the outermost
6994 ;; paren pair that surrounds the declarator.
6995 got-prefix-before-parens
6996 ;; True if there's a suffix match outside the outermost
6997 ;; paren pair that surrounds the declarator. The value is
6998 ;; the position of the first suffix match.
6999 got-suffix-after-parens
7000 ;; True if we've parsed the type decl to a token that is
7001 ;; known to end declarations in this context.
7002 at-decl-end
7003 ;; The earlier values of `at-type' and `type-start' if we've
7004 ;; shifted the type backwards.
7005 identifier-type identifier-start
7006 ;; If `c-parse-and-markup-<>-arglists' is set we need to
7007 ;; turn it off during the name skipping below to avoid
7008 ;; getting `c-type' properties that might be bogus. That
7009 ;; can happen since we don't know if
7010 ;; `c-restricted-<>-arglists' will be correct inside the
7011 ;; arglist paren that gets entered.
7012 c-parse-and-markup-<>-arglists
7013 ;; Start of the identifier for which `got-identifier' was set.
7014 name-start)
7015
7016 (goto-char id-start)
7017
7018 ;; Skip over type decl prefix operators. (Note similar code in
7019 ;; `c-font-lock-declarators'.)
7020 (if (and c-recognize-typeless-decls
7021 (equal c-type-decl-prefix-key "\\<\\>"))
7022 (when (eq (char-after) ?\()
7023 (progn
7024 (setq paren-depth (1+ paren-depth))
7025 (forward-char)))
7026 (while (and (looking-at c-type-decl-prefix-key)
7027 (if (and (c-major-mode-is 'c++-mode)
7028 (match-beginning 3))
7029 ;; If the third submatch matches in C++ then
7030 ;; we're looking at an identifier that's a
7031 ;; prefix only if it specifies a member pointer.
7032 (when (progn (setq pos (point))
7033 (setq got-identifier (c-forward-name)))
7034 (setq name-start pos)
7035 (if (looking-at "\\(::\\)")
7036 ;; We only check for a trailing "::" and
7037 ;; let the "*" that should follow be
7038 ;; matched in the next round.
7039 (progn (setq got-identifier nil) t)
7040 ;; It turned out to be the real identifier,
7041 ;; so stop.
7042 nil))
7043 t))
7044
7045 (if (eq (char-after) ?\()
7046 (progn
7047 (setq paren-depth (1+ paren-depth))
7048 (forward-char))
7049 (unless got-prefix-before-parens
7050 (setq got-prefix-before-parens (= paren-depth 0)))
7051 (setq got-prefix t)
7052 (goto-char (match-end 1)))
7053 (c-forward-syntactic-ws)))
7054
7055 (setq got-parens (> paren-depth 0))
7056
7057 ;; Skip over an identifier.
7058 (or got-identifier
7059 (and (looking-at c-identifier-start)
7060 (setq pos (point))
7061 (setq got-identifier (c-forward-name))
7062 (setq name-start pos)))
7063
7064 ;; Skip over type decl suffix operators.
7065 (while (if (looking-at c-type-decl-suffix-key)
7066
7067 (if (eq (char-after) ?\))
7068 (when (> paren-depth 0)
7069 (setq paren-depth (1- paren-depth))
7070 (forward-char)
7071 t)
7072 (when (if (save-match-data (looking-at "\\s\("))
7073 (c-safe (c-forward-sexp 1) t)
7074 (goto-char (match-end 1))
7075 t)
7076 (when (and (not got-suffix-after-parens)
7077 (= paren-depth 0))
7078 (setq got-suffix-after-parens (match-beginning 0)))
7079 (setq got-suffix t)))
7080
7081 ;; No suffix matched. We might have matched the
7082 ;; identifier as a type and the open paren of a
7083 ;; function arglist as a type decl prefix. In that
7084 ;; case we should "backtrack": Reinterpret the last
7085 ;; type as the identifier, move out of the arglist and
7086 ;; continue searching for suffix operators.
7087 ;;
7088 ;; Do this even if there's no preceding type, to cope
7089 ;; with old style function declarations in K&R C,
7090 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
7091 ;; style declarations. That isn't applicable in an
7092 ;; arglist context, though.
7093 (when (and (= paren-depth 1)
7094 (not got-prefix-before-parens)
7095 (not (eq at-type t))
7096 (or backup-at-type
7097 maybe-typeless
7098 backup-maybe-typeless
7099 (when c-recognize-typeless-decls
7100 (not context)))
7101 (setq pos (c-up-list-forward (point)))
7102 (eq (char-before pos) ?\)))
7103 (c-fdoc-shift-type-backward)
7104 (goto-char pos)
7105 t))
7106
7107 (c-forward-syntactic-ws))
7108
7109 (when (or (and new-style-auto
7110 (looking-at c-auto-ops-re))
7111 (and (or maybe-typeless backup-maybe-typeless)
7112 (not got-identifier)
7113 (not got-prefix)
7114 at-type))
7115 ;; Have found no identifier but `c-typeless-decl-kwds' has
7116 ;; matched so we know we're inside a declaration. The
7117 ;; preceding type must be the identifier instead.
7118 (c-fdoc-shift-type-backward))
7119
7120 ;; Prepare the "-> type;" for fontification later on.
7121 (when (and new-style-auto
7122 (looking-at c-haskell-op-re))
7123 (save-excursion
7124 (goto-char (match-end 0))
7125 (c-forward-syntactic-ws)
7126 (setq type-start (point))
7127 (setq at-type (c-forward-type))))
7128
7129 (setq
7130 at-decl-or-cast
7131 (catch 'at-decl-or-cast
7132
7133 ;; CASE 1
7134 (when (> paren-depth 0)
7135 ;; Encountered something inside parens that isn't matched by
7136 ;; the `c-type-decl-*' regexps, so it's not a type decl
7137 ;; expression. Try to skip out to the same paren depth to
7138 ;; not confuse the cast check below.
7139 (c-safe (goto-char (scan-lists (point) 1 paren-depth)))
7140 ;; If we've found a specifier keyword then it's a
7141 ;; declaration regardless.
7142 (throw 'at-decl-or-cast (eq at-decl-or-cast t)))
7143
7144 (setq at-decl-end
7145 (looking-at (cond ((eq context '<>) "[,>]")
7146 (context "[,\)]")
7147 (t "[,;]"))))
7148
7149 ;; Now we've collected info about various characteristics of
7150 ;; the construct we're looking at. Below follows a decision
7151 ;; tree based on that. It's ordered to check more certain
7152 ;; signs before less certain ones.
7153
7154 (if got-identifier
7155 (progn
7156
7157 ;; CASE 2
7158 (when (and (or at-type maybe-typeless)
7159 (not (or got-prefix got-parens)))
7160 ;; Got another identifier directly after the type, so it's a
7161 ;; declaration.
7162 (throw 'at-decl-or-cast t))
7163
7164 (when (and got-parens
7165 (not got-prefix)
7166 ;; (not got-suffix-after-parens)
7167 (or backup-at-type
7168 maybe-typeless
7169 backup-maybe-typeless
7170 (eq at-decl-or-cast t)
7171 (save-excursion
7172 (goto-char name-start)
7173 (not (memq (c-forward-type) '(nil maybe))))))
7174 ;; Got a declaration of the form "foo bar (gnu);" or "bar
7175 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
7176 ;; as the declarator. In this case it's however more likely
7177 ;; that "bar" is the declarator and "gnu" a function argument
7178 ;; or initializer (if `c-recognize-paren-inits' is set),
7179 ;; since the parens around "gnu" would be superfluous if it's
7180 ;; a declarator. Shift the type one step backward.
7181 (c-fdoc-shift-type-backward)))
7182
7183 ;; Found no identifier.
7184
7185 (if backup-at-type
7186 (progn
7187
7188 ;; CASE 3
7189 (when (= (point) start)
7190 ;; Got a plain list of identifiers. If a colon follows it's
7191 ;; a valid label, or maybe a bitfield. Otherwise the last
7192 ;; one probably is the declared identifier and we should
7193 ;; back up to the previous type, providing it isn't a cast.
7194 (if (and (eq (char-after) ?:)
7195 (not (c-major-mode-is 'java-mode)))
7196 (cond
7197 ;; If we've found a specifier keyword then it's a
7198 ;; declaration regardless.
7199 ((eq at-decl-or-cast t)
7200 (throw 'at-decl-or-cast t))
7201 ((and c-has-bitfields
7202 (eq at-decl-or-cast 'ids)) ; bitfield.
7203 (setq backup-if-not-cast t)
7204 (throw 'at-decl-or-cast t)))
7205
7206 (setq backup-if-not-cast t)
7207 (throw 'at-decl-or-cast t)))
7208
7209 ;; CASE 4
7210 (when (and got-suffix
7211 (not got-prefix)
7212 (not got-parens))
7213 ;; Got a plain list of identifiers followed by some suffix.
7214 ;; If this isn't a cast then the last identifier probably is
7215 ;; the declared one and we should back up to the previous
7216 ;; type.
7217 (setq backup-if-not-cast t)
7218 (throw 'at-decl-or-cast t)))
7219
7220 ;; CASE 5
7221 (when (eq at-type t)
7222 ;; If the type is known we know that there can't be any
7223 ;; identifier somewhere else, and it's only in declarations in
7224 ;; e.g. function prototypes and in casts that the identifier may
7225 ;; be left out.
7226 (throw 'at-decl-or-cast t))
7227
7228 (when (= (point) start)
7229 ;; Only got a single identifier (parsed as a type so far).
7230 ;; CASE 6
7231 (if (and
7232 ;; Check that the identifier isn't at the start of an
7233 ;; expression.
7234 at-decl-end
7235 (cond
7236 ((eq context 'decl)
7237 ;; Inside an arglist that contains declarations. If K&R
7238 ;; style declarations and parenthesis style initializers
7239 ;; aren't allowed then the single identifier must be a
7240 ;; type, else we require that it's known or found
7241 ;; (primitive types are handled above).
7242 (or (and (not c-recognize-knr-p)
7243 (not c-recognize-paren-inits))
7244 (memq at-type '(known found))))
7245 ((eq context '<>)
7246 ;; Inside a template arglist. Accept known and found
7247 ;; types; other identifiers could just as well be
7248 ;; constants in C++.
7249 (memq at-type '(known found)))))
7250 (throw 'at-decl-or-cast t)
7251 ;; CASE 7
7252 ;; Can't be a valid declaration or cast, but if we've found a
7253 ;; specifier it can't be anything else either, so treat it as
7254 ;; an invalid/unfinished declaration or cast.
7255 (throw 'at-decl-or-cast at-decl-or-cast))))
7256
7257 (if (and got-parens
7258 (not got-prefix)
7259 (not context)
7260 (not (eq at-type t))
7261 (or backup-at-type
7262 maybe-typeless
7263 backup-maybe-typeless
7264 (when c-recognize-typeless-decls
7265 (or (not got-suffix)
7266 (not (looking-at
7267 c-after-suffixed-type-maybe-decl-key))))))
7268 ;; Got an empty paren pair and a preceding type that probably
7269 ;; really is the identifier. Shift the type backwards to make
7270 ;; the last one the identifier. This is analogous to the
7271 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7272 ;; above.
7273 ;;
7274 ;; Exception: In addition to the conditions in that
7275 ;; "backtracking" code, do not shift backward if we're not
7276 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7277 ;; Since there's no preceding type, the shift would mean that
7278 ;; the declaration is typeless. But if the regexp doesn't match
7279 ;; then we will simply fall through in the tests below and not
7280 ;; recognize it at all, so it's better to try it as an abstract
7281 ;; declarator instead.
7282 (c-fdoc-shift-type-backward)
7283
7284 ;; Still no identifier.
7285 ;; CASE 8
7286 (when (and got-prefix (or got-parens got-suffix))
7287 ;; Require `got-prefix' together with either `got-parens' or
7288 ;; `got-suffix' to recognize it as an abstract declarator:
7289 ;; `got-parens' only is probably an empty function call.
7290 ;; `got-suffix' only can build an ordinary expression together
7291 ;; with the preceding identifier which we've taken as a type.
7292 ;; We could actually accept on `got-prefix' only, but that can
7293 ;; easily occur temporarily while writing an expression so we
7294 ;; avoid that case anyway. We could do a better job if we knew
7295 ;; the point when the fontification was invoked.
7296 (throw 'at-decl-or-cast t))
7297
7298 ;; CASE 9
7299 (when (and at-type
7300 (not got-prefix)
7301 (not got-parens)
7302 got-suffix-after-parens
7303 (eq (char-after got-suffix-after-parens) ?\())
7304 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7305 ;; normal function call after all (or perhaps a C++ style object
7306 ;; instantiation expression).
7307 (throw 'at-decl-or-cast nil))))
7308
7309 ;; CASE 10
7310 (when at-decl-or-cast
7311 ;; By now we've located the type in the declaration that we know
7312 ;; we're in.
7313 (throw 'at-decl-or-cast t))
7314
7315 ;; CASE 11
7316 (when (and got-identifier
7317 (not context)
7318 (looking-at c-after-suffixed-type-decl-key)
7319 (if (and got-parens
7320 (not got-prefix)
7321 (not got-suffix)
7322 (not (eq at-type t)))
7323 ;; Shift the type backward in the case that there's a
7324 ;; single identifier inside parens. That can only
7325 ;; occur in K&R style function declarations so it's
7326 ;; more likely that it really is a function call.
7327 ;; Therefore we only do this after
7328 ;; `c-after-suffixed-type-decl-key' has matched.
7329 (progn (c-fdoc-shift-type-backward) t)
7330 got-suffix-after-parens))
7331 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7332 (throw 'at-decl-or-cast t))
7333
7334 ;; CASE 12
7335 (when (and (or got-prefix (not got-parens))
7336 (memq at-type '(t known)))
7337 ;; It's a declaration if a known type precedes it and it can't be a
7338 ;; function call.
7339 (throw 'at-decl-or-cast t))
7340
7341 ;; If we get here we can't tell if this is a type decl or a normal
7342 ;; expression by looking at it alone. (That's under the assumption
7343 ;; that normal expressions always can look like type decl expressions,
7344 ;; which isn't really true but the cases where it doesn't hold are so
7345 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7346 ;; the effort to look for them.)
7347
7348 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
7349 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
7350 ;;; as a(n almost complete) declaration, enabling it to be fontified.
7351 ;; CASE 13
7352 ;; (unless (or at-decl-end (looking-at "=[^=]"))
7353 ;; If this is a declaration it should end here or its initializer(*)
7354 ;; should start here, so check for allowed separation tokens. Note
7355 ;; that this rule doesn't work e.g. with a K&R arglist after a
7356 ;; function header.
7357 ;;
7358 ;; *) Don't check for C++ style initializers using parens
7359 ;; since those already have been matched as suffixes.
7360 ;;
7361 ;; If `at-decl-or-cast' is then we've found some other sign that
7362 ;; it's a declaration or cast, so then it's probably an
7363 ;; invalid/unfinished one.
7364 ;; (throw 'at-decl-or-cast at-decl-or-cast))
7365
7366 ;; Below are tests that only should be applied when we're certain to
7367 ;; not have parsed halfway through an expression.
7368
7369 ;; CASE 14
7370 (when (memq at-type '(t known))
7371 ;; The expression starts with a known type so treat it as a
7372 ;; declaration.
7373 (throw 'at-decl-or-cast t))
7374
7375 ;; CASE 15
7376 (when (and (c-major-mode-is 'c++-mode)
7377 ;; In C++ we check if the identifier is a known type, since
7378 ;; (con|de)structors use the class name as identifier.
7379 ;; We've always shifted over the identifier as a type and
7380 ;; then backed up again in this case.
7381 identifier-type
7382 (or (memq identifier-type '(found known))
7383 (and (eq (char-after identifier-start) ?~)
7384 ;; `at-type' probably won't be 'found for
7385 ;; destructors since the "~" is then part of the
7386 ;; type name being checked against the list of
7387 ;; known types, so do a check without that
7388 ;; operator.
7389 (or (save-excursion
7390 (goto-char (1+ identifier-start))
7391 (c-forward-syntactic-ws)
7392 (c-with-syntax-table
7393 c-identifier-syntax-table
7394 (looking-at c-known-type-key)))
7395 (save-excursion
7396 (goto-char (1+ identifier-start))
7397 ;; We have already parsed the type earlier,
7398 ;; so it'd be possible to cache the end
7399 ;; position instead of redoing it here, but
7400 ;; then we'd need to keep track of another
7401 ;; position everywhere.
7402 (c-check-type (point)
7403 (progn (c-forward-type)
7404 (point))))))))
7405 (throw 'at-decl-or-cast t))
7406
7407 (if got-identifier
7408 (progn
7409 ;; CASE 16
7410 (when (and got-prefix-before-parens
7411 at-type
7412 (or at-decl-end (looking-at "=[^=]"))
7413 (not context)
7414 (not got-suffix))
7415 ;; Got something like "foo * bar;". Since we're not inside an
7416 ;; arglist it would be a meaningless expression because the
7417 ;; result isn't used. We therefore choose to recognize it as
7418 ;; a declaration. Do not allow a suffix since it could then
7419 ;; be a function call.
7420 (throw 'at-decl-or-cast t))
7421
7422 ;; CASE 17
7423 (when (and (or got-suffix-after-parens
7424 (looking-at "=[^=]"))
7425 (eq at-type 'found)
7426 (not (eq context 'arglist)))
7427 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7428 ;; be an odd expression or it could be a declaration. Treat
7429 ;; it as a declaration if "a" has been used as a type
7430 ;; somewhere else (if it's a known type we won't get here).
7431 (throw 'at-decl-or-cast t)))
7432
7433 ;; CASE 18
7434 (when (and context
7435 (or got-prefix
7436 (and (eq context 'decl)
7437 (not c-recognize-paren-inits)
7438 (or got-parens got-suffix))))
7439 ;; Got a type followed by an abstract declarator. If `got-prefix'
7440 ;; is set it's something like "a *" without anything after it. If
7441 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7442 ;; or similar, which we accept only if the context rules out
7443 ;; expressions.
7444 (throw 'at-decl-or-cast t)))
7445
7446 ;; If we had a complete symbol table here (which rules out
7447 ;; `c-found-types') we should return t due to the disambiguation rule
7448 ;; (in at least C++) that anything that can be parsed as a declaration
7449 ;; is a declaration. Now we're being more defensive and prefer to
7450 ;; highlight things like "foo (bar);" as a declaration only if we're
7451 ;; inside an arglist that contains declarations.
7452 ;; CASE 19
7453 (eq context 'decl))))
7454
7455 ;; The point is now after the type decl expression.
7456
7457 (cond
7458 ;; Check for a cast.
7459 ((save-excursion
7460 (and
7461 c-cast-parens
7462
7463 ;; Should be the first type/identifier in a cast paren.
7464 (> preceding-token-end (point-min))
7465 (memq (char-before preceding-token-end) c-cast-parens)
7466
7467 ;; The closing paren should follow.
7468 (progn
7469 (c-forward-syntactic-ws)
7470 (looking-at "\\s\)"))
7471
7472 ;; There should be a primary expression after it.
7473 (let (pos)
7474 (forward-char)
7475 (c-forward-syntactic-ws)
7476 (setq cast-end (point))
7477 (and (looking-at c-primary-expr-regexp)
7478 (progn
7479 (setq pos (match-end 0))
7480 (or
7481 ;; Check if the expression begins with a prefix keyword.
7482 (match-beginning 2)
7483 (if (match-beginning 1)
7484 ;; Expression begins with an ambiguous operator. Treat
7485 ;; it as a cast if it's a type decl or if we've
7486 ;; recognized the type somewhere else.
7487 (or at-decl-or-cast
7488 (memq at-type '(t known found)))
7489 ;; Unless it's a keyword, it's the beginning of a primary
7490 ;; expression.
7491 (not (looking-at c-keywords-regexp)))))
7492 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7493 ;; that it matched a whole one so that we don't e.g. confuse
7494 ;; the operator '-' with '->'. It's ok if it matches further,
7495 ;; though, since it e.g. can match the float '.5' while the
7496 ;; operator regexp only matches '.'.
7497 (or (not (looking-at c-nonsymbol-token-regexp))
7498 (<= (match-end 0) pos))))
7499
7500 ;; There should either be a cast before it or something that isn't an
7501 ;; identifier or close paren.
7502 (> preceding-token-end (point-min))
7503 (progn
7504 (goto-char (1- preceding-token-end))
7505 (or (eq (point) last-cast-end)
7506 (progn
7507 (c-backward-syntactic-ws)
7508 (if (< (skip-syntax-backward "w_") 0)
7509 ;; It's a symbol. Accept it only if it's one of the
7510 ;; keywords that can precede an expression (without
7511 ;; surrounding parens).
7512 (looking-at c-simple-stmt-key)
7513 (and
7514 ;; Check that it isn't a close paren (block close is ok,
7515 ;; though).
7516 (not (memq (char-before) '(?\) ?\])))
7517 ;; Check that it isn't a nonsymbol identifier.
7518 (not (c-on-identifier)))))))))
7519
7520 ;; Handle the cast.
7521 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
7522 (let ((c-promote-possible-types t))
7523 (goto-char type-start)
7524 (c-forward-type)))
7525
7526 (goto-char cast-end)
7527 'cast)
7528
7529 (at-decl-or-cast
7530 ;; We're at a declaration. Highlight the type and the following
7531 ;; declarators.
7532
7533 (when backup-if-not-cast
7534 (c-fdoc-shift-type-backward t))
7535
7536 (when (and (eq context 'decl) (looking-at ","))
7537 ;; Make sure to propagate the `c-decl-arg-start' property to
7538 ;; the next argument if it's set in this one, to cope with
7539 ;; interactive refontification.
7540 (c-put-c-type-property (point) 'c-decl-arg-start))
7541
7542 ;; Record the type's coordinates in `c-record-type-identifiers' for
7543 ;; later fontification.
7544 (when (and c-record-type-identifiers at-type ;; (not (eq at-type t))
7545 ;; There seems no reason to exclude a token from
7546 ;; fontification just because it's "a known type that can't
7547 ;; be a name or other expression". 2013-09-18.
7548 )
7549 (let ((c-promote-possible-types t))
7550 (save-excursion
7551 (goto-char type-start)
7552 (c-forward-type))))
7553
7554 (cons id-start
7555 (and (or at-type-decl at-typedef)
7556 (cons at-type-decl at-typedef))))
7557
7558 (t
7559 ;; False alarm. Restore the recorded ranges.
7560 (setq c-record-type-identifiers save-rec-type-ids
7561 c-record-ref-identifiers save-rec-ref-ids)
7562 nil))))
7563
7564 (defun c-forward-label (&optional assume-markup preceding-token-end limit)
7565 ;; Assuming that point is at the beginning of a token, check if it starts a
7566 ;; label and if so move over it and return non-nil (t in default situations,
7567 ;; specific symbols (see below) for interesting situations), otherwise don't
7568 ;; move and return nil. "Label" here means "most things with a colon".
7569 ;;
7570 ;; More precisely, a "label" is regarded as one of:
7571 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7572 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7573 ;; bare "case", should the colon be missing. We return t;
7574 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7575 ;; return t;
7576 ;; (iv) One of QT's "extended" C++ variants of
7577 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7578 ;; Returns the symbol `qt-2kwds-colon'.
7579 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7580 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7581 ;; colon). Currently (2006-03), this applies only to Objective C's
7582 ;; keywords "@private", "@protected", and "@public". Returns t.
7583 ;;
7584 ;; One of the things which will NOT be recognized as a label is a bit-field
7585 ;; element of a struct, something like "int foo:5".
7586 ;;
7587 ;; The end of the label is taken to be just after the colon, or the end of
7588 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7589 ;; after the end on return. The terminating char gets marked with
7590 ;; `c-decl-end' to improve recognition of the following declaration or
7591 ;; statement.
7592 ;;
7593 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7594 ;; label, if any, has already been marked up like that.
7595 ;;
7596 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7597 ;; after the preceding token, i.e. on the other side of the
7598 ;; syntactic ws from the point. Use a value less than or equal to
7599 ;; (point-min) if the point is at the first token in (the visible
7600 ;; part of) the buffer.
7601 ;;
7602 ;; The optional LIMIT limits the forward scan for the colon.
7603 ;;
7604 ;; This function records the ranges of the label symbols on
7605 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7606 ;; non-nil.
7607 ;;
7608 ;; This function might do hidden buffer changes.
7609
7610 (let ((start (point))
7611 label-end
7612 qt-symbol-idx
7613 macro-start ; if we're in one.
7614 label-type
7615 kwd)
7616 (cond
7617 ;; "case" or "default" (Doesn't apply to AWK).
7618 ((looking-at c-label-kwds-regexp)
7619 (let ((kwd-end (match-end 1)))
7620 ;; Record only the keyword itself for fontification, since in
7621 ;; case labels the following is a constant expression and not
7622 ;; a label.
7623 (when c-record-type-identifiers
7624 (c-record-ref-id (cons (match-beginning 1) kwd-end)))
7625
7626 ;; Find the label end.
7627 (goto-char kwd-end)
7628 (setq label-type
7629 (if (and (c-syntactic-re-search-forward
7630 ;; Stop on chars that aren't allowed in expressions,
7631 ;; and on operator chars that would be meaningless
7632 ;; there. FIXME: This doesn't cope with ?: operators.
7633 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
7634 limit t t nil 1)
7635 (match-beginning 2))
7636
7637 (progn ; there's a proper :
7638 (goto-char (match-beginning 2)) ; just after the :
7639 (c-put-c-type-property (1- (point)) 'c-decl-end)
7640 t)
7641
7642 ;; It's an unfinished label. We consider the keyword enough
7643 ;; to recognize it as a label, so that it gets fontified.
7644 ;; Leave the point at the end of it, but don't put any
7645 ;; `c-decl-end' marker.
7646 (goto-char kwd-end)
7647 t))))
7648
7649 ;; @private, @protected, @public, in Objective C, or similar.
7650 ((and c-opt-extra-label-key
7651 (looking-at c-opt-extra-label-key))
7652 ;; For a `c-opt-extra-label-key' match, we record the whole
7653 ;; thing for fontification. That's to get the leading '@' in
7654 ;; Objective-C protection labels fontified.
7655 (goto-char (match-end 1))
7656 (when c-record-type-identifiers
7657 (c-record-ref-id (cons (match-beginning 1) (point))))
7658 (c-put-c-type-property (1- (point)) 'c-decl-end)
7659 (setq label-type t))
7660
7661 ;; All other cases of labels.
7662 ((and c-recognize-colon-labels ; nil for AWK and IDL, otherwise t.
7663
7664 ;; A colon label must have something before the colon.
7665 (not (eq (char-after) ?:))
7666
7667 ;; Check that we're not after a token that can't precede a label.
7668 (or
7669 ;; Trivially succeeds when there's no preceding token.
7670 ;; Succeeds when we're at a virtual semicolon.
7671 (if preceding-token-end
7672 (<= preceding-token-end (point-min))
7673 (save-excursion
7674 (c-backward-syntactic-ws)
7675 (setq preceding-token-end (point))
7676 (or (bobp)
7677 (c-at-vsemi-p))))
7678
7679 ;; Check if we're after a label, if we're after a closing
7680 ;; paren that belong to statement, and with
7681 ;; `c-label-prefix-re'. It's done in different order
7682 ;; depending on `assume-markup' since the checks have
7683 ;; different expensiveness.
7684 (if assume-markup
7685 (or
7686 (eq (c-get-char-property (1- preceding-token-end) 'c-type)
7687 'c-decl-end)
7688
7689 (save-excursion
7690 (goto-char (1- preceding-token-end))
7691 (c-beginning-of-current-token)
7692 (or (looking-at c-label-prefix-re)
7693 (looking-at c-block-stmt-1-key)))
7694
7695 (and (eq (char-before preceding-token-end) ?\))
7696 (c-after-conditional)))
7697
7698 (or
7699 (save-excursion
7700 (goto-char (1- preceding-token-end))
7701 (c-beginning-of-current-token)
7702 (or (looking-at c-label-prefix-re)
7703 (looking-at c-block-stmt-1-key)))
7704
7705 (cond
7706 ((eq (char-before preceding-token-end) ?\))
7707 (c-after-conditional))
7708
7709 ((eq (char-before preceding-token-end) ?:)
7710 ;; Might be after another label, so check it recursively.
7711 (save-restriction
7712 (save-excursion
7713 (goto-char (1- preceding-token-end))
7714 ;; Essentially the same as the
7715 ;; `c-syntactic-re-search-forward' regexp below.
7716 (setq macro-start
7717 (save-excursion (and (c-beginning-of-macro)
7718 (point))))
7719 (if macro-start (narrow-to-region macro-start (point-max)))
7720 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t)
7721 ;; Note: the following should work instead of the
7722 ;; narrow-to-region above. Investigate why not,
7723 ;; sometime. ACM, 2006-03-31.
7724 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7725 ;; macro-start t)
7726 (let ((pte (point))
7727 ;; If the caller turned on recording for us,
7728 ;; it shouldn't apply when we check the
7729 ;; preceding label.
7730 c-record-type-identifiers)
7731 ;; A label can't start at a cpp directive. Check for
7732 ;; this, since c-forward-syntactic-ws would foul up on it.
7733 (unless (and c-opt-cpp-prefix (looking-at c-opt-cpp-prefix))
7734 (c-forward-syntactic-ws)
7735 (c-forward-label nil pte start))))))))))
7736
7737 ;; Point is still at the beginning of the possible label construct.
7738 ;;
7739 ;; Check that the next nonsymbol token is ":", or that we're in one
7740 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
7741 ;; arguments. FIXME: Should build this regexp from the language
7742 ;; constants.
7743 (cond
7744 ;; public: protected: private:
7745 ((and
7746 (c-major-mode-is 'c++-mode)
7747 (search-forward-regexp
7748 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t)
7749 (progn (backward-char)
7750 (c-forward-syntactic-ws limit)
7751 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
7752 (forward-char)
7753 (setq label-type t))
7754 ;; QT double keyword like "protected slots:" or goto target.
7755 ((progn (goto-char start) nil))
7756 ((when (c-syntactic-re-search-forward
7757 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t) ; not at EOB
7758 (backward-char)
7759 (setq label-end (point))
7760 (setq qt-symbol-idx
7761 (and (c-major-mode-is 'c++-mode)
7762 (string-match
7763 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
7764 (buffer-substring start (point)))))
7765 (c-forward-syntactic-ws limit)
7766 (cond
7767 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
7768 (forward-char)
7769 (setq label-type
7770 (if (or (string= "signals" ; Special QT macro
7771 (setq kwd (buffer-substring-no-properties start label-end)))
7772 (string= "Q_SIGNALS" kwd))
7773 'qt-1kwd-colon
7774 'goto-target)))
7775 ((and qt-symbol-idx
7776 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t)
7777 (progn (c-forward-syntactic-ws limit)
7778 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
7779 (forward-char)
7780 (setq label-type 'qt-2kwds-colon)))))))
7781
7782 (save-restriction
7783 (narrow-to-region start (point))
7784
7785 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
7786 (catch 'check-label
7787 (goto-char start)
7788 (while (progn
7789 (when (looking-at c-nonlabel-token-key)
7790 (goto-char start)
7791 (setq label-type nil)
7792 (throw 'check-label nil))
7793 (and (c-safe (c-forward-sexp)
7794 (c-forward-syntactic-ws)
7795 t)
7796 (not (eobp)))))
7797
7798 ;; Record the identifiers in the label for fontification, unless
7799 ;; it begins with `c-label-kwds' in which case the following
7800 ;; identifiers are part of a (constant) expression that
7801 ;; shouldn't be fontified.
7802 (when (and c-record-type-identifiers
7803 (progn (goto-char start)
7804 (not (looking-at c-label-kwds-regexp))))
7805 (while (c-syntactic-re-search-forward c-symbol-key nil t)
7806 (c-record-ref-id (cons (match-beginning 0)
7807 (match-end 0)))))
7808
7809 (c-put-c-type-property (1- (point-max)) 'c-decl-end)
7810 (goto-char (point-max)))))
7811
7812 (t
7813 ;; Not a label.
7814 (goto-char start)))
7815 label-type))
7816
7817 (defun c-forward-objc-directive ()
7818 ;; Assuming the point is at the beginning of a token, try to move
7819 ;; forward to the end of the Objective-C directive that starts
7820 ;; there. Return t if a directive was fully recognized, otherwise
7821 ;; the point is moved as far as one could be successfully parsed and
7822 ;; nil is returned.
7823 ;;
7824 ;; This function records identifier ranges on
7825 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7826 ;; `c-record-type-identifiers' is non-nil.
7827 ;;
7828 ;; This function might do hidden buffer changes.
7829
7830 (let ((start (point))
7831 start-char
7832 (c-promote-possible-types t)
7833 lim
7834 ;; Turn off recognition of angle bracket arglists while parsing
7835 ;; types here since the protocol reference list might then be
7836 ;; considered part of the preceding name or superclass-name.
7837 c-recognize-<>-arglists)
7838
7839 (if (or
7840 (when (looking-at
7841 (eval-when-compile
7842 (c-make-keywords-re t
7843 (append (c-lang-const c-protection-kwds objc)
7844 '("@end"))
7845 'objc-mode)))
7846 (goto-char (match-end 1))
7847 t)
7848
7849 (and
7850 (looking-at
7851 (eval-when-compile
7852 (c-make-keywords-re t
7853 '("@interface" "@implementation" "@protocol")
7854 'objc-mode)))
7855
7856 ;; Handle the name of the class itself.
7857 (progn
7858 ;; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
7859 ;; at EOB.
7860 (goto-char (match-end 0))
7861 (setq lim (point))
7862 (c-skip-ws-forward)
7863 (c-forward-type))
7864
7865 (catch 'break
7866 ;; Look for ": superclass-name" or "( category-name )".
7867 (when (looking-at "[:\(]")
7868 (setq start-char (char-after))
7869 (forward-char)
7870 (c-forward-syntactic-ws)
7871 (unless (c-forward-type) (throw 'break nil))
7872 (when (eq start-char ?\()
7873 (unless (eq (char-after) ?\)) (throw 'break nil))
7874 (forward-char)
7875 (c-forward-syntactic-ws)))
7876
7877 ;; Look for a protocol reference list.
7878 (if (eq (char-after) ?<)
7879 (let ((c-recognize-<>-arglists t)
7880 (c-parse-and-markup-<>-arglists t)
7881 c-restricted-<>-arglists)
7882 (c-forward-<>-arglist t))
7883 t))))
7884
7885 (progn
7886 (c-backward-syntactic-ws lim)
7887 (c-clear-c-type-property start (1- (point)) 'c-decl-end)
7888 (c-put-c-type-property (1- (point)) 'c-decl-end)
7889 t)
7890
7891 (c-clear-c-type-property start (point) 'c-decl-end)
7892 nil)))
7893
7894 (defun c-beginning-of-inheritance-list (&optional lim)
7895 ;; Go to the first non-whitespace after the colon that starts a
7896 ;; multiple inheritance introduction. Optional LIM is the farthest
7897 ;; back we should search.
7898 ;;
7899 ;; This function might do hidden buffer changes.
7900 (c-with-syntax-table c++-template-syntax-table
7901 (c-backward-token-2 0 t lim)
7902 (while (and (or (looking-at c-symbol-start)
7903 (looking-at "[<,]\\|::"))
7904 (zerop (c-backward-token-2 1 t lim))))))
7905
7906 (defun c-in-method-def-p ()
7907 ;; Return nil if we aren't in a method definition, otherwise the
7908 ;; position of the initial [+-].
7909 ;;
7910 ;; This function might do hidden buffer changes.
7911 (save-excursion
7912 (beginning-of-line)
7913 (and c-opt-method-key
7914 (looking-at c-opt-method-key)
7915 (point))
7916 ))
7917
7918 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
7919 (defun c-in-gcc-asm-p ()
7920 ;; Return non-nil if point is within a gcc \"asm\" block.
7921 ;;
7922 ;; This should be called with point inside an argument list.
7923 ;;
7924 ;; Only one level of enclosing parentheses is considered, so for
7925 ;; instance `nil' is returned when in a function call within an asm
7926 ;; operand.
7927 ;;
7928 ;; This function might do hidden buffer changes.
7929
7930 (and c-opt-asm-stmt-key
7931 (save-excursion
7932 (beginning-of-line)
7933 (backward-up-list 1)
7934 (c-beginning-of-statement-1 (point-min) nil t)
7935 (looking-at c-opt-asm-stmt-key))))
7936
7937 (defun c-at-toplevel-p ()
7938 "Return a determination as to whether point is \"at the top level\".
7939 Informally, \"at the top level\" is anywhere where you can write
7940 a function.
7941
7942 More precisely, being at the top-level means that point is either
7943 outside any enclosing block (such as a function definition), or
7944 directly inside a class, namespace or other block that contains
7945 another declaration level.
7946
7947 If point is not at the top-level (e.g. it is inside a method
7948 definition), then nil is returned. Otherwise, if point is at a
7949 top-level not enclosed within a class definition, t is returned.
7950 Otherwise, a 2-vector is returned where the zeroth element is the
7951 buffer position of the start of the class declaration, and the first
7952 element is the buffer position of the enclosing class's opening
7953 brace.
7954
7955 Note that this function might do hidden buffer changes. See the
7956 comment at the start of cc-engine.el for more info."
7957 (let ((paren-state (c-parse-state)))
7958 (or (not (c-most-enclosing-brace paren-state))
7959 (c-search-uplist-for-classkey paren-state))))
7960
7961 (defun c-just-after-func-arglist-p (&optional lim)
7962 ;; Return non-nil if the point is in the region after the argument
7963 ;; list of a function and its opening brace (or semicolon in case it
7964 ;; got no body). If there are K&R style argument declarations in
7965 ;; that region, the point has to be inside the first one for this
7966 ;; function to recognize it.
7967 ;;
7968 ;; If successful, the point is moved to the first token after the
7969 ;; function header (see `c-forward-decl-or-cast-1' for details) and
7970 ;; the position of the opening paren of the function arglist is
7971 ;; returned.
7972 ;;
7973 ;; The point is clobbered if not successful.
7974 ;;
7975 ;; LIM is used as bound for backward buffer searches.
7976 ;;
7977 ;; This function might do hidden buffer changes.
7978
7979 (let ((beg (point)) id-start)
7980 (and
7981 (eq (c-beginning-of-statement-1 lim) 'same)
7982
7983 (not (and (c-major-mode-is 'objc-mode)
7984 (c-forward-objc-directive)))
7985
7986 (setq id-start
7987 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil)))
7988 (< id-start beg)
7989
7990 ;; There should not be a '=' or ',' between beg and the
7991 ;; start of the declaration since that means we were in the
7992 ;; "expression part" of the declaration.
7993 (or (> (point) beg)
7994 (not (looking-at "[=,]")))
7995
7996 (save-excursion
7997 ;; Check that there's an arglist paren in the
7998 ;; declaration.
7999 (goto-char id-start)
8000 (cond ((eq (char-after) ?\()
8001 ;; The declarator is a paren expression, so skip past it
8002 ;; so that we don't get stuck on that instead of the
8003 ;; function arglist.
8004 (c-forward-sexp))
8005 ((and c-opt-op-identifier-prefix
8006 (looking-at c-opt-op-identifier-prefix))
8007 ;; Don't trip up on "operator ()".
8008 (c-forward-token-2 2 t)))
8009 (and (< (point) beg)
8010 (c-syntactic-re-search-forward "(" beg t t)
8011 (1- (point)))))))
8012
8013 (defun c-in-knr-argdecl (&optional lim)
8014 ;; Return the position of the first argument declaration if point is
8015 ;; inside a K&R style argument declaration list, nil otherwise.
8016 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
8017 ;; position that bounds the backward search for the argument list.
8018 ;;
8019 ;; Point must be within a possible K&R region, e.g. just before a top-level
8020 ;; "{". It must be outside of parens and brackets. The test can return
8021 ;; false positives otherwise.
8022 ;;
8023 ;; This function might do hidden buffer changes.
8024
8025 (save-excursion
8026 (save-restriction
8027 ;; If we're in a macro, our search range is restricted to it. Narrow to
8028 ;; the searchable range.
8029 (let* ((macro-start (save-excursion (and (c-beginning-of-macro) (point))))
8030 (macro-end (save-excursion (and macro-start (c-end-of-macro) (point))))
8031 (low-lim (max (or lim (point-min)) (or macro-start (point-min))))
8032 before-lparen after-rparen
8033 (pp-count-out 20)) ; Max number of paren/brace constructs before
8034 ; we give up
8035 (narrow-to-region low-lim (or macro-end (point-max)))
8036
8037 ;; Search backwards for the defun's argument list. We give up if we
8038 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
8039 ;; a knr region) or BOB.
8040 ;;
8041 ;; The criterion for a paren structure being the arg list is:
8042 ;; o - there is non-WS stuff after it but before any "{"; AND
8043 ;; o - the token after it isn't a ";" AND
8044 ;; o - it is preceded by either an identifier (the function name) or
8045 ;; a macro expansion like "DEFUN (...)"; AND
8046 ;; o - its content is a non-empty comma-separated list of identifiers
8047 ;; (an empty arg list won't have a knr region).
8048 ;;
8049 ;; The following snippet illustrates these rules:
8050 ;; int foo (bar, baz, yuk)
8051 ;; int bar [] ;
8052 ;; int (*baz) (my_type) ;
8053 ;; int (*) (void) (*yuk) (void) ;
8054 ;; {
8055
8056 (catch 'knr
8057 (while (> pp-count-out 0) ; go back one paren/bracket pair each time.
8058 (setq pp-count-out (1- pp-count-out))
8059 (c-syntactic-skip-backward "^)]}=")
8060 (cond ((eq (char-before) ?\))
8061 (setq after-rparen (point)))
8062 ((eq (char-before) ?\])
8063 (setq after-rparen nil))
8064 (t ; either } (hit previous defun) or = or no more
8065 ; parens/brackets.
8066 (throw 'knr nil)))
8067
8068 (if after-rparen
8069 ;; We're inside a paren. Could it be our argument list....?
8070 (if
8071 (and
8072 (progn
8073 (goto-char after-rparen)
8074 (unless (c-go-list-backward) (throw 'knr nil)) ;
8075 ;; FIXME!!! What about macros between the parens? 2007/01/20
8076 (setq before-lparen (point)))
8077
8078 ;; It can't be the arg list if next token is ; or {
8079 (progn (goto-char after-rparen)
8080 (c-forward-syntactic-ws)
8081 (not (memq (char-after) '(?\; ?\{ ?\=))))
8082
8083 ;; Is the thing preceding the list an identifier (the
8084 ;; function name), or a macro expansion?
8085 (progn
8086 (goto-char before-lparen)
8087 (eq (c-backward-token-2) 0)
8088 (or (eq (c-on-identifier) (point))
8089 (and (eq (char-after) ?\))
8090 (c-go-up-list-backward)
8091 (eq (c-backward-token-2) 0)
8092 (eq (c-on-identifier) (point)))))
8093
8094 ;; Have we got a non-empty list of comma-separated
8095 ;; identifiers?
8096 (progn
8097 (goto-char before-lparen)
8098 (c-forward-token-2) ; to first token inside parens
8099 (and
8100 (c-on-identifier)
8101 (c-forward-token-2)
8102 (catch 'id-list
8103 (while (eq (char-after) ?\,)
8104 (c-forward-token-2)
8105 (unless (c-on-identifier) (throw 'id-list nil))
8106 (c-forward-token-2))
8107 (eq (char-after) ?\))))))
8108
8109 ;; ...Yes. We've identified the function's argument list.
8110 (throw 'knr
8111 (progn (goto-char after-rparen)
8112 (c-forward-syntactic-ws)
8113 (point)))
8114
8115 ;; ...No. The current parens aren't the function's arg list.
8116 (goto-char before-lparen))
8117
8118 (or (c-go-list-backward) ; backwards over [ .... ]
8119 (throw 'knr nil)))))))))
8120
8121 (defun c-skip-conditional ()
8122 ;; skip forward over conditional at point, including any predicate
8123 ;; statements in parentheses. No error checking is performed.
8124 ;;
8125 ;; This function might do hidden buffer changes.
8126 (c-forward-sexp (cond
8127 ;; else if()
8128 ((looking-at (concat "\\<else"
8129 "\\([ \t\n]\\|\\\\\n\\)+"
8130 "if\\>\\([^_]\\|$\\)"))
8131 3)
8132 ;; do, else, try, finally
8133 ((looking-at (concat "\\<\\("
8134 "do\\|else\\|try\\|finally"
8135 "\\)\\>\\([^_]\\|$\\)"))
8136 1)
8137 ;; for, if, while, switch, catch, synchronized, foreach
8138 (t 2))))
8139
8140 (defun c-after-conditional (&optional lim)
8141 ;; If looking at the token after a conditional then return the
8142 ;; position of its start, otherwise return nil.
8143 ;;
8144 ;; This function might do hidden buffer changes.
8145 (save-excursion
8146 (and (zerop (c-backward-token-2 1 t lim))
8147 (or (looking-at c-block-stmt-1-key)
8148 (and (eq (char-after) ?\()
8149 (zerop (c-backward-token-2 1 t lim))
8150 (or (looking-at c-block-stmt-2-key)
8151 (looking-at c-block-stmt-1-2-key))))
8152 (point))))
8153
8154 (defun c-after-special-operator-id (&optional lim)
8155 ;; If the point is after an operator identifier that isn't handled
8156 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
8157 ;; position of the start of that identifier is returned. nil is
8158 ;; returned otherwise. The point may be anywhere in the syntactic
8159 ;; whitespace after the last token of the operator identifier.
8160 ;;
8161 ;; This function might do hidden buffer changes.
8162 (save-excursion
8163 (and c-overloadable-operators-regexp
8164 (zerop (c-backward-token-2 1 nil lim))
8165 (looking-at c-overloadable-operators-regexp)
8166 (or (not c-opt-op-identifier-prefix)
8167 (and
8168 (zerop (c-backward-token-2 1 nil lim))
8169 (looking-at c-opt-op-identifier-prefix)))
8170 (point))))
8171
8172 (defsubst c-backward-to-block-anchor (&optional lim)
8173 ;; Assuming point is at a brace that opens a statement block of some
8174 ;; kind, move to the proper anchor point for that block. It might
8175 ;; need to be adjusted further by c-add-stmt-syntax, but the
8176 ;; position at return is suitable as start position for that
8177 ;; function.
8178 ;;
8179 ;; This function might do hidden buffer changes.
8180 (unless (= (point) (c-point 'boi))
8181 (let ((start (c-after-conditional lim)))
8182 (if start
8183 (goto-char start)))))
8184
8185 (defsubst c-backward-to-decl-anchor (&optional lim)
8186 ;; Assuming point is at a brace that opens the block of a top level
8187 ;; declaration of some kind, move to the proper anchor point for
8188 ;; that block.
8189 ;;
8190 ;; This function might do hidden buffer changes.
8191 (unless (= (point) (c-point 'boi))
8192 (c-beginning-of-statement-1 lim)))
8193
8194 (defun c-search-decl-header-end ()
8195 ;; Search forward for the end of the "header" of the current
8196 ;; declaration. That's the position where the definition body
8197 ;; starts, or the first variable initializer, or the ending
8198 ;; semicolon. I.e. search forward for the closest following
8199 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8200 ;; _after_ the first found token, or at point-max if none is found.
8201 ;;
8202 ;; This function might do hidden buffer changes.
8203
8204 (let ((base (point)))
8205 (if (c-major-mode-is 'c++-mode)
8206
8207 ;; In C++ we need to take special care to handle operator
8208 ;; tokens and those pesky template brackets.
8209 (while (and
8210 (c-syntactic-re-search-forward "[;{<=]" nil 'move t t)
8211 (or
8212 (c-end-of-current-token base)
8213 ;; Handle operator identifiers, i.e. ignore any
8214 ;; operator token preceded by "operator".
8215 (save-excursion
8216 (and (c-safe (c-backward-sexp) t)
8217 (looking-at c-opt-op-identifier-prefix)))
8218 (and (eq (char-before) ?<)
8219 (c-with-syntax-table c++-template-syntax-table
8220 (if (c-safe (goto-char (c-up-list-forward (point))))
8221 t
8222 (goto-char (point-max))
8223 nil)))))
8224 (setq base (point)))
8225
8226 (while (and
8227 (c-syntactic-re-search-forward "[;{=]" nil 'move t t)
8228 (c-end-of-current-token base))
8229 (setq base (point))))))
8230
8231 (defun c-beginning-of-decl-1 (&optional lim)
8232 ;; Go to the beginning of the current declaration, or the beginning
8233 ;; of the previous one if already at the start of it. Point won't
8234 ;; be moved out of any surrounding paren. Return a cons cell of the
8235 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8236 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8237 ;; style argument declarations (and they are to be recognized) then
8238 ;; KNR-POS is set to the start of the first such argument
8239 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8240 ;; position that bounds the backward search.
8241 ;;
8242 ;; NB: Cases where the declaration continues after the block, as in
8243 ;; "struct foo { ... } bar;", are currently recognized as two
8244 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8245 ;;
8246 ;; This function might do hidden buffer changes.
8247 (catch 'return
8248 (let* ((start (point))
8249 (last-stmt-start (point))
8250 (move (c-beginning-of-statement-1 lim nil t)))
8251
8252 ;; `c-beginning-of-statement-1' stops at a block start, but we
8253 ;; want to continue if the block doesn't begin a top level
8254 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8255 ;; or an open paren.
8256 (let ((beg (point)) tentative-move)
8257 ;; Go back one "statement" each time round the loop until we're just
8258 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8259 ;; an ObjC method. This will move over a multiple declaration whose
8260 ;; components are comma separated.
8261 (while (and
8262 ;; Must check with c-opt-method-key in ObjC mode.
8263 (not (and c-opt-method-key
8264 (looking-at c-opt-method-key)))
8265 (/= last-stmt-start (point))
8266 (progn
8267 (c-backward-syntactic-ws lim)
8268 (not (memq (char-before) '(?\; ?} ?: nil))))
8269 (save-excursion
8270 (backward-char)
8271 (not (looking-at "\\s(")))
8272 ;; Check that we don't move from the first thing in a
8273 ;; macro to its header.
8274 (not (eq (setq tentative-move
8275 (c-beginning-of-statement-1 lim nil t))
8276 'macro)))
8277 (setq last-stmt-start beg
8278 beg (point)
8279 move tentative-move))
8280 (goto-char beg))
8281
8282 (when c-recognize-knr-p
8283 (let ((fallback-pos (point)) knr-argdecl-start)
8284 ;; Handle K&R argdecls. Back up after the "statement" jumped
8285 ;; over by `c-beginning-of-statement-1', unless it was the
8286 ;; function body, in which case we're sitting on the opening
8287 ;; brace now. Then test if we're in a K&R argdecl region and
8288 ;; that we started at the other side of the first argdecl in
8289 ;; it.
8290 (unless (eq (char-after) ?{)
8291 (goto-char last-stmt-start))
8292 (if (and (setq knr-argdecl-start (c-in-knr-argdecl lim))
8293 (< knr-argdecl-start start)
8294 (progn
8295 (goto-char knr-argdecl-start)
8296 (not (eq (c-beginning-of-statement-1 lim nil t) 'macro))))
8297 (throw 'return
8298 (cons (if (eq (char-after fallback-pos) ?{)
8299 'previous
8300 'same)
8301 knr-argdecl-start))
8302 (goto-char fallback-pos))))
8303
8304 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8305 ;; statement, so the result will be 'previous if we've moved over any.
8306 ;; So change our result back to 'same if necessary.
8307 ;;
8308 ;; If they were brace list initializers we might not have moved over a
8309 ;; declaration boundary though, so change it to 'same if we've moved
8310 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8311 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8312 ;; potentially can search over a large amount of text.). Take special
8313 ;; pains not to get mislead by C++'s "operator=", and the like.
8314 (if (and (eq move 'previous)
8315 (c-with-syntax-table (if (c-major-mode-is 'c++-mode)
8316 c++-template-syntax-table
8317 (syntax-table))
8318 (save-excursion
8319 (and
8320 (progn
8321 (while ; keep going back to "[;={"s until we either find
8322 ; no more, or get to one which isn't an "operator ="
8323 (and (c-syntactic-re-search-forward "[;={]" start t t t)
8324 (eq (char-before) ?=)
8325 c-overloadable-operators-regexp
8326 c-opt-op-identifier-prefix
8327 (save-excursion
8328 (eq (c-backward-token-2) 0)
8329 (looking-at c-overloadable-operators-regexp)
8330 (eq (c-backward-token-2) 0)
8331 (looking-at c-opt-op-identifier-prefix))))
8332 (eq (char-before) ?=))
8333 (c-syntactic-re-search-forward "[;{]" start t t)
8334 (eq (char-before) ?{)
8335 (c-safe (goto-char (c-up-list-forward (point))) t)
8336 (not (c-syntactic-re-search-forward ";" start t t))))))
8337 (cons 'same nil)
8338 (cons move nil)))))
8339
8340 (defun c-end-of-decl-1 ()
8341 ;; Assuming point is at the start of a declaration (as detected by
8342 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8343 ;; `c-beginning-of-decl-1', this function handles the case when a
8344 ;; block is followed by identifiers in e.g. struct declarations in C
8345 ;; or C++. If a proper end was found then t is returned, otherwise
8346 ;; point is moved as far as possible within the current sexp and nil
8347 ;; is returned. This function doesn't handle macros; use
8348 ;; `c-end-of-macro' instead in those cases.
8349 ;;
8350 ;; This function might do hidden buffer changes.
8351 (let ((start (point))
8352 (decl-syntax-table (if (c-major-mode-is 'c++-mode)
8353 c++-template-syntax-table
8354 (syntax-table))))
8355 (catch 'return
8356 (c-search-decl-header-end)
8357
8358 (when (and c-recognize-knr-p
8359 (eq (char-before) ?\;)
8360 (c-in-knr-argdecl start))
8361 ;; Stopped at the ';' in a K&R argdecl section which is
8362 ;; detected using the same criteria as in
8363 ;; `c-beginning-of-decl-1'. Move to the following block
8364 ;; start.
8365 (c-syntactic-re-search-forward "{" nil 'move t))
8366
8367 (when (eq (char-before) ?{)
8368 ;; Encountered a block in the declaration. Jump over it.
8369 (condition-case nil
8370 (goto-char (c-up-list-forward (point)))
8371 (error (goto-char (point-max))
8372 (throw 'return nil)))
8373 (if (or (not c-opt-block-decls-with-vars-key)
8374 (save-excursion
8375 (c-with-syntax-table decl-syntax-table
8376 (let ((lim (point)))
8377 (goto-char start)
8378 (not (and
8379 ;; Check for `c-opt-block-decls-with-vars-key'
8380 ;; before the first paren.
8381 (c-syntactic-re-search-forward
8382 (concat "[;=\(\[{]\\|\\("
8383 c-opt-block-decls-with-vars-key
8384 "\\)")
8385 lim t t t)
8386 (match-beginning 1)
8387 (not (eq (char-before) ?_))
8388 ;; Check that the first following paren is
8389 ;; the block.
8390 (c-syntactic-re-search-forward "[;=\(\[{]"
8391 lim t t t)
8392 (eq (char-before) ?{)))))))
8393 ;; The declaration doesn't have any of the
8394 ;; `c-opt-block-decls-with-vars' keywords in the
8395 ;; beginning, so it ends here at the end of the block.
8396 (throw 'return t)))
8397
8398 (c-with-syntax-table decl-syntax-table
8399 (while (progn
8400 (if (eq (char-before) ?\;)
8401 (throw 'return t))
8402 (c-syntactic-re-search-forward ";" nil 'move t))))
8403 nil)))
8404
8405 (defun c-looking-at-decl-block (containing-sexp goto-start &optional limit)
8406 ;; Assuming the point is at an open brace, check if it starts a
8407 ;; block that contains another declaration level, i.e. that isn't a
8408 ;; statement block or a brace list, and if so return non-nil.
8409 ;;
8410 ;; If the check is successful, the return value is the start of the
8411 ;; keyword that tells what kind of construct it is, i.e. typically
8412 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8413 ;; the point will be at the start of the construct, before any
8414 ;; leading specifiers, otherwise it's at the returned position.
8415 ;;
8416 ;; The point is clobbered if the check is unsuccessful.
8417 ;;
8418 ;; CONTAINING-SEXP is the position of the open of the surrounding
8419 ;; paren, or nil if none.
8420 ;;
8421 ;; The optional LIMIT limits the backward search for the start of
8422 ;; the construct. It's assumed to be at a syntactically relevant
8423 ;; position.
8424 ;;
8425 ;; If any template arglists are found in the searched region before
8426 ;; the open brace, they get marked with paren syntax.
8427 ;;
8428 ;; This function might do hidden buffer changes.
8429
8430 (let ((open-brace (point)) kwd-start first-specifier-pos)
8431 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8432
8433 (when (and c-recognize-<>-arglists
8434 (eq (char-before) ?>))
8435 ;; Could be at the end of a template arglist.
8436 (let ((c-parse-and-markup-<>-arglists t)
8437 (c-disallow-comma-in-<>-arglists
8438 (and containing-sexp
8439 (not (eq (char-after containing-sexp) ?{)))))
8440 (while (and
8441 (c-backward-<>-arglist nil limit)
8442 (progn
8443 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8444 (eq (char-before) ?>))))))
8445
8446 ;; Note: Can't get bogus hits inside template arglists below since they
8447 ;; have gotten paren syntax above.
8448 (when (and
8449 ;; If `goto-start' is set we begin by searching for the
8450 ;; first possible position of a leading specifier list.
8451 ;; The `c-decl-block-key' search continues from there since
8452 ;; we know it can't match earlier.
8453 (if goto-start
8454 (when (c-syntactic-re-search-forward c-symbol-start
8455 open-brace t t)
8456 (goto-char (setq first-specifier-pos (match-beginning 0)))
8457 t)
8458 t)
8459
8460 (cond
8461 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t)
8462 (goto-char (setq kwd-start (match-beginning 0)))
8463 (and
8464 ;; Exclude cases where we matched what would ordinarily
8465 ;; be a block declaration keyword, except where it's not
8466 ;; legal because it's part of a "compound keyword" like
8467 ;; "enum class". Of course, if c-after-brace-list-key
8468 ;; is nil, we can skip the test.
8469 (or (equal c-after-brace-list-key "\\<\\>")
8470 (save-match-data
8471 (save-excursion
8472 (not
8473 (and
8474 (looking-at c-after-brace-list-key)
8475 (= (c-backward-token-2 1 t) 0)
8476 (looking-at c-brace-list-key))))))
8477 (or
8478 ;; Found a keyword that can't be a type?
8479 (match-beginning 1)
8480
8481 ;; Can be a type too, in which case it's the return type of a
8482 ;; function (under the assumption that no declaration level
8483 ;; block construct starts with a type).
8484 (not (c-forward-type))
8485
8486 ;; Jumped over a type, but it could be a declaration keyword
8487 ;; followed by the declared identifier that we've jumped over
8488 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8489 ;; then we should be at the declarator now, so check for a
8490 ;; valid declarator start.
8491 ;;
8492 ;; Note: This doesn't cope with the case when a declared
8493 ;; identifier is followed by e.g. '(' in a language where '('
8494 ;; also might be part of a declarator expression. Currently
8495 ;; there's no such language.
8496 (not (or (looking-at c-symbol-start)
8497 (looking-at c-type-decl-prefix-key))))))
8498
8499 ;; In Pike a list of modifiers may be followed by a brace
8500 ;; to make them apply to many identifiers. Note that the
8501 ;; match data will be empty on return in this case.
8502 ((and (c-major-mode-is 'pike-mode)
8503 (progn
8504 (goto-char open-brace)
8505 (= (c-backward-token-2) 0))
8506 (looking-at c-specifier-key)
8507 ;; Use this variant to avoid yet another special regexp.
8508 (c-keyword-member (c-keyword-sym (match-string 1))
8509 'c-modifier-kwds))
8510 (setq kwd-start (point))
8511 t)))
8512
8513 ;; Got a match.
8514
8515 (if goto-start
8516 ;; Back up over any preceding specifiers and their clauses
8517 ;; by going forward from `first-specifier-pos', which is the
8518 ;; earliest possible position where the specifier list can
8519 ;; start.
8520 (progn
8521 (goto-char first-specifier-pos)
8522
8523 (while (< (point) kwd-start)
8524 (if (looking-at c-symbol-key)
8525 ;; Accept any plain symbol token on the ground that
8526 ;; it's a specifier masked through a macro (just
8527 ;; like `c-forward-decl-or-cast-1' skip forward over
8528 ;; such tokens).
8529 ;;
8530 ;; Could be more restrictive wrt invalid keywords,
8531 ;; but that'd only occur in invalid code so there's
8532 ;; no use spending effort on it.
8533 (let ((end (match-end 0)))
8534 (unless (c-forward-keyword-clause 0)
8535 (goto-char end)
8536 (c-forward-syntactic-ws)))
8537
8538 ;; Can't parse a declaration preamble and is still
8539 ;; before `kwd-start'. That means `first-specifier-pos'
8540 ;; was in some earlier construct. Search again.
8541 (if (c-syntactic-re-search-forward c-symbol-start
8542 kwd-start 'move t)
8543 (goto-char (setq first-specifier-pos (match-beginning 0)))
8544 ;; Got no preamble before the block declaration keyword.
8545 (setq first-specifier-pos kwd-start))))
8546
8547 (goto-char first-specifier-pos))
8548 (goto-char kwd-start))
8549
8550 kwd-start)))
8551
8552 (defun c-search-uplist-for-classkey (paren-state)
8553 ;; Check if the closest containing paren sexp is a declaration
8554 ;; block, returning a 2 element vector in that case. Aref 0
8555 ;; contains the bufpos at boi of the class key line, and aref 1
8556 ;; contains the bufpos of the open brace. This function is an
8557 ;; obsolete wrapper for `c-looking-at-decl-block'.
8558 ;;
8559 ;; This function might do hidden buffer changes.
8560 (let ((open-paren-pos (c-most-enclosing-brace paren-state)))
8561 (when open-paren-pos
8562 (save-excursion
8563 (goto-char open-paren-pos)
8564 (when (and (eq (char-after) ?{)
8565 (c-looking-at-decl-block
8566 (c-safe-position open-paren-pos paren-state)
8567 nil))
8568 (back-to-indentation)
8569 (vector (point) open-paren-pos))))))
8570
8571 (defun c-most-enclosing-decl-block (paren-state)
8572 ;; Return the buffer position of the most enclosing decl-block brace (in the
8573 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
8574 ;; none was found.
8575 (let* ((open-brace (c-pull-open-brace paren-state))
8576 (next-open-brace (c-pull-open-brace paren-state)))
8577 (while (and open-brace
8578 (save-excursion
8579 (goto-char open-brace)
8580 (not (c-looking-at-decl-block next-open-brace nil))))
8581 (setq open-brace next-open-brace
8582 next-open-brace (c-pull-open-brace paren-state)))
8583 open-brace))
8584
8585 (defun c-cheap-inside-bracelist-p (paren-state)
8586 ;; Return the position of the L-brace if point is inside a brace list
8587 ;; initialization of an array, etc. This is an approximate function,
8588 ;; designed for speed over accuracy. It will not find every bracelist, but
8589 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
8590 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
8591 ;; is everywhere else.
8592 (let (b-pos)
8593 (save-excursion
8594 (while
8595 (and (setq b-pos (c-pull-open-brace paren-state))
8596 (progn (goto-char b-pos)
8597 (c-backward-sws)
8598 (c-backward-token-2)
8599 (not (looking-at "=")))))
8600 b-pos)))
8601
8602 (defun c-backward-colon-prefixed-type ()
8603 ;; We're at the token after what might be a type prefixed with a colon. Try
8604 ;; moving backward over this type and the colon. On success, return t and
8605 ;; leave point before colon; on failure, leave point unchanged. Will clobber
8606 ;; match data.
8607 (let ((here (point))
8608 (colon-pos nil))
8609 (save-excursion
8610 (while
8611 (and (eql (c-backward-token-2) 0)
8612 (or (not (looking-at "\\s)"))
8613 (c-go-up-list-backward))
8614 (cond
8615 ((eql (char-after) ?:)
8616 (setq colon-pos (point))
8617 (forward-char)
8618 (c-forward-syntactic-ws)
8619 (or (and (c-forward-type)
8620 (progn (c-forward-syntactic-ws)
8621 (eq (point) here)))
8622 (setq colon-pos nil))
8623 nil)
8624 ((eql (char-after) ?\()
8625 t)
8626 ((looking-at c-symbol-key)
8627 t)
8628 (t nil)))))
8629 (when colon-pos
8630 (goto-char colon-pos)
8631 t)))
8632
8633 (defun c-backward-over-enum-header ()
8634 ;; We're at a "{". Move back to the enum-like keyword that starts this
8635 ;; declaration and return t, otherwise don't move and return nil.
8636 (let ((here (point))
8637 up-sexp-pos before-identifier)
8638 (when c-recognize-post-brace-list-type-p
8639 (c-backward-colon-prefixed-type))
8640 (while
8641 (and
8642 (eq (c-backward-token-2) 0)
8643 (or (not (looking-at "\\s)"))
8644 (c-go-up-list-backward))
8645 (cond
8646 ((and (looking-at c-symbol-key) (c-on-identifier)
8647 (not before-identifier))
8648 (setq before-identifier t))
8649 ((and before-identifier
8650 (or (eql (char-after) ?,)
8651 (looking-at c-postfix-decl-spec-key)))
8652 (setq before-identifier nil)
8653 t)
8654 ((looking-at c-after-brace-list-key) t)
8655 ((looking-at c-brace-list-key) nil)
8656 ((and c-recognize-<>-arglists
8657 (eq (char-after) ?<)
8658 (looking-at "\\s("))
8659 t)
8660 (t nil))))
8661 (or (looking-at c-brace-list-key)
8662 (progn (goto-char here) nil))))
8663
8664 (defun c-inside-bracelist-p (containing-sexp paren-state)
8665 ;; return the buffer position of the beginning of the brace list
8666 ;; statement if we're inside a brace list, otherwise return nil.
8667 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
8668 ;; paren. PAREN-STATE is the remainder of the state of enclosing
8669 ;; braces
8670 ;;
8671 ;; N.B.: This algorithm can potentially get confused by cpp macros
8672 ;; placed in inconvenient locations. It's a trade-off we make for
8673 ;; speed.
8674 ;;
8675 ;; This function might do hidden buffer changes.
8676 (or
8677 ;; This will pick up brace list declarations.
8678 (save-excursion
8679 (goto-char containing-sexp)
8680 (c-backward-over-enum-header))
8681 ;; this will pick up array/aggregate init lists, even if they are nested.
8682 (save-excursion
8683 (let ((class-key
8684 ;; Pike can have class definitions anywhere, so we must
8685 ;; check for the class key here.
8686 (and (c-major-mode-is 'pike-mode)
8687 c-decl-block-key))
8688 bufpos braceassignp lim next-containing macro-start)
8689 (while (and (not bufpos)
8690 containing-sexp)
8691 (when paren-state
8692 (if (consp (car paren-state))
8693 (setq lim (cdr (car paren-state))
8694 paren-state (cdr paren-state))
8695 (setq lim (car paren-state)))
8696 (when paren-state
8697 (setq next-containing (car paren-state)
8698 paren-state (cdr paren-state))))
8699 (goto-char containing-sexp)
8700 (if (c-looking-at-inexpr-block next-containing next-containing)
8701 ;; We're in an in-expression block of some kind. Do not
8702 ;; check nesting. We deliberately set the limit to the
8703 ;; containing sexp, so that c-looking-at-inexpr-block
8704 ;; doesn't check for an identifier before it.
8705 (setq containing-sexp nil)
8706 ;; see if the open brace is preceded by = or [...] in
8707 ;; this statement, but watch out for operator=
8708 (setq braceassignp 'dontknow)
8709 (c-backward-token-2 1 t lim)
8710 ;; Checks to do only on the first sexp before the brace.
8711 (when (and c-opt-inexpr-brace-list-key
8712 (eq (char-after) ?\[))
8713 ;; In Java, an initialization brace list may follow
8714 ;; directly after "new Foo[]", so check for a "new"
8715 ;; earlier.
8716 (while (eq braceassignp 'dontknow)
8717 (setq braceassignp
8718 (cond ((/= (c-backward-token-2 1 t lim) 0) nil)
8719 ((looking-at c-opt-inexpr-brace-list-key) t)
8720 ((looking-at "\\sw\\|\\s_\\|[.[]")
8721 ;; Carry on looking if this is an
8722 ;; identifier (may contain "." in Java)
8723 ;; or another "[]" sexp.
8724 'dontknow)
8725 (t nil)))))
8726 ;; Checks to do on all sexps before the brace, up to the
8727 ;; beginning of the statement.
8728 (while (eq braceassignp 'dontknow)
8729 (cond ((eq (char-after) ?\;)
8730 (setq braceassignp nil))
8731 ((and class-key
8732 (looking-at class-key))
8733 (setq braceassignp nil))
8734 ((eq (char-after) ?=)
8735 ;; We've seen a =, but must check earlier tokens so
8736 ;; that it isn't something that should be ignored.
8737 (setq braceassignp 'maybe)
8738 (while (and (eq braceassignp 'maybe)
8739 (zerop (c-backward-token-2 1 t lim)))
8740 (setq braceassignp
8741 (cond
8742 ;; Check for operator =
8743 ((and c-opt-op-identifier-prefix
8744 (looking-at c-opt-op-identifier-prefix))
8745 nil)
8746 ;; Check for `<opchar>= in Pike.
8747 ((and (c-major-mode-is 'pike-mode)
8748 (or (eq (char-after) ?`)
8749 ;; Special case for Pikes
8750 ;; `[]=, since '[' is not in
8751 ;; the punctuation class.
8752 (and (eq (char-after) ?\[)
8753 (eq (char-before) ?`))))
8754 nil)
8755 ((looking-at "\\s.") 'maybe)
8756 ;; make sure we're not in a C++ template
8757 ;; argument assignment
8758 ((and
8759 (c-major-mode-is 'c++-mode)
8760 (save-excursion
8761 (let ((here (point))
8762 (pos< (progn
8763 (skip-chars-backward "^<>")
8764 (point))))
8765 (and (eq (char-before) ?<)
8766 (not (c-crosses-statement-barrier-p
8767 pos< here))
8768 (not (c-in-literal))
8769 ))))
8770 nil)
8771 (t t))))))
8772 (if (and (eq braceassignp 'dontknow)
8773 (/= (c-backward-token-2 1 t lim) 0))
8774 (setq braceassignp nil)))
8775 (cond
8776 (braceassignp
8777 ;; We've hit the beginning of the aggregate list.
8778 (c-beginning-of-statement-1
8779 (c-most-enclosing-brace paren-state))
8780 (setq bufpos (point)))
8781 ((eq (char-after) ?\;)
8782 ;; Brace lists can't contain a semicolon, so we're done.
8783 (setq containing-sexp nil))
8784 ((and (setq macro-start (point))
8785 (c-forward-to-cpp-define-body)
8786 (eq (point) containing-sexp))
8787 ;; We've a macro whose expansion starts with the '{'.
8788 ;; Heuristically, if we have a ';' in it we've not got a
8789 ;; brace list, otherwise we have.
8790 (let ((macro-end (progn (c-end-of-macro) (point))))
8791 (goto-char containing-sexp)
8792 (forward-char)
8793 (if (and (c-syntactic-re-search-forward "[;,]" macro-end t t)
8794 (eq (char-before) ?\;))
8795 (setq bufpos nil
8796 containing-sexp nil)
8797 (setq bufpos macro-start))))
8798 (t
8799 ;; Go up one level
8800 (setq containing-sexp next-containing
8801 lim nil
8802 next-containing nil)))))
8803
8804 bufpos))
8805 ))
8806
8807 (defun c-looking-at-special-brace-list (&optional lim)
8808 ;; If we're looking at the start of a pike-style list, i.e., `({ })',
8809 ;; `([ ])', `(< >)', etc., a cons of a cons of its starting and ending
8810 ;; positions and its entry in c-special-brace-lists is returned, nil
8811 ;; otherwise. The ending position is nil if the list is still open.
8812 ;; LIM is the limit for forward search. The point may either be at
8813 ;; the `(' or at the following paren character. Tries to check the
8814 ;; matching closer, but assumes it's correct if no balanced paren is
8815 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
8816 ;; a special brace list).
8817 ;;
8818 ;; This function might do hidden buffer changes.
8819 (if c-special-brace-lists
8820 (condition-case ()
8821 (save-excursion
8822 (let ((beg (point))
8823 inner-beg end type)
8824 (c-forward-syntactic-ws)
8825 (if (eq (char-after) ?\()
8826 (progn
8827 (forward-char 1)
8828 (c-forward-syntactic-ws)
8829 (setq inner-beg (point))
8830 (setq type (assq (char-after) c-special-brace-lists)))
8831 (if (setq type (assq (char-after) c-special-brace-lists))
8832 (progn
8833 (setq inner-beg (point))
8834 (c-backward-syntactic-ws)
8835 (forward-char -1)
8836 (setq beg (if (eq (char-after) ?\()
8837 (point)
8838 nil)))))
8839 (if (and beg type)
8840 (if (and (c-safe
8841 (goto-char beg)
8842 (c-forward-sexp 1)
8843 (setq end (point))
8844 (= (char-before) ?\)))
8845 (c-safe
8846 (goto-char inner-beg)
8847 (if (looking-at "\\s(")
8848 ;; Check balancing of the inner paren
8849 ;; below.
8850 (progn
8851 (c-forward-sexp 1)
8852 t)
8853 ;; If the inner char isn't a paren then
8854 ;; we can't check balancing, so just
8855 ;; check the char before the outer
8856 ;; closing paren.
8857 (goto-char end)
8858 (backward-char)
8859 (c-backward-syntactic-ws)
8860 (= (char-before) (cdr type)))))
8861 (if (or (/= (char-syntax (char-before)) ?\))
8862 (= (progn
8863 (c-forward-syntactic-ws)
8864 (point))
8865 (1- end)))
8866 (cons (cons beg end) type))
8867 (cons (list beg) type)))))
8868 (error nil))))
8869
8870 (defun c-looking-at-bos (&optional lim)
8871 ;; Return non-nil if between two statements or declarations, assuming
8872 ;; point is not inside a literal or comment.
8873 ;;
8874 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
8875 ;; are recommended instead.
8876 ;;
8877 ;; This function might do hidden buffer changes.
8878 (c-at-statement-start-p))
8879 (make-obsolete 'c-looking-at-bos 'c-at-statement-start-p "22.1")
8880
8881 (defun c-looking-at-inexpr-block (lim containing-sexp &optional check-at-end)
8882 ;; Return non-nil if we're looking at the beginning of a block
8883 ;; inside an expression. The value returned is actually a cons of
8884 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
8885 ;; position of the beginning of the construct.
8886 ;;
8887 ;; LIM limits the backward search. CONTAINING-SEXP is the start
8888 ;; position of the closest containing list. If it's nil, the
8889 ;; containing paren isn't used to decide whether we're inside an
8890 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
8891 ;; needs to be farther back.
8892 ;;
8893 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
8894 ;; brace block might be done. It should only be used when the
8895 ;; construct can be assumed to be complete, i.e. when the original
8896 ;; starting position was further down than that.
8897 ;;
8898 ;; This function might do hidden buffer changes.
8899
8900 (save-excursion
8901 (let ((res 'maybe) passed-paren
8902 (closest-lim (or containing-sexp lim (point-min)))
8903 ;; Look at the character after point only as a last resort
8904 ;; when we can't disambiguate.
8905 (block-follows (and (eq (char-after) ?{) (point))))
8906
8907 (while (and (eq res 'maybe)
8908 (progn (c-backward-syntactic-ws)
8909 (> (point) closest-lim))
8910 (not (bobp))
8911 (progn (backward-char)
8912 (looking-at "[\]\).]\\|\\w\\|\\s_"))
8913 (c-safe (forward-char)
8914 (goto-char (scan-sexps (point) -1))))
8915
8916 (setq res
8917 (if (looking-at c-keywords-regexp)
8918 (let ((kw-sym (c-keyword-sym (match-string 1))))
8919 (cond
8920 ((and block-follows
8921 (c-keyword-member kw-sym 'c-inexpr-class-kwds))
8922 (and (not (eq passed-paren ?\[))
8923 (or (not (looking-at c-class-key))
8924 ;; If the class definition is at the start of
8925 ;; a statement, we don't consider it an
8926 ;; in-expression class.
8927 (let ((prev (point)))
8928 (while (and
8929 (= (c-backward-token-2 1 nil closest-lim) 0)
8930 (eq (char-syntax (char-after)) ?w))
8931 (setq prev (point)))
8932 (goto-char prev)
8933 (not (c-at-statement-start-p)))
8934 ;; Also, in Pike we treat it as an
8935 ;; in-expression class if it's used in an
8936 ;; object clone expression.
8937 (save-excursion
8938 (and check-at-end
8939 (c-major-mode-is 'pike-mode)
8940 (progn (goto-char block-follows)
8941 (zerop (c-forward-token-2 1 t)))
8942 (eq (char-after) ?\())))
8943 (cons 'inexpr-class (point))))
8944 ((c-keyword-member kw-sym 'c-inexpr-block-kwds)
8945 (when (not passed-paren)
8946 (cons 'inexpr-statement (point))))
8947 ((c-keyword-member kw-sym 'c-lambda-kwds)
8948 (when (or (not passed-paren)
8949 (eq passed-paren ?\())
8950 (cons 'inlambda (point))))
8951 ((c-keyword-member kw-sym 'c-block-stmt-kwds)
8952 nil)
8953 (t
8954 'maybe)))
8955
8956 (if (looking-at "\\s(")
8957 (if passed-paren
8958 (if (and (eq passed-paren ?\[)
8959 (eq (char-after) ?\[))
8960 ;; Accept several square bracket sexps for
8961 ;; Java array initializations.
8962 'maybe)
8963 (setq passed-paren (char-after))
8964 'maybe)
8965 'maybe))))
8966
8967 (if (eq res 'maybe)
8968 (when (and c-recognize-paren-inexpr-blocks
8969 block-follows
8970 containing-sexp
8971 (eq (char-after containing-sexp) ?\())
8972 (goto-char containing-sexp)
8973 (if (or (save-excursion
8974 (c-backward-syntactic-ws lim)
8975 (and (> (point) (or lim (point-min)))
8976 (c-on-identifier)))
8977 (and c-special-brace-lists
8978 (c-looking-at-special-brace-list)))
8979 nil
8980 (cons 'inexpr-statement (point))))
8981
8982 res))))
8983
8984 (defun c-looking-at-inexpr-block-backward (paren-state)
8985 ;; Returns non-nil if we're looking at the end of an in-expression
8986 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
8987 ;; PAREN-STATE is the paren state relevant at the current position.
8988 ;;
8989 ;; This function might do hidden buffer changes.
8990 (save-excursion
8991 ;; We currently only recognize a block.
8992 (let ((here (point))
8993 (elem (car-safe paren-state))
8994 containing-sexp)
8995 (when (and (consp elem)
8996 (progn (goto-char (cdr elem))
8997 (c-forward-syntactic-ws here)
8998 (= (point) here)))
8999 (goto-char (car elem))
9000 (if (setq paren-state (cdr paren-state))
9001 (setq containing-sexp (car-safe paren-state)))
9002 (c-looking-at-inexpr-block (c-safe-position containing-sexp
9003 paren-state)
9004 containing-sexp)))))
9005
9006 (defun c-at-macro-vsemi-p (&optional pos)
9007 ;; Is there a "virtual semicolon" at POS or point?
9008 ;; (See cc-defs.el for full details of "virtual semicolons".)
9009 ;;
9010 ;; This is true when point is at the last non syntactic WS position on the
9011 ;; line, there is a macro call last on the line, and this particular macro's
9012 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
9013 ;; semicolon.
9014 (save-excursion
9015 (save-restriction
9016 (widen)
9017 (if pos
9018 (goto-char pos)
9019 (setq pos (point)))
9020 (and
9021 c-macro-with-semi-re
9022 (eq (skip-chars-backward " \t") 0)
9023
9024 ;; Check we've got nothing after this except comments and empty lines
9025 ;; joined by escaped EOLs.
9026 (skip-chars-forward " \t") ; always returns non-nil.
9027 (progn
9028 (while ; go over 1 block comment per iteration.
9029 (and
9030 (looking-at "\\(\\\\[\n\r][ \t]*\\)*")
9031 (goto-char (match-end 0))
9032 (cond
9033 ((looking-at c-block-comment-start-regexp)
9034 (and (forward-comment 1)
9035 (skip-chars-forward " \t"))) ; always returns non-nil
9036 ((looking-at c-line-comment-start-regexp)
9037 (end-of-line)
9038 nil)
9039 (t nil))))
9040 (eolp))
9041
9042 (goto-char pos)
9043 (progn (c-backward-syntactic-ws)
9044 (eq (point) pos))
9045
9046 ;; Check for one of the listed macros being before point.
9047 (or (not (eq (char-before) ?\)))
9048 (when (c-go-list-backward)
9049 (c-backward-syntactic-ws)
9050 t))
9051 (c-simple-skip-symbol-backward)
9052 (looking-at c-macro-with-semi-re)
9053 (goto-char pos)
9054 (not (c-in-literal)))))) ; The most expensive check last.
9055
9056 (defun c-macro-vsemi-status-unknown-p () t) ; See cc-defs.el.
9057
9058 \f
9059 ;; `c-guess-basic-syntax' and the functions that precedes it below
9060 ;; implements the main decision tree for determining the syntactic
9061 ;; analysis of the current line of code.
9062
9063 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
9064 ;; auto newline analysis.
9065 (defvar c-auto-newline-analysis nil)
9066
9067 (defun c-brace-anchor-point (bracepos)
9068 ;; BRACEPOS is the position of a brace in a construct like "namespace
9069 ;; Bar {". Return the anchor point in this construct; this is the
9070 ;; earliest symbol on the brace's line which isn't earlier than
9071 ;; "namespace".
9072 ;;
9073 ;; Currently (2007-08-17), "like namespace" means "matches
9074 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
9075 ;; or anything like that.
9076 (save-excursion
9077 (let ((boi (c-point 'boi bracepos)))
9078 (goto-char bracepos)
9079 (while (and (> (point) boi)
9080 (not (looking-at c-other-decl-block-key)))
9081 (c-backward-token-2))
9082 (if (> (point) boi) (point) boi))))
9083
9084 (defsubst c-add-syntax (symbol &rest args)
9085 ;; A simple function to prepend a new syntax element to
9086 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
9087 ;; should always be dynamically bound but since we read it first
9088 ;; we'll fail properly anyway if this function is misused.
9089 (setq c-syntactic-context (cons (cons symbol args)
9090 c-syntactic-context)))
9091
9092 (defsubst c-append-syntax (symbol &rest args)
9093 ;; Like `c-add-syntax' but appends to the end of the syntax list.
9094 ;; (Normally not necessary.)
9095 (setq c-syntactic-context (nconc c-syntactic-context
9096 (list (cons symbol args)))))
9097
9098 (defun c-add-stmt-syntax (syntax-symbol
9099 syntax-extra-args
9100 stop-at-boi-only
9101 containing-sexp
9102 paren-state)
9103 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
9104 ;; needed with further syntax elements of the types `substatement',
9105 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
9106 ;; `defun-block-intro'.
9107 ;;
9108 ;; Do the generic processing to anchor the given syntax symbol on
9109 ;; the preceding statement: Skip over any labels and containing
9110 ;; statements on the same line, and then search backward until we
9111 ;; find a statement or block start that begins at boi without a
9112 ;; label or comment.
9113 ;;
9114 ;; Point is assumed to be at the prospective anchor point for the
9115 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
9116 ;; skip past open parens and containing statements. Most of the added
9117 ;; syntax elements will get the same anchor point - the exception is
9118 ;; for an anchor in a construct like "namespace"[*] - this is as early
9119 ;; as possible in the construct but on the same line as the {.
9120 ;;
9121 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
9122 ;;
9123 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
9124 ;; syntax symbol. They are appended after the anchor point.
9125 ;;
9126 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
9127 ;; if the current statement starts there.
9128 ;;
9129 ;; Note: It's not a problem if PAREN-STATE "overshoots"
9130 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
9131 ;;
9132 ;; This function might do hidden buffer changes.
9133
9134 (if (= (point) (c-point 'boi))
9135 ;; This is by far the most common case, so let's give it special
9136 ;; treatment.
9137 (apply 'c-add-syntax syntax-symbol (point) syntax-extra-args)
9138
9139 (let ((syntax-last c-syntactic-context)
9140 (boi (c-point 'boi))
9141 ;; Set when we're on a label, so that we don't stop there.
9142 ;; FIXME: To be complete we should check if we're on a label
9143 ;; now at the start.
9144 on-label)
9145
9146 ;; Use point as the anchor point for "namespace", "extern", etc.
9147 (apply 'c-add-syntax syntax-symbol
9148 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist)
9149 (point) nil)
9150 syntax-extra-args)
9151
9152 ;; Loop while we have to back out of containing blocks.
9153 (while
9154 (and
9155 (catch 'back-up-block
9156
9157 ;; Loop while we have to back up statements.
9158 (while (or (/= (point) boi)
9159 on-label
9160 (looking-at c-comment-start-regexp))
9161
9162 ;; Skip past any comments that stands between the
9163 ;; statement start and boi.
9164 (let ((savepos (point)))
9165 (while (and (/= savepos boi)
9166 (c-backward-single-comment))
9167 (setq savepos (point)
9168 boi (c-point 'boi)))
9169 (goto-char savepos))
9170
9171 ;; Skip to the beginning of this statement or backward
9172 ;; another one.
9173 (let ((old-pos (point))
9174 (old-boi boi)
9175 (step-type (c-beginning-of-statement-1 containing-sexp)))
9176 (setq boi (c-point 'boi)
9177 on-label (eq step-type 'label))
9178
9179 (cond ((= (point) old-pos)
9180 ;; If we didn't move we're at the start of a block and
9181 ;; have to continue outside it.
9182 (throw 'back-up-block t))
9183
9184 ((and (eq step-type 'up)
9185 (>= (point) old-boi)
9186 (looking-at "else\\>[^_]")
9187 (save-excursion
9188 (goto-char old-pos)
9189 (looking-at "if\\>[^_]")))
9190 ;; Special case to avoid deeper and deeper indentation
9191 ;; of "else if" clauses.
9192 )
9193
9194 ((and (not stop-at-boi-only)
9195 (/= old-pos old-boi)
9196 (memq step-type '(up previous)))
9197 ;; If stop-at-boi-only is nil, we shouldn't back up
9198 ;; over previous or containing statements to try to
9199 ;; reach boi, so go back to the last position and
9200 ;; exit.
9201 (goto-char old-pos)
9202 (throw 'back-up-block nil))
9203
9204 (t
9205 (if (and (not stop-at-boi-only)
9206 (memq step-type '(up previous beginning)))
9207 ;; If we've moved into another statement then we
9208 ;; should no longer try to stop in the middle of a
9209 ;; line.
9210 (setq stop-at-boi-only t))
9211
9212 ;; Record this as a substatement if we skipped up one
9213 ;; level.
9214 (when (eq step-type 'up)
9215 (c-add-syntax 'substatement nil))))
9216 )))
9217
9218 containing-sexp)
9219
9220 ;; Now we have to go out of this block.
9221 (goto-char containing-sexp)
9222
9223 ;; Don't stop in the middle of a special brace list opener
9224 ;; like "({".
9225 (when c-special-brace-lists
9226 (let ((special-list (c-looking-at-special-brace-list)))
9227 (when (and special-list
9228 (< (car (car special-list)) (point)))
9229 (setq containing-sexp (car (car special-list)))
9230 (goto-char containing-sexp))))
9231
9232 (setq paren-state (c-whack-state-after containing-sexp paren-state)
9233 containing-sexp (c-most-enclosing-brace paren-state)
9234 boi (c-point 'boi))
9235
9236 ;; Analyze the construct in front of the block we've stepped out
9237 ;; from and add the right syntactic element for it.
9238 (let ((paren-pos (point))
9239 (paren-char (char-after))
9240 step-type)
9241
9242 (if (eq paren-char ?\()
9243 ;; Stepped out of a parenthesis block, so we're in an
9244 ;; expression now.
9245 (progn
9246 (when (/= paren-pos boi)
9247 (if (and c-recognize-paren-inexpr-blocks
9248 (progn
9249 (c-backward-syntactic-ws containing-sexp)
9250 (or (not (looking-at "\\>"))
9251 (not (c-on-identifier))))
9252 (save-excursion
9253 (goto-char (1+ paren-pos))
9254 (c-forward-syntactic-ws)
9255 (eq (char-after) ?{)))
9256 ;; Stepped out of an in-expression statement. This
9257 ;; syntactic element won't get an anchor pos.
9258 (c-add-syntax 'inexpr-statement)
9259
9260 ;; A parenthesis normally belongs to an arglist.
9261 (c-add-syntax 'arglist-cont-nonempty nil paren-pos)))
9262
9263 (goto-char (max boi
9264 (if containing-sexp
9265 (1+ containing-sexp)
9266 (point-min))))
9267 (setq step-type 'same
9268 on-label nil))
9269
9270 ;; Stepped out of a brace block.
9271 (setq step-type (c-beginning-of-statement-1 containing-sexp)
9272 on-label (eq step-type 'label))
9273
9274 (if (and (eq step-type 'same)
9275 (/= paren-pos (point)))
9276 (let (inexpr)
9277 (cond
9278 ((save-excursion
9279 (goto-char paren-pos)
9280 (setq inexpr (c-looking-at-inexpr-block
9281 (c-safe-position containing-sexp paren-state)
9282 containing-sexp)))
9283 (c-add-syntax (if (eq (car inexpr) 'inlambda)
9284 'defun-block-intro
9285 'statement-block-intro)
9286 nil))
9287 ((looking-at c-other-decl-block-key)
9288 (c-add-syntax
9289 (cdr (assoc (match-string 1)
9290 c-other-decl-block-key-in-symbols-alist))
9291 (max (c-point 'boi paren-pos) (point))))
9292 (t (c-add-syntax 'defun-block-intro nil))))
9293
9294 (c-add-syntax 'statement-block-intro nil)))
9295
9296 (if (= paren-pos boi)
9297 ;; Always done if the open brace was at boi. The
9298 ;; c-beginning-of-statement-1 call above is necessary
9299 ;; anyway, to decide the type of block-intro to add.
9300 (goto-char paren-pos)
9301 (setq boi (c-point 'boi)))
9302 ))
9303
9304 ;; Fill in the current point as the anchor for all the symbols
9305 ;; added above.
9306 (let ((p c-syntactic-context) q)
9307 (while (not (eq p syntax-last))
9308 (setq q (cdr (car p))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
9309 (while q
9310 (unless (car q)
9311 (setcar q (point)))
9312 (setq q (cdr q)))
9313 (setq p (cdr p))))
9314 )))
9315
9316 (defun c-add-class-syntax (symbol
9317 containing-decl-open
9318 containing-decl-start
9319 containing-decl-kwd
9320 paren-state)
9321 ;; The inclass and class-close syntactic symbols are added in
9322 ;; several places and some work is needed to fix everything.
9323 ;; Therefore it's collected here.
9324 ;;
9325 ;; This function might do hidden buffer changes.
9326 (goto-char containing-decl-open)
9327 (if (and (eq symbol 'inclass) (= (point) (c-point 'boi)))
9328 (progn
9329 (c-add-syntax symbol containing-decl-open)
9330 containing-decl-open)
9331 (goto-char containing-decl-start)
9332 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9333 ;; here, but we have to do like this for compatibility.
9334 (back-to-indentation)
9335 (c-add-syntax symbol (point))
9336 (if (and (c-keyword-member containing-decl-kwd
9337 'c-inexpr-class-kwds)
9338 (/= containing-decl-start (c-point 'boi containing-decl-start)))
9339 (c-add-syntax 'inexpr-class))
9340 (point)))
9341
9342 (defun c-guess-continued-construct (indent-point
9343 char-after-ip
9344 beg-of-same-or-containing-stmt
9345 containing-sexp
9346 paren-state)
9347 ;; This function contains the decision tree reached through both
9348 ;; cases 18 and 10. It's a continued statement or top level
9349 ;; construct of some kind.
9350 ;;
9351 ;; This function might do hidden buffer changes.
9352
9353 (let (special-brace-list placeholder)
9354 (goto-char indent-point)
9355 (skip-chars-forward " \t")
9356
9357 (cond
9358 ;; (CASE A removed.)
9359 ;; CASE B: open braces for class or brace-lists
9360 ((setq special-brace-list
9361 (or (and c-special-brace-lists
9362 (c-looking-at-special-brace-list))
9363 (eq char-after-ip ?{)))
9364
9365 (cond
9366 ;; CASE B.1: class-open
9367 ((save-excursion
9368 (and (eq (char-after) ?{)
9369 (c-looking-at-decl-block containing-sexp t)
9370 (setq beg-of-same-or-containing-stmt (point))))
9371 (c-add-syntax 'class-open beg-of-same-or-containing-stmt))
9372
9373 ;; CASE B.2: brace-list-open
9374 ((or (consp special-brace-list)
9375 (save-excursion
9376 (goto-char beg-of-same-or-containing-stmt)
9377 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
9378 indent-point t t t)))
9379 ;; The most semantically accurate symbol here is
9380 ;; brace-list-open, but we normally report it simply as a
9381 ;; statement-cont. The reason is that one normally adjusts
9382 ;; brace-list-open for brace lists as top-level constructs,
9383 ;; and brace lists inside statements is a completely different
9384 ;; context. C.f. case 5A.3.
9385 (c-beginning-of-statement-1 containing-sexp)
9386 (c-add-stmt-syntax (if c-auto-newline-analysis
9387 ;; Turn off the dwim above when we're
9388 ;; analyzing the nature of the brace
9389 ;; for the auto newline feature.
9390 'brace-list-open
9391 'statement-cont)
9392 nil nil
9393 containing-sexp paren-state))
9394
9395 ;; CASE B.3: The body of a function declared inside a normal
9396 ;; block. Can occur e.g. in Pike and when using gcc
9397 ;; extensions, but watch out for macros followed by blocks.
9398 ;; C.f. cases E, 16F and 17G.
9399 ((and (not (c-at-statement-start-p))
9400 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9401 'same)
9402 (save-excursion
9403 (let ((c-recognize-typeless-decls nil))
9404 ;; Turn off recognition of constructs that lacks a
9405 ;; type in this case, since that's more likely to be
9406 ;; a macro followed by a block.
9407 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9408 (c-add-stmt-syntax 'defun-open nil t
9409 containing-sexp paren-state))
9410
9411 ;; CASE B.4: Continued statement with block open. The most
9412 ;; accurate analysis is perhaps `statement-cont' together with
9413 ;; `block-open' but we play DWIM and use `substatement-open'
9414 ;; instead. The rationale is that this typically is a macro
9415 ;; followed by a block which makes it very similar to a
9416 ;; statement with a substatement block.
9417 (t
9418 (c-add-stmt-syntax 'substatement-open nil nil
9419 containing-sexp paren-state))
9420 ))
9421
9422 ;; CASE C: iostream insertion or extraction operator
9423 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
9424 (save-excursion
9425 (goto-char beg-of-same-or-containing-stmt)
9426 ;; If there is no preceding streamop in the statement
9427 ;; then indent this line as a normal statement-cont.
9428 (when (c-syntactic-re-search-forward
9429 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point 'move t t)
9430 (c-add-syntax 'stream-op (c-point 'boi))
9431 t))))
9432
9433 ;; CASE E: In the "K&R region" of a function declared inside a
9434 ;; normal block. C.f. case B.3.
9435 ((and (save-excursion
9436 ;; Check that the next token is a '{'. This works as
9437 ;; long as no language that allows nested function
9438 ;; definitions allows stuff like member init lists, K&R
9439 ;; declarations or throws clauses there.
9440 ;;
9441 ;; Note that we do a forward search for something ahead
9442 ;; of the indentation line here. That's not good since
9443 ;; the user might not have typed it yet. Unfortunately
9444 ;; it's exceedingly tricky to recognize a function
9445 ;; prototype in a code block without resorting to this.
9446 (c-forward-syntactic-ws)
9447 (eq (char-after) ?{))
9448 (not (c-at-statement-start-p))
9449 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9450 'same)
9451 (save-excursion
9452 (let ((c-recognize-typeless-decls nil))
9453 ;; Turn off recognition of constructs that lacks a
9454 ;; type in this case, since that's more likely to be
9455 ;; a macro followed by a block.
9456 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9457 (c-add-stmt-syntax 'func-decl-cont nil t
9458 containing-sexp paren-state))
9459
9460 ;;CASE F: continued statement and the only preceding items are
9461 ;;annotations.
9462 ((and (c-major-mode-is 'java-mode)
9463 (setq placeholder (point))
9464 (c-beginning-of-statement-1)
9465 (progn
9466 (while (and (c-forward-annotation)
9467 (< (point) placeholder))
9468 (c-forward-syntactic-ws))
9469 t)
9470 (prog1
9471 (>= (point) placeholder)
9472 (goto-char placeholder)))
9473 (c-beginning-of-statement-1 containing-sexp)
9474 (c-add-syntax 'annotation-var-cont (point)))
9475
9476 ;; CASE G: a template list continuation?
9477 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9478 ((and (c-major-mode-is 'c++-mode)
9479 (save-excursion
9480 (goto-char indent-point)
9481 (c-with-syntax-table c++-template-syntax-table
9482 (setq placeholder (c-up-list-backward)))
9483 (and placeholder
9484 (eq (char-after placeholder) ?<)
9485 (/= (char-before placeholder) ?<)
9486 (progn
9487 (goto-char (1+ placeholder))
9488 (not (looking-at c-<-op-cont-regexp))))))
9489 (c-with-syntax-table c++-template-syntax-table
9490 (goto-char placeholder)
9491 (c-beginning-of-statement-1 containing-sexp t))
9492 (if (save-excursion
9493 (c-backward-syntactic-ws containing-sexp)
9494 (eq (char-before) ?<))
9495 ;; In a nested template arglist.
9496 (progn
9497 (goto-char placeholder)
9498 (c-syntactic-skip-backward "^,;" containing-sexp t)
9499 (c-forward-syntactic-ws))
9500 (back-to-indentation))
9501 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9502 ;; template aware.
9503 (c-add-syntax 'template-args-cont (point) placeholder))
9504
9505 ;; CASE D: continued statement.
9506 (t
9507 (c-beginning-of-statement-1 containing-sexp)
9508 (c-add-stmt-syntax 'statement-cont nil nil
9509 containing-sexp paren-state))
9510 )))
9511
9512 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9513 ;; 2005/11/29).
9514 ;;;###autoload
9515 (defun c-guess-basic-syntax ()
9516 "Return the syntactic context of the current line."
9517 (save-excursion
9518 (beginning-of-line)
9519 (c-save-buffer-state
9520 ((indent-point (point))
9521 (case-fold-search nil)
9522 open-paren-in-column-0-is-defun-start
9523 ;; A whole ugly bunch of various temporary variables. Have
9524 ;; to declare them here since it's not possible to declare
9525 ;; a variable with only the scope of a cond test and the
9526 ;; following result clauses, and most of this function is a
9527 ;; single gigantic cond. :P
9528 literal char-before-ip before-ws-ip char-after-ip macro-start
9529 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9530 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9531 containing-<
9532 ;; The following record some positions for the containing
9533 ;; declaration block if we're directly within one:
9534 ;; `containing-decl-open' is the position of the open
9535 ;; brace. `containing-decl-start' is the start of the
9536 ;; declaration. `containing-decl-kwd' is the keyword
9537 ;; symbol of the keyword that tells what kind of block it
9538 ;; is.
9539 containing-decl-open
9540 containing-decl-start
9541 containing-decl-kwd
9542 ;; The open paren of the closest surrounding sexp or nil if
9543 ;; there is none.
9544 containing-sexp
9545 ;; The position after the closest preceding brace sexp
9546 ;; (nested sexps are ignored), or the position after
9547 ;; `containing-sexp' if there is none, or (point-min) if
9548 ;; `containing-sexp' is nil.
9549 lim
9550 ;; The paren state outside `containing-sexp', or at
9551 ;; `indent-point' if `containing-sexp' is nil.
9552 (paren-state (c-parse-state))
9553 ;; There's always at most one syntactic element which got
9554 ;; an anchor pos. It's stored in syntactic-relpos.
9555 syntactic-relpos
9556 (c-stmt-delim-chars c-stmt-delim-chars))
9557
9558 ;; Check if we're directly inside an enclosing declaration
9559 ;; level block.
9560 (when (and (setq containing-sexp
9561 (c-most-enclosing-brace paren-state))
9562 (progn
9563 (goto-char containing-sexp)
9564 (eq (char-after) ?{))
9565 (setq placeholder
9566 (c-looking-at-decl-block
9567 (c-most-enclosing-brace paren-state
9568 containing-sexp)
9569 t)))
9570 (setq containing-decl-open containing-sexp
9571 containing-decl-start (point)
9572 containing-sexp nil)
9573 (goto-char placeholder)
9574 (setq containing-decl-kwd (and (looking-at c-keywords-regexp)
9575 (c-keyword-sym (match-string 1)))))
9576
9577 ;; Init some position variables.
9578 (if c-state-cache
9579 (progn
9580 (setq containing-sexp (car paren-state)
9581 paren-state (cdr paren-state))
9582 (if (consp containing-sexp)
9583 (progn
9584 (setq lim (cdr containing-sexp))
9585 (if (cdr c-state-cache)
9586 ;; Ignore balanced paren. The next entry
9587 ;; can't be another one.
9588 (setq containing-sexp (car (cdr c-state-cache))
9589 paren-state (cdr paren-state))
9590 ;; If there is no surrounding open paren then
9591 ;; put the last balanced pair back on paren-state.
9592 (setq paren-state (cons containing-sexp paren-state)
9593 containing-sexp nil)))
9594 (setq lim (1+ containing-sexp))))
9595 (setq lim (point-min)))
9596
9597 ;; If we're in a parenthesis list then ',' delimits the
9598 ;; "statements" rather than being an operator (with the
9599 ;; exception of the "for" clause). This difference is
9600 ;; typically only noticeable when statements are used in macro
9601 ;; arglists.
9602 (when (and containing-sexp
9603 (eq (char-after containing-sexp) ?\())
9604 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma))
9605 ;; cache char before and after indent point, and move point to
9606 ;; the most likely position to perform the majority of tests
9607 (goto-char indent-point)
9608 (c-backward-syntactic-ws lim)
9609 (setq before-ws-ip (point)
9610 char-before-ip (char-before))
9611 (goto-char indent-point)
9612 (skip-chars-forward " \t")
9613 (setq char-after-ip (char-after))
9614
9615 ;; are we in a literal?
9616 (setq literal (c-in-literal lim))
9617
9618 ;; now figure out syntactic qualities of the current line
9619 (cond
9620
9621 ;; CASE 1: in a string.
9622 ((eq literal 'string)
9623 (c-add-syntax 'string (c-point 'bopl)))
9624
9625 ;; CASE 2: in a C or C++ style comment.
9626 ((and (memq literal '(c c++))
9627 ;; This is a kludge for XEmacs where we use
9628 ;; `buffer-syntactic-context', which doesn't correctly
9629 ;; recognize "\*/" to end a block comment.
9630 ;; `parse-partial-sexp' which is used by
9631 ;; `c-literal-limits' will however do that in most
9632 ;; versions, which results in that we get nil from
9633 ;; `c-literal-limits' even when `c-in-literal' claims
9634 ;; we're inside a comment.
9635 (setq placeholder (c-literal-limits lim)))
9636 (c-add-syntax literal (car placeholder)))
9637
9638 ;; CASE 3: in a cpp preprocessor macro continuation.
9639 ((and (save-excursion
9640 (when (c-beginning-of-macro)
9641 (setq macro-start (point))))
9642 (/= macro-start (c-point 'boi))
9643 (progn
9644 (setq tmpsymbol 'cpp-macro-cont)
9645 (or (not c-syntactic-indentation-in-macros)
9646 (save-excursion
9647 (goto-char macro-start)
9648 ;; If at the beginning of the body of a #define
9649 ;; directive then analyze as cpp-define-intro
9650 ;; only. Go on with the syntactic analysis
9651 ;; otherwise. in-macro-expr is set if we're in a
9652 ;; cpp expression, i.e. before the #define body
9653 ;; or anywhere in a non-#define directive.
9654 (if (c-forward-to-cpp-define-body)
9655 (let ((indent-boi (c-point 'boi indent-point)))
9656 (setq in-macro-expr (> (point) indent-boi)
9657 tmpsymbol 'cpp-define-intro)
9658 (= (point) indent-boi))
9659 (setq in-macro-expr t)
9660 nil)))))
9661 (c-add-syntax tmpsymbol macro-start)
9662 (setq macro-start nil))
9663
9664 ;; CASE 11: an else clause?
9665 ((looking-at "else\\>[^_]")
9666 (c-beginning-of-statement-1 containing-sexp)
9667 (c-add-stmt-syntax 'else-clause nil t
9668 containing-sexp paren-state))
9669
9670 ;; CASE 12: while closure of a do/while construct?
9671 ((and (looking-at "while\\>[^_]")
9672 (save-excursion
9673 (prog1 (eq (c-beginning-of-statement-1 containing-sexp)
9674 'beginning)
9675 (setq placeholder (point)))))
9676 (goto-char placeholder)
9677 (c-add-stmt-syntax 'do-while-closure nil t
9678 containing-sexp paren-state))
9679
9680 ;; CASE 13: A catch or finally clause? This case is simpler
9681 ;; than if-else and do-while, because a block is required
9682 ;; after every try, catch and finally.
9683 ((save-excursion
9684 (and (cond ((c-major-mode-is 'c++-mode)
9685 (looking-at "catch\\>[^_]"))
9686 ((c-major-mode-is 'java-mode)
9687 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
9688 (and (c-safe (c-backward-syntactic-ws)
9689 (c-backward-sexp)
9690 t)
9691 (eq (char-after) ?{)
9692 (c-safe (c-backward-syntactic-ws)
9693 (c-backward-sexp)
9694 t)
9695 (if (eq (char-after) ?\()
9696 (c-safe (c-backward-sexp) t)
9697 t))
9698 (looking-at "\\(try\\|catch\\)\\>[^_]")
9699 (setq placeholder (point))))
9700 (goto-char placeholder)
9701 (c-add-stmt-syntax 'catch-clause nil t
9702 containing-sexp paren-state))
9703
9704 ;; CASE 18: A substatement we can recognize by keyword.
9705 ((save-excursion
9706 (and c-opt-block-stmt-key
9707 (not (eq char-before-ip ?\;))
9708 (not (c-at-vsemi-p before-ws-ip))
9709 (not (memq char-after-ip '(?\) ?\] ?,)))
9710 (or (not (eq char-before-ip ?}))
9711 (c-looking-at-inexpr-block-backward c-state-cache))
9712 (> (point)
9713 (progn
9714 ;; Ought to cache the result from the
9715 ;; c-beginning-of-statement-1 calls here.
9716 (setq placeholder (point))
9717 (while (eq (setq step-type
9718 (c-beginning-of-statement-1 lim))
9719 'label))
9720 (if (eq step-type 'previous)
9721 (goto-char placeholder)
9722 (setq placeholder (point))
9723 (if (and (eq step-type 'same)
9724 (not (looking-at c-opt-block-stmt-key)))
9725 ;; Step up to the containing statement if we
9726 ;; stayed in the same one.
9727 (let (step)
9728 (while (eq
9729 (setq step
9730 (c-beginning-of-statement-1 lim))
9731 'label))
9732 (if (eq step 'up)
9733 (setq placeholder (point))
9734 ;; There was no containing statement after all.
9735 (goto-char placeholder)))))
9736 placeholder))
9737 (if (looking-at c-block-stmt-2-key)
9738 ;; Require a parenthesis after these keywords.
9739 ;; Necessary to catch e.g. synchronized in Java,
9740 ;; which can be used both as statement and
9741 ;; modifier.
9742 (and (zerop (c-forward-token-2 1 nil))
9743 (eq (char-after) ?\())
9744 (looking-at c-opt-block-stmt-key))))
9745
9746 (if (eq step-type 'up)
9747 ;; CASE 18A: Simple substatement.
9748 (progn
9749 (goto-char placeholder)
9750 (cond
9751 ((eq char-after-ip ?{)
9752 (c-add-stmt-syntax 'substatement-open nil nil
9753 containing-sexp paren-state))
9754 ((save-excursion
9755 (goto-char indent-point)
9756 (back-to-indentation)
9757 (c-forward-label))
9758 (c-add-stmt-syntax 'substatement-label nil nil
9759 containing-sexp paren-state))
9760 (t
9761 (c-add-stmt-syntax 'substatement nil nil
9762 containing-sexp paren-state))))
9763
9764 ;; CASE 18B: Some other substatement. This is shared
9765 ;; with case 10.
9766 (c-guess-continued-construct indent-point
9767 char-after-ip
9768 placeholder
9769 lim
9770 paren-state)))
9771
9772 ;; CASE 14: A case or default label
9773 ((looking-at c-label-kwds-regexp)
9774 (if containing-sexp
9775 (progn
9776 (goto-char containing-sexp)
9777 (setq lim (c-most-enclosing-brace c-state-cache
9778 containing-sexp))
9779 (c-backward-to-block-anchor lim)
9780 (c-add-stmt-syntax 'case-label nil t lim paren-state))
9781 ;; Got a bogus label at the top level. In lack of better
9782 ;; alternatives, anchor it on (point-min).
9783 (c-add-syntax 'case-label (point-min))))
9784
9785 ;; CASE 15: any other label
9786 ((save-excursion
9787 (back-to-indentation)
9788 (and (not (looking-at c-syntactic-ws-start))
9789 (c-forward-label)))
9790 (cond (containing-decl-open
9791 (setq placeholder (c-add-class-syntax 'inclass
9792 containing-decl-open
9793 containing-decl-start
9794 containing-decl-kwd
9795 paren-state))
9796 ;; Append access-label with the same anchor point as
9797 ;; inclass gets.
9798 (c-append-syntax 'access-label placeholder))
9799
9800 (containing-sexp
9801 (goto-char containing-sexp)
9802 (setq lim (c-most-enclosing-brace c-state-cache
9803 containing-sexp))
9804 (save-excursion
9805 (setq tmpsymbol
9806 (if (and (eq (c-beginning-of-statement-1 lim) 'up)
9807 (looking-at "switch\\>[^_]"))
9808 ;; If the surrounding statement is a switch then
9809 ;; let's analyze all labels as switch labels, so
9810 ;; that they get lined up consistently.
9811 'case-label
9812 'label)))
9813 (c-backward-to-block-anchor lim)
9814 (c-add-stmt-syntax tmpsymbol nil t lim paren-state))
9815
9816 (t
9817 ;; A label on the top level. Treat it as a class
9818 ;; context. (point-min) is the closest we get to the
9819 ;; class open brace.
9820 (c-add-syntax 'access-label (point-min)))))
9821
9822 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
9823 ;; 17E.
9824 ((setq placeholder (c-looking-at-inexpr-block
9825 (c-safe-position containing-sexp paren-state)
9826 containing-sexp
9827 ;; Have to turn on the heuristics after
9828 ;; the point even though it doesn't work
9829 ;; very well. C.f. test case class-16.pike.
9830 t))
9831 (setq tmpsymbol (assq (car placeholder)
9832 '((inexpr-class . class-open)
9833 (inexpr-statement . block-open))))
9834 (if tmpsymbol
9835 ;; It's a statement block or an anonymous class.
9836 (setq tmpsymbol (cdr tmpsymbol))
9837 ;; It's a Pike lambda. Check whether we are between the
9838 ;; lambda keyword and the argument list or at the defun
9839 ;; opener.
9840 (setq tmpsymbol (if (eq char-after-ip ?{)
9841 'inline-open
9842 'lambda-intro-cont)))
9843 (goto-char (cdr placeholder))
9844 (back-to-indentation)
9845 (c-add-stmt-syntax tmpsymbol nil t
9846 (c-most-enclosing-brace c-state-cache (point))
9847 paren-state)
9848 (unless (eq (point) (cdr placeholder))
9849 (c-add-syntax (car placeholder))))
9850
9851 ;; CASE 5: Line is inside a declaration level block or at top level.
9852 ((or containing-decl-open (null containing-sexp))
9853 (cond
9854
9855 ;; CASE 5A: we are looking at a defun, brace list, class,
9856 ;; or inline-inclass method opening brace
9857 ((setq special-brace-list
9858 (or (and c-special-brace-lists
9859 (c-looking-at-special-brace-list))
9860 (eq char-after-ip ?{)))
9861 (cond
9862
9863 ;; CASE 5A.1: Non-class declaration block open.
9864 ((save-excursion
9865 (let (tmp)
9866 (and (eq char-after-ip ?{)
9867 (setq tmp (c-looking-at-decl-block containing-sexp t))
9868 (progn
9869 (setq placeholder (point))
9870 (goto-char tmp)
9871 (looking-at c-symbol-key))
9872 (c-keyword-member
9873 (c-keyword-sym (setq keyword (match-string 0)))
9874 'c-other-block-decl-kwds))))
9875 (goto-char placeholder)
9876 (c-add-stmt-syntax
9877 (if (string-equal keyword "extern")
9878 ;; Special case for extern-lang-open.
9879 'extern-lang-open
9880 (intern (concat keyword "-open")))
9881 nil t containing-sexp paren-state))
9882
9883 ;; CASE 5A.2: we are looking at a class opening brace
9884 ((save-excursion
9885 (goto-char indent-point)
9886 (skip-chars-forward " \t")
9887 (and (eq (char-after) ?{)
9888 (c-looking-at-decl-block containing-sexp t)
9889 (setq placeholder (point))))
9890 (c-add-syntax 'class-open placeholder))
9891
9892 ;; CASE 5A.3: brace list open
9893 ((save-excursion
9894 (c-beginning-of-decl-1 lim)
9895 (while (looking-at c-specifier-key)
9896 (goto-char (match-end 1))
9897 (c-forward-syntactic-ws indent-point))
9898 (setq placeholder (c-point 'boi))
9899 (or (consp special-brace-list)
9900 (and (or (save-excursion
9901 (goto-char indent-point)
9902 (setq tmpsymbol nil)
9903 (while (and (> (point) placeholder)
9904 (zerop (c-backward-token-2 1 t))
9905 (not (looking-at "=\\([^=]\\|$\\)")))
9906 (and c-opt-inexpr-brace-list-key
9907 (not tmpsymbol)
9908 (looking-at c-opt-inexpr-brace-list-key)
9909 (setq tmpsymbol 'topmost-intro-cont)))
9910 (looking-at "=\\([^=]\\|$\\)"))
9911 (looking-at c-brace-list-key))
9912 (save-excursion
9913 (while (and (< (point) indent-point)
9914 (zerop (c-forward-token-2 1 t))
9915 (not (memq (char-after) '(?\; ?\()))))
9916 (not (memq (char-after) '(?\; ?\()))
9917 ))))
9918 (if (and (not c-auto-newline-analysis)
9919 (c-major-mode-is 'java-mode)
9920 (eq tmpsymbol 'topmost-intro-cont))
9921 ;; We're in Java and have found that the open brace
9922 ;; belongs to a "new Foo[]" initialization list,
9923 ;; which means the brace list is part of an
9924 ;; expression and not a top level definition. We
9925 ;; therefore treat it as any topmost continuation
9926 ;; even though the semantically correct symbol still
9927 ;; is brace-list-open, on the same grounds as in
9928 ;; case B.2.
9929 (progn
9930 (c-beginning-of-statement-1 lim)
9931 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
9932 (c-add-syntax 'brace-list-open placeholder)))
9933
9934 ;; CASE 5A.4: inline defun open
9935 ((and containing-decl-open
9936 (not (c-keyword-member containing-decl-kwd
9937 'c-other-block-decl-kwds)))
9938 (c-add-syntax 'inline-open)
9939 (c-add-class-syntax 'inclass
9940 containing-decl-open
9941 containing-decl-start
9942 containing-decl-kwd
9943 paren-state))
9944
9945 ;; CASE 5A.5: ordinary defun open
9946 (t
9947 (save-excursion
9948 (c-beginning-of-decl-1 lim)
9949 (while (looking-at c-specifier-key)
9950 (goto-char (match-end 1))
9951 (c-forward-syntactic-ws indent-point))
9952 (c-add-syntax 'defun-open (c-point 'boi))
9953 ;; Bogus to use bol here, but it's the legacy. (Resolved,
9954 ;; 2007-11-09)
9955 ))))
9956
9957 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
9958 ;; Note there is no limit on the backward search here, since member
9959 ;; init lists can, in practice, be very large.
9960 ((save-excursion
9961 (when (setq placeholder (c-back-over-member-initializers))
9962 (setq tmp-pos (point))))
9963 (if (= (c-point 'bosws) (1+ tmp-pos))
9964 (progn
9965 ;; There is no preceding member init clause.
9966 ;; Indent relative to the beginning of indentation
9967 ;; for the topmost-intro line that contains the
9968 ;; prototype's open paren.
9969 (goto-char placeholder)
9970 (c-add-syntax 'member-init-intro (c-point 'boi)))
9971 ;; Indent relative to the first member init clause.
9972 (goto-char (1+ tmp-pos))
9973 (c-forward-syntactic-ws)
9974 (c-add-syntax 'member-init-cont (point))))
9975
9976 ;; CASE 5B: After a function header but before the body (or
9977 ;; the ending semicolon if there's no body).
9978 ((save-excursion
9979 (when (setq placeholder (c-just-after-func-arglist-p
9980 (max lim (c-determine-limit 500))))
9981 (setq tmp-pos (point))))
9982 (cond
9983
9984 ;; CASE 5B.1: Member init list.
9985 ((eq (char-after tmp-pos) ?:)
9986 ;; There is no preceding member init clause.
9987 ;; Indent relative to the beginning of indentation
9988 ;; for the topmost-intro line that contains the
9989 ;; prototype's open paren.
9990 (goto-char placeholder)
9991 (c-add-syntax 'member-init-intro (c-point 'boi)))
9992
9993 ;; CASE 5B.2: K&R arg decl intro
9994 ((and c-recognize-knr-p
9995 (c-in-knr-argdecl lim))
9996 (c-beginning-of-statement-1 lim)
9997 (c-add-syntax 'knr-argdecl-intro (c-point 'boi))
9998 (if containing-decl-open
9999 (c-add-class-syntax 'inclass
10000 containing-decl-open
10001 containing-decl-start
10002 containing-decl-kwd
10003 paren-state)))
10004
10005 ;; CASE 5B.4: Nether region after a C++ or Java func
10006 ;; decl, which could include a `throws' declaration.
10007 (t
10008 (c-beginning-of-statement-1 lim)
10009 (c-add-syntax 'func-decl-cont (c-point 'boi))
10010 )))
10011
10012 ;; CASE 5C: inheritance line. could be first inheritance
10013 ;; line, or continuation of a multiple inheritance
10014 ((or (and (c-major-mode-is 'c++-mode)
10015 (progn
10016 (when (eq char-after-ip ?,)
10017 (skip-chars-forward " \t")
10018 (forward-char))
10019 (looking-at c-opt-postfix-decl-spec-key)))
10020 (and (or (eq char-before-ip ?:)
10021 ;; watch out for scope operator
10022 (save-excursion
10023 (and (eq char-after-ip ?:)
10024 (c-safe (forward-char 1) t)
10025 (not (eq (char-after) ?:))
10026 )))
10027 (save-excursion
10028 (c-beginning-of-statement-1 lim)
10029 (when (looking-at c-opt-<>-sexp-key)
10030 (goto-char (match-end 1))
10031 (c-forward-syntactic-ws)
10032 (c-forward-<>-arglist nil)
10033 (c-forward-syntactic-ws))
10034 (looking-at c-class-key)))
10035 ;; for Java
10036 (and (c-major-mode-is 'java-mode)
10037 (let ((fence (save-excursion
10038 (c-beginning-of-statement-1 lim)
10039 (point)))
10040 cont done)
10041 (save-excursion
10042 (while (not done)
10043 (cond ((looking-at c-opt-postfix-decl-spec-key)
10044 (setq injava-inher (cons cont (point))
10045 done t))
10046 ((or (not (c-safe (c-forward-sexp -1) t))
10047 (<= (point) fence))
10048 (setq done t))
10049 )
10050 (setq cont t)))
10051 injava-inher)
10052 (not (c-crosses-statement-barrier-p (cdr injava-inher)
10053 (point)))
10054 ))
10055 (cond
10056
10057 ;; CASE 5C.1: non-hanging colon on an inher intro
10058 ((eq char-after-ip ?:)
10059 (c-beginning-of-statement-1 lim)
10060 (c-add-syntax 'inher-intro (c-point 'boi))
10061 ;; don't add inclass symbol since relative point already
10062 ;; contains any class offset
10063 )
10064
10065 ;; CASE 5C.2: hanging colon on an inher intro
10066 ((eq char-before-ip ?:)
10067 (c-beginning-of-statement-1 lim)
10068 (c-add-syntax 'inher-intro (c-point 'boi))
10069 (if containing-decl-open
10070 (c-add-class-syntax 'inclass
10071 containing-decl-open
10072 containing-decl-start
10073 containing-decl-kwd
10074 paren-state)))
10075
10076 ;; CASE 5C.3: in a Java implements/extends
10077 (injava-inher
10078 (let ((where (cdr injava-inher))
10079 (cont (car injava-inher)))
10080 (goto-char where)
10081 (cond ((looking-at "throws\\>[^_]")
10082 (c-add-syntax 'func-decl-cont
10083 (progn (c-beginning-of-statement-1 lim)
10084 (c-point 'boi))))
10085 (cont (c-add-syntax 'inher-cont where))
10086 (t (c-add-syntax 'inher-intro
10087 (progn (goto-char (cdr injava-inher))
10088 (c-beginning-of-statement-1 lim)
10089 (point))))
10090 )))
10091
10092 ;; CASE 5C.4: a continued inheritance line
10093 (t
10094 (c-beginning-of-inheritance-list lim)
10095 (c-add-syntax 'inher-cont (point))
10096 ;; don't add inclass symbol since relative point already
10097 ;; contains any class offset
10098 )))
10099
10100 ;; CASE 5P: AWK pattern or function or continuation
10101 ;; thereof.
10102 ((c-major-mode-is 'awk-mode)
10103 (setq placeholder (point))
10104 (c-add-stmt-syntax
10105 (if (and (eq (c-beginning-of-statement-1) 'same)
10106 (/= (point) placeholder))
10107 'topmost-intro-cont
10108 'topmost-intro)
10109 nil nil
10110 containing-sexp paren-state))
10111
10112 ;; CASE 5D: this could be a top-level initialization, a
10113 ;; member init list continuation, or a template argument
10114 ;; list continuation.
10115 ((save-excursion
10116 ;; Note: We use the fact that lim is always after any
10117 ;; preceding brace sexp.
10118 (if c-recognize-<>-arglists
10119 (while (and
10120 (progn
10121 (c-syntactic-skip-backward "^;,=<>" lim t)
10122 (> (point) lim))
10123 (or
10124 (when c-overloadable-operators-regexp
10125 (when (setq placeholder (c-after-special-operator-id lim))
10126 (goto-char placeholder)
10127 t))
10128 (cond
10129 ((eq (char-before) ?>)
10130 (or (c-backward-<>-arglist nil lim)
10131 (backward-char))
10132 t)
10133 ((eq (char-before) ?<)
10134 (backward-char)
10135 (if (save-excursion
10136 (c-forward-<>-arglist nil))
10137 (progn (forward-char)
10138 nil)
10139 t))
10140 (t nil)))))
10141 ;; NB: No c-after-special-operator-id stuff in this
10142 ;; clause - we assume only C++ needs it.
10143 (c-syntactic-skip-backward "^;,=" lim t))
10144 (memq (char-before) '(?, ?= ?<)))
10145 (cond
10146
10147 ;; CASE 5D.3: perhaps a template list continuation?
10148 ((and (c-major-mode-is 'c++-mode)
10149 (save-excursion
10150 (save-restriction
10151 (c-with-syntax-table c++-template-syntax-table
10152 (goto-char indent-point)
10153 (setq placeholder (c-up-list-backward))
10154 (and placeholder
10155 (eq (char-after placeholder) ?<))))))
10156 (c-with-syntax-table c++-template-syntax-table
10157 (goto-char placeholder)
10158 (c-beginning-of-statement-1 lim t))
10159 (if (save-excursion
10160 (c-backward-syntactic-ws lim)
10161 (eq (char-before) ?<))
10162 ;; In a nested template arglist.
10163 (progn
10164 (goto-char placeholder)
10165 (c-syntactic-skip-backward "^,;" lim t)
10166 (c-forward-syntactic-ws))
10167 (back-to-indentation))
10168 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
10169 ;; template aware.
10170 (c-add-syntax 'template-args-cont (point) placeholder))
10171
10172 ;; CASE 5D.4: perhaps a multiple inheritance line?
10173 ((and (c-major-mode-is 'c++-mode)
10174 (save-excursion
10175 (c-beginning-of-statement-1 lim)
10176 (setq placeholder (point))
10177 (if (looking-at "static\\>[^_]")
10178 (c-forward-token-2 1 nil indent-point))
10179 (and (looking-at c-class-key)
10180 (zerop (c-forward-token-2 2 nil indent-point))
10181 (if (eq (char-after) ?<)
10182 (c-with-syntax-table c++-template-syntax-table
10183 (zerop (c-forward-token-2 1 t indent-point)))
10184 t)
10185 (eq (char-after) ?:))))
10186 (goto-char placeholder)
10187 (c-add-syntax 'inher-cont (c-point 'boi)))
10188
10189 ;; CASE 5D.5: Continuation of the "expression part" of a
10190 ;; top level construct. Or, perhaps, an unrecognized construct.
10191 (t
10192 (while (and (setq placeholder (point))
10193 (eq (car (c-beginning-of-decl-1 containing-sexp)) ; Can't use `lim' here.
10194 'same)
10195 (save-excursion
10196 (c-backward-syntactic-ws)
10197 (eq (char-before) ?}))
10198 (< (point) placeholder)))
10199 (c-add-stmt-syntax
10200 (cond
10201 ((eq (point) placeholder) 'statement) ; unrecognized construct
10202 ;; A preceding comma at the top level means that a
10203 ;; new variable declaration starts here. Use
10204 ;; topmost-intro-cont for it, for consistency with
10205 ;; the first variable declaration. C.f. case 5N.
10206 ((eq char-before-ip ?,) 'topmost-intro-cont)
10207 (t 'statement-cont))
10208 nil nil containing-sexp paren-state))
10209 ))
10210
10211 ;; CASE 5F: Close of a non-class declaration level block.
10212 ((and (eq char-after-ip ?})
10213 (c-keyword-member containing-decl-kwd
10214 'c-other-block-decl-kwds))
10215 ;; This is inconsistent: Should use `containing-decl-open'
10216 ;; here if it's at boi, like in case 5J.
10217 (goto-char containing-decl-start)
10218 (c-add-stmt-syntax
10219 (if (string-equal (symbol-name containing-decl-kwd) "extern")
10220 ;; Special case for compatibility with the
10221 ;; extern-lang syntactic symbols.
10222 'extern-lang-close
10223 (intern (concat (symbol-name containing-decl-kwd)
10224 "-close")))
10225 nil t
10226 (c-most-enclosing-brace paren-state (point))
10227 paren-state))
10228
10229 ;; CASE 5G: we are looking at the brace which closes the
10230 ;; enclosing nested class decl
10231 ((and containing-sexp
10232 (eq char-after-ip ?})
10233 (eq containing-decl-open containing-sexp))
10234 (c-add-class-syntax 'class-close
10235 containing-decl-open
10236 containing-decl-start
10237 containing-decl-kwd
10238 paren-state))
10239
10240 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10241 ((and c-recognize-knr-p
10242 (not containing-sexp) ; can't be knr inside braces.
10243 (not (eq char-before-ip ?}))
10244 (save-excursion
10245 (setq placeholder (cdr (c-beginning-of-decl-1 lim)))
10246 (and placeholder
10247 ;; Do an extra check to avoid tripping up on
10248 ;; statements that occur in invalid contexts
10249 ;; (e.g. in macro bodies where we don't really
10250 ;; know the context of what we're looking at).
10251 (not (and c-opt-block-stmt-key
10252 (looking-at c-opt-block-stmt-key)))))
10253 (< placeholder indent-point))
10254 (goto-char placeholder)
10255 (c-add-syntax 'knr-argdecl (point)))
10256
10257 ;; CASE 5I: ObjC method definition.
10258 ((and c-opt-method-key
10259 (looking-at c-opt-method-key))
10260 (c-beginning-of-statement-1 nil t)
10261 (if (= (point) indent-point)
10262 ;; Handle the case when it's the first (non-comment)
10263 ;; thing in the buffer. Can't look for a 'same return
10264 ;; value from cbos1 since ObjC directives currently
10265 ;; aren't recognized fully, so that we get 'same
10266 ;; instead of 'previous if it moved over a preceding
10267 ;; directive.
10268 (goto-char (point-min)))
10269 (c-add-syntax 'objc-method-intro (c-point 'boi)))
10270
10271 ;; CASE 5N: At a variable declaration that follows a class
10272 ;; definition or some other block declaration that doesn't
10273 ;; end at the closing '}'. C.f. case 5D.5.
10274 ((progn
10275 (c-backward-syntactic-ws lim)
10276 (and (eq (char-before) ?})
10277 (save-excursion
10278 (let ((start (point)))
10279 (if (and c-state-cache
10280 (consp (car c-state-cache))
10281 (eq (cdar c-state-cache) (point)))
10282 ;; Speed up the backward search a bit.
10283 (goto-char (caar c-state-cache)))
10284 (c-beginning-of-decl-1 containing-sexp) ; Can't use `lim' here.
10285 (setq placeholder (point))
10286 (if (= start (point))
10287 ;; The '}' is unbalanced.
10288 nil
10289 (c-end-of-decl-1)
10290 (>= (point) indent-point))))))
10291 (goto-char placeholder)
10292 (c-add-stmt-syntax 'topmost-intro-cont nil nil
10293 containing-sexp paren-state))
10294
10295 ;; NOTE: The point is at the end of the previous token here.
10296
10297 ;; CASE 5J: we are at the topmost level, make
10298 ;; sure we skip back past any access specifiers
10299 ((and
10300 ;; A macro continuation line is never at top level.
10301 (not (and macro-start
10302 (> indent-point macro-start)))
10303 (save-excursion
10304 (setq placeholder (point))
10305 (or (memq char-before-ip '(?\; ?{ ?} nil))
10306 (c-at-vsemi-p before-ws-ip)
10307 (when (and (eq char-before-ip ?:)
10308 (eq (c-beginning-of-statement-1 lim)
10309 'label))
10310 (c-backward-syntactic-ws lim)
10311 (setq placeholder (point)))
10312 (and (c-major-mode-is 'objc-mode)
10313 (catch 'not-in-directive
10314 (c-beginning-of-statement-1 lim)
10315 (setq placeholder (point))
10316 (while (and (c-forward-objc-directive)
10317 (< (point) indent-point))
10318 (c-forward-syntactic-ws)
10319 (if (>= (point) indent-point)
10320 (throw 'not-in-directive t))
10321 (setq placeholder (point)))
10322 nil)))))
10323 ;; For historic reasons we anchor at bol of the last
10324 ;; line of the previous declaration. That's clearly
10325 ;; highly bogus and useless, and it makes our lives hard
10326 ;; to remain compatible. :P
10327 (goto-char placeholder)
10328 (c-add-syntax 'topmost-intro (c-point 'bol))
10329 (if containing-decl-open
10330 (if (c-keyword-member containing-decl-kwd
10331 'c-other-block-decl-kwds)
10332 (progn
10333 (goto-char (c-brace-anchor-point containing-decl-open))
10334 (c-add-stmt-syntax
10335 (if (string-equal (symbol-name containing-decl-kwd)
10336 "extern")
10337 ;; Special case for compatibility with the
10338 ;; extern-lang syntactic symbols.
10339 'inextern-lang
10340 (intern (concat "in"
10341 (symbol-name containing-decl-kwd))))
10342 nil t
10343 (c-most-enclosing-brace paren-state (point))
10344 paren-state))
10345 (c-add-class-syntax 'inclass
10346 containing-decl-open
10347 containing-decl-start
10348 containing-decl-kwd
10349 paren-state)))
10350 (when (and c-syntactic-indentation-in-macros
10351 macro-start
10352 (/= macro-start (c-point 'boi indent-point)))
10353 (c-add-syntax 'cpp-define-intro)
10354 (setq macro-start nil)))
10355
10356 ;; CASE 5K: we are at an ObjC method definition
10357 ;; continuation line.
10358 ((and c-opt-method-key
10359 (save-excursion
10360 (c-beginning-of-statement-1 lim)
10361 (beginning-of-line)
10362 (when (looking-at c-opt-method-key)
10363 (setq placeholder (point)))))
10364 (c-add-syntax 'objc-method-args-cont placeholder))
10365
10366 ;; CASE 5L: we are at the first argument of a template
10367 ;; arglist that begins on the previous line.
10368 ((and c-recognize-<>-arglists
10369 (eq (char-before) ?<)
10370 (not (and c-overloadable-operators-regexp
10371 (c-after-special-operator-id lim))))
10372 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10373 (c-add-syntax 'template-args-cont (c-point 'boi)))
10374
10375 ;; CASE 5Q: we are at a statement within a macro.
10376 (macro-start
10377 (c-beginning-of-statement-1 containing-sexp)
10378 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state))
10379
10380 ;;CASE 5N: We are at a topmost continuation line and the only
10381 ;;preceding items are annotations.
10382 ((and (c-major-mode-is 'java-mode)
10383 (setq placeholder (point))
10384 (c-beginning-of-statement-1)
10385 (progn
10386 (while (and (c-forward-annotation))
10387 (c-forward-syntactic-ws))
10388 t)
10389 (prog1
10390 (>= (point) placeholder)
10391 (goto-char placeholder)))
10392 (c-add-syntax 'annotation-top-cont (c-point 'boi)))
10393
10394 ;; CASE 5M: we are at a topmost continuation line
10395 (t
10396 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10397 (when (c-major-mode-is 'objc-mode)
10398 (setq placeholder (point))
10399 (while (and (c-forward-objc-directive)
10400 (< (point) indent-point))
10401 (c-forward-syntactic-ws)
10402 (setq placeholder (point)))
10403 (goto-char placeholder))
10404 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10405 ))
10406
10407 ;; (CASE 6 has been removed.)
10408
10409 ;; CASE 7: line is an expression, not a statement. Most
10410 ;; likely we are either in a function prototype or a function
10411 ;; call argument list
10412 ((not (or (and c-special-brace-lists
10413 (save-excursion
10414 (goto-char containing-sexp)
10415 (c-looking-at-special-brace-list)))
10416 (eq (char-after containing-sexp) ?{)))
10417 (cond
10418
10419 ;; CASE 7A: we are looking at the arglist closing paren.
10420 ;; C.f. case 7F.
10421 ((memq char-after-ip '(?\) ?\]))
10422 (goto-char containing-sexp)
10423 (setq placeholder (c-point 'boi))
10424 (if (and (c-safe (backward-up-list 1) t)
10425 (>= (point) placeholder))
10426 (progn
10427 (forward-char)
10428 (skip-chars-forward " \t"))
10429 (goto-char placeholder))
10430 (c-add-stmt-syntax 'arglist-close (list containing-sexp) t
10431 (c-most-enclosing-brace paren-state (point))
10432 paren-state))
10433
10434 ;; CASE 7B: Looking at the opening brace of an
10435 ;; in-expression block or brace list. C.f. cases 4, 16A
10436 ;; and 17E.
10437 ((and (eq char-after-ip ?{)
10438 (progn
10439 (setq placeholder (c-inside-bracelist-p (point)
10440 paren-state))
10441 (if placeholder
10442 (setq tmpsymbol '(brace-list-open . inexpr-class))
10443 (setq tmpsymbol '(block-open . inexpr-statement)
10444 placeholder
10445 (cdr-safe (c-looking-at-inexpr-block
10446 (c-safe-position containing-sexp
10447 paren-state)
10448 containing-sexp)))
10449 ;; placeholder is nil if it's a block directly in
10450 ;; a function arglist. That makes us skip out of
10451 ;; this case.
10452 )))
10453 (goto-char placeholder)
10454 (back-to-indentation)
10455 (c-add-stmt-syntax (car tmpsymbol) nil t
10456 (c-most-enclosing-brace paren-state (point))
10457 paren-state)
10458 (if (/= (point) placeholder)
10459 (c-add-syntax (cdr tmpsymbol))))
10460
10461 ;; CASE 7C: we are looking at the first argument in an empty
10462 ;; argument list. Use arglist-close if we're actually
10463 ;; looking at a close paren or bracket.
10464 ((memq char-before-ip '(?\( ?\[))
10465 (goto-char containing-sexp)
10466 (setq placeholder (c-point 'boi))
10467 (if (and (c-safe (backward-up-list 1) t)
10468 (>= (point) placeholder))
10469 (progn
10470 (forward-char)
10471 (skip-chars-forward " \t"))
10472 (goto-char placeholder))
10473 (c-add-stmt-syntax 'arglist-intro (list containing-sexp) t
10474 (c-most-enclosing-brace paren-state (point))
10475 paren-state))
10476
10477 ;; CASE 7D: we are inside a conditional test clause. treat
10478 ;; these things as statements
10479 ((progn
10480 (goto-char containing-sexp)
10481 (and (c-safe (c-forward-sexp -1) t)
10482 (looking-at "\\<for\\>[^_]")))
10483 (goto-char (1+ containing-sexp))
10484 (c-forward-syntactic-ws indent-point)
10485 (if (eq char-before-ip ?\;)
10486 (c-add-syntax 'statement (point))
10487 (c-add-syntax 'statement-cont (point))
10488 ))
10489
10490 ;; CASE 7E: maybe a continued ObjC method call. This is the
10491 ;; case when we are inside a [] bracketed exp, and what
10492 ;; precede the opening bracket is not an identifier.
10493 ((and c-opt-method-key
10494 (eq (char-after containing-sexp) ?\[)
10495 (progn
10496 (goto-char (1- containing-sexp))
10497 (c-backward-syntactic-ws (c-point 'bod))
10498 (if (not (looking-at c-symbol-key))
10499 (c-add-syntax 'objc-method-call-cont containing-sexp))
10500 )))
10501
10502 ;; CASE 7F: we are looking at an arglist continuation line,
10503 ;; but the preceding argument is on the same line as the
10504 ;; opening paren. This case includes multi-line
10505 ;; mathematical paren groupings, but we could be on a
10506 ;; for-list continuation line. C.f. case 7A.
10507 ((progn
10508 (goto-char (1+ containing-sexp))
10509 (< (save-excursion
10510 (c-forward-syntactic-ws)
10511 (point))
10512 (c-point 'bonl)))
10513 (goto-char containing-sexp) ; paren opening the arglist
10514 (setq placeholder (c-point 'boi))
10515 (if (and (c-safe (backward-up-list 1) t)
10516 (>= (point) placeholder))
10517 (progn
10518 (forward-char)
10519 (skip-chars-forward " \t"))
10520 (goto-char placeholder))
10521 (c-add-stmt-syntax 'arglist-cont-nonempty (list containing-sexp) t
10522 (c-most-enclosing-brace c-state-cache (point))
10523 paren-state))
10524
10525 ;; CASE 7G: we are looking at just a normal arglist
10526 ;; continuation line
10527 (t (c-forward-syntactic-ws indent-point)
10528 (c-add-syntax 'arglist-cont (c-point 'boi)))
10529 ))
10530
10531 ;; CASE 8: func-local multi-inheritance line
10532 ((and (c-major-mode-is 'c++-mode)
10533 (save-excursion
10534 (goto-char indent-point)
10535 (skip-chars-forward " \t")
10536 (looking-at c-opt-postfix-decl-spec-key)))
10537 (goto-char indent-point)
10538 (skip-chars-forward " \t")
10539 (cond
10540
10541 ;; CASE 8A: non-hanging colon on an inher intro
10542 ((eq char-after-ip ?:)
10543 (c-backward-syntactic-ws lim)
10544 (c-add-syntax 'inher-intro (c-point 'boi)))
10545
10546 ;; CASE 8B: hanging colon on an inher intro
10547 ((eq char-before-ip ?:)
10548 (c-add-syntax 'inher-intro (c-point 'boi)))
10549
10550 ;; CASE 8C: a continued inheritance line
10551 (t
10552 (c-beginning-of-inheritance-list lim)
10553 (c-add-syntax 'inher-cont (point))
10554 )))
10555
10556 ;; CASE 9: we are inside a brace-list
10557 ((and (not (c-major-mode-is 'awk-mode)) ; Maybe this isn't needed (ACM, 2002/3/29)
10558 (setq special-brace-list
10559 (or (and c-special-brace-lists ;;;; ALWAYS NIL FOR AWK!!
10560 (save-excursion
10561 (goto-char containing-sexp)
10562 (c-looking-at-special-brace-list)))
10563 (c-inside-bracelist-p containing-sexp paren-state))))
10564 (cond
10565
10566 ;; CASE 9A: In the middle of a special brace list opener.
10567 ((and (consp special-brace-list)
10568 (save-excursion
10569 (goto-char containing-sexp)
10570 (eq (char-after) ?\())
10571 (eq char-after-ip (car (cdr special-brace-list))))
10572 (goto-char (car (car special-brace-list)))
10573 (skip-chars-backward " \t")
10574 (if (and (bolp)
10575 (assoc 'statement-cont
10576 (setq placeholder (c-guess-basic-syntax))))
10577 (setq c-syntactic-context placeholder)
10578 (c-beginning-of-statement-1
10579 (c-safe-position (1- containing-sexp) paren-state))
10580 (c-forward-token-2 0)
10581 (while (looking-at c-specifier-key)
10582 (goto-char (match-end 1))
10583 (c-forward-syntactic-ws))
10584 (c-add-syntax 'brace-list-open (c-point 'boi))))
10585
10586 ;; CASE 9B: brace-list-close brace
10587 ((if (consp special-brace-list)
10588 ;; Check special brace list closer.
10589 (progn
10590 (goto-char (car (car special-brace-list)))
10591 (save-excursion
10592 (goto-char indent-point)
10593 (back-to-indentation)
10594 (or
10595 ;; We were between the special close char and the `)'.
10596 (and (eq (char-after) ?\))
10597 (eq (1+ (point)) (cdr (car special-brace-list))))
10598 ;; We were before the special close char.
10599 (and (eq (char-after) (cdr (cdr special-brace-list)))
10600 (zerop (c-forward-token-2))
10601 (eq (1+ (point)) (cdr (car special-brace-list)))))))
10602 ;; Normal brace list check.
10603 (and (eq char-after-ip ?})
10604 (c-safe (goto-char (c-up-list-backward (point))) t)
10605 (= (point) containing-sexp)))
10606 (if (eq (point) (c-point 'boi))
10607 (c-add-syntax 'brace-list-close (point))
10608 (setq lim (c-most-enclosing-brace c-state-cache (point)))
10609 (c-beginning-of-statement-1 lim nil nil t)
10610 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state)))
10611
10612 (t
10613 ;; Prepare for the rest of the cases below by going to the
10614 ;; token following the opening brace
10615 (if (consp special-brace-list)
10616 (progn
10617 (goto-char (car (car special-brace-list)))
10618 (c-forward-token-2 1 nil indent-point))
10619 (goto-char containing-sexp))
10620 (forward-char)
10621 (let ((start (point)))
10622 (c-forward-syntactic-ws indent-point)
10623 (goto-char (max start (c-point 'bol))))
10624 (c-skip-ws-forward indent-point)
10625 (cond
10626
10627 ;; CASE 9C: we're looking at the first line in a brace-list
10628 ((= (point) indent-point)
10629 (if (consp special-brace-list)
10630 (goto-char (car (car special-brace-list)))
10631 (goto-char containing-sexp))
10632 (if (eq (point) (c-point 'boi))
10633 (c-add-syntax 'brace-list-intro (point))
10634 (setq lim (c-most-enclosing-brace c-state-cache (point)))
10635 (c-beginning-of-statement-1 lim)
10636 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state)))
10637
10638 ;; CASE 9D: this is just a later brace-list-entry or
10639 ;; brace-entry-open
10640 (t (if (or (eq char-after-ip ?{)
10641 (and c-special-brace-lists
10642 (save-excursion
10643 (goto-char indent-point)
10644 (c-forward-syntactic-ws (c-point 'eol))
10645 (c-looking-at-special-brace-list (point)))))
10646 (c-add-syntax 'brace-entry-open (point))
10647 (c-add-syntax 'brace-list-entry (point))
10648 ))
10649 ))))
10650
10651 ;; CASE 10: A continued statement or top level construct.
10652 ((and (not (memq char-before-ip '(?\; ?:)))
10653 (not (c-at-vsemi-p before-ws-ip))
10654 (or (not (eq char-before-ip ?}))
10655 (c-looking-at-inexpr-block-backward c-state-cache))
10656 (> (point)
10657 (save-excursion
10658 (c-beginning-of-statement-1 containing-sexp)
10659 (setq placeholder (point))))
10660 (/= placeholder containing-sexp))
10661 ;; This is shared with case 18.
10662 (c-guess-continued-construct indent-point
10663 char-after-ip
10664 placeholder
10665 containing-sexp
10666 paren-state))
10667
10668 ;; CASE 16: block close brace, possibly closing the defun or
10669 ;; the class
10670 ((eq char-after-ip ?})
10671 ;; From here on we have the next containing sexp in lim.
10672 (setq lim (c-most-enclosing-brace paren-state))
10673 (goto-char containing-sexp)
10674 (cond
10675
10676 ;; CASE 16E: Closing a statement block? This catches
10677 ;; cases where it's preceded by a statement keyword,
10678 ;; which works even when used in an "invalid" context,
10679 ;; e.g. a macro argument.
10680 ((c-after-conditional)
10681 (c-backward-to-block-anchor lim)
10682 (c-add-stmt-syntax 'block-close nil t lim paren-state))
10683
10684 ;; CASE 16A: closing a lambda defun or an in-expression
10685 ;; block? C.f. cases 4, 7B and 17E.
10686 ((setq placeholder (c-looking-at-inexpr-block
10687 (c-safe-position containing-sexp paren-state)
10688 nil))
10689 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
10690 'inline-close
10691 'block-close))
10692 (goto-char containing-sexp)
10693 (back-to-indentation)
10694 (if (= containing-sexp (point))
10695 (c-add-syntax tmpsymbol (point))
10696 (goto-char (cdr placeholder))
10697 (back-to-indentation)
10698 (c-add-stmt-syntax tmpsymbol nil t
10699 (c-most-enclosing-brace paren-state (point))
10700 paren-state)
10701 (if (/= (point) (cdr placeholder))
10702 (c-add-syntax (car placeholder)))))
10703
10704 ;; CASE 16B: does this close an inline or a function in
10705 ;; a non-class declaration level block?
10706 ((save-excursion
10707 (and lim
10708 (progn
10709 (goto-char lim)
10710 (c-looking-at-decl-block
10711 (c-most-enclosing-brace paren-state lim)
10712 nil))
10713 (setq placeholder (point))))
10714 (c-backward-to-decl-anchor lim)
10715 (back-to-indentation)
10716 (if (save-excursion
10717 (goto-char placeholder)
10718 (looking-at c-other-decl-block-key))
10719 (c-add-syntax 'defun-close (point))
10720 (c-add-syntax 'inline-close (point))))
10721
10722 ;; CASE 16F: Can be a defun-close of a function declared
10723 ;; in a statement block, e.g. in Pike or when using gcc
10724 ;; extensions, but watch out for macros followed by
10725 ;; blocks. Let it through to be handled below.
10726 ;; C.f. cases B.3 and 17G.
10727 ((save-excursion
10728 (and (not (c-at-statement-start-p))
10729 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
10730 (setq placeholder (point))
10731 (let ((c-recognize-typeless-decls nil))
10732 ;; Turn off recognition of constructs that
10733 ;; lacks a type in this case, since that's more
10734 ;; likely to be a macro followed by a block.
10735 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
10736 (back-to-indentation)
10737 (if (/= (point) containing-sexp)
10738 (goto-char placeholder))
10739 (c-add-stmt-syntax 'defun-close nil t lim paren-state))
10740
10741 ;; CASE 16C: If there is an enclosing brace then this is
10742 ;; a block close since defun closes inside declaration
10743 ;; level blocks have been handled above.
10744 (lim
10745 ;; If the block is preceded by a case/switch label on
10746 ;; the same line, we anchor at the first preceding label
10747 ;; at boi. The default handling in c-add-stmt-syntax
10748 ;; really fixes it better, but we do like this to keep
10749 ;; the indentation compatible with version 5.28 and
10750 ;; earlier. C.f. case 17H.
10751 (while (and (/= (setq placeholder (point)) (c-point 'boi))
10752 (eq (c-beginning-of-statement-1 lim) 'label)))
10753 (goto-char placeholder)
10754 (if (looking-at c-label-kwds-regexp)
10755 (c-add-syntax 'block-close (point))
10756 (goto-char containing-sexp)
10757 ;; c-backward-to-block-anchor not necessary here; those
10758 ;; situations are handled in case 16E above.
10759 (c-add-stmt-syntax 'block-close nil t lim paren-state)))
10760
10761 ;; CASE 16D: Only top level defun close left.
10762 (t
10763 (goto-char containing-sexp)
10764 (c-backward-to-decl-anchor lim)
10765 (c-add-stmt-syntax 'defun-close nil nil
10766 (c-most-enclosing-brace paren-state)
10767 paren-state))
10768 ))
10769
10770 ;; CASE 19: line is an expression, not a statement, and is directly
10771 ;; contained by a template delimiter. Most likely, we are in a
10772 ;; template arglist within a statement. This case is based on CASE
10773 ;; 7. At some point in the future, we may wish to create more
10774 ;; syntactic symbols such as `template-intro',
10775 ;; `template-cont-nonempty', etc., and distinguish between them as we
10776 ;; do for `arglist-intro' etc. (2009-12-07).
10777 ((and c-recognize-<>-arglists
10778 (setq containing-< (c-up-list-backward indent-point containing-sexp))
10779 (eq (char-after containing-<) ?\<))
10780 (setq placeholder (c-point 'boi containing-<))
10781 (goto-char containing-sexp) ; Most nested Lbrace/Lparen (but not
10782 ; '<') before indent-point.
10783 (if (>= (point) placeholder)
10784 (progn
10785 (forward-char)
10786 (skip-chars-forward " \t"))
10787 (goto-char placeholder))
10788 (c-add-stmt-syntax 'template-args-cont (list containing-<) t
10789 (c-most-enclosing-brace c-state-cache (point))
10790 paren-state))
10791
10792 ;; CASE 17: Statement or defun catchall.
10793 (t
10794 (goto-char indent-point)
10795 ;; Back up statements until we find one that starts at boi.
10796 (while (let* ((prev-point (point))
10797 (last-step-type (c-beginning-of-statement-1
10798 containing-sexp)))
10799 (if (= (point) prev-point)
10800 (progn
10801 (setq step-type (or step-type last-step-type))
10802 nil)
10803 (setq step-type last-step-type)
10804 (/= (point) (c-point 'boi)))))
10805 (cond
10806
10807 ;; CASE 17B: continued statement
10808 ((and (eq step-type 'same)
10809 (/= (point) indent-point))
10810 (c-add-stmt-syntax 'statement-cont nil nil
10811 containing-sexp paren-state))
10812
10813 ;; CASE 17A: After a case/default label?
10814 ((progn
10815 (while (and (eq step-type 'label)
10816 (not (looking-at c-label-kwds-regexp)))
10817 (setq step-type
10818 (c-beginning-of-statement-1 containing-sexp)))
10819 (eq step-type 'label))
10820 (c-add-stmt-syntax (if (eq char-after-ip ?{)
10821 'statement-case-open
10822 'statement-case-intro)
10823 nil t containing-sexp paren-state))
10824
10825 ;; CASE 17D: any old statement
10826 ((progn
10827 (while (eq step-type 'label)
10828 (setq step-type
10829 (c-beginning-of-statement-1 containing-sexp)))
10830 (eq step-type 'previous))
10831 (c-add-stmt-syntax 'statement nil t
10832 containing-sexp paren-state)
10833 (if (eq char-after-ip ?{)
10834 (c-add-syntax 'block-open)))
10835
10836 ;; CASE 17I: Inside a substatement block.
10837 ((progn
10838 ;; The following tests are all based on containing-sexp.
10839 (goto-char containing-sexp)
10840 ;; From here on we have the next containing sexp in lim.
10841 (setq lim (c-most-enclosing-brace paren-state containing-sexp))
10842 (c-after-conditional))
10843 (c-backward-to-block-anchor lim)
10844 (c-add-stmt-syntax 'statement-block-intro nil t
10845 lim paren-state)
10846 (if (eq char-after-ip ?{)
10847 (c-add-syntax 'block-open)))
10848
10849 ;; CASE 17E: first statement in an in-expression block.
10850 ;; C.f. cases 4, 7B and 16A.
10851 ((setq placeholder (c-looking-at-inexpr-block
10852 (c-safe-position containing-sexp paren-state)
10853 nil))
10854 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
10855 'defun-block-intro
10856 'statement-block-intro))
10857 (back-to-indentation)
10858 (if (= containing-sexp (point))
10859 (c-add-syntax tmpsymbol (point))
10860 (goto-char (cdr placeholder))
10861 (back-to-indentation)
10862 (c-add-stmt-syntax tmpsymbol nil t
10863 (c-most-enclosing-brace c-state-cache (point))
10864 paren-state)
10865 (if (/= (point) (cdr placeholder))
10866 (c-add-syntax (car placeholder))))
10867 (if (eq char-after-ip ?{)
10868 (c-add-syntax 'block-open)))
10869
10870 ;; CASE 17F: first statement in an inline, or first
10871 ;; statement in a top-level defun. we can tell this is it
10872 ;; if there are no enclosing braces that haven't been
10873 ;; narrowed out by a class (i.e. don't use bod here).
10874 ((save-excursion
10875 (or (not (setq placeholder (c-most-enclosing-brace
10876 paren-state)))
10877 (and (progn
10878 (goto-char placeholder)
10879 (eq (char-after) ?{))
10880 (c-looking-at-decl-block (c-most-enclosing-brace
10881 paren-state (point))
10882 nil))))
10883 (c-backward-to-decl-anchor lim)
10884 (back-to-indentation)
10885 (c-add-syntax 'defun-block-intro (point)))
10886
10887 ;; CASE 17G: First statement in a function declared inside
10888 ;; a normal block. This can occur in Pike and with
10889 ;; e.g. the gcc extensions, but watch out for macros
10890 ;; followed by blocks. C.f. cases B.3 and 16F.
10891 ((save-excursion
10892 (and (not (c-at-statement-start-p))
10893 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
10894 (setq placeholder (point))
10895 (let ((c-recognize-typeless-decls nil))
10896 ;; Turn off recognition of constructs that lacks
10897 ;; a type in this case, since that's more likely
10898 ;; to be a macro followed by a block.
10899 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
10900 (back-to-indentation)
10901 (if (/= (point) containing-sexp)
10902 (goto-char placeholder))
10903 (c-add-stmt-syntax 'defun-block-intro nil t
10904 lim paren-state))
10905
10906 ;; CASE 17H: First statement in a block.
10907 (t
10908 ;; If the block is preceded by a case/switch label on the
10909 ;; same line, we anchor at the first preceding label at
10910 ;; boi. The default handling in c-add-stmt-syntax is
10911 ;; really fixes it better, but we do like this to keep the
10912 ;; indentation compatible with version 5.28 and earlier.
10913 ;; C.f. case 16C.
10914 (while (and (/= (setq placeholder (point)) (c-point 'boi))
10915 (eq (c-beginning-of-statement-1 lim) 'label)))
10916 (goto-char placeholder)
10917 (if (looking-at c-label-kwds-regexp)
10918 (c-add-syntax 'statement-block-intro (point))
10919 (goto-char containing-sexp)
10920 ;; c-backward-to-block-anchor not necessary here; those
10921 ;; situations are handled in case 17I above.
10922 (c-add-stmt-syntax 'statement-block-intro nil t
10923 lim paren-state))
10924 (if (eq char-after-ip ?{)
10925 (c-add-syntax 'block-open)))
10926 ))
10927 )
10928
10929 ;; now we need to look at any modifiers
10930 (goto-char indent-point)
10931 (skip-chars-forward " \t")
10932
10933 ;; are we looking at a comment only line?
10934 (when (and (looking-at c-comment-start-regexp)
10935 (/= (c-forward-token-2 0 nil (c-point 'eol)) 0))
10936 (c-append-syntax 'comment-intro))
10937
10938 ;; we might want to give additional offset to friends (in C++).
10939 (when (and c-opt-friend-key
10940 (looking-at c-opt-friend-key))
10941 (c-append-syntax 'friend))
10942
10943 ;; Set syntactic-relpos.
10944 (let ((p c-syntactic-context))
10945 (while (and p
10946 (if (integerp (c-langelem-pos (car p)))
10947 (progn
10948 (setq syntactic-relpos (c-langelem-pos (car p)))
10949 nil)
10950 t))
10951 (setq p (cdr p))))
10952
10953 ;; Start of or a continuation of a preprocessor directive?
10954 (if (and macro-start
10955 (eq macro-start (c-point 'boi))
10956 (not (and (c-major-mode-is 'pike-mode)
10957 (eq (char-after (1+ macro-start)) ?\"))))
10958 (c-append-syntax 'cpp-macro)
10959 (when (and c-syntactic-indentation-in-macros macro-start)
10960 (if in-macro-expr
10961 (when (or
10962 (< syntactic-relpos macro-start)
10963 (not (or
10964 (assq 'arglist-intro c-syntactic-context)
10965 (assq 'arglist-cont c-syntactic-context)
10966 (assq 'arglist-cont-nonempty c-syntactic-context)
10967 (assq 'arglist-close c-syntactic-context))))
10968 ;; If inside a cpp expression, i.e. anywhere in a
10969 ;; cpp directive except a #define body, we only let
10970 ;; through the syntactic analysis that is internal
10971 ;; in the expression. That means the arglist
10972 ;; elements, if they are anchored inside the cpp
10973 ;; expression.
10974 (setq c-syntactic-context nil)
10975 (c-add-syntax 'cpp-macro-cont macro-start))
10976 (when (and (eq macro-start syntactic-relpos)
10977 (not (assq 'cpp-define-intro c-syntactic-context))
10978 (save-excursion
10979 (goto-char macro-start)
10980 (or (not (c-forward-to-cpp-define-body))
10981 (<= (point) (c-point 'boi indent-point)))))
10982 ;; Inside a #define body and the syntactic analysis is
10983 ;; anchored on the start of the #define. In this case
10984 ;; we add cpp-define-intro to get the extra
10985 ;; indentation of the #define body.
10986 (c-add-syntax 'cpp-define-intro)))))
10987
10988 ;; return the syntax
10989 c-syntactic-context)))
10990
10991 \f
10992 ;; Indentation calculation.
10993
10994 (defun c-evaluate-offset (offset langelem symbol)
10995 ;; offset can be a number, a function, a variable, a list, or one of
10996 ;; the symbols + or -
10997 ;;
10998 ;; This function might do hidden buffer changes.
10999 (let ((res
11000 (cond
11001 ((numberp offset) offset)
11002 ((vectorp offset) offset)
11003 ((null offset) nil)
11004
11005 ((eq offset '+) c-basic-offset)
11006 ((eq offset '-) (- c-basic-offset))
11007 ((eq offset '++) (* 2 c-basic-offset))
11008 ((eq offset '--) (* 2 (- c-basic-offset)))
11009 ((eq offset '*) (/ c-basic-offset 2))
11010 ((eq offset '/) (/ (- c-basic-offset) 2))
11011
11012 ((functionp offset)
11013 (c-evaluate-offset
11014 (funcall offset
11015 (cons (c-langelem-sym langelem)
11016 (c-langelem-pos langelem)))
11017 langelem symbol))
11018
11019 ((listp offset)
11020 (cond
11021 ((eq (car offset) 'quote)
11022 (c-benign-error "The offset %S for %s was mistakenly quoted"
11023 offset symbol)
11024 nil)
11025
11026 ((memq (car offset) '(min max))
11027 (let (res val (method (car offset)))
11028 (setq offset (cdr offset))
11029 (while offset
11030 (setq val (c-evaluate-offset (car offset) langelem symbol))
11031 (cond
11032 ((not val))
11033 ((not res)
11034 (setq res val))
11035 ((integerp val)
11036 (if (vectorp res)
11037 (c-benign-error "\
11038 Error evaluating offset %S for %s: \
11039 Cannot combine absolute offset %S with relative %S in `%s' method"
11040 (car offset) symbol res val method)
11041 (setq res (funcall method res val))))
11042 (t
11043 (if (integerp res)
11044 (c-benign-error "\
11045 Error evaluating offset %S for %s: \
11046 Cannot combine relative offset %S with absolute %S in `%s' method"
11047 (car offset) symbol res val method)
11048 (setq res (vector (funcall method (aref res 0)
11049 (aref val 0)))))))
11050 (setq offset (cdr offset)))
11051 res))
11052
11053 ((eq (car offset) 'add)
11054 (let (res val)
11055 (setq offset (cdr offset))
11056 (while offset
11057 (setq val (c-evaluate-offset (car offset) langelem symbol))
11058 (cond
11059 ((not val))
11060 ((not res)
11061 (setq res val))
11062 ((integerp val)
11063 (if (vectorp res)
11064 (setq res (vector (+ (aref res 0) val)))
11065 (setq res (+ res val))))
11066 (t
11067 (if (vectorp res)
11068 (c-benign-error "\
11069 Error evaluating offset %S for %s: \
11070 Cannot combine absolute offsets %S and %S in `add' method"
11071 (car offset) symbol res val)
11072 (setq res val)))) ; Override.
11073 (setq offset (cdr offset)))
11074 res))
11075
11076 (t
11077 (let (res)
11078 (when (eq (car offset) 'first)
11079 (setq offset (cdr offset)))
11080 (while (and (not res) offset)
11081 (setq res (c-evaluate-offset (car offset) langelem symbol)
11082 offset (cdr offset)))
11083 res))))
11084
11085 ((and (symbolp offset) (boundp offset))
11086 (symbol-value offset))
11087
11088 (t
11089 (c-benign-error "Unknown offset format %S for %s" offset symbol)
11090 nil))))
11091
11092 (if (or (null res) (integerp res)
11093 (and (vectorp res) (= (length res) 1) (integerp (aref res 0))))
11094 res
11095 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
11096 offset symbol res)
11097 nil)))
11098
11099 (defun c-calc-offset (langelem)
11100 ;; Get offset from LANGELEM which is a list beginning with the
11101 ;; syntactic symbol and followed by any analysis data it provides.
11102 ;; That data may be zero or more elements, but if at least one is
11103 ;; given then the first is the anchor position (or nil). The symbol
11104 ;; is matched against `c-offsets-alist' and the offset calculated
11105 ;; from that is returned.
11106 ;;
11107 ;; This function might do hidden buffer changes.
11108 (let* ((symbol (c-langelem-sym langelem))
11109 (match (assq symbol c-offsets-alist))
11110 (offset (cdr-safe match)))
11111 (if match
11112 (setq offset (c-evaluate-offset offset langelem symbol))
11113 (if c-strict-syntax-p
11114 (c-benign-error "No offset found for syntactic symbol %s" symbol))
11115 (setq offset 0))
11116 (if (vectorp offset)
11117 offset
11118 (or (and (numberp offset) offset)
11119 (and (symbolp offset) (symbol-value offset))
11120 0))
11121 ))
11122
11123 (defun c-get-offset (langelem)
11124 ;; This is a compatibility wrapper for `c-calc-offset' in case
11125 ;; someone is calling it directly. It takes an old style syntactic
11126 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
11127 ;; new list form.
11128 ;;
11129 ;; This function might do hidden buffer changes.
11130 (if (c-langelem-pos langelem)
11131 (c-calc-offset (list (c-langelem-sym langelem)
11132 (c-langelem-pos langelem)))
11133 (c-calc-offset langelem)))
11134
11135 (defun c-get-syntactic-indentation (langelems)
11136 ;; Calculate the syntactic indentation from a syntactic description
11137 ;; as returned by `c-guess-syntax'.
11138 ;;
11139 ;; Note that topmost-intro always has an anchor position at bol, for
11140 ;; historical reasons. It's often used together with other symbols
11141 ;; that has more sane positions. Since we always use the first
11142 ;; found anchor position, we rely on that these other symbols always
11143 ;; precede topmost-intro in the LANGELEMS list.
11144 ;;
11145 ;; This function might do hidden buffer changes.
11146 (let ((indent 0) anchor)
11147
11148 (while langelems
11149 (let* ((c-syntactic-element (car langelems))
11150 (res (c-calc-offset c-syntactic-element)))
11151
11152 (if (vectorp res)
11153 ;; Got an absolute column that overrides any indentation
11154 ;; we've collected so far, but not the relative
11155 ;; indentation we might get for the nested structures
11156 ;; further down the langelems list.
11157 (setq indent (elt res 0)
11158 anchor (point-min)) ; A position at column 0.
11159
11160 ;; Got a relative change of the current calculated
11161 ;; indentation.
11162 (setq indent (+ indent res))
11163
11164 ;; Use the anchor position from the first syntactic
11165 ;; element with one.
11166 (unless anchor
11167 (setq anchor (c-langelem-pos (car langelems)))))
11168
11169 (setq langelems (cdr langelems))))
11170
11171 (if anchor
11172 (+ indent (save-excursion
11173 (goto-char anchor)
11174 (current-column)))
11175 indent)))
11176
11177 \f
11178 (cc-provide 'cc-engine)
11179
11180 ;;; cc-engine.el ends here