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