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