Update copyright year to 2014 by running admin/update-copyright.
[emacs.git] / lisp / progmodes / cc-fonts.el
blobbf5630da0457fa3060229bcea00e140b62660be2
1 ;;; cc-fonts.el --- font lock support for CC Mode
3 ;; Copyright (C) 2002-2014 Free Software Foundation, Inc.
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
12 ;; This file is part of GNU Emacs.
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.
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.
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/>.
27 ;;; Commentary:
29 ;; Some comments on the use of faces:
31 ;; o `c-label-face-name' is either `font-lock-constant-face' (in
32 ;; Emacs), or `font-lock-reference-face'.
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'.
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.
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).
48 ;; TBD: We should probably provide real faces for the above uses and
49 ;; instead initialize them from the standard faces.
51 ;;; Code:
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):
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.
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)))
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 ..).
83 ;; Avoid repeated loading through the eval-after-load directive in
84 ;; cc-mode.el.
85 (provide 'cc-fonts)
87 (cc-external-require 'font-lock)
89 (cc-bytecomp-defvar parse-sexp-lookup-properties) ; Emacs only.
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)
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.
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)
117 'font-lock-reference-face)))
119 (cc-bytecomp-defvar font-lock-constant-face)
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)
134 'font-lock-reference-face)))
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))
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)))
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)
163 'font-lock-comment-face)))
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))
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))
178 (cc-bytecomp-defun face-inverse-video-p) ; Only in Emacs.
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)))))
196 (defvar c-annotation-face 'c-annotation-face)
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)
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.
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)
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.
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)))
229 (defmacro c-remove-font-lock-face (from to)
230 ;; This is the inverse of `c-put-font-lock-face'.
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))))
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.
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)))
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.
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)
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.
266 ;; This function might do hidden buffer changes.
267 (when (c-got-face-at (point) c-literal-faces)
268 (while (progn
269 (goto-char (next-single-property-change
270 (point) 'face nil limit))
271 (and (< (point) limit)
272 (c-got-face-at (point) c-literal-faces))))
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.
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))))
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))))
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.
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.
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.
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.)
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))))
370 ;; (while (re-search-forward ,regexp limit t)
371 ;; (unless (progn
372 ;; (goto-char (match-beginning 0))
373 ;; (c-skip-comments-and-strings limit))
374 ;; (goto-char (match-end 0))
375 ;; ,@(mapcar
376 ;; (lambda (highlight)
377 ;; (if (integerp (car highlight))
378 ;; (progn
379 ;; (unless (eq (nth 2 highlight) t)
380 ;; (error
381 ;; "The override flag must currently be t in %s"
382 ;; highlight))
383 ;; (when (nth 3 highlight)
384 ;; (error
385 ;; "The laxmatch flag may currently not be set in %s"
386 ;; highlight))
387 ;; `(save-match-data
388 ;; (c-put-font-lock-face
389 ;; (match-beginning ,(car highlight))
390 ;; (match-end ,(car highlight))
391 ;; ,(elt highlight 1))))
392 ;; (when (nth 3 highlight)
393 ;; (error "Match highlights currently not supported in %s"
394 ;; highlight))
395 ;; `(progn
396 ;; ,(nth 1 highlight)
397 ;; (save-match-data ,(car highlight))
398 ;; ,(nth 2 highlight))))
399 ;; highlights)))
400 ,(c-make-font-lock-search-form regexp highlights))
402 nil)))
404 (defun c-make-font-lock-BO-decl-search-function (regexp &rest highlights)
405 ;; This function makes a byte compiled function that first moves back
406 ;; to the beginning of the current declaration (if any), then searches
407 ;; forward for matcher elements (as in `font-lock-keywords') and
408 ;; fontifies them.
410 ;; The motivation for moving back to the declaration start is to
411 ;; establish a context for the current text when, e.g., a character
412 ;; is typed on a C++ inheritance continuation line, or a jit-lock
413 ;; chunk starts there.
415 ;; The new function works much like a matcher element in
416 ;; `font-lock-keywords'. It cuts out a little bit of the overhead
417 ;; compared to a real matcher. The main reason is however to pass the
418 ;; real search limit to the anchored matcher(s), since most (if not
419 ;; all) font-lock implementations arbitrarily limit anchored matchers
420 ;; to the same line, and also to insulate against various other
421 ;; irritating differences between the different (X)Emacs font-lock
422 ;; packages.
424 ;; REGEXP is the matcher, which must be a regexp. Only matches
425 ;; where the beginning is outside any comment or string literal are
426 ;; significant.
428 ;; HIGHLIGHTS is a list of highlight specs, just like in
429 ;; `font-lock-keywords', with these limitations: The face is always
430 ;; overridden (no big disadvantage, since hits in comments etc are
431 ;; filtered anyway), there is no "laxmatch", and an anchored matcher
432 ;; is always a form which must do all the fontification directly.
433 ;; `limit' is a variable bound to the real limit in the context of
434 ;; the anchored matcher forms.
436 ;; This function does not do any hidden buffer changes, but the
437 ;; generated functions will. (They are however used in places
438 ;; covered by the font-lock context.)
440 ;; Note: Replace `byte-compile' with `eval' to debug the generated
441 ;; lambda more easily.
442 (byte-compile
443 `(lambda (limit)
444 (let ( ;; The font-lock package in Emacs is known to clobber
445 ;; `parse-sexp-lookup-properties' (when it exists).
446 (parse-sexp-lookup-properties
447 (cc-eval-when-compile
448 (boundp 'parse-sexp-lookup-properties)))
449 (BOD-limit
450 (c-determine-limit 1000)))
451 (goto-char
452 (let ((here (point)))
453 (if (eq (car (c-beginning-of-decl-1 BOD-limit)) 'same)
454 (point)
455 here)))
456 ,(c-make-font-lock-search-form regexp highlights))
457 nil)))
459 (defun c-make-font-lock-context-search-function (normal &rest state-stanzas)
460 ;; This function makes a byte compiled function that works much like
461 ;; a matcher element in `font-lock-keywords', with the following
462 ;; enhancement: the generated function will test for particular "font
463 ;; lock contexts" at the start of the region, i.e. is this point in
464 ;; the middle of some particular construct? if so the generated
465 ;; function will first fontify the tail of the construct, before
466 ;; going into the main loop and fontify full constructs up to limit.
468 ;; The generated function takes one parameter called `limit', and
469 ;; will fontify the region between POINT and LIMIT.
471 ;; NORMAL is a list of the form (REGEXP HIGHLIGHTS .....), and is
472 ;; used to fontify the "regular" bit of the region.
473 ;; STATE-STANZAS is list of elements of the form (STATE LIM REGEXP
474 ;; HIGHLIGHTS), each element coding one possible font lock context.
476 ;; o - REGEXP is a font-lock regular expression (NOT a function),
477 ;; o - HIGHLIGHTS is a list of zero or more highlighters as defined
478 ;; on page "Search-based Fontification" in the elisp manual. As
479 ;; yet (2009-06), they must have OVERRIDE set, and may not have
480 ;; LAXMATCH set.
482 ;; o - STATE is the "font lock context" (e.g. in-cpp-expr) and is
483 ;; not quoted.
484 ;; o - LIM is a lisp form whose evaluation will yield the limit
485 ;; position in the buffer for fontification by this stanza.
487 ;; This function does not do any hidden buffer changes, but the
488 ;; generated functions will. (They are however used in places
489 ;; covered by the font-lock context.)
491 ;; Note: Replace `byte-compile' with `eval' to debug the generated
492 ;; lambda more easily.
493 (byte-compile
494 `(lambda (limit)
495 (let ( ;; The font-lock package in Emacs is known to clobber
496 ;; `parse-sexp-lookup-properties' (when it exists).
497 (parse-sexp-lookup-properties
498 (cc-eval-when-compile
499 (boundp 'parse-sexp-lookup-properties))))
500 ,@(mapcar
501 (lambda (stanza)
502 (let ((state (car stanza))
503 (lim (nth 1 stanza))
504 (regexp (nth 2 stanza))
505 (highlights (cdr (cddr stanza))))
506 `(if (eq c-font-lock-context ',state)
507 (let ((limit ,lim))
508 ,(c-make-font-lock-search-form
509 regexp highlights)))))
510 state-stanzas)
511 ,(c-make-font-lock-search-form (car normal) (cdr normal))
512 nil))))
514 ; (eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
515 ; '(progn
516 (def-edebug-spec c-fontify-types-and-refs let*)
517 (def-edebug-spec c-make-syntactic-matcher t)
518 ;; If there are literal quoted or backquoted highlight specs in
519 ;; the call to `c-make-font-lock-search-function' then let's
520 ;; instrument the forms in them.
521 (def-edebug-spec c-make-font-lock-search-function
522 (form &rest &or ("quote" (&rest form)) ("`" (&rest form)) form)));))
524 (defun c-fontify-recorded-types-and-refs ()
525 ;; Convert the ranges recorded on `c-record-type-identifiers' and
526 ;; `c-record-ref-identifiers' to fontification.
528 ;; This function does hidden buffer changes.
529 (let (elem)
530 (while (consp c-record-type-identifiers)
531 (setq elem (car c-record-type-identifiers)
532 c-record-type-identifiers (cdr c-record-type-identifiers))
533 (c-put-font-lock-face (car elem) (cdr elem)
534 'font-lock-type-face))
535 (while c-record-ref-identifiers
536 (setq elem (car c-record-ref-identifiers)
537 c-record-ref-identifiers (cdr c-record-ref-identifiers))
538 ;; Note that the reference face is a variable that is
539 ;; dereferenced, since it's an alias in Emacs.
540 (c-put-font-lock-face (car elem) (cdr elem)
541 c-reference-face-name))))
543 (c-lang-defconst c-cpp-matchers
544 "Font lock matchers for preprocessor directives and purely lexical
545 stuff. Used on level 1 and higher."
547 ;; Note: `c-font-lock-declarations' assumes that no matcher here
548 ;; sets `font-lock-type-face' in languages where
549 ;; `c-recognize-<>-arglists' is set.
551 t `(,@(when (c-lang-const c-opt-cpp-prefix)
552 (let* ((noncontinued-line-end "\\(\\=\\|\\(\\=\\|[^\\]\\)[\n\r]\\)")
553 (ncle-depth (regexp-opt-depth noncontinued-line-end))
554 (sws-depth (c-lang-const c-syntactic-ws-depth))
555 (nsws-depth (c-lang-const c-nonempty-syntactic-ws-depth)))
557 `(;; The stuff after #error and #warning is a message, so
558 ;; fontify it as a string.
559 ,@(when (c-lang-const c-cpp-message-directives)
560 (let* ((re (c-make-keywords-re 'appendable ; nil
561 (c-lang-const c-cpp-message-directives)))
562 (re-depth (regexp-opt-depth re)))
563 `((,(concat noncontinued-line-end
564 (c-lang-const c-opt-cpp-prefix)
566 "\\s +\\(.*\\)$")
567 ,(+ ncle-depth re-depth 1) font-lock-string-face t))))
569 ;; Fontify filenames in #include <...> as strings.
570 ,@(when (c-lang-const c-cpp-include-directives)
571 (let* ((re (c-make-keywords-re nil
572 (c-lang-const c-cpp-include-directives)))
573 (re-depth (regexp-opt-depth re)))
574 `((,(concat noncontinued-line-end
575 (c-lang-const c-opt-cpp-prefix)
577 (c-lang-const c-syntactic-ws)
578 "\\(<[^>\n\r]*>?\\)")
579 (,(+ ncle-depth re-depth sws-depth 1)
580 font-lock-string-face)
582 ;; Use an anchored matcher to put paren syntax
583 ;; on the brackets.
584 (,(byte-compile
585 `(lambda (limit)
586 (let ((beg (match-beginning
587 ,(+ ncle-depth re-depth sws-depth 1)))
588 (end (1- (match-end ,(+ ncle-depth re-depth
589 sws-depth 1)))))
590 (if (eq (char-after end) ?>)
591 (progn
592 (c-mark-<-as-paren beg)
593 (c-mark->-as-paren end))
594 ;; (c-clear-char-property beg 'syntax-table)
595 (c-clear-char-property beg 'category)))
596 nil)))))))
598 ;; #define.
599 ,@(when (c-lang-const c-opt-cpp-macro-define)
600 `((,(c-make-font-lock-search-function
601 (concat
602 noncontinued-line-end
603 (c-lang-const c-opt-cpp-prefix)
604 (c-lang-const c-opt-cpp-macro-define)
605 (c-lang-const c-nonempty-syntactic-ws)
606 "\\(" (c-lang-const ; 1 + ncle + nsws
607 c-symbol-key) "\\)"
608 (concat "\\(" ; 2 + ncle + nsws + c-sym-key
609 ;; Macro with arguments - a "function".
610 "\\(\(\\)" ; 3 + ncle + nsws + c-sym-key
611 "\\|"
612 ;; Macro without arguments - a "variable".
613 "\\([^\(]\\|$\\)"
614 "\\)"))
615 `((if (match-beginning
616 ,(+ 3 ncle-depth nsws-depth
617 (c-lang-const c-symbol-key-depth)))
619 ;; "Function". Fontify the name and the arguments.
620 (save-restriction
621 (c-put-font-lock-face
622 (match-beginning ,(+ 1 ncle-depth nsws-depth))
623 (match-end ,(+ 1 ncle-depth nsws-depth))
624 'font-lock-function-name-face)
625 (goto-char
626 (match-end
627 ,(+ 3 ncle-depth nsws-depth
628 (c-lang-const c-symbol-key-depth))))
630 (narrow-to-region (point-min) limit)
631 (while (and
632 (progn
633 (c-forward-syntactic-ws)
634 (looking-at c-symbol-key))
635 (progn
636 (c-put-font-lock-face
637 (match-beginning 0) (match-end 0)
638 'font-lock-variable-name-face)
639 (goto-char (match-end 0))
640 (c-forward-syntactic-ws)
641 (eq (char-after) ?,)))
642 (forward-char)))
644 ;; "Variable".
645 (c-put-font-lock-face
646 (match-beginning ,(+ 1 ncle-depth nsws-depth))
647 (match-end ,(+ 1 ncle-depth nsws-depth))
648 'font-lock-variable-name-face)))))))
650 ;; Fontify cpp function names in preprocessor
651 ;; expressions in #if and #elif.
652 ,@(when (and (c-lang-const c-cpp-expr-directives)
653 (c-lang-const c-cpp-expr-functions))
654 (let ((ced-re (c-make-keywords-re t
655 (c-lang-const c-cpp-expr-directives)))
656 (cef-re (c-make-keywords-re t
657 (c-lang-const c-cpp-expr-functions))))
659 `((,(c-make-font-lock-context-search-function
660 `(,(concat noncontinued-line-end
661 (c-lang-const c-opt-cpp-prefix)
662 ced-re ; 1 + ncle-depth
663 ;; Match the whole logical line to look
664 ;; for the functions in.
665 "\\(\\\\\\(.\\|[\n\r]\\)\\|[^\n\r]\\)*")
666 ((let ((limit (match-end 0)))
667 (while (re-search-forward ,cef-re limit 'move)
668 (c-put-font-lock-face (match-beginning 1)
669 (match-end 1)
670 c-preprocessor-face-name)))
671 (goto-char (match-end ,(1+ ncle-depth)))))
672 `(in-cpp-expr
673 (save-excursion (c-end-of-macro) (point))
674 ,cef-re
675 (1 c-preprocessor-face-name t)))))))
677 ;; Fontify the directive names.
678 (,(c-make-font-lock-search-function
679 (concat noncontinued-line-end
680 "\\("
681 (c-lang-const c-opt-cpp-prefix)
682 "[" (c-lang-const c-symbol-chars) "]+"
683 "\\)")
684 `(,(1+ ncle-depth) c-preprocessor-face-name t)))
686 (eval . (list ,(c-make-syntactic-matcher
687 (concat noncontinued-line-end
688 (c-lang-const c-opt-cpp-prefix)
689 "if\\(n\\)def\\>"))
690 ,(+ ncle-depth 1)
691 c-negation-char-face-name
692 'append))
695 ,@(when (c-major-mode-is 'pike-mode)
696 ;; Recognize hashbangs in Pike.
697 `((eval . (list "\\`#![^\n\r]*"
698 0 c-preprocessor-face-name))))
700 ;; Make hard spaces visible through an inverted `font-lock-warning-face'.
701 (eval . (list
702 "\240"
703 0 (progn
704 (unless (c-face-name-p 'c-nonbreakable-space-face)
705 (c-make-inverse-face 'font-lock-warning-face
706 'c-nonbreakable-space-face))
707 ''c-nonbreakable-space-face)))
710 (defun c-font-lock-invalid-string ()
711 ;; Assuming the point is after the opening character of a string,
712 ;; fontify that char with `font-lock-warning-face' if the string
713 ;; decidedly isn't terminated properly.
715 ;; This function does hidden buffer changes.
716 (let ((start (1- (point))))
717 (save-excursion
718 (and (eq (elt (parse-partial-sexp start (c-point 'eol)) 8) start)
719 (if (integerp c-multiline-string-start-char)
720 ;; There's no multiline string start char before the
721 ;; string, so newlines aren't allowed.
722 (not (eq (char-before start) c-multiline-string-start-char))
723 ;; Multiline strings are allowed anywhere if
724 ;; c-multiline-string-start-char is t.
725 (not c-multiline-string-start-char))
726 (if c-string-escaped-newlines
727 ;; There's no \ before the newline.
728 (not (eq (char-before (point)) ?\\))
729 ;; Escaped newlines aren't supported.
731 (c-put-font-lock-face start (1+ start) 'font-lock-warning-face)))))
733 (c-lang-defconst c-basic-matchers-before
734 "Font lock matchers for basic keywords, labels, references and various
735 other easily recognizable things that should be fontified before generic
736 casts and declarations are fontified. Used on level 2 and higher."
738 ;; Note: `c-font-lock-declarations' assumes that no matcher here
739 ;; sets `font-lock-type-face' in languages where
740 ;; `c-recognize-<>-arglists' is set.
742 t `(;; Put a warning face on the opener of unclosed strings that
743 ;; can't span lines. Later font
744 ;; lock packages have a `font-lock-syntactic-face-function' for
745 ;; this, but it doesn't give the control we want since any
746 ;; fontification done inside the function will be
747 ;; unconditionally overridden.
748 ,(c-make-font-lock-search-function
749 ;; Match a char before the string starter to make
750 ;; `c-skip-comments-and-strings' work correctly.
751 (concat ".\\(" c-string-limit-regexp "\\)")
752 '((c-font-lock-invalid-string)))
754 ;; Fontify keyword constants.
755 ,@(when (c-lang-const c-constant-kwds)
756 (let ((re (c-make-keywords-re nil (c-lang-const c-constant-kwds))))
757 (if (c-major-mode-is 'pike-mode)
758 ;; No symbol is a keyword after "->" in Pike.
759 `((eval . (list ,(concat "\\(\\=.?\\|[^>]\\|[^-]>\\)"
760 "\\<\\(" re "\\)\\>")
761 2 c-constant-face-name)))
762 `((eval . (list ,(concat "\\<\\(" re "\\)\\>")
763 1 c-constant-face-name))))))
765 ;; Fontify all keywords except the primitive types.
766 ,(if (c-major-mode-is 'pike-mode)
767 ;; No symbol is a keyword after "->" in Pike.
768 `(,(concat "\\(\\=.?\\|[^>]\\|[^-]>\\)"
769 "\\<" (c-lang-const c-regular-keywords-regexp))
770 2 font-lock-keyword-face)
771 `(,(concat "\\<" (c-lang-const c-regular-keywords-regexp))
772 1 font-lock-keyword-face))
774 ;; Fontify leading identifiers in fully qualified names like
775 ;; "foo::bar" in languages that supports such things.
776 ,@(when (c-lang-const c-opt-identifier-concat-key)
777 (if (c-major-mode-is 'java-mode)
778 ;; Java needs special treatment since "." is used both to
779 ;; qualify names and in normal indexing. Here we look for
780 ;; capital characters at the beginning of an identifier to
781 ;; recognize the class. "*" is also recognized to cover
782 ;; wildcard import declarations. All preceding dot separated
783 ;; identifiers are taken as package names and therefore
784 ;; fontified as references.
785 `(,(c-make-font-lock-search-function
786 ;; Search for class identifiers preceded by ".". The
787 ;; anchored matcher takes it from there.
788 (concat (c-lang-const c-opt-identifier-concat-key)
789 (c-lang-const c-simple-ws) "*"
790 (concat "\\("
791 "[" c-upper "]"
792 "[" (c-lang-const c-symbol-chars) "]*"
793 "\\|"
794 "\\*"
795 "\\)"))
796 `((let (id-end)
797 (goto-char (1+ (match-beginning 0)))
798 (while (and (eq (char-before) ?.)
799 (progn
800 (backward-char)
801 (c-backward-syntactic-ws)
802 (setq id-end (point))
803 (< (skip-chars-backward
804 ,(c-lang-const c-symbol-chars)) 0))
805 (not (get-text-property (point) 'face)))
806 (c-put-font-lock-face (point) id-end
807 c-reference-face-name)
808 (c-backward-syntactic-ws)))
810 (goto-char (match-end 0)))))
812 `((,(byte-compile
813 ;; Must use a function here since we match longer than
814 ;; we want to move before doing a new search. This is
815 ;; not necessary for XEmacs since it restarts the
816 ;; search from the end of the first highlighted
817 ;; submatch (something that causes problems in other
818 ;; places).
819 `(lambda (limit)
820 (while (re-search-forward
821 ,(concat "\\(\\<" ; 1
822 "\\(" (c-lang-const c-symbol-key) "\\)" ; 2
823 (c-lang-const c-simple-ws) "*"
824 (c-lang-const c-opt-identifier-concat-key)
825 (c-lang-const c-simple-ws) "*"
826 "\\)"
827 "\\("
828 (c-lang-const c-opt-after-id-concat-key)
829 "\\)")
830 limit t)
831 (unless (progn
832 (goto-char (match-beginning 0))
833 (c-skip-comments-and-strings limit))
834 (or (get-text-property (match-beginning 2) 'face)
835 (c-put-font-lock-face (match-beginning 2)
836 (match-end 2)
837 c-reference-face-name))
838 (goto-char (match-end 1))))))))))
840 ;; Fontify the special declarations in Objective-C.
841 ,@(when (c-major-mode-is 'objc-mode)
842 `(;; Fontify class names in the beginning of message expressions.
843 ,(c-make-font-lock-search-function
844 "\\["
845 '((c-fontify-types-and-refs ()
846 (c-forward-syntactic-ws limit)
847 (let ((start (point)))
848 ;; In this case we accept both primitive and known types.
849 (when (eq (c-forward-type) 'known)
850 (goto-char start)
851 (let ((c-promote-possible-types t))
852 (c-forward-type))))
853 (if (> (point) limit) (goto-char limit)))))
855 ;; The @interface/@implementation/@protocol directives.
856 ,(c-make-font-lock-search-function
857 (concat "\\<"
858 (regexp-opt
859 '("@interface" "@implementation" "@protocol")
861 "\\>")
862 '((c-fontify-types-and-refs
863 (;; The font-lock package in Emacs is known to clobber
864 ;; `parse-sexp-lookup-properties' (when it exists).
865 (parse-sexp-lookup-properties
866 (cc-eval-when-compile
867 (boundp 'parse-sexp-lookup-properties))))
868 (c-forward-objc-directive)
869 nil)
870 (goto-char (match-beginning 0))))))
872 (eval . (list "\\(!\\)[^=]" 1 c-negation-char-face-name))
875 (defun c-font-lock-complex-decl-prepare (limit)
876 ;; This function will be called from font-lock for a region bounded by POINT
877 ;; and LIMIT, as though it were to identify a keyword for
878 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
879 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
880 ;; Fontification".
882 ;; Called before any of the matchers in `c-complex-decl-matchers'.
884 ;; This function does hidden buffer changes.
886 ;;(message "c-font-lock-complex-decl-prepare %s %s" (point) limit)
888 ;; Clear the list of found types if we start from the start of the
889 ;; buffer, to make it easier to get rid of misspelled types and
890 ;; variables that have gotten recognized as types in malformed code.
891 (when (bobp)
892 (c-clear-found-types))
894 ;; Clear the c-type char properties which mark the region, to recalculate
895 ;; them properly. The most interesting properties are those put on the
896 ;; closest token before the region.
897 (save-excursion
898 (let ((pos (point)))
899 (c-backward-syntactic-ws)
900 (c-clear-char-properties
901 (if (and (not (bobp))
902 (memq (c-get-char-property (1- (point)) 'c-type)
903 '(c-decl-arg-start
904 c-decl-end
905 c-decl-id-start
906 c-decl-type-start)))
907 (1- (point))
908 pos)
909 limit 'c-type)))
911 ;; Update `c-state-cache' to the beginning of the region. This will
912 ;; make `c-beginning-of-syntax' go faster when it's used later on,
913 ;; and it's near the point most of the time.
914 (c-parse-state)
916 ;; Check if the fontified region starts inside a declarator list so
917 ;; that `c-font-lock-declarators' should be called at the start.
918 ;; The declared identifiers are font-locked correctly as types, if
919 ;; that is what they are.
920 (let ((prop (save-excursion
921 (c-backward-syntactic-ws)
922 (unless (bobp)
923 (c-get-char-property (1- (point)) 'c-type)))))
924 (when (memq prop '(c-decl-id-start c-decl-type-start))
925 (c-forward-syntactic-ws limit)
926 (c-font-lock-declarators limit t (eq prop 'c-decl-type-start))))
928 (setq c-font-lock-context ;; (c-guess-font-lock-context)
929 (save-excursion
930 (if (and c-cpp-expr-intro-re
931 (c-beginning-of-macro)
932 (looking-at c-cpp-expr-intro-re))
933 'in-cpp-expr)))
934 nil)
936 (defun c-font-lock-<>-arglists (limit)
937 ;; This function will be called from font-lock for a region bounded by POINT
938 ;; and LIMIT, as though it were to identify a keyword for
939 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
940 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
941 ;; Fontification".
943 ;; Fontify types and references in names containing angle bracket
944 ;; arglists from the point to LIMIT. Note that
945 ;; `c-font-lock-declarations' already has handled many of them.
947 ;; This function might do hidden buffer changes.
949 (let (;; The font-lock package in Emacs is known to clobber
950 ;; `parse-sexp-lookup-properties' (when it exists).
951 (parse-sexp-lookup-properties
952 (cc-eval-when-compile
953 (boundp 'parse-sexp-lookup-properties)))
954 (c-parse-and-markup-<>-arglists t)
955 c-restricted-<>-arglists
956 id-start id-end id-face pos kwd-sym)
958 (while (and (< (point) limit)
959 (re-search-forward c-opt-<>-arglist-start limit t))
961 (setq id-start (match-beginning 1)
962 id-end (match-end 1)
963 pos (point))
965 (goto-char id-start)
966 (unless (c-skip-comments-and-strings limit)
967 (setq kwd-sym nil
968 c-restricted-<>-arglists nil
969 id-face (get-text-property id-start 'face))
971 (if (cond
972 ((eq id-face 'font-lock-type-face)
973 ;; The identifier got the type face so it has already been
974 ;; handled in `c-font-lock-declarations'.
975 nil)
977 ((eq id-face 'font-lock-keyword-face)
978 (when (looking-at c-opt-<>-sexp-key)
979 ;; There's a special keyword before the "<" that tells
980 ;; that it's an angle bracket arglist.
981 (setq kwd-sym (c-keyword-sym (match-string 1)))))
984 ;; There's a normal identifier before the "<". If we're not in
985 ;; a declaration context then we set `c-restricted-<>-arglists'
986 ;; to avoid recognizing templates in function calls like "foo (a
987 ;; < b, c > d)".
988 (c-backward-syntactic-ws)
989 (when (and (memq (char-before) '(?\( ?,))
990 (not (eq (get-text-property (1- (point)) 'c-type)
991 'c-decl-arg-start)))
992 (setq c-restricted-<>-arglists t))
995 (progn
996 (goto-char (1- pos))
997 ;; Check for comment/string both at the identifier and
998 ;; at the "<".
999 (unless (c-skip-comments-and-strings limit)
1001 (c-fontify-types-and-refs ()
1002 (when (c-forward-<>-arglist (c-keyword-member
1003 kwd-sym 'c-<>-type-kwds))
1004 (when (and c-opt-identifier-concat-key
1005 (not (get-text-property id-start 'face)))
1006 (c-forward-syntactic-ws)
1007 (if (looking-at c-opt-identifier-concat-key)
1008 (c-put-font-lock-face id-start id-end
1009 c-reference-face-name)
1010 (c-put-font-lock-face id-start id-end
1011 'font-lock-type-face)))))
1013 (goto-char pos)))
1014 (goto-char pos)))))
1015 nil)
1017 (defun c-font-lock-declarators (limit list types)
1018 ;; Assuming the point is at the start of a declarator in a declaration,
1019 ;; fontify the identifier it declares. (If TYPES is set, it does this via
1020 ;; the macro `c-fontify-types-and-refs'.)
1022 ;; If LIST is non-nil, also fontify the ids in any following declarators in
1023 ;; a comma separated list (e.g. "foo" and "*bar" in "int foo = 17, *bar;");
1024 ;; additionally, mark the commas with c-type property 'c-decl-id-start or
1025 ;; 'c-decl-type-start (according to TYPES). Stop at LIMIT.
1027 ;; If TYPES is non-nil, fontify all identifiers as types.
1029 ;; Nil is always returned. The function leaves point at the delimiter after
1030 ;; the last declarator it processes.
1032 ;; This function might do hidden buffer changes.
1034 ;;(message "c-font-lock-declarators from %s to %s" (point) limit)
1035 (c-fontify-types-and-refs
1036 ((pos (point)) next-pos id-start id-end
1037 paren-depth
1038 id-face got-init
1039 c-last-identifier-range
1040 (separator-prop (if types 'c-decl-type-start 'c-decl-id-start)))
1042 ;; The following `while' fontifies a single declarator id each time round.
1043 ;; It loops only when LIST is non-nil.
1044 (while
1045 ;; Inside the following "condition form", we move forward over the
1046 ;; declarator's identifier up as far as any opening bracket (for array
1047 ;; size) or paren (for parameters of function-type) or brace (for
1048 ;; array/struct initialization) or "=" or terminating delimiter
1049 ;; (e.g. "," or ";" or "}").
1050 (and
1052 (< (point) limit)
1054 ;; The following form moves forward over the declarator's
1055 ;; identifier (and what precedes it), returning t. If there
1056 ;; wasn't one, it returns nil, terminating the `while'.
1057 (let (got-identifier)
1058 (setq paren-depth 0)
1059 ;; Skip over type decl prefix operators, one for each iteration
1060 ;; of the while. These are, e.g. "*" in "int *foo" or "(" and
1061 ;; "*" in "int (*foo) (void)" (Note similar code in
1062 ;; `c-forward-decl-or-cast-1'.)
1063 (while (and (looking-at c-type-decl-prefix-key)
1064 (if (and (c-major-mode-is 'c++-mode)
1065 (match-beginning 3))
1066 ;; If the third submatch matches in C++ then
1067 ;; we're looking at an identifier that's a
1068 ;; prefix only if it specifies a member pointer.
1069 (progn
1070 (setq id-start (point))
1071 (c-forward-name)
1072 (if (looking-at "\\(::\\)")
1073 ;; We only check for a trailing "::" and
1074 ;; let the "*" that should follow be
1075 ;; matched in the next round.
1077 ;; It turned out to be the real identifier,
1078 ;; so flag that and stop.
1079 (setq got-identifier t)
1080 nil))
1082 (if (eq (char-after) ?\()
1083 (progn
1084 (setq paren-depth (1+ paren-depth))
1085 (forward-char))
1086 (goto-char (match-end 1)))
1087 (c-forward-syntactic-ws))
1089 ;; If we haven't passed the identifier already, do it now.
1090 (unless got-identifier
1091 (setq id-start (point))
1092 (c-forward-name))
1093 (setq id-end (point))
1095 (/= id-end pos))
1097 ;; Skip out of the parens surrounding the identifier. If closing
1098 ;; parens are missing, this form returns nil.
1099 (or (= paren-depth 0)
1100 (c-safe (goto-char (scan-lists (point) 1 paren-depth))))
1102 (<= (point) limit)
1104 ;; Skip over any trailing bit, such as "__attribute__".
1105 (progn
1106 (when (looking-at c-decl-hangon-key)
1107 (c-forward-keyword-clause 1))
1108 (<= (point) limit))
1110 ;; Search syntactically to the end of the declarator (";",
1111 ;; ",", a closing paren, eob etc) or to the beginning of an
1112 ;; initializer or function prototype ("=" or "\\s\(").
1113 ;; Note that the open paren will match array specs in
1114 ;; square brackets, and we treat them as initializers too.
1115 (c-syntactic-re-search-forward
1116 "[;,]\\|\\s)\\|\\'\\|\\(=\\|\\s(\\)" limit t t))
1118 (setq next-pos (match-beginning 0)
1119 id-face (if (and (eq (char-after next-pos) ?\()
1120 (let (c-last-identifier-range)
1121 (save-excursion
1122 (goto-char next-pos)
1123 (c-at-toplevel-p))))
1124 'font-lock-function-name-face
1125 'font-lock-variable-name-face)
1126 got-init (and (match-beginning 1)
1127 (char-after (match-beginning 1))))
1129 (if types
1130 ;; Register and fontify the identifier as a type.
1131 (let ((c-promote-possible-types t))
1132 (goto-char id-start)
1133 (c-forward-type))
1134 ;; Fontify the last symbol in the identifier if it isn't fontified
1135 ;; already. The check is necessary only in certain cases where this
1136 ;; function is used "sloppily", e.g. in `c-simple-decl-matchers'.
1137 (when (and c-last-identifier-range
1138 (not (get-text-property (car c-last-identifier-range)
1139 'face)))
1140 (c-put-font-lock-face (car c-last-identifier-range)
1141 (cdr c-last-identifier-range)
1142 id-face)))
1144 (goto-char next-pos)
1145 (setq pos nil) ; So as to terminate the enclosing `while' form.
1146 (when list
1147 ;; Jump past any initializer or function prototype to see if
1148 ;; there's a ',' to continue at.
1150 (cond ((eq id-face 'font-lock-function-name-face)
1151 ;; Skip a parenthesized initializer (C++) or a function
1152 ;; prototype.
1153 (if (c-safe (c-forward-sexp 1) t) ; over the parameter list.
1154 (c-forward-syntactic-ws limit)
1155 (goto-char limit))) ; unbalanced parens
1157 (got-init ; "=" sign OR opening "(", "[", or "{"
1158 ;; Skip an initializer expression. If we're at a '='
1159 ;; then accept a brace list directly after it to cope
1160 ;; with array initializers. Otherwise stop at braces
1161 ;; to avoid going past full function and class blocks.
1162 (and (if (and (eq got-init ?=)
1163 (= (c-forward-token-2 1 nil limit) 0)
1164 (looking-at "{"))
1165 (c-safe (c-forward-sexp) t) ; over { .... }
1167 ;; FIXME: Should look for c-decl-end markers here;
1168 ;; we might go far into the following declarations
1169 ;; in e.g. ObjC mode (see e.g. methods-4.m).
1170 (c-syntactic-re-search-forward "[;,{]" limit 'move t)
1171 (backward-char)))
1173 (t (c-forward-syntactic-ws limit)))
1175 ;; If a ',' is found we set pos to the next declarator and iterate.
1176 (when (and (< (point) limit) (looking-at ","))
1177 (c-put-char-property (point) 'c-type separator-prop)
1178 (forward-char)
1179 (c-forward-syntactic-ws limit)
1180 (setq pos (point)))))) ; acts to make the `while' form continue.
1181 nil)
1183 (defconst c-font-lock-maybe-decl-faces
1184 ;; List of faces that might be put at the start of a type when
1185 ;; `c-font-lock-declarations' runs. This needs to be evaluated to
1186 ;; ensure that face name aliases in Emacs are resolved.
1187 (list nil
1188 font-lock-type-face
1189 c-reference-face-name
1190 font-lock-keyword-face))
1192 (defun c-font-lock-declarations (limit)
1193 ;; Fontify all the declarations, casts and labels from the point to LIMIT.
1194 ;; Assumes that strings and comments have been fontified already.
1196 ;; This function will be called from font-lock for a region bounded by POINT
1197 ;; and LIMIT, as though it were to identify a keyword for
1198 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
1199 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
1200 ;; Fontification".
1202 ;; This function might do hidden buffer changes.
1204 ;;(message "c-font-lock-declarations search from %s to %s" (point) limit)
1206 (save-restriction
1207 (let (;; The position where `c-find-decl-spots' last stopped.
1208 start-pos
1209 ;; o - 'decl if we're in an arglist containing declarations
1210 ;; (but if `c-recognize-paren-inits' is set it might also be
1211 ;; an initializer arglist);
1212 ;; o - '<> if the arglist is of angle bracket type;
1213 ;; o - 'arglist if it's some other arglist;
1214 ;; o - nil, if not in an arglist at all. This includes the
1215 ;; parenthesized condition which follows "if", "while", etc.
1216 context
1217 ;; The position of the next token after the closing paren of
1218 ;; the last detected cast.
1219 last-cast-end
1220 ;; The result from `c-forward-decl-or-cast-1'.
1221 decl-or-cast
1222 ;; The maximum of the end positions of all the checked type
1223 ;; decl expressions in the successfully identified
1224 ;; declarations. The position might be either before or
1225 ;; after the syntactic whitespace following the last token
1226 ;; in the type decl expression.
1227 (max-type-decl-end 0)
1228 ;; Same as `max-type-decl-*', but used when we're before
1229 ;; `token-pos'.
1230 (max-type-decl-end-before-token 0)
1231 ;; Set according to the context to direct the heuristics for
1232 ;; recognizing C++ templates.
1233 c-restricted-<>-arglists
1234 ;; Turn on recording of identifier ranges in
1235 ;; `c-forward-decl-or-cast-1' and `c-forward-label' for
1236 ;; later fontification.
1237 (c-record-type-identifiers t)
1238 label-type
1239 c-record-ref-identifiers
1240 ;; Make `c-forward-type' calls mark up template arglists if
1241 ;; it finds any. That's necessary so that we later will
1242 ;; stop inside them to fontify types there.
1243 (c-parse-and-markup-<>-arglists t)
1244 lbrace ; position of some {.
1245 ;; The font-lock package in Emacs is known to clobber
1246 ;; `parse-sexp-lookup-properties' (when it exists).
1247 (parse-sexp-lookup-properties
1248 (cc-eval-when-compile
1249 (boundp 'parse-sexp-lookup-properties))))
1251 ;; Below we fontify a whole declaration even when it crosses the limit,
1252 ;; to avoid gaps when jit/lazy-lock fontifies the file a block at a
1253 ;; time. That is however annoying during editing, e.g. the following is
1254 ;; a common situation while the first line is being written:
1256 ;; my_variable
1257 ;; some_other_variable = 0;
1259 ;; font-lock will put the limit at the beginning of the second line
1260 ;; here, and if we go past it we'll fontify "my_variable" as a type and
1261 ;; "some_other_variable" as an identifier, and the latter will not
1262 ;; correct itself until the second line is changed. To avoid that we
1263 ;; narrow to the limit if the region to fontify is a single line.
1264 (if (<= limit (c-point 'bonl))
1265 (narrow-to-region
1266 (point-min)
1267 (save-excursion
1268 ;; Narrow after any operator chars following the limit though,
1269 ;; since those characters can be useful in recognizing a
1270 ;; declaration (in particular the '{' that opens a function body
1271 ;; after the header).
1272 (goto-char limit)
1273 (skip-chars-forward c-nonsymbol-chars)
1274 (point))))
1276 (c-find-decl-spots
1277 limit
1278 c-decl-start-re
1279 c-font-lock-maybe-decl-faces
1281 (lambda (match-pos inside-macro)
1282 (setq start-pos (point))
1283 (when
1284 ;; The result of the form below is true when we don't recognize a
1285 ;; declaration or cast.
1286 (if (or (and (eq (get-text-property (point) 'face)
1287 'font-lock-keyword-face)
1288 (looking-at c-not-decl-init-keywords))
1289 (and c-macro-with-semi-re
1290 (looking-at c-macro-with-semi-re))) ; 2008-11-04
1291 ;; Don't do anything more if we're looking at a keyword that
1292 ;; can't start a declaration.
1295 ;; Set `context' and `c-restricted-<>-arglists'. Look for
1296 ;; "<" for the sake of C++-style template arglists.
1297 ;; Ignore "(" when it's part of a control flow construct
1298 ;; (e.g. "for (").
1299 (let ((type (and (> match-pos (point-min))
1300 (c-get-char-property (1- match-pos) 'c-type))))
1301 (cond ((not (memq (char-before match-pos) '(?\( ?, ?\[ ?<)))
1302 (setq context nil
1303 c-restricted-<>-arglists nil))
1304 ;; A control flow expression
1305 ((and (eq (char-before match-pos) ?\()
1306 (save-excursion
1307 (goto-char match-pos)
1308 (backward-char)
1309 (c-backward-token-2)
1310 (or (looking-at c-block-stmt-2-key)
1311 (looking-at c-block-stmt-1-2-key))))
1312 (setq context nil
1313 c-restricted-<>-arglists t))
1314 ;; Near BOB.
1315 ((<= match-pos (point-min))
1316 (setq context 'arglist
1317 c-restricted-<>-arglists t))
1318 ;; Got a cached hit in a declaration arglist.
1319 ((eq type 'c-decl-arg-start)
1320 (setq context 'decl
1321 c-restricted-<>-arglists nil))
1322 ;; Inside an angle bracket arglist.
1323 ((or (eq type 'c-<>-arg-sep)
1324 (eq (char-before match-pos) ?<))
1325 (setq context '<>
1326 c-restricted-<>-arglists nil))
1327 ;; Got a cached hit in some other type of arglist.
1328 (type
1329 (setq context 'arglist
1330 c-restricted-<>-arglists t))
1331 ((if inside-macro
1332 (< match-pos max-type-decl-end-before-token)
1333 (< match-pos max-type-decl-end))
1334 ;; The point is within the range of a previously
1335 ;; encountered type decl expression, so the arglist
1336 ;; is probably one that contains declarations.
1337 ;; However, if `c-recognize-paren-inits' is set it
1338 ;; might also be an initializer arglist.
1339 (setq context 'decl
1340 c-restricted-<>-arglists nil)
1341 ;; The result of this check is cached with a char
1342 ;; property on the match token, so that we can look
1343 ;; it up again when refontifying single lines in a
1344 ;; multiline declaration.
1345 (c-put-char-property (1- match-pos)
1346 'c-type 'c-decl-arg-start))
1347 (t (setq context 'arglist
1348 c-restricted-<>-arglists t))))
1350 ;; Check we haven't missed a preceding "typedef".
1351 (when (not (looking-at c-typedef-key))
1352 (c-backward-syntactic-ws)
1353 (c-backward-token-2)
1354 (or (looking-at c-typedef-key)
1355 (goto-char start-pos)))
1357 ;; In QT, "more" is an irritating keyword that expands to nothing.
1358 ;; We skip over it to prevent recognition of "more slots: <symbol>"
1359 ;; as a bitfield declaration.
1360 (when (and (c-major-mode-is 'c++-mode)
1361 (looking-at
1362 (concat "\\(more\\)\\([^" c-symbol-chars "]\\|$\\)")))
1363 (goto-char (match-end 1))
1364 (c-forward-syntactic-ws))
1366 ;; Now analyze the construct.
1367 (setq decl-or-cast (c-forward-decl-or-cast-1
1368 match-pos context last-cast-end))
1370 (cond
1371 ((eq decl-or-cast 'cast)
1372 ;; Save the position after the previous cast so we can feed
1373 ;; it to `c-forward-decl-or-cast-1' in the next round. That
1374 ;; helps it discover cast chains like "(a) (b) c".
1375 (setq last-cast-end (point))
1376 (c-fontify-recorded-types-and-refs)
1377 nil)
1379 (decl-or-cast
1380 ;; We've found a declaration.
1382 ;; Set `max-type-decl-end' or `max-type-decl-end-before-token'
1383 ;; under the assumption that we're after the first type decl
1384 ;; expression in the declaration now. That's not really true;
1385 ;; we could also be after a parenthesized initializer
1386 ;; expression in C++, but this is only used as a last resort
1387 ;; to slant ambiguous expression/declarations, and overall
1388 ;; it's worth the risk to occasionally fontify an expression
1389 ;; as a declaration in an initializer expression compared to
1390 ;; getting ambiguous things in normal function prototypes
1391 ;; fontified as expressions.
1392 (if inside-macro
1393 (when (> (point) max-type-decl-end-before-token)
1394 (setq max-type-decl-end-before-token (point)))
1395 (when (> (point) max-type-decl-end)
1396 (setq max-type-decl-end (point))))
1398 ;; Back up to the type to fontify the declarator(s).
1399 (goto-char (car decl-or-cast))
1401 (let ((decl-list
1402 (if context
1403 ;; Should normally not fontify a list of
1404 ;; declarators inside an arglist, but the first
1405 ;; argument in the ';' separated list of a "for"
1406 ;; statement is an exception.
1407 (when (eq (char-before match-pos) ?\()
1408 (save-excursion
1409 (goto-char (1- match-pos))
1410 (c-backward-syntactic-ws)
1411 (and (c-simple-skip-symbol-backward)
1412 (looking-at c-paren-stmt-key))))
1413 t)))
1415 ;; Fix the `c-decl-id-start' or `c-decl-type-start' property
1416 ;; before the first declarator if it's a list.
1417 ;; `c-font-lock-declarators' handles the rest.
1418 (when decl-list
1419 (save-excursion
1420 (c-backward-syntactic-ws)
1421 (unless (bobp)
1422 (c-put-char-property (1- (point)) 'c-type
1423 (if (cdr decl-or-cast)
1424 'c-decl-type-start
1425 'c-decl-id-start)))))
1427 (c-font-lock-declarators
1428 (point-max) decl-list (cdr decl-or-cast)))
1430 ;; A declaration has been successfully identified, so do all the
1431 ;; fontification of types and refs that've been recorded.
1432 (c-fontify-recorded-types-and-refs)
1433 nil)
1435 ;; Restore point, since at this point in the code it has been
1436 ;; left undefined by c-forward-decl-or-cast-1 above.
1437 ((progn (goto-char start-pos) nil))
1439 ;; If point is inside a bracelist, there's no point checking it
1440 ;; being at a declarator.
1441 ((let ((paren-state (c-parse-state)))
1442 (setq lbrace (c-cheap-inside-bracelist-p paren-state)))
1443 ;; Move past this bracelist to prevent an endless loop.
1444 (goto-char lbrace)
1445 (unless (c-safe (progn (forward-list) t))
1446 (goto-char start-pos)
1447 (c-forward-token-2))
1448 nil)
1450 ;; If point is just after a ")" which is followed by an
1451 ;; identifier which isn't a label, or at the matching "(", we're
1452 ;; at either a macro invocation, a cast, or a
1453 ;; for/while/etc. statement. The cast case is handled above.
1454 ;; None of these cases can contain a declarator.
1455 ((or (and (eq (char-before match-pos) ?\))
1456 (c-on-identifier)
1457 (save-excursion (not (c-forward-label))))
1458 (and (eq (char-after) ?\()
1459 (save-excursion
1460 (and
1461 (progn (c-backward-token-2) (c-on-identifier))
1462 (save-excursion (not (c-forward-label)))
1463 (progn (c-backward-token-2)
1464 (eq (char-after) ?\())))))
1465 (c-forward-token-2) ; Must prevent looping.
1466 nil)
1468 ((and (not c-enums-contain-decls)
1469 ;; An optimization quickly to eliminate scans of long enum
1470 ;; declarations in the next cond arm.
1471 (let ((paren-state (c-parse-state)))
1472 (and
1473 (numberp (car paren-state))
1474 (save-excursion
1475 (goto-char (car paren-state))
1476 (c-backward-over-enum-header)))))
1477 (c-forward-token-2)
1478 nil)
1481 ;; Are we at a declarator? Try to go back to the declaration
1482 ;; to check this. If we get there, check whether a "typedef"
1483 ;; is there, then fontify the declarators accordingly.
1484 (let ((decl-search-lim (c-determine-limit 1000))
1485 paren-state bod-res encl-pos is-typedef
1486 c-recognize-knr-p) ; Strictly speaking, bogus, but it
1487 ; speeds up lisp.h tremendously.
1488 (save-excursion
1489 (setq bod-res (car (c-beginning-of-decl-1 decl-search-lim)))
1490 (if (and (eq bod-res 'same)
1491 (progn
1492 (c-backward-syntactic-ws)
1493 (eq (char-before) ?\})))
1494 (c-beginning-of-decl-1 decl-search-lim))
1496 ;; We're now putatively at the declaration.
1497 (setq paren-state (c-parse-state))
1498 ;; At top level or inside a "{"?
1499 (if (or (not (setq encl-pos
1500 (c-most-enclosing-brace paren-state)))
1501 (eq (char-after encl-pos) ?\{))
1502 (progn
1503 (when (looking-at c-typedef-key) ; "typedef"
1504 (setq is-typedef t)
1505 (goto-char (match-end 0))
1506 (c-forward-syntactic-ws))
1507 ;; At a real declaration?
1508 (if (memq (c-forward-type t) '(t known found))
1509 (progn
1510 (c-font-lock-declarators limit t is-typedef)
1511 nil)
1512 ;; False alarm. Return t to go on to the next check.
1513 (goto-char start-pos)
1515 t))))))
1517 ;; It was a false alarm. Check if we're in a label (or other
1518 ;; construct with `:' except bitfield) instead.
1519 (goto-char start-pos)
1520 (when (setq label-type (c-forward-label t match-pos nil))
1521 ;; Can't use `c-fontify-types-and-refs' here since we
1522 ;; use the label face at times.
1523 (cond ((eq label-type 'goto-target)
1524 (c-put-font-lock-face (caar c-record-ref-identifiers)
1525 (cdar c-record-ref-identifiers)
1526 c-label-face-name))
1527 ((eq label-type 'qt-1kwd-colon)
1528 (c-put-font-lock-face (caar c-record-ref-identifiers)
1529 (cdar c-record-ref-identifiers)
1530 'font-lock-keyword-face))
1531 ((eq label-type 'qt-2kwds-colon)
1532 (mapc
1533 (lambda (kwd)
1534 (c-put-font-lock-face (car kwd) (cdr kwd)
1535 'font-lock-keyword-face))
1536 c-record-ref-identifiers)))
1537 (setq c-record-ref-identifiers nil)
1538 ;; `c-forward-label' has probably added a `c-decl-end'
1539 ;; marker, so return t to `c-find-decl-spots' to signal
1540 ;; that.
1541 t))))
1543 nil)))
1545 (defun c-font-lock-enum-tail (limit)
1546 ;; Fontify an enum's identifiers when POINT is within the enum's brace
1547 ;; block.
1549 ;; This function will be called from font-lock for a region bounded by POINT
1550 ;; and LIMIT, as though it were to identify a keyword for
1551 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
1552 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
1553 ;; Fontification".
1555 ;; Note that this function won't attempt to fontify beyond the end of the
1556 ;; current enum block, if any.
1557 (let* ((paren-state (c-parse-state))
1558 (encl-pos (c-most-enclosing-brace paren-state))
1559 (start (point))
1561 (when (and
1562 encl-pos
1563 (eq (char-after encl-pos) ?\{)
1564 (save-excursion
1565 (goto-char encl-pos)
1566 (c-backward-over-enum-header)))
1567 (c-syntactic-skip-backward "^{," nil t)
1568 (c-put-char-property (1- (point)) 'c-type 'c-decl-id-start)
1570 (c-forward-syntactic-ws)
1571 (c-font-lock-declarators limit t nil)))
1572 nil)
1574 (defun c-font-lock-enclosing-decls (limit)
1575 ;; Fontify the declarators of (nested) declarations we're in the middle of.
1576 ;; This is mainly for when a jit-lock etc. chunk starts inside the brace
1577 ;; block of a struct/union/class, etc.
1579 ;; This function will be called from font-lock for a region bounded by POINT
1580 ;; and LIMIT, as though it were to identify a keyword for
1581 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
1582 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
1583 ;; Fontification".
1584 (let* ((paren-state (c-parse-state))
1585 (decl-search-lim (c-determine-limit 1000))
1586 decl-context in-typedef ps-elt)
1587 ;; Are we in any nested struct/union/class/etc. braces?
1588 (while paren-state
1589 (setq ps-elt (car paren-state)
1590 paren-state (cdr paren-state))
1591 (when (and (atom ps-elt)
1592 (eq (char-after ps-elt) ?\{))
1593 (goto-char ps-elt)
1594 (setq decl-context (c-beginning-of-decl-1 decl-search-lim)
1595 in-typedef (looking-at c-typedef-key))
1596 (if in-typedef (c-forward-token-2))
1597 (when (and c-opt-block-decls-with-vars-key
1598 (looking-at c-opt-block-decls-with-vars-key))
1599 (goto-char ps-elt)
1600 (when (c-safe (c-forward-sexp))
1601 (c-forward-syntactic-ws)
1602 (c-font-lock-declarators limit t in-typedef)))))))
1604 (c-lang-defconst c-simple-decl-matchers
1605 "Simple font lock matchers for types and declarations. These are used
1606 on level 2 only and so aren't combined with `c-complex-decl-matchers'."
1608 t `(;; Objective-C methods.
1609 ,@(when (c-major-mode-is 'objc-mode)
1610 `((,(c-lang-const c-opt-method-key)
1611 (,(byte-compile
1612 (lambda (limit)
1613 (let (;; The font-lock package in Emacs is known to clobber
1614 ;; `parse-sexp-lookup-properties' (when it exists).
1615 (parse-sexp-lookup-properties
1616 (cc-eval-when-compile
1617 (boundp 'parse-sexp-lookup-properties))))
1618 (save-restriction
1619 (narrow-to-region (point-min) limit)
1620 (c-font-lock-objc-method)))
1621 nil))
1622 (goto-char (match-end 1))))))
1624 ;; Fontify all type names and the identifiers in the
1625 ;; declarations they might start. Use eval here since
1626 ;; `c-known-type-key' gets its value from
1627 ;; `*-font-lock-extra-types' on mode init.
1628 (eval . (list ,(c-make-font-lock-search-function
1629 'c-known-type-key
1630 '(1 'font-lock-type-face t)
1631 '((c-font-lock-declarators limit t nil)
1632 (save-match-data
1633 (goto-char (match-end 1))
1634 (c-forward-syntactic-ws))
1635 (goto-char (match-end 1))))))
1637 ;; Fontify types preceded by `c-type-prefix-kwds' and the
1638 ;; identifiers in the declarations they might start.
1639 ,@(when (c-lang-const c-type-prefix-kwds)
1640 (let* ((prefix-re (c-make-keywords-re nil
1641 (c-lang-const c-type-prefix-kwds)))
1642 (type-match (+ 2
1643 (regexp-opt-depth prefix-re)
1644 (c-lang-const c-simple-ws-depth))))
1645 `((,(c-make-font-lock-search-function
1646 (concat "\\<\\(" prefix-re "\\)" ; 1
1647 (c-lang-const c-simple-ws) "+"
1648 (concat "\\(" ; 2 + prefix-re + c-simple-ws
1649 (c-lang-const c-symbol-key)
1650 "\\)"))
1651 `(,type-match
1652 'font-lock-type-face t)
1653 `((c-font-lock-declarators limit t nil)
1654 (save-match-data
1655 (goto-char (match-end ,type-match))
1656 (c-forward-syntactic-ws))
1657 (goto-char (match-end ,type-match))))))))
1659 ;; Fontify special declarations that lacks a type.
1660 ,@(when (c-lang-const c-typeless-decl-kwds)
1661 `((,(c-make-font-lock-search-function
1662 (concat "\\<\\("
1663 (regexp-opt (c-lang-const c-typeless-decl-kwds))
1664 "\\)\\>")
1665 '((c-font-lock-declarators limit t nil)
1666 (save-match-data
1667 (goto-char (match-end 1))
1668 (c-forward-syntactic-ws))
1669 (goto-char (match-end 1)))))))
1671 ;; Fontify generic colon labels in languages that support them.
1672 ,@(when (c-lang-const c-recognize-colon-labels)
1673 `(c-font-lock-labels))))
1675 (c-lang-defconst c-complex-decl-matchers
1676 "Complex font lock matchers for types and declarations. Used on level
1677 3 and higher."
1679 ;; Note: This code in this form dumps a number of functions into the
1680 ;; resulting constant, `c-matchers-3'. At run time, font lock will call
1681 ;; each of them as a "FUNCTION" (see Elisp page "Search-based
1682 ;; Fontification"). The font lock region is delimited by POINT and the
1683 ;; single parameter, LIMIT. Each of these functions returns NIL (thus
1684 ;; inhibiting spurious font-lock-keyword-face highlighting and another
1685 ;; call).
1687 t `(;; Initialize some things before the search functions below.
1688 c-font-lock-complex-decl-prepare
1690 ,@(if (c-major-mode-is 'objc-mode)
1691 ;; Fontify method declarations in Objective-C, but first
1692 ;; we have to put the `c-decl-end' `c-type' property on
1693 ;; all the @-style directives that haven't been handled in
1694 ;; `c-basic-matchers-before'.
1695 `(,(c-make-font-lock-search-function
1696 (c-make-keywords-re t
1697 ;; Exclude "@class" since that directive ends with a
1698 ;; semicolon anyway.
1699 (delete "@class"
1700 (append (c-lang-const c-protection-kwds)
1701 (c-lang-const c-other-decl-kwds)
1702 nil)))
1703 '((c-put-char-property (1- (match-end 1))
1704 'c-type 'c-decl-end)))
1705 c-font-lock-objc-methods))
1707 ;; Fontify all declarations, casts and normal labels.
1708 c-font-lock-declarations
1710 ;; Fontify declarators when POINT is within their declaration.
1711 c-font-lock-enclosing-decls
1713 ;; Fontify angle bracket arglists like templates in C++.
1714 ,@(when (c-lang-const c-recognize-<>-arglists)
1715 `(c-font-lock-<>-arglists))
1717 ;; The first two rules here mostly find occurrences that
1718 ;; `c-font-lock-declarations' has found already, but not
1719 ;; declarations containing blocks in the type (see note below).
1720 ;; It's also useful to fontify these everywhere to show e.g. when
1721 ;; a type keyword is accidentally used as an identifier.
1723 ;; Fontify basic types.
1724 ,(let ((re (c-make-keywords-re nil
1725 (c-lang-const c-primitive-type-kwds))))
1726 (if (c-major-mode-is 'pike-mode)
1727 ;; No symbol is a keyword after "->" in Pike.
1728 `(,(concat "\\(\\=.?\\|[^>]\\|[^-]>\\)"
1729 "\\<\\(" re "\\)\\>")
1730 2 font-lock-type-face)
1731 `(,(concat "\\<\\(" re "\\)\\>")
1732 1 'font-lock-type-face)))
1734 ;; Fontify types preceded by `c-type-prefix-kwds' (e.g. "struct").
1735 ,@(when (c-lang-const c-type-prefix-kwds)
1736 `((,(byte-compile
1737 `(lambda (limit)
1738 (c-fontify-types-and-refs
1739 ((c-promote-possible-types t)
1740 ;; The font-lock package in Emacs is known to clobber
1741 ;; `parse-sexp-lookup-properties' (when it exists).
1742 (parse-sexp-lookup-properties
1743 (cc-eval-when-compile
1744 (boundp 'parse-sexp-lookup-properties))))
1745 (save-restriction
1746 ;; Narrow to avoid going past the limit in
1747 ;; `c-forward-type'.
1748 (narrow-to-region (point) limit)
1749 (while (re-search-forward
1750 ,(concat "\\<\\("
1751 (c-make-keywords-re nil
1752 (c-lang-const c-type-prefix-kwds))
1753 "\\)\\>")
1754 limit t)
1755 (unless (c-skip-comments-and-strings limit)
1756 (c-forward-syntactic-ws)
1757 ;; Handle prefix declaration specifiers.
1758 (when (or (looking-at c-prefix-spec-kwds-re)
1759 (and (c-major-mode-is 'java-mode)
1760 (looking-at "@[A-Za-z0-9]+")))
1761 (c-forward-keyword-clause 1))
1762 ,(if (c-major-mode-is 'c++-mode)
1763 `(when (and (c-forward-type)
1764 (eq (char-after) ?=))
1765 ;; In C++ we additionally check for a "class
1766 ;; X = Y" construct which is used in
1767 ;; templates, to fontify Y as a type.
1768 (forward-char)
1769 (c-forward-syntactic-ws)
1770 (c-forward-type))
1771 `(c-forward-type))
1772 )))))))))
1774 ;; Fontify symbols after closing braces as declaration
1775 ;; identifiers under the assumption that they are part of
1776 ;; declarations like "class Foo { ... } foo;". It's too
1777 ;; expensive to check this accurately by skipping past the
1778 ;; brace block, so we use the heuristic that it's such a
1779 ;; declaration if the first identifier is on the same line as
1780 ;; the closing brace. `c-font-lock-declarations' will later
1781 ;; override it if it turns out to be an new declaration, but
1782 ;; it will be wrong if it's an expression (see the test
1783 ;; decls-8.cc).
1784 ;; ,@(when (c-lang-const c-opt-block-decls-with-vars-key)
1785 ;; `((,(c-make-font-lock-search-function
1786 ;; (concat "}"
1787 ;; (c-lang-const c-single-line-syntactic-ws)
1788 ;; "\\(" ; 1 + c-single-line-syntactic-ws-depth
1789 ;; (c-lang-const c-type-decl-prefix-key)
1790 ;; "\\|"
1791 ;; (c-lang-const c-symbol-key)
1792 ;; "\\)")
1793 ;; `((c-font-lock-declarators limit t nil) ; That `nil' says use `font-lock-variable-name-face';
1794 ;; ; `t' would mean `font-lock-function-name-face'.
1795 ;; (progn
1796 ;; (c-put-char-property (match-beginning 0) 'c-type
1797 ;; 'c-decl-id-start)
1798 ;; ; 'c-decl-type-start)
1799 ;; (goto-char (match-beginning
1800 ;; ,(1+ (c-lang-const
1801 ;; c-single-line-syntactic-ws-depth)))))
1802 ;; (goto-char (match-end 0)))))))
1804 ;; Fontify the type in C++ "new" expressions.
1805 ,@(when (c-major-mode-is 'c++-mode)
1806 ;; This pattern is a probably a "(MATCHER . ANCHORED-HIGHLIGHTER)"
1807 ;; (see Elisp page "Search-based Fontification").
1808 `(("\\<new\\>"
1809 (c-font-lock-c++-new))))
1812 (defun c-font-lock-labels (limit)
1813 ;; Fontify all statement labels from the point to LIMIT. Assumes
1814 ;; that strings and comments have been fontified already. Nil is
1815 ;; always returned.
1817 ;; Note: This function is only used on decoration level 2; this is
1818 ;; taken care of directly by the gargantuan
1819 ;; `c-font-lock-declarations' on higher levels.
1821 ;; This function might do hidden buffer changes.
1823 (let (continue-pos id-start
1824 ;; The font-lock package in Emacs is known to clobber
1825 ;; `parse-sexp-lookup-properties' (when it exists).
1826 (parse-sexp-lookup-properties
1827 (cc-eval-when-compile
1828 (boundp 'parse-sexp-lookup-properties))))
1830 (while (re-search-forward ":[^:]" limit t)
1831 (setq continue-pos (point))
1832 (goto-char (match-beginning 0))
1833 (unless (c-skip-comments-and-strings limit)
1835 (c-backward-syntactic-ws)
1836 (and (setq id-start (c-on-identifier))
1838 (not (get-text-property id-start 'face))
1840 (progn
1841 (goto-char id-start)
1842 (c-backward-syntactic-ws)
1844 ;; Check for a char that precedes a statement.
1845 (memq (char-before) '(?\} ?\{ ?\;))
1846 ;; Check for a preceding label. We exploit the font
1847 ;; locking made earlier by this function.
1848 (and (eq (char-before) ?:)
1849 (progn
1850 (backward-char)
1851 (c-backward-syntactic-ws)
1852 (not (bobp)))
1853 (eq (get-text-property (1- (point)) 'face)
1854 c-label-face-name))
1855 ;; Check for a keyword that precedes a statement.
1856 (c-after-conditional)))
1858 (progn
1859 ;; Got a label.
1860 (goto-char id-start)
1861 (looking-at c-symbol-key)
1862 (c-put-font-lock-face (match-beginning 0) (match-end 0)
1863 c-label-face-name)))
1865 (goto-char continue-pos))))
1866 nil)
1868 (c-lang-defconst c-basic-matchers-after
1869 "Font lock matchers for various things that should be fontified after
1870 generic casts and declarations are fontified. Used on level 2 and
1871 higher."
1873 t `(,@(when (c-lang-const c-brace-id-list-kwds)
1874 ;; Fontify the remaining identifiers inside an enum list when we start
1875 ;; inside it.
1876 `(c-font-lock-enum-tail
1877 ;; Fontify the identifiers inside enum lists. (The enum type
1878 ;; name is handled by `c-simple-decl-matchers' or
1879 ;; `c-complex-decl-matchers' below.
1880 (,(c-make-font-lock-search-function
1881 (concat
1882 "\\<\\("
1883 (c-make-keywords-re nil (c-lang-const c-brace-id-list-kwds))
1884 "\\)\\>"
1885 ;; Disallow various common punctuation chars that can't come
1886 ;; before the '{' of the enum list, to avoid searching too far.
1887 "[^\]\[{}();/#=]*"
1888 "{")
1889 '((c-font-lock-declarators limit t nil)
1890 (save-match-data
1891 (goto-char (match-end 0))
1892 (c-put-char-property (1- (point)) 'c-type
1893 'c-decl-id-start)
1894 (c-forward-syntactic-ws))
1895 (goto-char (match-end 0)))))))
1897 ;; Fontify labels after goto etc.
1898 ,@(when (c-lang-const c-before-label-kwds)
1899 `(;; (Got three different interpretation levels here,
1900 ;; which makes it a bit complicated: 1) The backquote
1901 ;; stuff is expanded when compiled or loaded, 2) the
1902 ;; eval form is evaluated at font-lock setup (to
1903 ;; substitute c-label-face-name correctly), and 3) the
1904 ;; resulting structure is interpreted during
1905 ;; fontification.)
1906 (eval
1907 . ,(let* ((c-before-label-re
1908 (c-make-keywords-re nil
1909 (c-lang-const c-before-label-kwds))))
1910 `(list
1911 ,(concat "\\<\\(" c-before-label-re "\\)\\>"
1912 "\\s *"
1913 "\\(" ; identifier-offset
1914 (c-lang-const c-symbol-key)
1915 "\\)")
1916 (list ,(+ (regexp-opt-depth c-before-label-re) 2)
1917 c-label-face-name nil t))))))
1919 ;; Fontify the clauses after various keywords.
1920 ,@(when (or (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 `((,(c-make-font-lock-BO-decl-search-function
1924 (concat "\\<\\("
1925 (c-make-keywords-re nil
1926 (append (c-lang-const c-type-list-kwds)
1927 (c-lang-const c-ref-list-kwds)
1928 (c-lang-const c-colon-type-list-kwds)))
1929 "\\)\\>")
1930 '((c-fontify-types-and-refs ((c-promote-possible-types t))
1931 (c-forward-keyword-clause 1)
1932 (if (> (point) limit) (goto-char limit))))))))
1934 ,@(when (c-lang-const c-paren-type-kwds)
1935 `((,(c-make-font-lock-search-function
1936 (concat "\\<\\("
1937 (c-make-keywords-re nil
1938 (c-lang-const c-paren-type-kwds))
1939 "\\)\\>")
1940 '((c-fontify-types-and-refs ((c-promote-possible-types t))
1941 (c-forward-keyword-clause 1)
1942 (if (> (point) limit) (goto-char limit))))))))
1944 ,@(when (c-major-mode-is 'java-mode)
1945 `((eval . (list "\\<\\(@[a-zA-Z0-9]+\\)\\>" 1 c-annotation-face))))
1948 (c-lang-defconst c-matchers-1
1949 t (c-lang-const c-cpp-matchers))
1951 (c-lang-defconst c-matchers-2
1952 t (append (c-lang-const c-matchers-1)
1953 (c-lang-const c-basic-matchers-before)
1954 (c-lang-const c-simple-decl-matchers)
1955 (c-lang-const c-basic-matchers-after)))
1957 (c-lang-defconst c-matchers-3
1958 t (append (c-lang-const c-matchers-1)
1959 (c-lang-const c-basic-matchers-before)
1960 (c-lang-const c-complex-decl-matchers)
1961 (c-lang-const c-basic-matchers-after)))
1963 (defun c-compose-keywords-list (base-list)
1964 ;; Incorporate the font lock keyword lists according to
1965 ;; `c-doc-comment-style' on the given keyword list and return it.
1966 ;; This is used in the function bindings of the
1967 ;; `*-font-lock-keywords-*' symbols since we have to build the list
1968 ;; when font-lock is initialized.
1970 (unless (memq c-doc-face-name c-literal-faces)
1971 (setq c-literal-faces (cons c-doc-face-name c-literal-faces)))
1973 (let* ((doc-keywords
1974 (if (consp (car-safe c-doc-comment-style))
1975 (cdr-safe (or (assq c-buffer-is-cc-mode c-doc-comment-style)
1976 (assq 'other c-doc-comment-style)))
1977 c-doc-comment-style))
1978 (list (nconc (apply 'nconc
1979 (mapcar
1980 (lambda (doc-style)
1981 (let ((sym (intern
1982 (concat (symbol-name doc-style)
1983 "-font-lock-keywords"))))
1984 (cond ((fboundp sym)
1985 (funcall sym))
1986 ((boundp sym)
1987 (append (eval sym) nil)))))
1988 (if (listp doc-keywords)
1989 doc-keywords
1990 (list doc-keywords))))
1991 base-list)))
1993 ;; Kludge: If `c-font-lock-complex-decl-prepare' is on the list we
1994 ;; move it first since the doc comment font lockers might add
1995 ;; `c-type' text properties, so they have to be cleared before that.
1996 (when (memq 'c-font-lock-complex-decl-prepare list)
1997 (setq list (cons 'c-font-lock-complex-decl-prepare
1998 (delq 'c-font-lock-complex-decl-prepare
1999 (append list nil)))))
2001 list))
2003 (defun c-override-default-keywords (def-var)
2004 ;; This is used to override the value on a `*-font-lock-keywords'
2005 ;; variable only if it's nil or has the same value as one of the
2006 ;; `*-font-lock-keywords-*' variables. Older font-lock packages
2007 ;; define a default value for `*-font-lock-keywords' which we want
2008 ;; to override, but we should otoh avoid clobbering a user setting.
2009 ;; This heuristic for that isn't perfect, but I can't think of any
2010 ;; better. /mast
2011 (when (and (boundp def-var)
2012 (memq (symbol-value def-var)
2013 (cons nil
2014 (mapcar
2015 (lambda (suffix)
2016 (let ((sym (intern (concat (symbol-name def-var)
2017 suffix))))
2018 (and (boundp sym) (symbol-value sym))))
2019 '("-1" "-2" "-3")))))
2020 ;; The overriding is done by unbinding the variable so that the normal
2021 ;; defvar will install its default value later on.
2022 (makunbound def-var)))
2025 ;;; C.
2027 (c-override-default-keywords 'c-font-lock-keywords)
2029 (defconst c-font-lock-keywords-1 (c-lang-const c-matchers-1 c)
2030 "Minimal font locking for C mode.
2031 Fontifies only preprocessor directives (in addition to the syntactic
2032 fontification of strings and comments).")
2034 (defconst c-font-lock-keywords-2 (c-lang-const c-matchers-2 c)
2035 "Fast normal font locking for C mode.
2036 In addition to `c-font-lock-keywords-1', this adds fontification of
2037 keywords, simple types, declarations that are easy to recognize, the
2038 user defined types on `c-font-lock-extra-types', and the doc comment
2039 styles specified by `c-doc-comment-style'.")
2041 (defconst c-font-lock-keywords-3 (c-lang-const c-matchers-3 c)
2042 "Accurate normal font locking for C mode.
2043 Like the variable `c-font-lock-keywords-2' but detects declarations in a more
2044 accurate way that works in most cases for arbitrary types without the
2045 need for `c-font-lock-extra-types'.")
2047 (defvar c-font-lock-keywords c-font-lock-keywords-3
2048 "Default expressions to highlight in C mode.")
2050 (defun c-font-lock-keywords-2 ()
2051 (c-compose-keywords-list c-font-lock-keywords-2))
2052 (defun c-font-lock-keywords-3 ()
2053 (c-compose-keywords-list c-font-lock-keywords-3))
2054 (defun c-font-lock-keywords ()
2055 (c-compose-keywords-list c-font-lock-keywords))
2058 ;;; C++.
2060 (defun c-font-lock-c++-new (limit)
2061 ;; FIXME!!! Put in a comment about the context of this function's
2062 ;; invocation. I think it's called as an ANCHORED-MATCHER within an
2063 ;; ANCHORED-HIGHLIGHTER. (2007/2/10).
2065 ;; Assuming point is after a "new" word, check that it isn't inside
2066 ;; a string or comment, and if so try to fontify the type in the
2067 ;; allocation expression. Nil is always returned.
2069 ;; As usual, C++ takes the prize in coming up with a hard to parse
2070 ;; syntax. :P
2072 ;; This function might do hidden buffer changes.
2074 (unless (c-skip-comments-and-strings limit)
2075 (save-excursion
2076 (catch 'false-alarm
2077 ;; A "new" keyword is followed by one to three expressions, where
2078 ;; the type is the middle one, and the only required part.
2079 (let (expr1-pos expr2-pos
2080 ;; Enable recording of identifier ranges in `c-forward-type'
2081 ;; etc for later fontification. Not using
2082 ;; `c-fontify-types-and-refs' here since the ranges should
2083 ;; be fontified selectively only when an allocation
2084 ;; expression is successfully recognized.
2085 (c-record-type-identifiers t)
2086 c-record-ref-identifiers
2087 ;; The font-lock package in Emacs is known to clobber
2088 ;; `parse-sexp-lookup-properties' (when it exists).
2089 (parse-sexp-lookup-properties
2090 (cc-eval-when-compile
2091 (boundp 'parse-sexp-lookup-properties))))
2092 (c-forward-syntactic-ws)
2094 ;; The first placement arglist is always parenthesized, if it
2095 ;; exists.
2096 (when (eq (char-after) ?\()
2097 (setq expr1-pos (1+ (point)))
2098 (condition-case nil
2099 (c-forward-sexp)
2100 (scan-error (throw 'false-alarm t)))
2101 (c-forward-syntactic-ws))
2103 ;; The second expression is either a type followed by some "*" or
2104 ;; "[...]" or similar, or a parenthesized type followed by a full
2105 ;; identifierless declarator.
2106 (setq expr2-pos (1+ (point)))
2107 (cond ((eq (char-after) ?\())
2108 ((let ((c-promote-possible-types t))
2109 (c-forward-type)))
2110 (t (setq expr2-pos nil)))
2112 (when expr1-pos
2113 (cond
2114 ((not expr2-pos)
2115 ;; No second expression, so the first has to be a
2116 ;; parenthesized type.
2117 (goto-char expr1-pos)
2118 (let ((c-promote-possible-types t))
2119 (c-forward-type)))
2121 ((eq (char-before expr2-pos) ?\()
2122 ;; Got two parenthesized expressions, so we have to look
2123 ;; closer at them to decide which is the type. No need to
2124 ;; handle `c-record-ref-identifiers' since all references
2125 ;; has already been handled by other fontification rules.
2126 (let (expr1-res expr2-res)
2128 (goto-char expr1-pos)
2129 (when (setq expr1-res (c-forward-type))
2130 (unless (looking-at
2131 (cc-eval-when-compile
2132 (concat (c-lang-const c-symbol-start c++)
2133 "\\|[*:\)\[]")))
2134 ;; There's something after the would-be type that
2135 ;; can't be there, so this is a placement arglist.
2136 (setq expr1-res nil)))
2138 (goto-char expr2-pos)
2139 (when (setq expr2-res (c-forward-type))
2140 (unless (looking-at
2141 (cc-eval-when-compile
2142 (concat (c-lang-const c-symbol-start c++)
2143 "\\|[*:\)\[]")))
2144 ;; There's something after the would-be type that can't
2145 ;; be there, so this is an initialization expression.
2146 (setq expr2-res nil))
2147 (when (and (c-go-up-list-forward)
2148 (progn (c-forward-syntactic-ws)
2149 (eq (char-after) ?\()))
2150 ;; If there's a third initialization expression
2151 ;; then the second one is the type, so demote the
2152 ;; first match.
2153 (setq expr1-res nil)))
2155 ;; We fontify the most likely type, with a preference for
2156 ;; the first argument since a placement arglist is more
2157 ;; unusual than an initializer.
2158 (cond ((memq expr1-res '(t known prefix)))
2159 ((memq expr2-res '(t known prefix)))
2160 ((eq expr1-res 'found)
2161 (let ((c-promote-possible-types t))
2162 (goto-char expr1-pos)
2163 (c-forward-type)))
2164 ((eq expr2-res 'found)
2165 (let ((c-promote-possible-types t))
2166 (goto-char expr2-pos)
2167 (c-forward-type)))
2168 ((and (eq expr1-res 'maybe) (not expr2-res))
2169 (let ((c-promote-possible-types t))
2170 (goto-char expr1-pos)
2171 (c-forward-type)))
2172 ((and (not expr1-res) (eq expr2-res 'maybe))
2173 (let ((c-promote-possible-types t))
2174 (goto-char expr2-pos)
2175 (c-forward-type)))
2176 ;; If both type matches are 'maybe then we're
2177 ;; too uncertain to promote either of them.
2178 )))))
2180 ;; Fontify the type that now is recorded in
2181 ;; `c-record-type-identifiers', if any.
2182 (c-fontify-recorded-types-and-refs)))))
2183 nil)
2185 (c-override-default-keywords 'c++-font-lock-keywords)
2187 (defconst c++-font-lock-keywords-1 (c-lang-const c-matchers-1 c++)
2188 "Minimal font locking for C++ mode.
2189 Fontifies only preprocessor directives (in addition to the syntactic
2190 fontification of strings and comments).")
2192 (defconst c++-font-lock-keywords-2 (c-lang-const c-matchers-2 c++)
2193 "Fast normal font locking for C++ mode.
2194 In addition to `c++-font-lock-keywords-1', this adds fontification of
2195 keywords, simple types, declarations that are easy to recognize, the
2196 user defined types on `c++-font-lock-extra-types', and the doc comment
2197 styles specified by `c-doc-comment-style'.")
2199 (defconst c++-font-lock-keywords-3 (c-lang-const c-matchers-3 c++)
2200 "Accurate normal font locking for C++ mode.
2201 Like the variable `c++-font-lock-keywords-2' but detects declarations in a more
2202 accurate way that works in most cases for arbitrary types without the
2203 need for `c++-font-lock-extra-types'.")
2205 (defvar c++-font-lock-keywords c++-font-lock-keywords-3
2206 "Default expressions to highlight in C++ mode.")
2208 (defun c++-font-lock-keywords-2 ()
2209 (c-compose-keywords-list c++-font-lock-keywords-2))
2210 (defun c++-font-lock-keywords-3 ()
2211 (c-compose-keywords-list c++-font-lock-keywords-3))
2212 (defun c++-font-lock-keywords ()
2213 (c-compose-keywords-list c++-font-lock-keywords))
2216 ;;; Objective-C.
2218 (defun c-font-lock-objc-method ()
2219 ;; Assuming the point is after the + or - that starts an Objective-C
2220 ;; method declaration, fontify it. This must be done before normal
2221 ;; casts, declarations and labels are fontified since they will get
2222 ;; false matches in these things.
2224 ;; This function might do hidden buffer changes.
2226 (c-fontify-types-and-refs
2227 ((first t)
2228 (c-promote-possible-types t))
2230 (while (and
2231 (progn
2232 (c-forward-syntactic-ws)
2234 ;; An optional method type.
2235 (if (eq (char-after) ?\()
2236 (progn
2237 (forward-char)
2238 (c-forward-syntactic-ws)
2239 (c-forward-type)
2240 (prog1 (c-go-up-list-forward)
2241 (c-forward-syntactic-ws)))
2244 ;; The name. The first time it's the first part of
2245 ;; the function name, the rest of the time it's an
2246 ;; argument name.
2247 (looking-at c-symbol-key)
2248 (progn
2249 (goto-char (match-end 0))
2250 (c-put-font-lock-face (match-beginning 0)
2251 (point)
2252 (if first
2253 'font-lock-function-name-face
2254 'font-lock-variable-name-face))
2255 (c-forward-syntactic-ws)
2257 ;; Another optional part of the function name.
2258 (when (looking-at c-symbol-key)
2259 (goto-char (match-end 0))
2260 (c-put-font-lock-face (match-beginning 0)
2261 (point)
2262 'font-lock-function-name-face)
2263 (c-forward-syntactic-ws))
2265 ;; There's another argument if a colon follows.
2266 (eq (char-after) ?:)))
2267 (forward-char)
2268 (setq first nil))))
2270 (defun c-font-lock-objc-methods (limit)
2271 ;; Fontify method declarations in Objective-C. Nil is always
2272 ;; returned.
2274 ;; This function might do hidden buffer changes.
2276 (let (;; The font-lock package in Emacs is known to clobber
2277 ;; `parse-sexp-lookup-properties' (when it exists).
2278 (parse-sexp-lookup-properties
2279 (cc-eval-when-compile
2280 (boundp 'parse-sexp-lookup-properties))))
2282 (c-find-decl-spots
2283 limit
2284 "[-+]"
2286 (lambda (match-pos inside-macro)
2287 (forward-char)
2288 (c-font-lock-objc-method))))
2289 nil)
2291 (c-override-default-keywords 'objc-font-lock-keywords)
2293 (defconst objc-font-lock-keywords-1 (c-lang-const c-matchers-1 objc)
2294 "Minimal font locking for Objective-C mode.
2295 Fontifies only compiler directives (in addition to the syntactic
2296 fontification of strings and comments).")
2298 (defconst objc-font-lock-keywords-2 (c-lang-const c-matchers-2 objc)
2299 "Fast normal font locking for Objective-C mode.
2300 In addition to `objc-font-lock-keywords-1', this adds fontification of
2301 keywords, simple types, declarations that are easy to recognize, the
2302 user defined types on `objc-font-lock-extra-types', and the doc
2303 comment styles specified by `c-doc-comment-style'.")
2305 (defconst objc-font-lock-keywords-3 (c-lang-const c-matchers-3 objc)
2306 "Accurate normal font locking for Objective-C mode.
2307 Like the variable `objc-font-lock-keywords-2' but detects declarations in a more
2308 accurate way that works in most cases for arbitrary types without the
2309 need for `objc-font-lock-extra-types'.")
2311 (defvar objc-font-lock-keywords objc-font-lock-keywords-3
2312 "Default expressions to highlight in Objective-C mode.")
2314 (defun objc-font-lock-keywords-2 ()
2315 (c-compose-keywords-list objc-font-lock-keywords-2))
2316 (defun objc-font-lock-keywords-3 ()
2317 (c-compose-keywords-list objc-font-lock-keywords-3))
2318 (defun objc-font-lock-keywords ()
2319 (c-compose-keywords-list objc-font-lock-keywords))
2321 ;; Kludge to override the default value that
2322 ;; `objc-font-lock-extra-types' might have gotten from the font-lock
2323 ;; package. The value replaced here isn't relevant now anyway since
2324 ;; those types are builtin and therefore listed directly in
2325 ;; `c-primitive-type-kwds'.
2326 (when (equal (sort (append objc-font-lock-extra-types nil) 'string-lessp)
2327 '("BOOL" "Class" "IMP" "SEL"))
2328 (setq objc-font-lock-extra-types
2329 (cc-eval-when-compile (list (concat "[" c-upper "]\\sw*")))))
2332 ;;; Java.
2334 (c-override-default-keywords 'java-font-lock-keywords)
2336 (defconst java-font-lock-keywords-1 (c-lang-const c-matchers-1 java)
2337 "Minimal font locking for Java mode.
2338 Fontifies nothing except the syntactic fontification of strings and
2339 comments.")
2341 (defconst java-font-lock-keywords-2 (c-lang-const c-matchers-2 java)
2342 "Fast normal font locking for Java mode.
2343 In addition to `java-font-lock-keywords-1', this adds fontification of
2344 keywords, simple types, declarations that are easy to recognize, the
2345 user defined types on `java-font-lock-extra-types', and the doc
2346 comment styles specified by `c-doc-comment-style'.")
2348 (defconst java-font-lock-keywords-3 (c-lang-const c-matchers-3 java)
2349 "Accurate normal font locking for Java mode.
2350 Like variable `java-font-lock-keywords-2' but detects declarations in a more
2351 accurate way that works in most cases for arbitrary types without the
2352 need for `java-font-lock-extra-types'.")
2354 (defvar java-font-lock-keywords java-font-lock-keywords-3
2355 "Default expressions to highlight in Java mode.")
2357 (defun java-font-lock-keywords-2 ()
2358 (c-compose-keywords-list java-font-lock-keywords-2))
2359 (defun java-font-lock-keywords-3 ()
2360 (c-compose-keywords-list java-font-lock-keywords-3))
2361 (defun java-font-lock-keywords ()
2362 (c-compose-keywords-list java-font-lock-keywords))
2365 ;;; CORBA IDL.
2367 (c-override-default-keywords 'idl-font-lock-keywords)
2369 (defconst idl-font-lock-keywords-1 (c-lang-const c-matchers-1 idl)
2370 "Minimal font locking for CORBA IDL mode.
2371 Fontifies nothing except the syntactic fontification of strings and
2372 comments.")
2374 (defconst idl-font-lock-keywords-2 (c-lang-const c-matchers-2 idl)
2375 "Fast normal font locking for CORBA IDL mode.
2376 In addition to `idl-font-lock-keywords-1', this adds fontification of
2377 keywords, simple types, declarations that are easy to recognize, the
2378 user defined types on `idl-font-lock-extra-types', and the doc comment
2379 styles specified by `c-doc-comment-style'.")
2381 (defconst idl-font-lock-keywords-3 (c-lang-const c-matchers-3 idl)
2382 "Accurate normal font locking for CORBA IDL mode.
2383 Like the variable `idl-font-lock-keywords-2' but detects declarations in a more
2384 accurate way that works in most cases for arbitrary types without the
2385 need for `idl-font-lock-extra-types'.")
2387 (defvar idl-font-lock-keywords idl-font-lock-keywords-3
2388 "Default expressions to highlight in CORBA IDL mode.")
2390 (defun idl-font-lock-keywords-2 ()
2391 (c-compose-keywords-list idl-font-lock-keywords-2))
2392 (defun idl-font-lock-keywords-3 ()
2393 (c-compose-keywords-list idl-font-lock-keywords-3))
2394 (defun idl-font-lock-keywords ()
2395 (c-compose-keywords-list idl-font-lock-keywords))
2398 ;;; Pike.
2400 (c-override-default-keywords 'pike-font-lock-keywords)
2402 (defconst pike-font-lock-keywords-1 (c-lang-const c-matchers-1 pike)
2403 "Minimal font locking for Pike mode.
2404 Fontifies only preprocessor directives (in addition to the syntactic
2405 fontification of strings and comments).")
2407 (defconst pike-font-lock-keywords-2 (c-lang-const c-matchers-2 pike)
2408 "Fast normal font locking for Pike mode.
2409 In addition to `pike-font-lock-keywords-1', this adds fontification of
2410 keywords, simple types, declarations that are easy to recognize, the
2411 user defined types on `pike-font-lock-extra-types', and the doc
2412 comment styles specified by `c-doc-comment-style'.")
2414 (defconst pike-font-lock-keywords-3 (c-lang-const c-matchers-3 pike)
2415 "Accurate normal font locking for Pike mode.
2416 Like the variable `pike-font-lock-keywords-2' but detects declarations in a more
2417 accurate way that works in most cases for arbitrary types without the
2418 need for `pike-font-lock-extra-types'.")
2420 (defvar pike-font-lock-keywords pike-font-lock-keywords-3
2421 "Default expressions to highlight in Pike mode.")
2423 (defun pike-font-lock-keywords-2 ()
2424 (c-compose-keywords-list pike-font-lock-keywords-2))
2425 (defun pike-font-lock-keywords-3 ()
2426 (c-compose-keywords-list pike-font-lock-keywords-3))
2427 (defun pike-font-lock-keywords ()
2428 (c-compose-keywords-list pike-font-lock-keywords))
2431 ;;; Doc comments.
2433 (defun c-font-lock-doc-comments (prefix limit keywords)
2434 ;; Fontify the comments between the point and LIMIT whose start
2435 ;; matches PREFIX with `c-doc-face-name'. Assumes comments have been
2436 ;; fontified with `font-lock-comment-face' already. nil is always
2437 ;; returned.
2439 ;; After the fontification of a matching comment, fontification
2440 ;; according to KEYWORDS is applied inside it. It's a list like
2441 ;; `font-lock-keywords' except that anchored matches and eval
2442 ;; clauses aren't supported and that some abbreviated forms can't be
2443 ;; used. The buffer is narrowed to the comment while KEYWORDS is
2444 ;; applied; leading comment starters are included but trailing
2445 ;; comment enders for block comment are not.
2447 ;; Note that faces added through KEYWORDS should never replace the
2448 ;; existing `c-doc-face-name' face since the existence of that face
2449 ;; is used as a flag in other code to skip comments.
2451 ;; This function might do hidden buffer changes.
2453 (let (comment-beg region-beg)
2454 (if (eq (get-text-property (point) 'face)
2455 'font-lock-comment-face)
2456 ;; Handle the case when the fontified region starts inside a
2457 ;; comment.
2458 (let ((range (c-literal-limits)))
2459 (setq region-beg (point))
2460 (when range
2461 (goto-char (car range)))
2462 (when (looking-at prefix)
2463 (setq comment-beg (point)))))
2465 (while (or
2466 comment-beg
2468 ;; Search for the prefix until a match is found at the start
2469 ;; of a comment.
2470 (while (when (re-search-forward prefix limit t)
2471 (setq comment-beg (match-beginning 0))
2472 (or (not (c-got-face-at comment-beg
2473 c-literal-faces))
2474 (and (/= comment-beg (point-min))
2475 (c-got-face-at (1- comment-beg)
2476 c-literal-faces))))
2477 (setq comment-beg nil))
2478 (setq region-beg comment-beg))
2480 (if (elt (parse-partial-sexp comment-beg (+ comment-beg 2)) 7)
2481 ;; Collect a sequence of doc style line comments.
2482 (progn
2483 (goto-char comment-beg)
2484 (while (and (progn
2485 (c-forward-single-comment)
2486 (skip-syntax-forward " ")
2487 (< (point) limit))
2488 (looking-at prefix))))
2489 (goto-char comment-beg)
2490 (c-forward-single-comment))
2491 (if (> (point) limit) (goto-char limit))
2492 (setq comment-beg nil)
2494 (let ((region-end (point))
2495 (keylist keywords) keyword matcher highlights)
2496 (c-put-font-lock-face region-beg region-end c-doc-face-name)
2497 (save-restriction
2498 ;; Narrow to the doc comment. Among other things, this
2499 ;; helps by making "^" match at the start of the comment.
2500 ;; Do not include a trailing block comment ender, though.
2501 (and (> region-end (1+ region-beg))
2502 (progn (goto-char region-end)
2503 (backward-char 2)
2504 (looking-at "\\*/"))
2505 (setq region-end (point)))
2506 (narrow-to-region region-beg region-end)
2508 (while keylist
2509 (setq keyword (car keylist)
2510 keylist (cdr keylist)
2511 matcher (car keyword))
2512 (goto-char region-beg)
2513 (while (if (stringp matcher)
2514 (re-search-forward matcher region-end t)
2515 (funcall matcher region-end))
2516 (setq highlights (cdr keyword))
2517 (if (consp (car highlights))
2518 (while highlights
2519 (font-lock-apply-highlight (car highlights))
2520 (setq highlights (cdr highlights)))
2521 (font-lock-apply-highlight highlights))))
2523 (goto-char region-end)))))
2524 nil)
2525 (put 'c-font-lock-doc-comments 'lisp-indent-function 2)
2527 (defun c-find-invalid-doc-markup (regexp limit)
2528 ;; Used to fontify invalid markup in doc comments after the correct
2529 ;; ones have been fontified: Find the first occurrence of REGEXP
2530 ;; between the point and LIMIT that only is fontified with
2531 ;; `c-doc-face-name'. If a match is found then submatch 0 surrounds
2532 ;; the first char and t is returned, otherwise nil is returned.
2534 ;; This function might do hidden buffer changes.
2535 (let (start)
2536 (while (if (re-search-forward regexp limit t)
2537 (not (eq (get-text-property
2538 (setq start (match-beginning 0)) 'face)
2539 c-doc-face-name))
2540 (setq start nil)))
2541 (when start
2542 (store-match-data (list (copy-marker start)
2543 (copy-marker (1+ start))))
2544 t)))
2546 ;; GtkDoc patterns contributed by Masatake YAMATO <jet@gyve.org>.
2548 (defconst gtkdoc-font-lock-doc-comments
2549 (let ((symbol "[a-zA-Z0-9_]+")
2550 (header "^ \\* "))
2551 `((,(concat header "\\(" symbol "\\):[ \t]*$")
2552 1 ,c-doc-markup-face-name prepend nil)
2553 (,(concat symbol "()")
2554 0 ,c-doc-markup-face-name prepend nil)
2555 (,(concat header "\\(" "@" symbol "\\):")
2556 1 ,c-doc-markup-face-name prepend nil)
2557 (,(concat "[#%@]" symbol)
2558 0 ,c-doc-markup-face-name prepend nil))
2561 (defconst gtkdoc-font-lock-doc-protection
2562 `(("< \\(public\\|private\\|protected\\) >"
2563 1 ,c-doc-markup-face-name prepend nil)))
2565 (defconst gtkdoc-font-lock-keywords
2566 `((,(lambda (limit)
2567 (c-font-lock-doc-comments "/\\*\\*$" limit
2568 gtkdoc-font-lock-doc-comments)
2569 (c-font-lock-doc-comments "/\\*< " limit
2570 gtkdoc-font-lock-doc-protection)
2571 ))))
2573 ;; Javadoc.
2575 (defconst javadoc-font-lock-doc-comments
2576 `(("{@[a-z]+[^}\n\r]*}" ; "{@foo ...}" markup.
2577 0 ,c-doc-markup-face-name prepend nil)
2578 ("^\\(/\\*\\)?\\(\\s \\|\\*\\)*\\(@[a-z]+\\)" ; "@foo ..." markup.
2579 3 ,c-doc-markup-face-name prepend nil)
2580 (,(concat "</?\\sw" ; HTML tags.
2581 "\\("
2582 (concat "\\sw\\|\\s \\|[=\n\r*.:]\\|"
2583 "\"[^\"]*\"\\|'[^']*'")
2584 "\\)*>")
2585 0 ,c-doc-markup-face-name prepend nil)
2586 ("&\\(\\sw\\|[.:]\\)+;" ; HTML entities.
2587 0 ,c-doc-markup-face-name prepend nil)
2588 ;; Fontify remaining markup characters as invalid. Note
2589 ;; that the Javadoc spec is hazy about when "@" is
2590 ;; allowed in non-markup use.
2591 (,(lambda (limit)
2592 (c-find-invalid-doc-markup "[<>&]\\|{@" limit))
2593 0 'font-lock-warning-face prepend nil)))
2595 (defconst javadoc-font-lock-keywords
2596 `((,(lambda (limit)
2597 (c-font-lock-doc-comments "/\\*\\*" limit
2598 javadoc-font-lock-doc-comments)))))
2600 ;; Pike autodoc.
2602 (defconst autodoc-decl-keywords
2603 ;; Adorned regexp matching the keywords that introduce declarations
2604 ;; in Pike Autodoc.
2605 (cc-eval-when-compile
2606 (c-make-keywords-re t '("@decl" "@elem" "@index" "@member") 'pike-mode)))
2608 (defconst autodoc-decl-type-keywords
2609 ;; Adorned regexp matching the keywords that are followed by a type.
2610 (cc-eval-when-compile
2611 (c-make-keywords-re t '("@elem" "@member") 'pike-mode)))
2613 (defun autodoc-font-lock-line-markup (limit)
2614 ;; Fontify all line oriented keywords between the point and LIMIT.
2615 ;; Nil is always returned.
2617 ;; This function might do hidden buffer changes.
2619 (let ((line-re (concat "^\\(\\(/\\*!\\|\\s *\\("
2620 c-current-comment-prefix
2621 "\\)\\)\\s *\\)@[A-Za-z_-]+\\(\\s \\|$\\)"))
2622 (markup-faces (list c-doc-markup-face-name c-doc-face-name)))
2624 (while (re-search-forward line-re limit t)
2625 (goto-char (match-end 1))
2627 (if (looking-at autodoc-decl-keywords)
2628 (let* ((kwd-pos (point))
2629 (start (match-end 1))
2630 (pos start)
2631 end)
2633 (c-put-font-lock-face (point) pos markup-faces)
2635 ;; Put a declaration end mark at the markup keyword and
2636 ;; remove the faces from the rest of the line so that it
2637 ;; gets refontified as a declaration later on by
2638 ;; `c-font-lock-declarations'.
2639 (c-put-char-property (1- pos) 'c-type 'c-decl-end)
2640 (goto-char pos)
2641 (while (progn
2642 (end-of-line)
2643 (setq end (point))
2644 (and (eq (char-before) ?@)
2645 (not (eobp))
2646 (progn (forward-char)
2647 (skip-syntax-forward " ")
2648 (looking-at c-current-comment-prefix))))
2649 (goto-char (match-end 0))
2650 (c-remove-font-lock-face pos (1- end))
2651 (c-put-font-lock-face (1- end) end markup-faces)
2652 (setq pos (point)))
2654 ;; Include the final newline in the removed area. This
2655 ;; has no visual effect but it avoids some tricky special
2656 ;; cases in the testsuite wrt the differences in string
2657 ;; fontification in Emacs vs XEmacs.
2658 (c-remove-font-lock-face pos (min (1+ (point)) (point-max)))
2660 ;; Must handle string literals explicitly inside the declaration.
2661 (goto-char start)
2662 (while (re-search-forward
2663 "\"\\([^\\\"]\\|\\\\.\\)*\"\\|'\\([^\\']\\|\\\\.\\)*'"
2664 end 'move)
2665 (c-put-font-lock-string-face (match-beginning 0)
2666 (point)))
2668 ;; Fontify types after keywords that always are followed
2669 ;; by them.
2670 (goto-char kwd-pos)
2671 (when (looking-at autodoc-decl-type-keywords)
2672 (c-fontify-types-and-refs ((c-promote-possible-types t))
2673 (goto-char start)
2674 (c-forward-syntactic-ws)
2675 (c-forward-type))))
2677 ;; Mark each whole line as markup, as long as the logical line
2678 ;; continues.
2679 (while (progn
2680 (c-put-font-lock-face (point)
2681 (progn (end-of-line) (point))
2682 markup-faces)
2683 (and (eq (char-before) ?@)
2684 (not (eobp))
2685 (progn (forward-char)
2686 (skip-syntax-forward " ")
2687 (looking-at c-current-comment-prefix))))
2688 (goto-char (match-end 0))))))
2690 nil)
2692 (defconst autodoc-font-lock-doc-comments
2693 `(("@\\(\\w+{\\|\\[\\([^\]@\n\r]\\|@@\\)*\\]\\|[@}]\\|$\\)"
2694 ;; In-text markup.
2695 0 ,c-doc-markup-face-name prepend nil)
2696 (autodoc-font-lock-line-markup)
2697 ;; Fontify remaining markup characters as invalid.
2698 (,(lambda (limit)
2699 (c-find-invalid-doc-markup "@" limit))
2700 0 'font-lock-warning-face prepend nil)
2703 (defun autodoc-font-lock-keywords ()
2704 ;; Note that we depend on that `c-current-comment-prefix' has got
2705 ;; its proper value here.
2707 ;; This function might do hidden buffer changes.
2709 ;; The `c-type' text property with `c-decl-end' is used to mark the
2710 ;; end of the `autodoc-decl-keywords' occurrences to fontify the
2711 ;; following declarations.
2712 (setq c-type-decl-end-used t)
2714 `((,(lambda (limit)
2715 (c-font-lock-doc-comments "/[*/]!" limit
2716 autodoc-font-lock-doc-comments)))))
2719 ;; 2006-07-10: awk-font-lock-keywords has been moved back to cc-awk.el.
2720 (cc-provide 'cc-fonts)
2722 ;;; cc-fonts.el ends here