]> code.delx.au - gnu-emacs/blob - lisp/progmodes/cc-fonts.el
Use eldoc-documentation-functions
[gnu-emacs] / lisp / progmodes / cc-fonts.el
1 ;;; cc-fonts.el --- font lock support for CC Mode
2
3 ;; Copyright (C) 2002-2016 Free Software Foundation, Inc.
4
5 ;; Authors: 2003- Alan Mackenzie
6 ;; 2002- Martin Stjernholm
7 ;; Maintainer: bug-cc-mode@gnu.org
8 ;; Created: 07-Jan-2002
9 ;; Keywords: c languages
10 ;; Package: cc-mode
11
12 ;; This file is part of GNU Emacs.
13
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
18
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
23
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26
27 ;;; Commentary:
28
29 ;; Some comments on the use of faces:
30 ;;
31 ;; o `c-label-face-name' is either `font-lock-constant-face' (in
32 ;; Emacs), or `font-lock-reference-face'.
33 ;;
34 ;; o `c-constant-face-name', `c-reference-face-name' and
35 ;; `c-doc-markup-face-name' are essentially set up like
36 ;; `c-label-face-name'.
37 ;;
38 ;; o `c-preprocessor-face-name' is `font-lock-preprocessor-face' in
39 ;; XEmacs and - in lack of a closer equivalent -
40 ;; `font-lock-builtin-face' or `font-lock-reference-face' in Emacs.
41 ;;
42 ;; o `c-doc-face-name' is `font-lock-doc-string-face' in XEmacs,
43 ;; `font-lock-doc-face' in Emacs 21 and later, or
44 ;; `font-lock-comment-face' in older Emacs (that since source
45 ;; documentation are actually comments in these languages, as opposed
46 ;; to elisp).
47 ;;
48 ;; TBD: We should probably provide real faces for the above uses and
49 ;; instead initialize them from the standard faces.
50
51 ;;; Code:
52
53 ;; The faces that already have been put onto the text is tested in
54 ;; various places to direct further fontifications. For this to work,
55 ;; the following assumptions regarding the faces must hold (apart from
56 ;; the dependencies on the font locking order):
57 ;;
58 ;; o `font-lock-comment-face' and the face in `c-doc-face-name' is
59 ;; not used in anything but comments.
60 ;; o If any face (e.g. `c-doc-markup-face-name') but those above is
61 ;; used in comments, it doesn't replace them.
62 ;; o `font-lock-string-face' is not used in anything but string
63 ;; literals (single or double quoted).
64 ;; o `font-lock-keyword-face' and the face in `c-label-face-name' are
65 ;; never overlaid with other faces.
66
67 (eval-when-compile
68 (let ((load-path
69 (if (and (boundp 'byte-compile-dest-file)
70 (stringp byte-compile-dest-file))
71 (cons (file-name-directory byte-compile-dest-file) load-path)
72 load-path)))
73 (load "cc-bytecomp" nil t)))
74
75 (cc-require 'cc-defs)
76 (cc-require-when-compile 'cc-langs)
77 (cc-require 'cc-vars)
78 (cc-require 'cc-engine)
79 (cc-require-when-compile 'cc-awk) ; Change from cc-require, 2003/6/18 to
80 ;; prevent cc-awk being loaded when it's not needed. There is now a (require
81 ;; 'cc-awk) in (defun awk-mode ..).
82
83 ;; Avoid repeated loading through the eval-after-load directive in
84 ;; cc-mode.el.
85 (provide 'cc-fonts)
86
87 (cc-external-require 'font-lock)
88
89 (cc-bytecomp-defvar parse-sexp-lookup-properties) ; Emacs only.
90
91 ;; Need to declare these local symbols during compilation since
92 ;; they're referenced from lambdas in `byte-compile' calls that are
93 ;; executed at compile time. They don't need to have the proper
94 ;; definitions, though, since the generated functions aren't called
95 ;; during compilation.
96 (cc-bytecomp-defvar c-preprocessor-face-name)
97 (cc-bytecomp-defvar c-reference-face-name)
98 (cc-bytecomp-defun c-fontify-recorded-types-and-refs)
99 (cc-bytecomp-defun c-font-lock-declarators)
100 (cc-bytecomp-defun c-font-lock-objc-method)
101 (cc-bytecomp-defun c-font-lock-invalid-string)
102
103 \f
104 ;; Note that font-lock in XEmacs doesn't expand face names as
105 ;; variables, so we have to use the (eval . FORM) in the font lock
106 ;; matchers wherever we use these alias variables.
107
108 (defconst c-preprocessor-face-name
109 (cond ((c-face-name-p 'font-lock-preprocessor-face)
110 ;; XEmacs has a font-lock-preprocessor-face.
111 'font-lock-preprocessor-face)
112 ((c-face-name-p 'font-lock-builtin-face)
113 ;; In Emacs font-lock-builtin-face has traditionally been
114 ;; used for preprocessor directives.
115 'font-lock-builtin-face)
116 (t
117 'font-lock-reference-face)))
118
119 (cc-bytecomp-defvar font-lock-constant-face)
120
121 (defconst c-label-face-name
122 (cond ((c-face-name-p 'font-lock-label-face)
123 ;; If it happens to occur in the future. (Well, the more
124 ;; pragmatic reason is to get unique faces for the test
125 ;; suite.)
126 'font-lock-label-face)
127 ((and (c-face-name-p 'font-lock-constant-face)
128 (eq font-lock-constant-face 'font-lock-constant-face))
129 ;; Test both if font-lock-constant-face exists and that it's
130 ;; not an alias for something else. This is important since
131 ;; we compare already set faces in various places.
132 'font-lock-constant-face)
133 (t
134 'font-lock-reference-face)))
135
136 (defconst c-constant-face-name
137 (if (and (c-face-name-p 'font-lock-constant-face)
138 (eq font-lock-constant-face 'font-lock-constant-face))
139 ;; This doesn't exist in some earlier versions of XEmacs 21.
140 'font-lock-constant-face
141 c-label-face-name))
142
143 (defconst c-reference-face-name
144 (with-no-warnings
145 (if (and (c-face-name-p 'font-lock-reference-face)
146 (eq font-lock-reference-face 'font-lock-reference-face))
147 ;; This is considered obsolete in Emacs, but it still maps well
148 ;; to this use. (Another reason to do this is to get unique
149 ;; faces for the test suite.)
150 'font-lock-reference-face
151 c-label-face-name)))
152
153 ;; This should not mapped to a face that also is used to fontify things
154 ;; that aren't comments or string literals.
155 (defconst c-doc-face-name
156 (cond ((c-face-name-p 'font-lock-doc-string-face)
157 ;; XEmacs.
158 'font-lock-doc-string-face)
159 ((c-face-name-p 'font-lock-doc-face)
160 ;; Emacs 21 and later.
161 'font-lock-doc-face)
162 (t
163 'font-lock-comment-face)))
164
165 (defconst c-doc-markup-face-name
166 (if (c-face-name-p 'font-lock-doc-markup-face)
167 ;; If it happens to occur in the future. (Well, the more
168 ;; pragmatic reason is to get unique faces for the test
169 ;; suite.)
170 'font-lock-doc-markup-face
171 c-label-face-name))
172
173 (defconst c-negation-char-face-name
174 (if (c-face-name-p 'font-lock-negation-char-face)
175 ;; Emacs 22 has a special face for negation chars.
176 'font-lock-negation-char-face))
177
178 (cc-bytecomp-defun face-inverse-video-p) ; Only in Emacs.
179
180 (defun c-make-inverse-face (oldface newface)
181 ;; Emacs and XEmacs have completely different face manipulation
182 ;; routines. :P
183 (copy-face oldface newface)
184 (cond ((fboundp 'face-inverse-video-p)
185 ;; Emacs. This only looks at the inverse flag in the current
186 ;; frame. Other display configurations might be different,
187 ;; but it can only show if the same Emacs has frames on
188 ;; e.g. a color and a monochrome display simultaneously.
189 (unless (face-inverse-video-p oldface)
190 (invert-face newface)))
191 ((fboundp 'face-property-instance)
192 ;; XEmacs. Same pitfall here.
193 (unless (face-property-instance oldface 'reverse)
194 (invert-face newface)))))
195
196 (defvar c-annotation-face 'c-annotation-face)
197
198 (defface c-annotation-face
199 '((default :inherit font-lock-constant-face))
200 "Face for highlighting annotations in Java mode and similar modes."
201 :version "24.1"
202 :group 'c)
203
204 (eval-and-compile
205 ;; We need the following definitions during compilation since they're
206 ;; used when the `c-lang-defconst' initializers are evaluated. Define
207 ;; them at runtime too for the sake of derived modes.
208
209 ;; This indicates the "font locking context", and is set just before
210 ;; fontification is done. If non-nil, it says, e.g., point starts
211 ;; from within a #if preprocessor construct.
212 (defvar c-font-lock-context nil)
213 (make-variable-buffer-local 'c-font-lock-context)
214
215 (defmacro c-put-font-lock-face (from to face)
216 ;; Put a face on a region (overriding any existing face) in the way
217 ;; font-lock would do it. In XEmacs that means putting an
218 ;; additional font-lock property, or else the font-lock package
219 ;; won't recognize it as fontified and might override it
220 ;; incorrectly.
221 ;;
222 ;; This function does a hidden buffer change.
223 (if (fboundp 'font-lock-set-face)
224 ;; Note: This function has no docstring in XEmacs so it might be
225 ;; considered internal.
226 `(font-lock-set-face ,from ,to ,face)
227 `(put-text-property ,from ,to 'face ,face)))
228
229 (defmacro c-remove-font-lock-face (from to)
230 ;; This is the inverse of `c-put-font-lock-face'.
231 ;;
232 ;; This function does a hidden buffer change.
233 (if (fboundp 'font-lock-remove-face)
234 `(font-lock-remove-face ,from ,to)
235 `(remove-text-properties ,from ,to '(face nil))))
236
237 (defmacro c-put-font-lock-string-face (from to)
238 ;; Put `font-lock-string-face' on a string. The surrounding
239 ;; quotes are included in Emacs but not in XEmacs. The passed
240 ;; region should include them.
241 ;;
242 ;; This function does a hidden buffer change.
243 (if (featurep 'xemacs)
244 `(c-put-font-lock-face (1+ ,from) (1- ,to) 'font-lock-string-face)
245 `(c-put-font-lock-face ,from ,to 'font-lock-string-face)))
246
247 (defmacro c-fontify-types-and-refs (varlist &rest body)
248 ;; Like `let', but additionally activates `c-record-type-identifiers'
249 ;; and `c-record-ref-identifiers', and fontifies the recorded ranges
250 ;; accordingly on exit.
251 ;;
252 ;; This function does hidden buffer changes.
253 `(let ((c-record-type-identifiers t)
254 c-record-ref-identifiers
255 ,@varlist)
256 (prog1 (progn ,@body)
257 (c-fontify-recorded-types-and-refs))))
258 (put 'c-fontify-types-and-refs 'lisp-indent-function 1)
259
260 (defun c-skip-comments-and-strings (limit)
261 ;; If the point is within a region fontified as a comment or
262 ;; string literal skip to the end of it or to LIMIT, whichever
263 ;; comes first, and return t. Otherwise return nil. The match
264 ;; data is not clobbered.
265 ;;
266 ;; This function might do hidden buffer changes.
267 (when (c-got-face-at (point) c-literal-faces)
268 (while (progn
269 (goto-char (c-next-single-property-change
270 (point) 'face nil limit))
271 (and (< (point) limit)
272 (c-got-face-at (point) c-literal-faces))))
273 t))
274
275 (defun c-make-syntactic-matcher (regexp)
276 ;; Returns a byte compiled function suitable for use in place of a
277 ;; regexp string in a `font-lock-keywords' matcher, except that
278 ;; only matches outside comments and string literals count.
279 ;;
280 ;; This function does not do any hidden buffer changes, but the
281 ;; generated functions will. (They are however used in places
282 ;; covered by the font-lock context.)
283 (byte-compile
284 `(lambda (limit)
285 (let (res)
286 (while (and (setq res (re-search-forward ,regexp limit t))
287 (progn
288 (goto-char (match-beginning 0))
289 (or (c-skip-comments-and-strings limit)
290 (progn
291 (goto-char (match-end 0))
292 nil)))))
293 res))))
294
295 (defun c-make-font-lock-search-form (regexp highlights)
296 ;; Return a lisp form which will fontify every occurrence of REGEXP
297 ;; (a regular expression, NOT a function) between POINT and `limit'
298 ;; with HIGHLIGHTS, a list of highlighters as specified on page
299 ;; "Search-based Fontification" in the elisp manual.
300 `(while (re-search-forward ,regexp limit t)
301 (unless (progn
302 (goto-char (match-beginning 0))
303 (c-skip-comments-and-strings limit))
304 (goto-char (match-end 0))
305 ,@(mapcar
306 (lambda (highlight)
307 (if (integerp (car highlight))
308 ;; e.g. highlight is (1 font-lock-type-face t)
309 (progn
310 (unless (eq (nth 2 highlight) t)
311 (error
312 "The override flag must currently be t in %s"
313 highlight))
314 (when (nth 3 highlight)
315 (error
316 "The laxmatch flag may currently not be set in %s"
317 highlight))
318 `(save-match-data
319 (c-put-font-lock-face
320 (match-beginning ,(car highlight))
321 (match-end ,(car highlight))
322 ,(elt highlight 1))))
323 ;; highlight is an "ANCHORED HIGHLIGHTER" of the form
324 ;; (ANCHORED-MATCHER PRE-FORM POST-FORM SUBEXP-HIGHLIGHTERS...)
325 (when (nth 3 highlight)
326 (error "Match highlights currently not supported in %s"
327 highlight))
328 `(progn
329 ,(nth 1 highlight)
330 (save-match-data ,(car highlight))
331 ,(nth 2 highlight))))
332 highlights))))
333
334 (defun c-make-font-lock-search-function (regexp &rest highlights)
335 ;; This function makes a byte compiled function that works much like
336 ;; a matcher element in `font-lock-keywords'. It cuts out a little
337 ;; bit of the overhead compared to a real matcher. The main reason
338 ;; is however to pass the real search limit to the anchored
339 ;; matcher(s), since most (if not all) font-lock implementations
340 ;; arbitrarily limit anchored matchers to the same line, and also
341 ;; to insulate against various other irritating differences between
342 ;; the different (X)Emacs font-lock packages.
343 ;;
344 ;; REGEXP is the matcher, which must be a regexp. Only matches
345 ;; where the beginning is outside any comment or string literal are
346 ;; significant.
347 ;;
348 ;; HIGHLIGHTS is a list of highlight specs, just like in
349 ;; `font-lock-keywords', with these limitations: The face is always
350 ;; overridden (no big disadvantage, since hits in comments etc are
351 ;; filtered anyway), there is no "laxmatch", and an anchored matcher
352 ;; is always a form which must do all the fontification directly.
353 ;; `limit' is a variable bound to the real limit in the context of
354 ;; the anchored matcher forms.
355 ;;
356 ;; This function does not do any hidden buffer changes, but the
357 ;; generated functions will. (They are however used in places
358 ;; covered by the font-lock context.)
359
360 ;; Note: Replace `byte-compile' with `eval' to debug the generated
361 ;; lambda more easily.
362 (byte-compile
363 `(lambda (limit)
364 (let ( ;; The font-lock package in Emacs is known to clobber
365 ;; `parse-sexp-lookup-properties' (when it exists).
366 (parse-sexp-lookup-properties
367 (cc-eval-when-compile
368 (boundp 'parse-sexp-lookup-properties))))
369 ,(c-make-font-lock-search-form regexp highlights))
370 nil)))
371
372 (defun c-make-font-lock-BO-decl-search-function (regexp &rest highlights)
373 ;; This function makes a byte compiled function that first moves back
374 ;; to the beginning of the current declaration (if any), then searches
375 ;; forward for matcher elements (as in `font-lock-keywords') and
376 ;; fontifies them.
377 ;;
378 ;; The motivation for moving back to the declaration start is to
379 ;; establish a context for the current text when, e.g., a character
380 ;; is typed on a C++ inheritance continuation line, or a jit-lock
381 ;; chunk starts there.
382 ;;
383 ;; The new function works much like a matcher element in
384 ;; `font-lock-keywords'. It cuts out a little bit of the overhead
385 ;; compared to a real matcher. The main reason is however to pass the
386 ;; real search limit to the anchored matcher(s), since most (if not
387 ;; all) font-lock implementations arbitrarily limit anchored matchers
388 ;; to the same line, and also to insulate against various other
389 ;; irritating differences between the different (X)Emacs font-lock
390 ;; packages.
391 ;;
392 ;; REGEXP is the matcher, which must be a regexp. Only matches
393 ;; where the beginning is outside any comment or string literal are
394 ;; significant.
395 ;;
396 ;; HIGHLIGHTS is a list of highlight specs, just like in
397 ;; `font-lock-keywords', with these limitations: The face is always
398 ;; overridden (no big disadvantage, since hits in comments etc are
399 ;; filtered anyway), there is no "laxmatch", and an anchored matcher
400 ;; is always a form which must do all the fontification directly.
401 ;; `limit' is a variable bound to the real limit in the context of
402 ;; the anchored matcher forms.
403 ;;
404 ;; This function does not do any hidden buffer changes, but the
405 ;; generated functions will. (They are however used in places
406 ;; covered by the font-lock context.)
407
408 ;; Note: Replace `byte-compile' with `eval' to debug the generated
409 ;; lambda more easily.
410 (byte-compile
411 `(lambda (limit)
412 (let ( ;; The font-lock package in Emacs is known to clobber
413 ;; `parse-sexp-lookup-properties' (when it exists).
414 (parse-sexp-lookup-properties
415 (cc-eval-when-compile
416 (boundp 'parse-sexp-lookup-properties)))
417 (BOD-limit
418 (c-determine-limit 1000)))
419 (goto-char
420 (let ((here (point)))
421 (if (eq (car (c-beginning-of-decl-1 BOD-limit)) 'same)
422 (point)
423 here)))
424 ,(c-make-font-lock-search-form regexp highlights))
425 nil)))
426
427 (defun c-make-font-lock-context-search-function (normal &rest state-stanzas)
428 ;; This function makes a byte compiled function that works much like
429 ;; a matcher element in `font-lock-keywords', with the following
430 ;; enhancement: the generated function will test for particular "font
431 ;; lock contexts" at the start of the region, i.e. is this point in
432 ;; the middle of some particular construct? if so the generated
433 ;; function will first fontify the tail of the construct, before
434 ;; going into the main loop and fontify full constructs up to limit.
435 ;;
436 ;; The generated function takes one parameter called `limit', and
437 ;; will fontify the region between POINT and LIMIT.
438 ;;
439 ;; NORMAL is a list of the form (REGEXP HIGHLIGHTS .....), and is
440 ;; used to fontify the "regular" bit of the region.
441 ;; STATE-STANZAS is list of elements of the form (STATE LIM REGEXP
442 ;; HIGHLIGHTS), each element coding one possible font lock context.
443
444 ;; o - REGEXP is a font-lock regular expression (NOT a function),
445 ;; o - HIGHLIGHTS is a list of zero or more highlighters as defined
446 ;; on page "Search-based Fontification" in the elisp manual. As
447 ;; yet (2009-06), they must have OVERRIDE set, and may not have
448 ;; LAXMATCH set.
449 ;;
450 ;; o - STATE is the "font lock context" (e.g. in-cpp-expr) and is
451 ;; not quoted.
452 ;; o - LIM is a lisp form whose evaluation will yield the limit
453 ;; position in the buffer for fontification by this stanza.
454 ;;
455 ;; This function does not do any hidden buffer changes, but the
456 ;; generated functions will. (They are however used in places
457 ;; covered by the font-lock context.)
458 ;;
459 ;; Note: Replace `byte-compile' with `eval' to debug the generated
460 ;; lambda more easily.
461 (byte-compile
462 `(lambda (limit)
463 (let ( ;; The font-lock package in Emacs is known to clobber
464 ;; `parse-sexp-lookup-properties' (when it exists).
465 (parse-sexp-lookup-properties
466 (cc-eval-when-compile
467 (boundp 'parse-sexp-lookup-properties))))
468 ,@(mapcar
469 (lambda (stanza)
470 (let ((state (car stanza))
471 (lim (nth 1 stanza))
472 (regexp (nth 2 stanza))
473 (highlights (cdr (cddr stanza))))
474 `(if (eq c-font-lock-context ',state)
475 (let ((limit ,lim))
476 ,(c-make-font-lock-search-form
477 regexp highlights)))))
478 state-stanzas)
479 ,(c-make-font-lock-search-form (car normal) (cdr normal))
480 nil))))
481
482 ; (eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
483 ; '(progn
484 (def-edebug-spec c-fontify-types-and-refs let*)
485 (def-edebug-spec c-make-syntactic-matcher t)
486 ;; If there are literal quoted or backquoted highlight specs in
487 ;; the call to `c-make-font-lock-search-function' then let's
488 ;; instrument the forms in them.
489 (def-edebug-spec c-make-font-lock-search-function
490 (form &rest &or ("quote" (&rest form)) ("`" (&rest form)) form)));))
491
492 (defun c-fontify-recorded-types-and-refs ()
493 ;; Convert the ranges recorded on `c-record-type-identifiers' and
494 ;; `c-record-ref-identifiers' to fontification.
495 ;;
496 ;; This function does hidden buffer changes.
497 (let (elem)
498 (while (consp c-record-type-identifiers)
499 (setq elem (car c-record-type-identifiers)
500 c-record-type-identifiers (cdr c-record-type-identifiers))
501 (c-put-font-lock-face (car elem) (cdr elem)
502 'font-lock-type-face))
503 (while c-record-ref-identifiers
504 (setq elem (car c-record-ref-identifiers)
505 c-record-ref-identifiers (cdr c-record-ref-identifiers))
506 ;; Note that the reference face is a variable that is
507 ;; dereferenced, since it's an alias in Emacs.
508 (c-put-font-lock-face (car elem) (cdr elem)
509 c-reference-face-name))))
510
511 (c-lang-defconst c-cpp-matchers
512 "Font lock matchers for preprocessor directives and purely lexical
513 stuff. Used on level 1 and higher."
514
515 ;; Note: `c-font-lock-declarations' assumes that no matcher here
516 ;; sets `font-lock-type-face' in languages where
517 ;; `c-recognize-<>-arglists' is set.
518
519 t `(,@(when (c-lang-const c-opt-cpp-prefix)
520 (let* ((noncontinued-line-end "\\(\\=\\|\\(\\=\\|[^\\]\\)[\n\r]\\)")
521 (ncle-depth (regexp-opt-depth noncontinued-line-end))
522 (sws-depth (c-lang-const c-syntactic-ws-depth))
523 (nsws-depth (c-lang-const c-nonempty-syntactic-ws-depth)))
524
525 `(;; The stuff after #error and #warning is a message, so
526 ;; fontify it as a string.
527 ,@(when (c-lang-const c-cpp-message-directives)
528 (let* ((re (c-make-keywords-re 'appendable ; nil
529 (c-lang-const c-cpp-message-directives)))
530 (re-depth (regexp-opt-depth re)))
531 `((,(concat noncontinued-line-end
532 (c-lang-const c-opt-cpp-prefix)
533 re
534 "\\s +\\(.*\\)$")
535 ,(+ ncle-depth re-depth 1) font-lock-string-face t))))
536
537 ;; Fontify filenames in #include <...> as strings.
538 ,@(when (c-lang-const c-cpp-include-directives)
539 (let* ((re (c-make-keywords-re nil
540 (c-lang-const c-cpp-include-directives)))
541 (re-depth (regexp-opt-depth re)))
542 ;; We used to use a font-lock "anchored matcher" here for
543 ;; the paren syntax. This failed when the ">" was at EOL,
544 ;; since `font-lock-fontify-anchored-keywords' terminated
545 ;; its loop at EOL without executing our lambda form at
546 ;; all.
547 `((,(c-make-font-lock-search-function
548 (concat noncontinued-line-end
549 (c-lang-const c-opt-cpp-prefix)
550 re
551 (c-lang-const c-syntactic-ws)
552 "\\(<[^>\n\r]*>?\\)")
553 `(,(+ ncle-depth re-depth sws-depth 1)
554 font-lock-string-face t)
555 `((let ((beg (match-beginning
556 ,(+ ncle-depth re-depth sws-depth 1)))
557 (end (1- (match-end ,(+ ncle-depth re-depth
558 sws-depth 1)))))
559 (if (eq (char-after end) ?>)
560 (progn
561 (c-mark-<-as-paren beg)
562 (c-mark->-as-paren end))
563 (c-unmark-<->-as-paren beg)))
564 nil))))))
565
566 ;; #define.
567 ,@(when (c-lang-const c-opt-cpp-macro-define)
568 `((,(c-make-font-lock-search-function
569 (concat
570 noncontinued-line-end
571 (c-lang-const c-opt-cpp-prefix)
572 (c-lang-const c-opt-cpp-macro-define)
573 (c-lang-const c-nonempty-syntactic-ws)
574 "\\(" (c-lang-const ; 1 + ncle + nsws
575 c-symbol-key) "\\)"
576 (concat "\\(" ; 2 + ncle + nsws + c-sym-key
577 ;; Macro with arguments - a "function".
578 "\\((\\)" ; 3 + ncle + nsws + c-sym-key
579 "\\|"
580 ;; Macro without arguments - a "variable".
581 "\\([^(]\\|$\\)"
582 "\\)"))
583 `((if (match-beginning
584 ,(+ 3 ncle-depth nsws-depth
585 (c-lang-const c-symbol-key-depth)))
586
587 ;; "Function". Fontify the name and the arguments.
588 (save-restriction
589 (c-put-font-lock-face
590 (match-beginning ,(+ 1 ncle-depth nsws-depth))
591 (match-end ,(+ 1 ncle-depth nsws-depth))
592 'font-lock-function-name-face)
593 (goto-char
594 (match-end
595 ,(+ 3 ncle-depth nsws-depth
596 (c-lang-const c-symbol-key-depth))))
597
598 (narrow-to-region (point-min) limit)
599 (while (and
600 (progn
601 (c-forward-syntactic-ws)
602 (looking-at c-symbol-key))
603 (progn
604 (c-put-font-lock-face
605 (match-beginning 0) (match-end 0)
606 'font-lock-variable-name-face)
607 (goto-char (match-end 0))
608 (c-forward-syntactic-ws)
609 (eq (char-after) ?,)))
610 (forward-char)))
611
612 ;; "Variable".
613 (c-put-font-lock-face
614 (match-beginning ,(+ 1 ncle-depth nsws-depth))
615 (match-end ,(+ 1 ncle-depth nsws-depth))
616 'font-lock-variable-name-face)))))))
617
618 ;; Fontify cpp function names in preprocessor
619 ;; expressions in #if and #elif.
620 ,@(when (and (c-lang-const c-cpp-expr-directives)
621 (c-lang-const c-cpp-expr-functions))
622 (let ((ced-re (c-make-keywords-re t
623 (c-lang-const c-cpp-expr-directives)))
624 (cef-re (c-make-keywords-re t
625 (c-lang-const c-cpp-expr-functions))))
626
627 `((,(c-make-font-lock-context-search-function
628 `(,(concat noncontinued-line-end
629 (c-lang-const c-opt-cpp-prefix)
630 ced-re ; 1 + ncle-depth
631 ;; Match the whole logical line to look
632 ;; for the functions in.
633 "\\(\\\\\\(.\\|[\n\r]\\)\\|[^\n\r]\\)*")
634 ((let ((limit (match-end 0)))
635 (while (re-search-forward ,cef-re limit 'move)
636 (c-put-font-lock-face (match-beginning 1)
637 (match-end 1)
638 c-preprocessor-face-name)))
639 (goto-char (match-end ,(1+ ncle-depth)))))
640 `(in-cpp-expr
641 (save-excursion (c-end-of-macro) (point))
642 ,cef-re
643 (1 c-preprocessor-face-name t)))))))
644
645 ;; Fontify the directive names.
646 (,(c-make-font-lock-search-function
647 (concat noncontinued-line-end
648 "\\("
649 (c-lang-const c-opt-cpp-prefix)
650 "[" (c-lang-const c-symbol-chars) "]+"
651 "\\)")
652 `(,(1+ ncle-depth) c-preprocessor-face-name t)))
653
654 (eval . (list ,(c-make-syntactic-matcher
655 (concat noncontinued-line-end
656 (c-lang-const c-opt-cpp-prefix)
657 "if\\(n\\)def\\>"))
658 ,(+ ncle-depth 1)
659 c-negation-char-face-name
660 'append))
661 )))
662
663 ,@(when (c-major-mode-is 'pike-mode)
664 ;; Recognize hashbangs in Pike.
665 `((eval . (list "\\`#![^\n\r]*"
666 0 c-preprocessor-face-name))))
667
668 ;; Make hard spaces visible through an inverted `font-lock-warning-face'.
669 (eval . (list
670 "\240"
671 0 (progn
672 (unless (c-face-name-p 'c-nonbreakable-space-face)
673 (c-make-inverse-face 'font-lock-warning-face
674 'c-nonbreakable-space-face))
675 ''c-nonbreakable-space-face)))
676 ))
677
678 (defun c-font-lock-invalid-string ()
679 ;; Assuming the point is after the opening character of a string,
680 ;; fontify that char with `font-lock-warning-face' if the string
681 ;; decidedly isn't terminated properly.
682 ;;
683 ;; This function does hidden buffer changes.
684 (let ((start (1- (point))))
685 (save-excursion
686 (and (eq (elt (parse-partial-sexp start (c-point 'eol)) 8) start)
687 (if (if (eval-when-compile (integerp ?c))
688 ;; Emacs
689 (integerp c-multiline-string-start-char)
690 ;; XEmacs
691 (characterp c-multiline-string-start-char))
692 ;; There's no multiline string start char before the
693 ;; string, so newlines aren't allowed.
694 (not (eq (char-before start) c-multiline-string-start-char))
695 ;; Multiline strings are allowed anywhere if
696 ;; c-multiline-string-start-char is t.
697 (not c-multiline-string-start-char))
698 (if c-string-escaped-newlines
699 ;; There's no \ before the newline.
700 (not (eq (char-before (point)) ?\\))
701 ;; Escaped newlines aren't supported.
702 t)
703 (c-put-font-lock-face start (1+ start) 'font-lock-warning-face)))))
704
705 (c-lang-defconst c-basic-matchers-before
706 "Font lock matchers for basic keywords, labels, references and various
707 other easily recognizable things that should be fontified before generic
708 casts and declarations are fontified. Used on level 2 and higher."
709
710 ;; Note: `c-font-lock-declarations' assumes that no matcher here
711 ;; sets `font-lock-type-face' in languages where
712 ;; `c-recognize-<>-arglists' is set.
713
714 t `(;; Put a warning face on the opener of unclosed strings that
715 ;; can't span lines. Later font
716 ;; lock packages have a `font-lock-syntactic-face-function' for
717 ;; this, but it doesn't give the control we want since any
718 ;; fontification done inside the function will be
719 ;; unconditionally overridden.
720 ,(c-make-font-lock-search-function
721 ;; Match a char before the string starter to make
722 ;; `c-skip-comments-and-strings' work correctly.
723 (concat ".\\(" c-string-limit-regexp "\\)")
724 '((c-font-lock-invalid-string)))
725
726 ;; Fontify C++ raw strings.
727 ,@(when (c-major-mode-is 'c++-mode)
728 '(c-font-lock-raw-strings))
729
730 ;; Fontify keyword constants.
731 ,@(when (c-lang-const c-constant-kwds)
732 (let ((re (c-make-keywords-re nil (c-lang-const c-constant-kwds))))
733 (if (c-major-mode-is 'pike-mode)
734 ;; No symbol is a keyword after "->" in Pike.
735 `((eval . (list ,(concat "\\(\\=.?\\|[^>]\\|[^-]>\\)"
736 "\\<\\(" re "\\)\\>")
737 2 c-constant-face-name)))
738 `((eval . (list ,(concat "\\<\\(" re "\\)\\>")
739 1 c-constant-face-name))))))
740
741 ;; Fontify all keywords except the primitive types.
742 ,(if (c-major-mode-is 'pike-mode)
743 ;; No symbol is a keyword after "->" in Pike.
744 `(,(concat "\\(\\=.?\\|[^>]\\|[^-]>\\)"
745 "\\<" (c-lang-const c-regular-keywords-regexp))
746 2 font-lock-keyword-face)
747 `(,(concat "\\<" (c-lang-const c-regular-keywords-regexp))
748 1 font-lock-keyword-face))
749
750 ;; Fontify leading identifiers in fully qualified names like
751 ;; "foo::bar" in languages that supports such things.
752 ,@(when (c-lang-const c-opt-identifier-concat-key)
753 (if (c-major-mode-is 'java-mode)
754 ;; Java needs special treatment since "." is used both to
755 ;; qualify names and in normal indexing. Here we look for
756 ;; capital characters at the beginning of an identifier to
757 ;; recognize the class. "*" is also recognized to cover
758 ;; wildcard import declarations. All preceding dot separated
759 ;; identifiers are taken as package names and therefore
760 ;; fontified as references.
761 `(,(c-make-font-lock-search-function
762 ;; Search for class identifiers preceded by ".". The
763 ;; anchored matcher takes it from there.
764 (concat (c-lang-const c-opt-identifier-concat-key)
765 (c-lang-const c-simple-ws) "*"
766 (concat "\\("
767 "[" c-upper "]"
768 "[" (c-lang-const c-symbol-chars) "]*"
769 "\\|"
770 "\\*"
771 "\\)"))
772 `((let (id-end)
773 (goto-char (1+ (match-beginning 0)))
774 (while (and (eq (char-before) ?.)
775 (progn
776 (backward-char)
777 (c-backward-syntactic-ws)
778 (setq id-end (point))
779 (< (skip-chars-backward
780 ,(c-lang-const c-symbol-chars)) 0))
781 (not (get-text-property (point) 'face)))
782 (c-put-font-lock-face (point) id-end
783 c-reference-face-name)
784 (c-backward-syntactic-ws)))
785 nil
786 (goto-char (match-end 0)))))
787
788 `((,(byte-compile
789 ;; Must use a function here since we match longer than
790 ;; we want to move before doing a new search. This is
791 ;; not necessary for XEmacs since it restarts the
792 ;; search from the end of the first highlighted
793 ;; submatch (something that causes problems in other
794 ;; places).
795 `(lambda (limit)
796 (while (re-search-forward
797 ,(concat "\\(\\<" ; 1
798 "\\(" (c-lang-const c-symbol-key) "\\)" ; 2
799 (c-lang-const c-simple-ws) "*"
800 (c-lang-const c-opt-identifier-concat-key)
801 (c-lang-const c-simple-ws) "*"
802 "\\)"
803 "\\("
804 (c-lang-const c-opt-after-id-concat-key)
805 "\\)")
806 limit t)
807 (unless (progn
808 (goto-char (match-beginning 0))
809 (c-skip-comments-and-strings limit))
810 (or (get-text-property (match-beginning 2) 'face)
811 (c-put-font-lock-face (match-beginning 2)
812 (match-end 2)
813 c-reference-face-name))
814 (goto-char (match-end 1))))))))))
815
816 ;; Fontify the special declarations in Objective-C.
817 ,@(when (c-major-mode-is 'objc-mode)
818 `(;; Fontify class names in the beginning of message expressions.
819 ,(c-make-font-lock-search-function
820 "\\["
821 '((c-fontify-types-and-refs ()
822 (c-forward-syntactic-ws limit)
823 (let ((start (point)))
824 ;; In this case we accept both primitive and known types.
825 (when (eq (c-forward-type) 'known)
826 (goto-char start)
827 (let ((c-promote-possible-types t))
828 (c-forward-type))))
829 (if (> (point) limit) (goto-char limit)))))
830
831 ;; The @interface/@implementation/@protocol directives.
832 ,(c-make-font-lock-search-function
833 (concat "\\<"
834 (regexp-opt
835 '("@interface" "@implementation" "@protocol")
836 t)
837 "\\>")
838 '((c-fontify-types-and-refs
839 (;; The font-lock package in Emacs is known to clobber
840 ;; `parse-sexp-lookup-properties' (when it exists).
841 (parse-sexp-lookup-properties
842 (cc-eval-when-compile
843 (boundp 'parse-sexp-lookup-properties))))
844 (c-forward-objc-directive)
845 nil)
846 (goto-char (match-beginning 0))))))
847
848 (eval . (list "\\(!\\)[^=]" 1 c-negation-char-face-name))
849 ))
850
851 (defun c-font-lock-complex-decl-prepare (limit)
852 ;; This function will be called from font-lock for a region bounded by POINT
853 ;; and LIMIT, as though it were to identify a keyword for
854 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
855 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
856 ;; Fontification".
857 ;;
858 ;; Called before any of the matchers in `c-complex-decl-matchers'.
859 ;;
860 ;; This function does hidden buffer changes.
861
862 ;;(message "c-font-lock-complex-decl-prepare %s %s" (point) limit)
863
864 ;; Clear the list of found types if we start from the start of the
865 ;; buffer, to make it easier to get rid of misspelled types and
866 ;; variables that have gotten recognized as types in malformed code.
867 (when (bobp)
868 (c-clear-found-types))
869
870 ;; Clear the c-type char properties which mark the region, to recalculate
871 ;; them properly. The most interesting properties are those put on the
872 ;; closest token before the region.
873 (save-excursion
874 (let ((pos (point)))
875 (c-backward-syntactic-ws)
876 (c-clear-char-properties
877 (if (and (not (bobp))
878 (memq (c-get-char-property (1- (point)) 'c-type)
879 '(c-decl-arg-start
880 c-decl-end
881 c-decl-id-start
882 c-decl-type-start)))
883 (1- (point))
884 pos)
885 limit 'c-type)))
886
887 ;; Update `c-state-cache' to the beginning of the region. This will
888 ;; make `c-beginning-of-syntax' go faster when it's used later on,
889 ;; and it's near the point most of the time.
890 (c-parse-state)
891
892 ;; Check if the fontified region starts inside a declarator list so
893 ;; that `c-font-lock-declarators' should be called at the start.
894 ;; The declared identifiers are font-locked correctly as types, if
895 ;; that is what they are.
896 (let ((prop (save-excursion
897 (c-backward-syntactic-ws)
898 (unless (bobp)
899 (c-get-char-property (1- (point)) 'c-type)))))
900 (when (memq prop '(c-decl-id-start c-decl-type-start))
901 (c-forward-syntactic-ws limit)
902 (c-font-lock-declarators limit t (eq prop 'c-decl-type-start))))
903
904 (setq c-font-lock-context ;; (c-guess-font-lock-context)
905 (save-excursion
906 (if (and c-cpp-expr-intro-re
907 (c-beginning-of-macro)
908 (looking-at c-cpp-expr-intro-re))
909 'in-cpp-expr)))
910 nil)
911
912 (defun c-font-lock-<>-arglists (limit)
913 ;; This function will be called from font-lock for a region bounded by POINT
914 ;; and LIMIT, as though it were to identify a keyword for
915 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
916 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
917 ;; Fontification".
918 ;;
919 ;; Fontify types and references in names containing angle bracket
920 ;; arglists from the point to LIMIT. Note that
921 ;; `c-font-lock-declarations' has already handled many of them.
922 ;;
923 ;; This function might do hidden buffer changes.
924
925 (let (;; The font-lock package in Emacs is known to clobber
926 ;; `parse-sexp-lookup-properties' (when it exists).
927 (parse-sexp-lookup-properties
928 (cc-eval-when-compile
929 (boundp 'parse-sexp-lookup-properties)))
930 (c-parse-and-markup-<>-arglists t)
931 c-restricted-<>-arglists
932 id-start id-end id-face pos kwd-sym)
933
934 (while (and (< (point) limit)
935 (re-search-forward c-opt-<>-arglist-start limit t))
936
937 (setq id-start (match-beginning 1)
938 id-end (match-end 1)
939 pos (point))
940
941 (goto-char id-start)
942 (unless (c-skip-comments-and-strings limit)
943 (setq kwd-sym nil
944 c-restricted-<>-arglists nil
945 id-face (get-text-property id-start 'face))
946
947 (if (cond
948 ((eq id-face 'font-lock-type-face)
949 ;; The identifier got the type face so it has already been
950 ;; handled in `c-font-lock-declarations'.
951 nil)
952
953 ((eq id-face 'font-lock-keyword-face)
954 (when (looking-at c-opt-<>-sexp-key)
955 ;; There's a special keyword before the "<" that tells
956 ;; that it's an angle bracket arglist.
957 (setq kwd-sym (c-keyword-sym (match-string 1)))))
958
959 (t
960 ;; There's a normal identifier before the "<". If we're not in
961 ;; a declaration context then we set `c-restricted-<>-arglists'
962 ;; to avoid recognizing templates in function calls like "foo (a
963 ;; < b, c > d)".
964 (c-backward-syntactic-ws)
965 (when (and (memq (char-before) '(?\( ?,))
966 (not (eq (get-text-property (1- (point)) 'c-type)
967 'c-decl-arg-start)))
968 (setq c-restricted-<>-arglists t))
969 t))
970
971 (progn
972 (goto-char (1- pos))
973 ;; Check for comment/string both at the identifier and
974 ;; at the "<".
975 (unless (c-skip-comments-and-strings limit)
976
977 (c-fontify-types-and-refs ()
978 (when (c-forward-<>-arglist (c-keyword-member
979 kwd-sym 'c-<>-type-kwds))
980 (when (and c-opt-identifier-concat-key
981 (not (get-text-property id-start 'face)))
982 (c-forward-syntactic-ws)
983 (cond ((looking-at c-opt-identifier-concat-key)
984 (c-put-font-lock-face id-start id-end
985 c-reference-face-name))
986 ((eq (char-after) ?\())
987 (t (c-put-font-lock-face id-start id-end
988 'font-lock-type-face))))))
989
990 (goto-char pos)))
991 (goto-char pos)))))
992 nil)
993
994 (defun c-font-lock-declarators (limit list types)
995 ;; Assuming the point is at the start of a declarator in a declaration,
996 ;; fontify the identifier it declares. (If TYPES is set, it does this via
997 ;; the macro `c-fontify-types-and-refs'.)
998 ;;
999 ;; If LIST is non-nil, also fontify the ids in any following declarators in
1000 ;; a comma separated list (e.g. "foo" and "*bar" in "int foo = 17, *bar;");
1001 ;; additionally, mark the commas with c-type property 'c-decl-id-start or
1002 ;; 'c-decl-type-start (according to TYPES). Stop at LIMIT.
1003 ;;
1004 ;; If TYPES is non-nil, fontify all identifiers as types.
1005 ;;
1006 ;; Nil is always returned. The function leaves point at the delimiter after
1007 ;; the last declarator it processes.
1008 ;;
1009 ;; This function might do hidden buffer changes.
1010
1011 ;;(message "c-font-lock-declarators from %s to %s" (point) limit)
1012 (c-fontify-types-and-refs
1013 ((pos (point)) next-pos id-start id-end
1014 decl-res
1015 paren-depth
1016 id-face got-type got-init
1017 c-last-identifier-range
1018 (separator-prop (if types 'c-decl-type-start 'c-decl-id-start))
1019 brackets-after-id)
1020
1021 ;; The following `while' fontifies a single declarator id each time round.
1022 ;; It loops only when LIST is non-nil.
1023 (while
1024 (and pos (setq decl-res (c-forward-declarator limit)))
1025 (setq next-pos (point)
1026 id-start (car decl-res)
1027 id-face (if (and (eq (char-after) ?\()
1028 (not (car (cddr decl-res))) ; brackets-after-id
1029 (or (not (c-major-mode-is 'c++-mode))
1030 (save-excursion
1031 (let (c-last-identifier-range)
1032 (forward-char)
1033 (c-forward-syntactic-ws)
1034 (catch 'is-function
1035 (while
1036 (progn
1037 (if (eq (char-after) ?\))
1038 (throw 'is-function t))
1039 (setq got-type (c-forward-type))
1040 (cond
1041 ((null got-type)
1042 (throw 'is-function nil))
1043 ((not (eq got-type 'maybe))
1044 (throw 'is-function t)))
1045 (c-forward-declarator limit t)
1046 (eq (char-after) ?,))
1047 (forward-char)
1048 (c-forward-syntactic-ws))
1049 t)))))
1050 'font-lock-function-name-face
1051 'font-lock-variable-name-face)
1052 got-init (and (cadr (cddr decl-res)) ; got-init
1053 (char-after)))
1054
1055 (if types
1056 ;; Register and fontify the identifier as a type.
1057 (let ((c-promote-possible-types t))
1058 (goto-char id-start)
1059 (c-forward-type))
1060 ;; Fontify the last symbol in the identifier if it isn't fontified
1061 ;; already. The check is necessary only in certain cases where this
1062 ;; function is used "sloppily", e.g. in `c-simple-decl-matchers'.
1063 (when (and c-last-identifier-range
1064 (not (get-text-property (car c-last-identifier-range)
1065 'face)))
1066 (c-put-font-lock-face (car c-last-identifier-range)
1067 (cdr c-last-identifier-range)
1068 id-face)))
1069
1070 (goto-char next-pos)
1071 (setq pos nil) ; So as to terminate the enclosing `while' form.
1072 (when list
1073 ;; Jump past any initializer or function prototype to see if
1074 ;; there's a ',' to continue at.
1075 (cond ((eq id-face 'font-lock-function-name-face)
1076 ;; Skip a parenthesized initializer (C++) or a function
1077 ;; prototype.
1078 (if (c-safe (c-forward-sexp 1) t) ; over the parameter list.
1079 (c-forward-syntactic-ws limit)
1080 (goto-char limit))) ; unbalanced parens
1081
1082 (got-init ; "=" sign OR opening "(", "[", or "{"
1083 ;; Skip an initializer expression. If we're at a '='
1084 ;; then accept a brace list directly after it to cope
1085 ;; with array initializers. Otherwise stop at braces
1086 ;; to avoid going past full function and class blocks.
1087 (and (if (and (eq got-init ?=)
1088 (= (c-forward-token-2 1 nil limit) 0)
1089 (looking-at "{"))
1090 (c-safe (c-forward-sexp) t) ; over { .... }
1091 t)
1092 (< (point) limit)
1093 ;; FIXME: Should look for c-decl-end markers here;
1094 ;; we might go far into the following declarations
1095 ;; in e.g. ObjC mode (see e.g. methods-4.m).
1096 (c-syntactic-re-search-forward "[;,{]" limit 'move t)
1097 (backward-char)))
1098
1099 (t (c-forward-syntactic-ws limit)))
1100
1101 ;; If a ',' is found we set pos to the next declarator and iterate.
1102 (when (and (< (point) limit) (looking-at ","))
1103 (c-put-char-property (point) 'c-type separator-prop)
1104 (forward-char)
1105 (c-forward-syntactic-ws limit)
1106 (setq pos (point)))))) ; acts to make the `while' form continue.
1107 nil)
1108
1109 (defun c-font-lock-declarations (limit)
1110 ;; Fontify all the declarations, casts and labels from the point to LIMIT.
1111 ;; Assumes that strings and comments have been fontified already.
1112 ;;
1113 ;; This function will be called from font-lock for a region bounded by POINT
1114 ;; and LIMIT, as though it were to identify a keyword for
1115 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
1116 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
1117 ;; Fontification".
1118 ;;
1119 ;; This function might do hidden buffer changes.
1120
1121 ;;(message "c-font-lock-declarations search from %s to %s" (point) limit)
1122
1123 (save-restriction
1124 (let (;; The position where `c-find-decl-spots' last stopped.
1125 start-pos
1126 ;; o - 'decl if we're in an arglist containing declarations
1127 ;; (but if `c-recognize-paren-inits' is set it might also be
1128 ;; an initializer arglist);
1129 ;; o - '<> if the arglist is of angle bracket type;
1130 ;; o - 'arglist if it's some other arglist;
1131 ;; o - nil, if not in an arglist at all. This includes the
1132 ;; parenthesized condition which follows "if", "while", etc.
1133 context
1134 ;; A list of starting positions of possible type declarations, or of
1135 ;; the typedef preceding one, if any.
1136 last-cast-end
1137 ;; The result from `c-forward-decl-or-cast-1'.
1138 decl-or-cast
1139 ;; The maximum of the end positions of all the checked type
1140 ;; decl expressions in the successfully identified
1141 ;; declarations. The position might be either before or
1142 ;; after the syntactic whitespace following the last token
1143 ;; in the type decl expression.
1144 (max-type-decl-end 0)
1145 ;; Same as `max-type-decl-*', but used when we're before
1146 ;; `token-pos'.
1147 (max-type-decl-end-before-token 0)
1148 ;; End of <..> construct which has had c-<>-arg-sep c-type
1149 ;; properties set within it.
1150 (max-<>-end 0)
1151 ;; Set according to the context to direct the heuristics for
1152 ;; recognizing C++ templates.
1153 c-restricted-<>-arglists
1154 ;; Turn on recording of identifier ranges in
1155 ;; `c-forward-decl-or-cast-1' and `c-forward-label' for
1156 ;; later fontification.
1157 (c-record-type-identifiers t)
1158 label-type
1159 c-record-ref-identifiers
1160 ;; Make `c-forward-type' calls mark up template arglists if
1161 ;; it finds any. That's necessary so that we later will
1162 ;; stop inside them to fontify types there.
1163 (c-parse-and-markup-<>-arglists t)
1164 lbrace ; position of some {.
1165 ;; The font-lock package in Emacs is known to clobber
1166 ;; `parse-sexp-lookup-properties' (when it exists).
1167 (parse-sexp-lookup-properties
1168 (cc-eval-when-compile
1169 (boundp 'parse-sexp-lookup-properties))))
1170
1171 ;; Below we fontify a whole declaration even when it crosses the limit,
1172 ;; to avoid gaps when jit/lazy-lock fontifies the file a block at a
1173 ;; time. That is however annoying during editing, e.g. the following is
1174 ;; a common situation while the first line is being written:
1175 ;;
1176 ;; my_variable
1177 ;; some_other_variable = 0;
1178 ;;
1179 ;; font-lock will put the limit at the beginning of the second line
1180 ;; here, and if we go past it we'll fontify "my_variable" as a type and
1181 ;; "some_other_variable" as an identifier, and the latter will not
1182 ;; correct itself until the second line is changed. To avoid that we
1183 ;; narrow to the limit if the region to fontify is a single line.
1184 (if (<= limit (c-point 'bonl))
1185 (narrow-to-region
1186 (point-min)
1187 (save-excursion
1188 ;; Narrow after any operator chars following the limit though,
1189 ;; since those characters can be useful in recognizing a
1190 ;; declaration (in particular the '{' that opens a function body
1191 ;; after the header).
1192 (goto-char limit)
1193 (skip-chars-forward c-nonsymbol-chars)
1194 (point))))
1195
1196 (c-find-decl-spots
1197 limit
1198 c-decl-start-re
1199 (eval c-maybe-decl-faces)
1200
1201 (lambda (match-pos inside-macro)
1202 ;; Note to maintainers: don't use `limit' inside this lambda form;
1203 ;; c-find-decl-spots sometimes narrows to less than `limit'.
1204 (setq start-pos (point))
1205 (when
1206 ;; The result of the form below is true when we don't recognize a
1207 ;; declaration or cast.
1208 (if (or (and (eq (get-text-property (point) 'face)
1209 'font-lock-keyword-face)
1210 (looking-at c-not-decl-init-keywords))
1211 (and c-macro-with-semi-re
1212 (looking-at c-macro-with-semi-re))) ; 2008-11-04
1213 ;; Don't do anything more if we're looking at a keyword that
1214 ;; can't start a declaration.
1215 t
1216
1217 ;; Set `context' and `c-restricted-<>-arglists'. Look for
1218 ;; "<" for the sake of C++-style template arglists.
1219 ;; Ignore "(" when it's part of a control flow construct
1220 ;; (e.g. "for (").
1221 (let ((type (and (> match-pos (point-min))
1222 (c-get-char-property (1- match-pos) 'c-type))))
1223 (cond ((not (memq (char-before match-pos) '(?\( ?, ?\[ ?<)))
1224 (setq context nil
1225 c-restricted-<>-arglists nil))
1226 ;; A control flow expression or a decltype
1227 ((and (eq (char-before match-pos) ?\()
1228 (save-excursion
1229 (goto-char match-pos)
1230 (backward-char)
1231 (c-backward-token-2)
1232 (or (looking-at c-block-stmt-2-key)
1233 (looking-at c-block-stmt-1-2-key)
1234 (looking-at c-typeof-key))))
1235 (setq context nil
1236 c-restricted-<>-arglists t))
1237 ;; Near BOB.
1238 ((<= match-pos (point-min))
1239 (setq context 'arglist
1240 c-restricted-<>-arglists t))
1241 ;; Got a cached hit in a declaration arglist.
1242 ((eq type 'c-decl-arg-start)
1243 (setq context 'decl
1244 c-restricted-<>-arglists nil))
1245 ;; Inside an angle bracket arglist.
1246 ((or (eq type 'c-<>-arg-sep)
1247 (eq (char-before match-pos) ?<))
1248 (setq context '<>
1249 c-restricted-<>-arglists nil))
1250 ;; Got a cached hit in some other type of arglist.
1251 (type
1252 (setq context 'arglist
1253 c-restricted-<>-arglists t))
1254 ((if inside-macro
1255 (< match-pos max-type-decl-end-before-token)
1256 (< match-pos max-type-decl-end))
1257 ;; The point is within the range of a previously
1258 ;; encountered type decl expression, so the arglist
1259 ;; is probably one that contains declarations.
1260 ;; However, if `c-recognize-paren-inits' is set it
1261 ;; might also be an initializer arglist.
1262 (setq context 'decl
1263 c-restricted-<>-arglists nil)
1264 ;; The result of this check is cached with a char
1265 ;; property on the match token, so that we can look
1266 ;; it up again when refontifying single lines in a
1267 ;; multiline declaration.
1268 (c-put-char-property (1- match-pos)
1269 'c-type 'c-decl-arg-start))
1270 (t (setq context 'arglist
1271 c-restricted-<>-arglists t))))
1272
1273 ;; Check we haven't missed a preceding "typedef".
1274 (when (not (looking-at c-typedef-key))
1275 (c-backward-syntactic-ws)
1276 (c-backward-token-2)
1277 (or (looking-at c-typedef-key)
1278 (goto-char start-pos)))
1279
1280 ;; In QT, "more" is an irritating keyword that expands to nothing.
1281 ;; We skip over it to prevent recognition of "more slots: <symbol>"
1282 ;; as a bitfield declaration.
1283 (when (and (c-major-mode-is 'c++-mode)
1284 (looking-at
1285 (concat "\\(more\\)\\([^" c-symbol-chars "]\\|$\\)")))
1286 (goto-char (match-end 1))
1287 (c-forward-syntactic-ws))
1288
1289 ;; Now analyze the construct.
1290 (setq decl-or-cast (c-forward-decl-or-cast-1
1291 match-pos context last-cast-end))
1292
1293 ;; Ensure that c-<>-arg-sep c-type properties are in place on the
1294 ;; commas separating the arguments inside template/generic <..>s.
1295 (when (and (eq (char-before match-pos) ?<)
1296 (> match-pos max-<>-end))
1297 (save-excursion
1298 (goto-char match-pos)
1299 (c-backward-token-2)
1300 (if (and
1301 (eq (char-after) ?<)
1302 (let ((c-restricted-<>-arglists
1303 (save-excursion
1304 (c-backward-token-2)
1305 (and
1306 (not (looking-at c-opt-<>-sexp-key))
1307 (progn (c-backward-syntactic-ws)
1308 (memq (char-before) '(?\( ?,)))
1309 (not (eq (c-get-char-property (1- (point))
1310 'c-type)
1311 'c-decl-arg-start))))))
1312 (c-forward-<>-arglist nil)))
1313 (setq max-<>-end (point)))))
1314
1315 (cond
1316 ((eq decl-or-cast 'cast)
1317 ;; Save the position after the previous cast so we can feed
1318 ;; it to `c-forward-decl-or-cast-1' in the next round. That
1319 ;; helps it discover cast chains like "(a) (b) c".
1320 (setq last-cast-end (point))
1321 (c-fontify-recorded-types-and-refs)
1322 nil)
1323
1324 (decl-or-cast
1325 ;; We've found a declaration.
1326
1327 ;; Set `max-type-decl-end' or `max-type-decl-end-before-token'
1328 ;; under the assumption that we're after the first type decl
1329 ;; expression in the declaration now. That's not really true;
1330 ;; we could also be after a parenthesized initializer
1331 ;; expression in C++, but this is only used as a last resort
1332 ;; to slant ambiguous expression/declarations, and overall
1333 ;; it's worth the risk to occasionally fontify an expression
1334 ;; as a declaration in an initializer expression compared to
1335 ;; getting ambiguous things in normal function prototypes
1336 ;; fontified as expressions.
1337 (if inside-macro
1338 (when (> (point) max-type-decl-end-before-token)
1339 (setq max-type-decl-end-before-token (point)))
1340 (when (> (point) max-type-decl-end)
1341 (setq max-type-decl-end (point))))
1342
1343 ;; Do we have an expression as the second or third clause of
1344 ;; a "for" paren expression?
1345 (if (save-excursion
1346 (and
1347 (car (cddr decl-or-cast)) ; maybe-expression flag.
1348 (goto-char start-pos)
1349 (c-go-up-list-backward)
1350 (eq (char-after) ?\()
1351 (progn (c-backward-syntactic-ws)
1352 (c-simple-skip-symbol-backward))
1353 (looking-at c-paren-stmt-key)
1354 (progn (goto-char match-pos)
1355 (while (and (eq (char-before) ?\))
1356 (c-go-list-backward))
1357 (c-backward-syntactic-ws))
1358 (eq (char-before) ?\;))))
1359 ;; We've got an expression in "for" parens. Remove the
1360 ;; "type" that would spuriously get fontified.
1361 (let ((elt (and (consp c-record-type-identifiers)
1362 (assq (cadr (cddr decl-or-cast))
1363 c-record-type-identifiers))))
1364 (when elt
1365 (setq c-record-type-identifiers
1366 (c-delq-from-dotted-list
1367 elt c-record-type-identifiers)))
1368 t)
1369 ;; Back up to the type to fontify the declarator(s).
1370 (goto-char (car decl-or-cast))
1371
1372 (let ((decl-list
1373 (if context
1374 ;; Should normally not fontify a list of
1375 ;; declarators inside an arglist, but the first
1376 ;; argument in the ';' separated list of a "for"
1377 ;; statement is an exception.
1378 (when (eq (char-before match-pos) ?\()
1379 (save-excursion
1380 (goto-char (1- match-pos))
1381 (c-backward-syntactic-ws)
1382 (and (c-simple-skip-symbol-backward)
1383 (looking-at c-paren-stmt-key))))
1384 t)))
1385
1386 ;; Fix the `c-decl-id-start' or `c-decl-type-start' property
1387 ;; before the first declarator if it's a list.
1388 ;; `c-font-lock-declarators' handles the rest.
1389 (when decl-list
1390 (save-excursion
1391 (c-backward-syntactic-ws)
1392 (unless (bobp)
1393 (c-put-char-property (1- (point)) 'c-type
1394 (if (cadr decl-or-cast)
1395 'c-decl-type-start
1396 'c-decl-id-start)))))
1397
1398 (c-font-lock-declarators
1399 (min limit (point-max)) decl-list (cadr decl-or-cast)))
1400
1401 ;; A declaration has been successfully identified, so do all the
1402 ;; fontification of types and refs that've been recorded.
1403 (c-fontify-recorded-types-and-refs)
1404 nil))
1405
1406 (t t)))
1407
1408 ;; It was a false alarm. Check if we're in a label (or other
1409 ;; construct with `:' except bitfield) instead.
1410 (goto-char start-pos)
1411 (when (setq label-type (c-forward-label t match-pos nil))
1412 ;; Can't use `c-fontify-types-and-refs' here since we
1413 ;; use the label face at times.
1414 (cond ((eq label-type 'goto-target)
1415 (c-put-font-lock-face (caar c-record-ref-identifiers)
1416 (cdar c-record-ref-identifiers)
1417 c-label-face-name))
1418 ((eq label-type 'qt-1kwd-colon)
1419 (c-put-font-lock-face (caar c-record-ref-identifiers)
1420 (cdar c-record-ref-identifiers)
1421 'font-lock-keyword-face))
1422 ((eq label-type 'qt-2kwds-colon)
1423 (mapc
1424 (lambda (kwd)
1425 (c-put-font-lock-face (car kwd) (cdr kwd)
1426 'font-lock-keyword-face))
1427 c-record-ref-identifiers)))
1428 (setq c-record-ref-identifiers nil)
1429 ;; `c-forward-label' has probably added a `c-decl-end'
1430 ;; marker, so return t to `c-find-decl-spots' to signal
1431 ;; that.
1432 t))))
1433
1434 nil)))
1435
1436 (defun c-font-lock-enum-tail (limit)
1437 ;; Fontify an enum's identifiers when POINT is within the enum's brace
1438 ;; block.
1439 ;;
1440 ;; This function will be called from font-lock for a region bounded by POINT
1441 ;; and LIMIT, as though it were to identify a keyword for
1442 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
1443 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
1444 ;; Fontification".
1445 ;;
1446 ;; Note that this function won't attempt to fontify beyond the end of the
1447 ;; current enum block, if any.
1448 (let* ((paren-state (c-parse-state))
1449 (encl-pos (c-most-enclosing-brace paren-state)))
1450 (when (and
1451 encl-pos
1452 (eq (char-after encl-pos) ?\{)
1453 (save-excursion
1454 (goto-char encl-pos)
1455 (c-backward-over-enum-header)))
1456 (c-syntactic-skip-backward "^{," nil t)
1457 (c-put-char-property (1- (point)) 'c-type 'c-decl-id-start)
1458
1459 (c-forward-syntactic-ws)
1460 (c-font-lock-declarators limit t nil)))
1461 nil)
1462
1463 (defun c-font-lock-cut-off-declarators (limit)
1464 ;; Fontify any declarators "cut off" from their declaring type at the start
1465 ;; of the region being fontified.
1466 ;;
1467 ;; This function will be called from font-lock- for a region bounded by
1468 ;; POINT and LIMIT, as though it were to identify a keyword for
1469 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
1470 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
1471 ;; fontification".
1472 (let ((decl-search-lim (c-determine-limit 1000))
1473 paren-state bod-res is-typedef encl-pos
1474 c-recognize-knr-p) ; Strictly speaking, bogus, but it
1475 ; speeds up lisp.h tremendously.
1476 (save-excursion
1477 (when (not (c-back-over-member-initializers))
1478 (unless (or (eobp)
1479 (looking-at "\\s(\\|\\s)"))
1480 (forward-char))
1481 (c-syntactic-skip-backward "^;{}" decl-search-lim t)
1482 (when (eq (char-before) ?})
1483 (c-go-list-backward) ; brace block of struct, etc.?
1484 (c-syntactic-skip-backward "^;{}" decl-search-lim t))
1485 (when (or (bobp)
1486 (memq (char-before) '(?\; ?{ ?})))
1487 (c-forward-syntactic-ws)
1488 ;; We're now putatively at the declaration.
1489 (setq paren-state (c-parse-state))
1490 ;; At top level or inside a "{"?
1491 (if (or (not (setq encl-pos
1492 (c-most-enclosing-brace paren-state)))
1493 (eq (char-after encl-pos) ?\{))
1494 (progn
1495 (when (looking-at c-typedef-key) ; "typedef"
1496 (setq is-typedef t)
1497 (goto-char (match-end 0))
1498 (c-forward-syntactic-ws))
1499 ;; At a real declaration?
1500 (if (memq (c-forward-type t) '(t known found decltype))
1501 (c-font-lock-declarators limit t is-typedef)))))))
1502 nil))
1503
1504 (defun c-font-lock-enclosing-decls (limit)
1505 ;; Fontify the declarators of (nested) declarations we're in the middle of.
1506 ;; This is mainly for when a jit-lock etc. chunk starts inside the brace
1507 ;; block of a struct/union/class, etc.
1508 ;;
1509 ;; This function will be called from font-lock for a region bounded by POINT
1510 ;; and LIMIT, as though it were to identify a keyword for
1511 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
1512 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
1513 ;; Fontification".
1514 (let* ((paren-state (c-parse-state))
1515 (decl-search-lim (c-determine-limit 1000))
1516 in-typedef ps-elt)
1517 ;; Are we in any nested struct/union/class/etc. braces?
1518 (while paren-state
1519 (setq ps-elt (car paren-state)
1520 paren-state (cdr paren-state))
1521 (when (and (atom ps-elt)
1522 (eq (char-after ps-elt) ?\{))
1523 (goto-char ps-elt)
1524 (c-syntactic-skip-backward "^;{}" decl-search-lim)
1525 (when (or (bobp)
1526 (memq (char-before) '(?\; ?})))
1527 (c-forward-syntactic-ws)
1528 (setq in-typedef (looking-at c-typedef-key))
1529 (if in-typedef (c-forward-token-2))
1530 (when (and c-opt-block-decls-with-vars-key
1531 (looking-at c-opt-block-decls-with-vars-key))
1532 (goto-char ps-elt)
1533 (when (c-safe (c-forward-sexp))
1534 (c-forward-syntactic-ws)
1535 (c-font-lock-declarators limit t in-typedef))))))))
1536
1537 (defun c-font-lock-raw-strings (limit)
1538 ;; Fontify C++ raw strings.
1539 ;;
1540 ;; This function will be called from font-lock for a region bounded by POINT
1541 ;; and LIMIT, as though it were to identify a keyword for
1542 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
1543 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
1544 ;; Fontification".
1545 (let* ((state (c-state-semi-pp-to-literal (point)))
1546 (string-start (and (eq (cadr state) 'string)
1547 (car (cddr state))))
1548 (raw-id (and string-start
1549 (save-excursion
1550 (goto-char string-start)
1551 (and (eq (char-before) ?R)
1552 (looking-at "\"\\([^ ()\\\n\r\t]\\{0,16\\}\\)(")
1553 (match-string-no-properties 1))))))
1554 (while (< (point) limit)
1555 (if raw-id
1556 (progn
1557 (if (search-forward-regexp (concat ")\\(" (regexp-quote raw-id) "\\)\"")
1558 limit 'limit)
1559 (c-put-font-lock-face (match-beginning 1) (point) 'default))
1560 (setq raw-id nil))
1561
1562 (when (search-forward-regexp
1563 "R\\(\"\\)\\([^ ()\\\n\r\t]\\{0,16\\}\\)(" limit 'limit)
1564 (when
1565 (or (and (eobp)
1566 (eq (c-get-char-property (1- (point)) 'face)
1567 'font-lock-warning-face))
1568 (eq (c-get-char-property (point) 'face) 'font-lock-string-face)
1569 (and (equal (c-get-char-property (match-end 2) 'syntax-table) '(1))
1570 (equal (c-get-char-property (match-beginning 1) 'syntax-table)
1571 '(1))))
1572 (let ((paren-prop (c-get-char-property (1- (point)) 'syntax-table)))
1573 (if paren-prop
1574 (progn
1575 (c-put-font-lock-face (match-beginning 0) (match-end 0)
1576 'font-lock-warning-face)
1577 (when
1578 (and
1579 (equal paren-prop '(15))
1580 (not (c-search-forward-char-property 'syntax-table '(15) limit)))
1581 (goto-char limit)))
1582 (c-put-font-lock-face (match-beginning 1) (match-end 2) 'default)
1583 (setq raw-id (match-string-no-properties 2)))))))))
1584 nil)
1585
1586 (c-lang-defconst c-simple-decl-matchers
1587 "Simple font lock matchers for types and declarations. These are used
1588 on level 2 only and so aren't combined with `c-complex-decl-matchers'."
1589
1590 t `(;; Objective-C methods.
1591 ,@(when (c-major-mode-is 'objc-mode)
1592 `((,(c-lang-const c-opt-method-key)
1593 (,(byte-compile
1594 (lambda (limit)
1595 (let (;; The font-lock package in Emacs is known to clobber
1596 ;; `parse-sexp-lookup-properties' (when it exists).
1597 (parse-sexp-lookup-properties
1598 (cc-eval-when-compile
1599 (boundp 'parse-sexp-lookup-properties))))
1600 (save-restriction
1601 (narrow-to-region (point-min) limit)
1602 (c-font-lock-objc-method)))
1603 nil))
1604 (goto-char (match-end 1))))))
1605
1606 ;; Fontify all type names and the identifiers in the
1607 ;; declarations they might start. Use eval here since
1608 ;; `c-known-type-key' gets its value from
1609 ;; `*-font-lock-extra-types' on mode init.
1610 (eval . (list ,(c-make-font-lock-search-function
1611 'c-known-type-key
1612 '(1 'font-lock-type-face t)
1613 '((c-font-lock-declarators limit t nil)
1614 (save-match-data
1615 (goto-char (match-end 1))
1616 (c-forward-syntactic-ws))
1617 (goto-char (match-end 1))))))
1618
1619 ;; Fontify types preceded by `c-type-prefix-kwds' and the
1620 ;; identifiers in the declarations they might start.
1621 ,@(when (c-lang-const c-type-prefix-kwds)
1622 (let* ((prefix-re (c-make-keywords-re nil
1623 (c-lang-const c-type-prefix-kwds)))
1624 (type-match (+ 2
1625 (regexp-opt-depth prefix-re)
1626 (c-lang-const c-simple-ws-depth))))
1627 `((,(c-make-font-lock-search-function
1628 (concat "\\<\\(" prefix-re "\\)" ; 1
1629 (c-lang-const c-simple-ws) "+"
1630 (concat "\\(" ; 2 + prefix-re + c-simple-ws
1631 (c-lang-const c-symbol-key)
1632 "\\)"))
1633 `(,type-match
1634 'font-lock-type-face t)
1635 `((c-font-lock-declarators limit t nil)
1636 (save-match-data
1637 (goto-char (match-end ,type-match))
1638 (c-forward-syntactic-ws))
1639 (goto-char (match-end ,type-match))))))))
1640
1641 ;; Fontify special declarations that lacks a type.
1642 ,@(when (c-lang-const c-typeless-decl-kwds)
1643 `((,(c-make-font-lock-search-function
1644 (concat "\\<\\("
1645 (regexp-opt (c-lang-const c-typeless-decl-kwds))
1646 "\\)\\>")
1647 '((c-font-lock-declarators limit t nil)
1648 (save-match-data
1649 (goto-char (match-end 1))
1650 (c-forward-syntactic-ws))
1651 (goto-char (match-end 1)))))))
1652
1653 ;; Fontify generic colon labels in languages that support them.
1654 ,@(when (c-lang-const c-recognize-colon-labels)
1655 `(c-font-lock-labels))))
1656
1657 (c-lang-defconst c-complex-decl-matchers
1658 "Complex font lock matchers for types and declarations. Used on level
1659 3 and higher."
1660
1661 ;; Note: This code in this form dumps a number of functions into the
1662 ;; resulting constant, `c-matchers-3'. At run time, font lock will call
1663 ;; each of them as a "FUNCTION" (see Elisp page "Search-based
1664 ;; Fontification"). The font lock region is delimited by POINT and the
1665 ;; single parameter, LIMIT. Each of these functions returns NIL (thus
1666 ;; inhibiting spurious font-lock-keyword-face highlighting and another
1667 ;; call).
1668
1669 t `(;; Initialize some things before the search functions below.
1670 c-font-lock-complex-decl-prepare
1671
1672 ,@(if (c-major-mode-is 'objc-mode)
1673 ;; Fontify method declarations in Objective-C, but first
1674 ;; we have to put the `c-decl-end' `c-type' property on
1675 ;; all the @-style directives that haven't been handled in
1676 ;; `c-basic-matchers-before'.
1677 `(,(c-make-font-lock-search-function
1678 (c-make-keywords-re t
1679 ;; Exclude "@class" since that directive ends with a
1680 ;; semicolon anyway.
1681 (delete "@class"
1682 (append (c-lang-const c-protection-kwds)
1683 (c-lang-const c-other-decl-kwds)
1684 nil)))
1685 '((c-put-char-property (1- (match-end 1))
1686 'c-type 'c-decl-end)))
1687 c-font-lock-objc-methods))
1688
1689 ;; Fontify declarators which have been cut off from their declaring
1690 ;; types at the start of the region.
1691 c-font-lock-cut-off-declarators
1692
1693 ;; Fontify all declarations, casts and normal labels.
1694 c-font-lock-declarations
1695
1696 ;; Fontify declarators when POINT is within their declaration.
1697 c-font-lock-enclosing-decls
1698
1699 ;; Fontify angle bracket arglists like templates in C++.
1700 ,@(when (c-lang-const c-recognize-<>-arglists)
1701 `(c-font-lock-<>-arglists))
1702
1703 ;; The first two rules here mostly find occurrences that
1704 ;; `c-font-lock-declarations' has found already, but not
1705 ;; declarations containing blocks in the type (see note below).
1706 ;; It's also useful to fontify these everywhere to show e.g. when
1707 ;; a type keyword is accidentally used as an identifier.
1708
1709 ;; Fontify basic types.
1710 ,(let ((re (c-make-keywords-re nil
1711 (c-lang-const c-primitive-type-kwds))))
1712 (if (c-major-mode-is 'pike-mode)
1713 ;; No symbol is a keyword after "->" in Pike.
1714 `(,(concat "\\(\\=.?\\|[^>]\\|[^-]>\\)"
1715 "\\<\\(" re "\\)\\>")
1716 2 font-lock-type-face)
1717 `(,(concat "\\<\\(" re "\\)\\>")
1718 1 'font-lock-type-face)))
1719
1720 ;; Fontify types preceded by `c-type-prefix-kwds' (e.g. "struct").
1721 ,@(when (c-lang-const c-type-prefix-kwds)
1722 `((,(byte-compile
1723 `(lambda (limit)
1724 (c-fontify-types-and-refs
1725 ((c-promote-possible-types t)
1726 ;; The font-lock package in Emacs is known to clobber
1727 ;; `parse-sexp-lookup-properties' (when it exists).
1728 (parse-sexp-lookup-properties
1729 (cc-eval-when-compile
1730 (boundp 'parse-sexp-lookup-properties))))
1731 (save-restriction
1732 ;; Narrow to avoid going past the limit in
1733 ;; `c-forward-type'.
1734 (narrow-to-region (point) limit)
1735 (while (re-search-forward
1736 ,(concat "\\<\\("
1737 (c-make-keywords-re nil
1738 (c-lang-const c-type-prefix-kwds))
1739 "\\)\\>")
1740 limit t)
1741 (unless (c-skip-comments-and-strings limit)
1742 (c-forward-syntactic-ws)
1743 ;; Handle prefix declaration specifiers.
1744 (while
1745 (or
1746 (when (or (looking-at c-prefix-spec-kwds-re)
1747 (and (c-major-mode-is 'java-mode)
1748 (looking-at "@[A-Za-z0-9]+")))
1749 (c-forward-keyword-clause 1)
1750 t)
1751 (when (and c-opt-cpp-prefix
1752 (looking-at
1753 c-noise-macro-with-parens-name-re))
1754 (c-forward-noise-clause)
1755 t)))
1756 ,(if (c-major-mode-is 'c++-mode)
1757 `(when (and (c-forward-type)
1758 (eq (char-after) ?=))
1759 ;; In C++ we additionally check for a "class
1760 ;; X = Y" construct which is used in
1761 ;; templates, to fontify Y as a type.
1762 (forward-char)
1763 (c-forward-syntactic-ws)
1764 (c-forward-type))
1765 `(c-forward-type))
1766 )))))))))
1767
1768 ;; Fontify symbols after closing braces as declaration
1769 ;; identifiers under the assumption that they are part of
1770 ;; declarations like "class Foo { ... } foo;". It's too
1771 ;; expensive to check this accurately by skipping past the
1772 ;; brace block, so we use the heuristic that it's such a
1773 ;; declaration if the first identifier is on the same line as
1774 ;; the closing brace. `c-font-lock-declarations' will later
1775 ;; override it if it turns out to be an new declaration, but
1776 ;; it will be wrong if it's an expression (see the test
1777 ;; decls-8.cc).
1778 ;; ,@(when (c-lang-const c-opt-block-decls-with-vars-key)
1779 ;; `((,(c-make-font-lock-search-function
1780 ;; (concat "}"
1781 ;; (c-lang-const c-single-line-syntactic-ws)
1782 ;; "\\(" ; 1 + c-single-line-syntactic-ws-depth
1783 ;; (c-lang-const c-type-decl-prefix-key)
1784 ;; "\\|"
1785 ;; (c-lang-const c-symbol-key)
1786 ;; "\\)")
1787 ;; `((c-font-lock-declarators limit t nil) ; That nil says use `font-lock-variable-name-face';
1788 ;; ; t would mean `font-lock-function-name-face'.
1789 ;; (progn
1790 ;; (c-put-char-property (match-beginning 0) 'c-type
1791 ;; 'c-decl-id-start)
1792 ;; ; 'c-decl-type-start)
1793 ;; (goto-char (match-beginning
1794 ;; ,(1+ (c-lang-const
1795 ;; c-single-line-syntactic-ws-depth)))))
1796 ;; (goto-char (match-end 0)))))))
1797
1798 ;; Fontify the type in C++ "new" expressions.
1799 ,@(when (c-major-mode-is 'c++-mode)
1800 ;; This pattern is a probably a "(MATCHER . ANCHORED-HIGHLIGHTER)"
1801 ;; (see Elisp page "Search-based Fontification").
1802 `(("\\<new\\>"
1803 (c-font-lock-c++-new))))
1804 ))
1805
1806 (defun c-font-lock-labels (limit)
1807 ;; Fontify all statement labels from the point to LIMIT. Assumes
1808 ;; that strings and comments have been fontified already. Nil is
1809 ;; always returned.
1810 ;;
1811 ;; Note: This function is only used on decoration level 2; this is
1812 ;; taken care of directly by the gargantuan
1813 ;; `c-font-lock-declarations' on higher levels.
1814 ;;
1815 ;; This function might do hidden buffer changes.
1816
1817 (let (continue-pos id-start
1818 ;; The font-lock package in Emacs is known to clobber
1819 ;; `parse-sexp-lookup-properties' (when it exists).
1820 (parse-sexp-lookup-properties
1821 (cc-eval-when-compile
1822 (boundp 'parse-sexp-lookup-properties))))
1823
1824 (while (re-search-forward ":[^:]" limit t)
1825 (setq continue-pos (point))
1826 (goto-char (match-beginning 0))
1827 (unless (c-skip-comments-and-strings limit)
1828
1829 (c-backward-syntactic-ws)
1830 (and (setq id-start (c-on-identifier))
1831
1832 (not (get-text-property id-start 'face))
1833
1834 (progn
1835 (goto-char id-start)
1836 (c-backward-syntactic-ws)
1837 (or
1838 ;; Check for a char that precedes a statement.
1839 (memq (char-before) '(?\} ?\{ ?\;))
1840 ;; Check for a preceding label. We exploit the font
1841 ;; locking made earlier by this function.
1842 (and (eq (char-before) ?:)
1843 (progn
1844 (backward-char)
1845 (c-backward-syntactic-ws)
1846 (not (bobp)))
1847 (eq (get-text-property (1- (point)) 'face)
1848 c-label-face-name))
1849 ;; Check for a keyword that precedes a statement.
1850 (c-after-conditional)))
1851
1852 (progn
1853 ;; Got a label.
1854 (goto-char id-start)
1855 (looking-at c-symbol-key)
1856 (c-put-font-lock-face (match-beginning 0) (match-end 0)
1857 c-label-face-name)))
1858
1859 (goto-char continue-pos))))
1860 nil)
1861
1862 (c-lang-defconst c-basic-matchers-after
1863 "Font lock matchers for various things that should be fontified after
1864 generic casts and declarations are fontified. Used on level 2 and
1865 higher."
1866
1867 t `(,@(when (c-lang-const c-brace-id-list-kwds)
1868 ;; Fontify the remaining identifiers inside an enum list when we start
1869 ;; inside it.
1870 `(c-font-lock-enum-tail
1871 ;; Fontify the identifiers inside enum lists. (The enum type
1872 ;; name is handled by `c-simple-decl-matchers' or
1873 ;; `c-complex-decl-matchers' below.
1874 (,(c-make-font-lock-search-function
1875 (concat
1876 "\\<\\("
1877 (c-make-keywords-re nil (c-lang-const c-brace-id-list-kwds))
1878 "\\)\\>"
1879 ;; Disallow various common punctuation chars that can't come
1880 ;; before the '{' of the enum list, to avoid searching too far.
1881 "[^][{};/#=]*"
1882 "{")
1883 '((c-font-lock-declarators limit t nil)
1884 (save-match-data
1885 (goto-char (match-end 0))
1886 (c-put-char-property (1- (point)) 'c-type
1887 'c-decl-id-start)
1888 (c-forward-syntactic-ws))
1889 (goto-char (match-end 0)))))))
1890
1891 ;; Fontify labels after goto etc.
1892 ,@(when (c-lang-const c-before-label-kwds)
1893 `(;; (Got three different interpretation levels here,
1894 ;; which makes it a bit complicated: 1) The backquote
1895 ;; stuff is expanded when compiled or loaded, 2) the
1896 ;; eval form is evaluated at font-lock setup (to
1897 ;; substitute c-label-face-name correctly), and 3) the
1898 ;; resulting structure is interpreted during
1899 ;; fontification.)
1900 (eval
1901 . ,(let* ((c-before-label-re
1902 (c-make-keywords-re nil
1903 (c-lang-const c-before-label-kwds))))
1904 `(list
1905 ,(concat "\\<\\(" c-before-label-re "\\)\\>"
1906 "\\s *"
1907 "\\(" ; identifier-offset
1908 (c-lang-const c-symbol-key)
1909 "\\)")
1910 (list ,(+ (regexp-opt-depth c-before-label-re) 2)
1911 c-label-face-name nil t))))))
1912
1913 ;; Fontify the clauses after various keywords.
1914 ,@(when (or (c-lang-const c-type-list-kwds)
1915 (c-lang-const c-ref-list-kwds)
1916 (c-lang-const c-colon-type-list-kwds))
1917 `((,(c-make-font-lock-BO-decl-search-function
1918 (concat "\\<\\("
1919 (c-make-keywords-re nil
1920 (append (c-lang-const c-type-list-kwds)
1921 (c-lang-const c-ref-list-kwds)
1922 (c-lang-const c-colon-type-list-kwds)))
1923 "\\)\\>")
1924 '((c-fontify-types-and-refs ((c-promote-possible-types t))
1925 (c-forward-keyword-clause 1)
1926 (if (> (point) limit) (goto-char limit))))))))
1927
1928 ,@(when (c-lang-const c-paren-type-kwds)
1929 `((,(c-make-font-lock-search-function
1930 (concat "\\<\\("
1931 (c-make-keywords-re nil
1932 (c-lang-const c-paren-type-kwds))
1933 "\\)\\>")
1934 '((c-fontify-types-and-refs ((c-promote-possible-types t))
1935 (c-forward-keyword-clause 1)
1936 (if (> (point) limit) (goto-char limit))))))))
1937
1938 ,@(when (c-major-mode-is 'java-mode)
1939 `((eval . (list "\\<\\(@[a-zA-Z0-9]+\\)\\>" 1 c-annotation-face))))
1940 ))
1941
1942 (c-lang-defconst c-matchers-1
1943 t (c-lang-const c-cpp-matchers))
1944
1945 (c-lang-defconst c-matchers-2
1946 t (append (c-lang-const c-matchers-1)
1947 (c-lang-const c-basic-matchers-before)
1948 (c-lang-const c-simple-decl-matchers)
1949 (c-lang-const c-basic-matchers-after)))
1950
1951 (c-lang-defconst c-matchers-3
1952 t (append (c-lang-const c-matchers-1)
1953 (c-lang-const c-basic-matchers-before)
1954 (c-lang-const c-complex-decl-matchers)
1955 (c-lang-const c-basic-matchers-after)))
1956
1957 (defun c-compose-keywords-list (base-list)
1958 ;; Incorporate the font lock keyword lists according to
1959 ;; `c-doc-comment-style' on the given keyword list and return it.
1960 ;; This is used in the function bindings of the
1961 ;; `*-font-lock-keywords-*' symbols since we have to build the list
1962 ;; when font-lock is initialized.
1963
1964 (unless (memq c-doc-face-name c-literal-faces)
1965 (setq c-literal-faces (cons c-doc-face-name c-literal-faces)))
1966
1967 (let* ((doc-keywords
1968 (if (consp (car-safe c-doc-comment-style))
1969 (cdr-safe (or (assq c-buffer-is-cc-mode c-doc-comment-style)
1970 (assq 'other c-doc-comment-style)))
1971 c-doc-comment-style))
1972 (list (nconc (c--mapcan
1973 (lambda (doc-style)
1974 (let ((sym (intern
1975 (concat (symbol-name doc-style)
1976 "-font-lock-keywords"))))
1977 (cond ((fboundp sym)
1978 (funcall sym))
1979 ((boundp sym)
1980 (append (eval sym) nil)))))
1981 (if (listp doc-keywords)
1982 doc-keywords
1983 (list doc-keywords)))
1984 base-list)))
1985
1986 ;; Kludge: If `c-font-lock-complex-decl-prepare' is on the list we
1987 ;; move it first since the doc comment font lockers might add
1988 ;; `c-type' text properties, so they have to be cleared before that.
1989 (when (memq 'c-font-lock-complex-decl-prepare list)
1990 (setq list (cons 'c-font-lock-complex-decl-prepare
1991 (delq 'c-font-lock-complex-decl-prepare
1992 (append list nil)))))
1993
1994 list))
1995
1996 (defun c-override-default-keywords (def-var)
1997 ;; This is used to override the value on a `*-font-lock-keywords'
1998 ;; variable only if it's nil or has the same value as one of the
1999 ;; `*-font-lock-keywords-*' variables. Older font-lock packages
2000 ;; define a default value for `*-font-lock-keywords' which we want
2001 ;; to override, but we should otoh avoid clobbering a user setting.
2002 ;; This heuristic for that isn't perfect, but I can't think of any
2003 ;; better. /mast
2004 (when (and (boundp def-var)
2005 (memq (symbol-value def-var)
2006 (cons nil
2007 (mapcar
2008 (lambda (suffix)
2009 (let ((sym (intern (concat (symbol-name def-var)
2010 suffix))))
2011 (and (boundp sym) (symbol-value sym))))
2012 '("-1" "-2" "-3")))))
2013 ;; The overriding is done by unbinding the variable so that the normal
2014 ;; defvar will install its default value later on.
2015 (makunbound def-var)))
2016
2017 \f
2018 ;;; C.
2019
2020 (c-override-default-keywords 'c-font-lock-keywords)
2021
2022 (defconst c-font-lock-keywords-1 (c-lang-const c-matchers-1 c)
2023 "Minimal font locking for C mode.
2024 Fontifies only preprocessor directives (in addition to the syntactic
2025 fontification of strings and comments).")
2026
2027 (defconst c-font-lock-keywords-2 (c-lang-const c-matchers-2 c)
2028 "Fast normal font locking for C mode.
2029 In addition to `c-font-lock-keywords-1', this adds fontification of
2030 keywords, simple types, declarations that are easy to recognize, the
2031 user defined types on `c-font-lock-extra-types', and the doc comment
2032 styles specified by `c-doc-comment-style'.")
2033
2034 (defconst c-font-lock-keywords-3 (c-lang-const c-matchers-3 c)
2035 "Accurate normal font locking for C mode.
2036 Like the variable `c-font-lock-keywords-2' but detects declarations in a more
2037 accurate way that works in most cases for arbitrary types without the
2038 need for `c-font-lock-extra-types'.")
2039
2040 (defvar c-font-lock-keywords c-font-lock-keywords-3
2041 "Default expressions to highlight in C mode.")
2042
2043 (defun c-font-lock-keywords-2 ()
2044 (c-compose-keywords-list c-font-lock-keywords-2))
2045 (defun c-font-lock-keywords-3 ()
2046 (c-compose-keywords-list c-font-lock-keywords-3))
2047 (defun c-font-lock-keywords ()
2048 (c-compose-keywords-list c-font-lock-keywords))
2049
2050 \f
2051 ;;; C++.
2052
2053 (defun c-font-lock-c++-new (limit)
2054 ;; FIXME!!! Put in a comment about the context of this function's
2055 ;; invocation. I think it's called as an ANCHORED-MATCHER within an
2056 ;; ANCHORED-HIGHLIGHTER. (2007/2/10).
2057 ;;
2058 ;; Assuming point is after a "new" word, check that it isn't inside
2059 ;; a string or comment, and if so try to fontify the type in the
2060 ;; allocation expression. Nil is always returned.
2061 ;;
2062 ;; As usual, C++ takes the prize in coming up with a hard to parse
2063 ;; syntax. :P
2064 ;;
2065 ;; This function might do hidden buffer changes.
2066
2067 (unless (c-skip-comments-and-strings limit)
2068 (save-excursion
2069 (catch 'false-alarm
2070 ;; A "new" keyword is followed by one to three expressions, where
2071 ;; the type is the middle one, and the only required part.
2072 (let (expr1-pos expr2-pos
2073 ;; Enable recording of identifier ranges in `c-forward-type'
2074 ;; etc for later fontification. Not using
2075 ;; `c-fontify-types-and-refs' here since the ranges should
2076 ;; be fontified selectively only when an allocation
2077 ;; expression is successfully recognized.
2078 (c-record-type-identifiers t)
2079 c-record-ref-identifiers
2080 ;; The font-lock package in Emacs is known to clobber
2081 ;; `parse-sexp-lookup-properties' (when it exists).
2082 (parse-sexp-lookup-properties
2083 (cc-eval-when-compile
2084 (boundp 'parse-sexp-lookup-properties))))
2085 (c-forward-syntactic-ws)
2086
2087 ;; The first placement arglist is always parenthesized, if it
2088 ;; exists.
2089 (when (eq (char-after) ?\()
2090 (setq expr1-pos (1+ (point)))
2091 (condition-case nil
2092 (c-forward-sexp)
2093 (scan-error (throw 'false-alarm t)))
2094 (c-forward-syntactic-ws))
2095
2096 ;; The second expression is either a type followed by some "*" or
2097 ;; "[...]" or similar, or a parenthesized type followed by a full
2098 ;; identifierless declarator.
2099 (setq expr2-pos (1+ (point)))
2100 (cond ((eq (char-after) ?\())
2101 ((let ((c-promote-possible-types t))
2102 (c-forward-type)))
2103 (t (setq expr2-pos nil)))
2104
2105 (when expr1-pos
2106 (cond
2107 ((not expr2-pos)
2108 ;; No second expression, so the first has to be a
2109 ;; parenthesized type.
2110 (goto-char expr1-pos)
2111 (let ((c-promote-possible-types t))
2112 (c-forward-type)))
2113
2114 ((eq (char-before expr2-pos) ?\()
2115 ;; Got two parenthesized expressions, so we have to look
2116 ;; closer at them to decide which is the type. No need to
2117 ;; handle `c-record-ref-identifiers' since all references
2118 ;; have already been handled by other fontification rules.
2119 (let (expr1-res expr2-res)
2120
2121 (goto-char expr1-pos)
2122 (when (setq expr1-res (c-forward-type))
2123 (unless (looking-at
2124 (cc-eval-when-compile
2125 (concat (c-lang-const c-symbol-start c++)
2126 "\\|[*:)[]")))
2127 ;; There's something after the would-be type that
2128 ;; can't be there, so this is a placement arglist.
2129 (setq expr1-res nil)))
2130
2131 (goto-char expr2-pos)
2132 (when (setq expr2-res (c-forward-type))
2133 (unless (looking-at
2134 (cc-eval-when-compile
2135 (concat (c-lang-const c-symbol-start c++)
2136 "\\|[*:)[]")))
2137 ;; There's something after the would-be type that can't
2138 ;; be there, so this is an initialization expression.
2139 (setq expr2-res nil))
2140 (when (and (c-go-up-list-forward)
2141 (progn (c-forward-syntactic-ws)
2142 (eq (char-after) ?\()))
2143 ;; If there's a third initialization expression
2144 ;; then the second one is the type, so demote the
2145 ;; first match.
2146 (setq expr1-res nil)))
2147
2148 ;; We fontify the most likely type, with a preference for
2149 ;; the first argument since a placement arglist is more
2150 ;; unusual than an initializer.
2151 (cond ((memq expr1-res '(t known prefix)))
2152 ((memq expr2-res '(t known prefix)))
2153 ;; Presumably 'decltype's will be fontified elsewhere.
2154 ((eq expr1-res 'decltype))
2155 ((eq expr2-res 'decltype))
2156 ((eq expr1-res 'found)
2157 (let ((c-promote-possible-types t))
2158 (goto-char expr1-pos)
2159 (c-forward-type)))
2160 ((eq expr2-res 'found)
2161 (let ((c-promote-possible-types t))
2162 (goto-char expr2-pos)
2163 (c-forward-type)))
2164 ((and (eq expr1-res 'maybe) (not expr2-res))
2165 (let ((c-promote-possible-types t))
2166 (goto-char expr1-pos)
2167 (c-forward-type)))
2168 ((and (not expr1-res) (eq expr2-res 'maybe))
2169 (let ((c-promote-possible-types t))
2170 (goto-char expr2-pos)
2171 (c-forward-type)))
2172 ;; If both type matches are 'maybe then we're
2173 ;; too uncertain to promote either of them.
2174 )))))
2175
2176 ;; Fontify the type that now is recorded in
2177 ;; `c-record-type-identifiers', if any.
2178 (c-fontify-recorded-types-and-refs)))))
2179 nil)
2180
2181 (c-override-default-keywords 'c++-font-lock-keywords)
2182
2183 (defconst c++-font-lock-keywords-1 (c-lang-const c-matchers-1 c++)
2184 "Minimal font locking for C++ mode.
2185 Fontifies only preprocessor directives (in addition to the syntactic
2186 fontification of strings and comments).")
2187
2188 (defconst c++-font-lock-keywords-2 (c-lang-const c-matchers-2 c++)
2189 "Fast normal font locking for C++ mode.
2190 In addition to `c++-font-lock-keywords-1', this adds fontification of
2191 keywords, simple types, declarations that are easy to recognize, the
2192 user defined types on `c++-font-lock-extra-types', and the doc comment
2193 styles specified by `c-doc-comment-style'.")
2194
2195 (defconst c++-font-lock-keywords-3 (c-lang-const c-matchers-3 c++)
2196 "Accurate normal font locking for C++ mode.
2197 Like the variable `c++-font-lock-keywords-2' but detects declarations in a more
2198 accurate way that works in most cases for arbitrary types without the
2199 need for `c++-font-lock-extra-types'.")
2200
2201 (defvar c++-font-lock-keywords c++-font-lock-keywords-3
2202 "Default expressions to highlight in C++ mode.")
2203
2204 (defun c++-font-lock-keywords-2 ()
2205 (c-compose-keywords-list c++-font-lock-keywords-2))
2206 (defun c++-font-lock-keywords-3 ()
2207 (c-compose-keywords-list c++-font-lock-keywords-3))
2208 (defun c++-font-lock-keywords ()
2209 (c-compose-keywords-list c++-font-lock-keywords))
2210
2211 \f
2212 ;;; Objective-C.
2213
2214 (defun c-font-lock-objc-method ()
2215 ;; Assuming the point is after the + or - that starts an Objective-C
2216 ;; method declaration, fontify it. This must be done before normal
2217 ;; casts, declarations and labels are fontified since they will get
2218 ;; false matches in these things.
2219 ;;
2220 ;; This function might do hidden buffer changes.
2221
2222 (c-fontify-types-and-refs
2223 ((first t)
2224 (c-promote-possible-types t))
2225
2226 (while (and
2227 (progn
2228 (c-forward-syntactic-ws)
2229
2230 ;; An optional method type.
2231 (if (eq (char-after) ?\()
2232 (progn
2233 (forward-char)
2234 (c-forward-syntactic-ws)
2235 (c-forward-type)
2236 (prog1 (c-go-up-list-forward)
2237 (c-forward-syntactic-ws)))
2238 t))
2239
2240 ;; The name. The first time it's the first part of
2241 ;; the function name, the rest of the time it's an
2242 ;; argument name.
2243 (looking-at c-symbol-key)
2244 (progn
2245 (goto-char (match-end 0))
2246 (c-put-font-lock-face (match-beginning 0)
2247 (point)
2248 (if first
2249 'font-lock-function-name-face
2250 'font-lock-variable-name-face))
2251 (c-forward-syntactic-ws)
2252
2253 ;; Another optional part of the function name.
2254 (when (looking-at c-symbol-key)
2255 (goto-char (match-end 0))
2256 (c-put-font-lock-face (match-beginning 0)
2257 (point)
2258 'font-lock-function-name-face)
2259 (c-forward-syntactic-ws))
2260
2261 ;; There's another argument if a colon follows.
2262 (eq (char-after) ?:)))
2263 (forward-char)
2264 (setq first nil))))
2265
2266 (defun c-font-lock-objc-methods (limit)
2267 ;; Fontify method declarations in Objective-C. Nil is always
2268 ;; returned.
2269 ;;
2270 ;; This function might do hidden buffer changes.
2271
2272 (let (;; The font-lock package in Emacs is known to clobber
2273 ;; `parse-sexp-lookup-properties' (when it exists).
2274 (parse-sexp-lookup-properties
2275 (cc-eval-when-compile
2276 (boundp 'parse-sexp-lookup-properties))))
2277
2278 (c-find-decl-spots
2279 limit
2280 "[-+]"
2281 nil
2282 (lambda (match-pos inside-macro)
2283 (forward-char)
2284 (c-font-lock-objc-method))))
2285 nil)
2286
2287 (c-override-default-keywords 'objc-font-lock-keywords)
2288
2289 (defconst objc-font-lock-keywords-1 (c-lang-const c-matchers-1 objc)
2290 "Minimal font locking for Objective-C mode.
2291 Fontifies only compiler directives (in addition to the syntactic
2292 fontification of strings and comments).")
2293
2294 (defconst objc-font-lock-keywords-2 (c-lang-const c-matchers-2 objc)
2295 "Fast normal font locking for Objective-C mode.
2296 In addition to `objc-font-lock-keywords-1', this adds fontification of
2297 keywords, simple types, declarations that are easy to recognize, the
2298 user defined types on `objc-font-lock-extra-types', and the doc
2299 comment styles specified by `c-doc-comment-style'.")
2300
2301 (defconst objc-font-lock-keywords-3 (c-lang-const c-matchers-3 objc)
2302 "Accurate normal font locking for Objective-C mode.
2303 Like the variable `objc-font-lock-keywords-2' but detects declarations in a more
2304 accurate way that works in most cases for arbitrary types without the
2305 need for `objc-font-lock-extra-types'.")
2306
2307 (defvar objc-font-lock-keywords objc-font-lock-keywords-3
2308 "Default expressions to highlight in Objective-C mode.")
2309
2310 (defun objc-font-lock-keywords-2 ()
2311 (c-compose-keywords-list objc-font-lock-keywords-2))
2312 (defun objc-font-lock-keywords-3 ()
2313 (c-compose-keywords-list objc-font-lock-keywords-3))
2314 (defun objc-font-lock-keywords ()
2315 (c-compose-keywords-list objc-font-lock-keywords))
2316
2317 ;; Kludge to override the default value that
2318 ;; `objc-font-lock-extra-types' might have gotten from the font-lock
2319 ;; package. The value replaced here isn't relevant now anyway since
2320 ;; those types are builtin and therefore listed directly in
2321 ;; `c-primitive-type-kwds'.
2322 (when (equal (sort (append objc-font-lock-extra-types nil) 'string-lessp)
2323 '("BOOL" "Class" "IMP" "SEL"))
2324 (setq objc-font-lock-extra-types
2325 (cc-eval-when-compile (list (concat "[" c-upper "]\\sw*")))))
2326
2327 \f
2328 ;;; Java.
2329
2330 (c-override-default-keywords 'java-font-lock-keywords)
2331
2332 (defconst java-font-lock-keywords-1 (c-lang-const c-matchers-1 java)
2333 "Minimal font locking for Java mode.
2334 Fontifies nothing except the syntactic fontification of strings and
2335 comments.")
2336
2337 (defconst java-font-lock-keywords-2 (c-lang-const c-matchers-2 java)
2338 "Fast normal font locking for Java mode.
2339 In addition to `java-font-lock-keywords-1', this adds fontification of
2340 keywords, simple types, declarations that are easy to recognize, the
2341 user defined types on `java-font-lock-extra-types', and the doc
2342 comment styles specified by `c-doc-comment-style'.")
2343
2344 (defconst java-font-lock-keywords-3 (c-lang-const c-matchers-3 java)
2345 "Accurate normal font locking for Java mode.
2346 Like variable `java-font-lock-keywords-2' but detects declarations in a more
2347 accurate way that works in most cases for arbitrary types without the
2348 need for `java-font-lock-extra-types'.")
2349
2350 (defvar java-font-lock-keywords java-font-lock-keywords-3
2351 "Default expressions to highlight in Java mode.")
2352
2353 (defun java-font-lock-keywords-2 ()
2354 (c-compose-keywords-list java-font-lock-keywords-2))
2355 (defun java-font-lock-keywords-3 ()
2356 (c-compose-keywords-list java-font-lock-keywords-3))
2357 (defun java-font-lock-keywords ()
2358 (c-compose-keywords-list java-font-lock-keywords))
2359
2360 \f
2361 ;;; CORBA IDL.
2362
2363 (c-override-default-keywords 'idl-font-lock-keywords)
2364
2365 (defconst idl-font-lock-keywords-1 (c-lang-const c-matchers-1 idl)
2366 "Minimal font locking for CORBA IDL mode.
2367 Fontifies nothing except the syntactic fontification of strings and
2368 comments.")
2369
2370 (defconst idl-font-lock-keywords-2 (c-lang-const c-matchers-2 idl)
2371 "Fast normal font locking for CORBA IDL mode.
2372 In addition to `idl-font-lock-keywords-1', this adds fontification of
2373 keywords, simple types, declarations that are easy to recognize, the
2374 user defined types on `idl-font-lock-extra-types', and the doc comment
2375 styles specified by `c-doc-comment-style'.")
2376
2377 (defconst idl-font-lock-keywords-3 (c-lang-const c-matchers-3 idl)
2378 "Accurate normal font locking for CORBA IDL mode.
2379 Like the variable `idl-font-lock-keywords-2' but detects declarations in a more
2380 accurate way that works in most cases for arbitrary types without the
2381 need for `idl-font-lock-extra-types'.")
2382
2383 (defvar idl-font-lock-keywords idl-font-lock-keywords-3
2384 "Default expressions to highlight in CORBA IDL mode.")
2385
2386 (defun idl-font-lock-keywords-2 ()
2387 (c-compose-keywords-list idl-font-lock-keywords-2))
2388 (defun idl-font-lock-keywords-3 ()
2389 (c-compose-keywords-list idl-font-lock-keywords-3))
2390 (defun idl-font-lock-keywords ()
2391 (c-compose-keywords-list idl-font-lock-keywords))
2392
2393 \f
2394 ;;; Pike.
2395
2396 (c-override-default-keywords 'pike-font-lock-keywords)
2397
2398 (defconst pike-font-lock-keywords-1 (c-lang-const c-matchers-1 pike)
2399 "Minimal font locking for Pike mode.
2400 Fontifies only preprocessor directives (in addition to the syntactic
2401 fontification of strings and comments).")
2402
2403 (defconst pike-font-lock-keywords-2 (c-lang-const c-matchers-2 pike)
2404 "Fast normal font locking for Pike mode.
2405 In addition to `pike-font-lock-keywords-1', this adds fontification of
2406 keywords, simple types, declarations that are easy to recognize, the
2407 user defined types on `pike-font-lock-extra-types', and the doc
2408 comment styles specified by `c-doc-comment-style'.")
2409
2410 (defconst pike-font-lock-keywords-3 (c-lang-const c-matchers-3 pike)
2411 "Accurate normal font locking for Pike mode.
2412 Like the variable `pike-font-lock-keywords-2' but detects declarations in a more
2413 accurate way that works in most cases for arbitrary types without the
2414 need for `pike-font-lock-extra-types'.")
2415
2416 (defvar pike-font-lock-keywords pike-font-lock-keywords-3
2417 "Default expressions to highlight in Pike mode.")
2418
2419 (defun pike-font-lock-keywords-2 ()
2420 (c-compose-keywords-list pike-font-lock-keywords-2))
2421 (defun pike-font-lock-keywords-3 ()
2422 (c-compose-keywords-list pike-font-lock-keywords-3))
2423 (defun pike-font-lock-keywords ()
2424 (c-compose-keywords-list pike-font-lock-keywords))
2425
2426 \f
2427 ;;; Doc comments.
2428
2429 (defun c-font-lock-doc-comments (prefix limit keywords)
2430 ;; Fontify the comments between the point and LIMIT whose start
2431 ;; matches PREFIX with `c-doc-face-name'. Assumes comments have been
2432 ;; fontified with `font-lock-comment-face' already. nil is always
2433 ;; returned.
2434 ;;
2435 ;; After the fontification of a matching comment, fontification
2436 ;; according to KEYWORDS is applied inside it. It's a list like
2437 ;; `font-lock-keywords' except that anchored matches and eval
2438 ;; clauses aren't supported and that some abbreviated forms can't be
2439 ;; used. The buffer is narrowed to the comment while KEYWORDS is
2440 ;; applied; leading comment starters are included but trailing
2441 ;; comment enders for block comment are not.
2442 ;;
2443 ;; Note that faces added through KEYWORDS should never replace the
2444 ;; existing `c-doc-face-name' face since the existence of that face
2445 ;; is used as a flag in other code to skip comments.
2446 ;;
2447 ;; This function might do hidden buffer changes.
2448
2449 (let (comment-beg region-beg)
2450 (if (eq (get-text-property (point) 'face)
2451 'font-lock-comment-face)
2452 ;; Handle the case when the fontified region starts inside a
2453 ;; comment.
2454 (let ((start (c-literal-start)))
2455 (setq region-beg (point))
2456 (when start
2457 (goto-char start))
2458 (when (looking-at prefix)
2459 (setq comment-beg (point)))))
2460
2461 (while (or
2462 comment-beg
2463
2464 ;; Search for the prefix until a match is found at the start
2465 ;; of a comment.
2466 (while (when (re-search-forward prefix limit t)
2467 (setq comment-beg (match-beginning 0))
2468 (or (not (c-got-face-at comment-beg
2469 c-literal-faces))
2470 (and (/= comment-beg (point-min))
2471 (c-got-face-at (1- comment-beg)
2472 c-literal-faces))))
2473 (setq comment-beg nil))
2474 (setq region-beg comment-beg))
2475
2476 (if (elt (parse-partial-sexp comment-beg (+ comment-beg 2)) 7)
2477 ;; Collect a sequence of doc style line comments.
2478 (progn
2479 (goto-char comment-beg)
2480 (while (and (progn
2481 (c-forward-single-comment)
2482 (skip-syntax-forward " ")
2483 (< (point) limit))
2484 (looking-at prefix))))
2485 (goto-char comment-beg)
2486 (c-forward-single-comment))
2487 (if (> (point) limit) (goto-char limit))
2488 (setq comment-beg nil)
2489
2490 (let ((region-end (point))
2491 (keylist keywords) keyword matcher highlights)
2492 (c-put-font-lock-face region-beg region-end c-doc-face-name)
2493 (save-restriction
2494 ;; Narrow to the doc comment. Among other things, this
2495 ;; helps by making "^" match at the start of the comment.
2496 ;; Do not include a trailing block comment ender, though.
2497 (and (> region-end (1+ region-beg))
2498 (progn (goto-char region-end)
2499 (backward-char 2)
2500 (looking-at "\\*/"))
2501 (setq region-end (point)))
2502 (narrow-to-region region-beg region-end)
2503
2504 (while keylist
2505 (setq keyword (car keylist)
2506 keylist (cdr keylist)
2507 matcher (car keyword))
2508 (goto-char region-beg)
2509 (while (if (stringp matcher)
2510 (re-search-forward matcher region-end t)
2511 (funcall matcher region-end))
2512 (setq highlights (cdr keyword))
2513 (if (consp (car highlights))
2514 (while highlights
2515 (font-lock-apply-highlight (car highlights))
2516 (setq highlights (cdr highlights)))
2517 (font-lock-apply-highlight highlights))))
2518
2519 (goto-char region-end)))))
2520 nil)
2521 (put 'c-font-lock-doc-comments 'lisp-indent-function 2)
2522
2523 (defun c-find-invalid-doc-markup (regexp limit)
2524 ;; Used to fontify invalid markup in doc comments after the correct
2525 ;; ones have been fontified: Find the first occurrence of REGEXP
2526 ;; between the point and LIMIT that only is fontified with
2527 ;; `c-doc-face-name'. If a match is found then submatch 0 surrounds
2528 ;; the first char and t is returned, otherwise nil is returned.
2529 ;;
2530 ;; This function might do hidden buffer changes.
2531 (let (start)
2532 (while (if (re-search-forward regexp limit t)
2533 (not (eq (get-text-property
2534 (setq start (match-beginning 0)) 'face)
2535 c-doc-face-name))
2536 (setq start nil)))
2537 (when start
2538 (store-match-data (list (copy-marker start)
2539 (copy-marker (1+ start))))
2540 t)))
2541
2542 ;; GtkDoc patterns contributed by Masatake YAMATO <jet@gyve.org>.
2543
2544 (defconst gtkdoc-font-lock-doc-comments
2545 (let ((symbol "[a-zA-Z0-9_]+")
2546 (header "^ \\* "))
2547 `((,(concat header "\\(" symbol "\\):[ \t]*$")
2548 1 ,c-doc-markup-face-name prepend nil)
2549 (,(concat symbol "()")
2550 0 ,c-doc-markup-face-name prepend nil)
2551 (,(concat header "\\(" "@" symbol "\\):")
2552 1 ,c-doc-markup-face-name prepend nil)
2553 (,(concat "[#%@]" symbol)
2554 0 ,c-doc-markup-face-name prepend nil))
2555 ))
2556
2557 (defconst gtkdoc-font-lock-doc-protection
2558 `(("< \\(public\\|private\\|protected\\) >"
2559 1 ,c-doc-markup-face-name prepend nil)))
2560
2561 (defconst gtkdoc-font-lock-keywords
2562 `((,(lambda (limit)
2563 (c-font-lock-doc-comments "/\\*\\*$" limit
2564 gtkdoc-font-lock-doc-comments)
2565 (c-font-lock-doc-comments "/\\*< " limit
2566 gtkdoc-font-lock-doc-protection)
2567 ))))
2568
2569 ;; Javadoc.
2570
2571 (defconst javadoc-font-lock-doc-comments
2572 `(("{@[a-z]+[^}\n\r]*}" ; "{@foo ...}" markup.
2573 0 ,c-doc-markup-face-name prepend nil)
2574 ("^\\(/\\*\\)?\\(\\s \\|\\*\\)*\\(@[a-z]+\\)" ; "@foo ..." markup.
2575 3 ,c-doc-markup-face-name prepend nil)
2576 (,(concat "</?\\sw" ; HTML tags.
2577 "\\("
2578 (concat "\\sw\\|\\s \\|[=\n\r*.:]\\|"
2579 "\"[^\"]*\"\\|'[^']*'")
2580 "\\)*>")
2581 0 ,c-doc-markup-face-name prepend nil)
2582 ("&\\(\\sw\\|[.:]\\)+;" ; HTML entities.
2583 0 ,c-doc-markup-face-name prepend nil)
2584 ;; Fontify remaining markup characters as invalid. Note
2585 ;; that the Javadoc spec is hazy about when "@" is
2586 ;; allowed in non-markup use.
2587 (,(lambda (limit)
2588 (c-find-invalid-doc-markup "[<>&]\\|{@" limit))
2589 0 'font-lock-warning-face prepend nil)))
2590
2591 (defconst javadoc-font-lock-keywords
2592 `((,(lambda (limit)
2593 (c-font-lock-doc-comments "/\\*\\*" limit
2594 javadoc-font-lock-doc-comments)))))
2595
2596 ;; Pike autodoc.
2597
2598 (defconst autodoc-decl-keywords
2599 ;; Adorned regexp matching the keywords that introduce declarations
2600 ;; in Pike Autodoc.
2601 (cc-eval-when-compile
2602 (c-make-keywords-re t '("@decl" "@elem" "@index" "@member") 'pike-mode)))
2603
2604 (defconst autodoc-decl-type-keywords
2605 ;; Adorned regexp matching the keywords that are followed by a type.
2606 (cc-eval-when-compile
2607 (c-make-keywords-re t '("@elem" "@member") 'pike-mode)))
2608
2609 (defun autodoc-font-lock-line-markup (limit)
2610 ;; Fontify all line oriented keywords between the point and LIMIT.
2611 ;; Nil is always returned.
2612 ;;
2613 ;; This function might do hidden buffer changes.
2614
2615 (let ((line-re (concat "^\\(\\(/\\*!\\|\\s *\\("
2616 c-current-comment-prefix
2617 "\\)\\)\\s *\\)@[A-Za-z_-]+\\(\\s \\|$\\)"))
2618 (markup-faces (list c-doc-markup-face-name c-doc-face-name)))
2619
2620 (while (re-search-forward line-re limit t)
2621 (goto-char (match-end 1))
2622
2623 (if (looking-at autodoc-decl-keywords)
2624 (let* ((kwd-pos (point))
2625 (start (match-end 1))
2626 (pos start)
2627 end)
2628
2629 (c-put-font-lock-face (point) pos markup-faces)
2630
2631 ;; Put a declaration end mark at the markup keyword and
2632 ;; remove the faces from the rest of the line so that it
2633 ;; gets refontified as a declaration later on by
2634 ;; `c-font-lock-declarations'.
2635 (c-put-char-property (1- pos) 'c-type 'c-decl-end)
2636 (goto-char pos)
2637 (while (progn
2638 (end-of-line)
2639 (setq end (point))
2640 (and (eq (char-before) ?@)
2641 (not (eobp))
2642 (progn (forward-char)
2643 (skip-syntax-forward " ")
2644 (looking-at c-current-comment-prefix))))
2645 (goto-char (match-end 0))
2646 (c-remove-font-lock-face pos (1- end))
2647 (c-put-font-lock-face (1- end) end markup-faces)
2648 (setq pos (point)))
2649
2650 ;; Include the final newline in the removed area. This
2651 ;; has no visual effect but it avoids some tricky special
2652 ;; cases in the testsuite wrt the differences in string
2653 ;; fontification in Emacs vs XEmacs.
2654 (c-remove-font-lock-face pos (min (1+ (point)) (point-max)))
2655
2656 ;; Must handle string literals explicitly inside the declaration.
2657 (goto-char start)
2658 (while (re-search-forward
2659 "\"\\([^\\\"]\\|\\\\.\\)*\"\\|'\\([^\\']\\|\\\\.\\)*'"
2660 end 'move)
2661 (c-put-font-lock-string-face (match-beginning 0)
2662 (point)))
2663
2664 ;; Fontify types after keywords that always are followed
2665 ;; by them.
2666 (goto-char kwd-pos)
2667 (when (looking-at autodoc-decl-type-keywords)
2668 (c-fontify-types-and-refs ((c-promote-possible-types t))
2669 (goto-char start)
2670 (c-forward-syntactic-ws)
2671 (c-forward-type))))
2672
2673 ;; Mark each whole line as markup, as long as the logical line
2674 ;; continues.
2675 (while (progn
2676 (c-put-font-lock-face (point)
2677 (progn (end-of-line) (point))
2678 markup-faces)
2679 (and (eq (char-before) ?@)
2680 (not (eobp))
2681 (progn (forward-char)
2682 (skip-syntax-forward " ")
2683 (looking-at c-current-comment-prefix))))
2684 (goto-char (match-end 0))))))
2685
2686 nil)
2687
2688 (defconst autodoc-font-lock-doc-comments
2689 `(("@\\(\\w+{\\|\\[\\([^]@\n\r]\\|@@\\)*\\]\\|[@}]\\|$\\)"
2690 ;; In-text markup.
2691 0 ,c-doc-markup-face-name prepend nil)
2692 (autodoc-font-lock-line-markup)
2693 ;; Fontify remaining markup characters as invalid.
2694 (,(lambda (limit)
2695 (c-find-invalid-doc-markup "@" limit))
2696 0 'font-lock-warning-face prepend nil)
2697 ))
2698
2699 (defun autodoc-font-lock-keywords ()
2700 ;; Note that we depend on that `c-current-comment-prefix' has got
2701 ;; its proper value here.
2702 ;;
2703 ;; This function might do hidden buffer changes.
2704
2705 ;; The `c-type' text property with `c-decl-end' is used to mark the
2706 ;; end of the `autodoc-decl-keywords' occurrences to fontify the
2707 ;; following declarations.
2708 (setq c-type-decl-end-used t)
2709
2710 `((,(lambda (limit)
2711 (c-font-lock-doc-comments "/[*/]!" limit
2712 autodoc-font-lock-doc-comments)))))
2713
2714 \f
2715 ;; 2006-07-10: awk-font-lock-keywords has been moved back to cc-awk.el.
2716 (cc-provide 'cc-fonts)
2717
2718 ;; Local Variables:
2719 ;; indent-tabs-mode: t
2720 ;; tab-width: 8
2721 ;; End:
2722 ;;; cc-fonts.el ends here