]> code.delx.au - gnu-emacs/blob - lisp/progmodes/cc-fonts.el
Convert consecutive FSF copyright years to ranges.
[gnu-emacs] / lisp / progmodes / cc-fonts.el
1 ;;; cc-fonts.el --- font lock support for CC Mode
2
3 ;; Copyright (C) 2002-2011 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 ;; Start of containing declaration (if any); limit for searching
1049 ;; backwards for it.
1050 decl-start decl-search-lim
1051 ;; Start of containing declaration (if any); limit for searching
1052 ;; backwards for it.
1053 decl-start decl-search-lim
1054 ;; The result from `c-forward-decl-or-cast-1'.
1055 decl-or-cast
1056 ;; The maximum of the end positions of all the checked type
1057 ;; decl expressions in the successfully identified
1058 ;; declarations. The position might be either before or
1059 ;; after the syntactic whitespace following the last token
1060 ;; in the type decl expression.
1061 (max-type-decl-end 0)
1062 ;; Same as `max-type-decl-*', but used when we're before
1063 ;; `token-pos'.
1064 (max-type-decl-end-before-token 0)
1065 ;; Set according to the context to direct the heuristics for
1066 ;; recognizing C++ templates.
1067 c-restricted-<>-arglists
1068 ;; Turn on recording of identifier ranges in
1069 ;; `c-forward-decl-or-cast-1' and `c-forward-label' for
1070 ;; later fontification.
1071 (c-record-type-identifiers t)
1072 label-type
1073 c-record-ref-identifiers
1074 ;; Make `c-forward-type' calls mark up template arglists if
1075 ;; it finds any. That's necessary so that we later will
1076 ;; stop inside them to fontify types there.
1077 (c-parse-and-markup-<>-arglists t)
1078 ;; The font-lock package in Emacs is known to clobber
1079 ;; `parse-sexp-lookup-properties' (when it exists).
1080 (parse-sexp-lookup-properties
1081 (cc-eval-when-compile
1082 (boundp 'parse-sexp-lookup-properties))))
1083
1084 ;; Below we fontify a whole declaration even when it crosses the limit,
1085 ;; to avoid gaps when lazy-lock fontifies the file a screenful at a
1086 ;; time. That is however annoying during editing, e.g. the following is
1087 ;; a common situation while the first line is being written:
1088 ;;
1089 ;; my_variable
1090 ;; some_other_variable = 0;
1091 ;;
1092 ;; font-lock will put the limit at the beginning of the second line
1093 ;; here, and if we go past it we'll fontify "my_variable" as a type and
1094 ;; "some_other_variable" as an identifier, and the latter will not
1095 ;; correct itself until the second line is changed. To avoid that we
1096 ;; narrow to the limit if the region to fontify is a single line.
1097 (narrow-to-region
1098 (point-min)
1099 (if (<= limit (c-point 'bonl))
1100 (save-excursion
1101 ;; Narrow after any operator chars following the limit though,
1102 ;; since those characters can be useful in recognizing a
1103 ;; declaration (in particular the '{' that opens a function body
1104 ;; after the header).
1105 (goto-char limit)
1106 (skip-chars-forward c-nonsymbol-chars)
1107 (point))
1108 limit))
1109
1110 (c-find-decl-spots
1111 limit
1112 c-decl-start-re
1113 c-font-lock-maybe-decl-faces
1114
1115 (lambda (match-pos inside-macro)
1116 (setq start-pos (point))
1117 (when
1118 ;; The result of the form below is true when we don't recognize a
1119 ;; declaration or cast.
1120 (if (and (eq (get-text-property (point) 'face)
1121 'font-lock-keyword-face)
1122 (looking-at c-not-decl-init-keywords))
1123 ;; Don't do anything more if we're looking at a keyword that
1124 ;; can't start a declaration.
1125 t
1126
1127 ;; Set `context' and `c-restricted-<>-arglists'. Look for
1128 ;; "<" for the sake of C++-style template arglists.
1129 ;; Ignore "(" when it's part of a control flow construct
1130 ;; (e.g. "for (").
1131 (let ((type (and (> match-pos (point-min))
1132 (c-get-char-property (1- match-pos) 'c-type))))
1133 (cond ((not (memq (char-before match-pos) '(?\( ?, ?\[ ?<)))
1134 (setq context nil
1135 c-restricted-<>-arglists nil))
1136 ;; A control flow expression
1137 ((and (eq (char-before match-pos) ?\()
1138 (save-excursion
1139 (goto-char match-pos)
1140 (backward-char)
1141 (c-backward-token-2)
1142 (looking-at c-block-stmt-2-key)))
1143 (setq context nil
1144 c-restricted-<>-arglists t))
1145 ;; Near BOB.
1146 ((<= match-pos (point-min))
1147 (setq context 'arglist
1148 c-restricted-<>-arglists t))
1149 ;; Got a cached hit in a declaration arglist.
1150 ((eq type 'c-decl-arg-start)
1151 (setq context 'decl
1152 c-restricted-<>-arglists nil))
1153 ;; Inside an angle bracket arglist.
1154 ((or (eq type 'c-<>-arg-sep)
1155 (eq (char-before match-pos) ?<))
1156 (setq context '<>
1157 c-restricted-<>-arglists nil))
1158 ;; Got a cached hit in some other type of arglist.
1159 (type
1160 (setq context 'arglist
1161 c-restricted-<>-arglists t))
1162 ((if inside-macro
1163 (< match-pos max-type-decl-end-before-token)
1164 (< match-pos max-type-decl-end))
1165 ;; The point is within the range of a previously
1166 ;; encountered type decl expression, so the arglist
1167 ;; is probably one that contains declarations.
1168 ;; However, if `c-recognize-paren-inits' is set it
1169 ;; might also be an initializer arglist.
1170 (setq context 'decl
1171 c-restricted-<>-arglists nil)
1172 ;; The result of this check is cached with a char
1173 ;; property on the match token, so that we can look
1174 ;; it up again when refontifying single lines in a
1175 ;; multiline declaration.
1176 (c-put-char-property (1- match-pos)
1177 'c-type 'c-decl-arg-start))
1178 (t (setq context 'arglist
1179 c-restricted-<>-arglists t))))
1180
1181 ;; Check we haven't missed a preceding "typedef".
1182 (when (not (looking-at c-typedef-key))
1183 (c-backward-syntactic-ws)
1184 (c-backward-token-2)
1185 (or (looking-at c-typedef-key)
1186 (goto-char start-pos)))
1187
1188 ;; Now analyze the construct.
1189 (setq decl-or-cast (c-forward-decl-or-cast-1
1190 match-pos context last-cast-end))
1191
1192 (if (not decl-or-cast)
1193 ;; Are we at a declarator? Try to go back to the declaration
1194 ;; to check this. Note that `c-beginning-of-decl-1' is slow,
1195 ;; so we cache its result between calls.
1196 (let (paren-state bod-res encl-pos is-typedef)
1197 (goto-char start-pos)
1198 (save-excursion
1199 (unless (and decl-search-lim
1200 (eq decl-search-lim
1201 (save-excursion
1202 (c-syntactic-skip-backward "^;" nil t)
1203 (point))))
1204 (setq decl-search-lim
1205 (and (c-syntactic-skip-backward "^;" nil t) (point)))
1206 (setq bod-res (car (c-beginning-of-decl-1 decl-search-lim)))
1207 (if (and (eq bod-res 'same)
1208 (progn
1209 (c-backward-syntactic-ws)
1210 (eq (char-before) ?\})))
1211 (c-beginning-of-decl-1 decl-search-lim))
1212 (setq decl-start (point))))
1213
1214 (save-excursion
1215 (goto-char decl-start)
1216 ;; We're now putatively at the declaration.
1217 (setq paren-state (c-parse-state))
1218 ;; At top level or inside a "{"?
1219 (if (or (not (setq encl-pos
1220 (c-most-enclosing-brace paren-state)))
1221 (eq (char-after encl-pos) ?\{))
1222 (progn
1223 (when (looking-at c-typedef-key) ; "typedef"
1224 (setq is-typedef t)
1225 (goto-char (match-end 0))
1226 (c-forward-syntactic-ws))
1227 ;; At a real declaration?
1228 (if (memq (c-forward-type t) '(t known found))
1229 (progn
1230 (c-font-lock-declarators limit t is-typedef)
1231 nil)
1232 ;; False alarm. Return t to go on to the next check.
1233 (goto-char start-pos)
1234 t))
1235 t)))
1236
1237 (if (eq decl-or-cast 'cast)
1238 ;; Save the position after the previous cast so we can feed
1239 ;; it to `c-forward-decl-or-cast-1' in the next round. That
1240 ;; helps it discover cast chains like "(a) (b) c".
1241 (setq last-cast-end (point))
1242
1243 ;; Set `max-type-decl-end' or `max-type-decl-end-before-token'
1244 ;; under the assumption that we're after the first type decl
1245 ;; expression in the declaration now. That's not really true;
1246 ;; we could also be after a parenthesized initializer
1247 ;; expression in C++, but this is only used as a last resort
1248 ;; to slant ambiguous expression/declarations, and overall
1249 ;; it's worth the risk to occasionally fontify an expression
1250 ;; as a declaration in an initializer expression compared to
1251 ;; getting ambiguous things in normal function prototypes
1252 ;; fontified as expressions.
1253 (if inside-macro
1254 (when (> (point) max-type-decl-end-before-token)
1255 (setq max-type-decl-end-before-token (point)))
1256 (when (> (point) max-type-decl-end)
1257 (setq max-type-decl-end (point))))
1258
1259 ;; Back up to the type to fontify the declarator(s).
1260 (goto-char (car decl-or-cast))
1261
1262 (let ((decl-list
1263 (if context
1264 ;; Should normally not fontify a list of
1265 ;; declarators inside an arglist, but the first
1266 ;; argument in the ';' separated list of a "for"
1267 ;; statement is an exception.
1268 (when (eq (char-before match-pos) ?\()
1269 (save-excursion
1270 (goto-char (1- match-pos))
1271 (c-backward-syntactic-ws)
1272 (and (c-simple-skip-symbol-backward)
1273 (looking-at c-paren-stmt-key))))
1274 t)))
1275
1276 ;; Fix the `c-decl-id-start' or `c-decl-type-start' property
1277 ;; before the first declarator if it's a list.
1278 ;; `c-font-lock-declarators' handles the rest.
1279 (when decl-list
1280 (save-excursion
1281 (c-backward-syntactic-ws)
1282 (unless (bobp)
1283 (c-put-char-property (1- (point)) 'c-type
1284 (if (cdr decl-or-cast)
1285 'c-decl-type-start
1286 'c-decl-id-start)))))
1287
1288 (c-font-lock-declarators
1289 (point-max) decl-list (cdr decl-or-cast))))
1290
1291 ;; A cast or declaration has been successfully identified, so do
1292 ;; all the fontification of types and refs that's been recorded.
1293 (c-fontify-recorded-types-and-refs)
1294 nil))
1295
1296 ;; It was a false alarm. Check if we're in a label (or other
1297 ;; construct with `:' except bitfield) instead.
1298 (goto-char start-pos)
1299 (when (setq label-type (c-forward-label t match-pos nil))
1300 ;; Can't use `c-fontify-types-and-refs' here since we
1301 ;; use the label face at times.
1302 (cond ((eq label-type 'goto-target)
1303 (c-put-font-lock-face (caar c-record-ref-identifiers)
1304 (cdar c-record-ref-identifiers)
1305 c-label-face-name))
1306 ((eq label-type 'qt-1kwd-colon)
1307 (c-put-font-lock-face (caar c-record-ref-identifiers)
1308 (cdar c-record-ref-identifiers)
1309 'font-lock-keyword-face))
1310 ((eq label-type 'qt-2kwds-colon)
1311 (mapc
1312 (lambda (kwd)
1313 (c-put-font-lock-face (car kwd) (cdr kwd)
1314 'font-lock-keyword-face))
1315 c-record-ref-identifiers)))
1316 (setq c-record-ref-identifiers nil)
1317 ;; `c-forward-label' has probably added a `c-decl-end'
1318 ;; marker, so return t to `c-find-decl-spots' to signal
1319 ;; that.
1320 t))))
1321
1322 nil)))
1323
1324 (defun c-font-lock-enum-tail (limit)
1325 ;; Fontify an enum's identifiers when POINT is within the enum's brace
1326 ;; block.
1327 ;;
1328 ;; This function will be called from font-lock for a region bounded by POINT
1329 ;; and LIMIT, as though it were to identify a keyword for
1330 ;; font-lock-keyword-face. It always returns NIL to inhibit this and
1331 ;; prevent a repeat invocation. See elisp/lispref page "Search-based
1332 ;; Fontification".
1333 ;;
1334 ;; Note that this function won't attempt to fontify beyond the end of the
1335 ;; current enum block, if any.
1336 (let* ((paren-state (c-parse-state))
1337 (encl-pos (c-most-enclosing-brace paren-state))
1338 (start (point))
1339 )
1340 (when (and
1341 encl-pos
1342 (eq (char-after encl-pos) ?\{)
1343 (save-excursion
1344 (goto-char encl-pos)
1345 (c-backward-syntactic-ws)
1346 (c-simple-skip-symbol-backward)
1347 (or (looking-at c-brace-list-key) ; "enum"
1348 (progn (c-backward-syntactic-ws)
1349 (c-simple-skip-symbol-backward)
1350 (looking-at c-brace-list-key)))))
1351 (c-syntactic-skip-backward "^{," nil t)
1352 (c-put-char-property (1- (point)) 'c-type 'c-decl-id-start)
1353
1354 (c-forward-syntactic-ws)
1355 (c-font-lock-declarators limit t nil)))
1356 nil)
1357
1358 (c-lang-defconst c-simple-decl-matchers
1359 "Simple font lock matchers for types and declarations. These are used
1360 on level 2 only and so aren't combined with `c-complex-decl-matchers'."
1361
1362 t `(;; Objective-C methods.
1363 ,@(when (c-major-mode-is 'objc-mode)
1364 `((,(c-lang-const c-opt-method-key)
1365 (,(byte-compile
1366 (lambda (limit)
1367 (let (;; The font-lock package in Emacs is known to clobber
1368 ;; `parse-sexp-lookup-properties' (when it exists).
1369 (parse-sexp-lookup-properties
1370 (cc-eval-when-compile
1371 (boundp 'parse-sexp-lookup-properties))))
1372 (save-restriction
1373 (narrow-to-region (point-min) limit)
1374 (c-font-lock-objc-method)))
1375 nil))
1376 (goto-char (match-end 1))))))
1377
1378 ;; Fontify all type names and the identifiers in the
1379 ;; declarations they might start. Use eval here since
1380 ;; `c-known-type-key' gets its value from
1381 ;; `*-font-lock-extra-types' on mode init.
1382 (eval . (list ,(c-make-font-lock-search-function
1383 'c-known-type-key
1384 '(1 'font-lock-type-face t)
1385 '((c-font-lock-declarators limit t nil)
1386 (save-match-data
1387 (goto-char (match-end 1))
1388 (c-forward-syntactic-ws))
1389 (goto-char (match-end 1))))))
1390
1391 ;; Fontify types preceded by `c-type-prefix-kwds' and the
1392 ;; identifiers in the declarations they might start.
1393 ,@(when (c-lang-const c-type-prefix-kwds)
1394 (let* ((prefix-re (c-make-keywords-re nil
1395 (c-lang-const c-type-prefix-kwds)))
1396 (type-match (+ 2
1397 (regexp-opt-depth prefix-re)
1398 (c-lang-const c-simple-ws-depth))))
1399 `((,(c-make-font-lock-search-function
1400 (concat "\\<\\(" prefix-re "\\)" ; 1
1401 (c-lang-const c-simple-ws) "+"
1402 (concat "\\(" ; 2 + prefix-re + c-simple-ws
1403 (c-lang-const c-symbol-key)
1404 "\\)"))
1405 `(,type-match
1406 'font-lock-type-face t)
1407 `((c-font-lock-declarators limit t nil)
1408 (save-match-data
1409 (goto-char (match-end ,type-match))
1410 (c-forward-syntactic-ws))
1411 (goto-char (match-end ,type-match))))))))
1412
1413 ;; Fontify special declarations that lacks a type.
1414 ,@(when (c-lang-const c-typeless-decl-kwds)
1415 `((,(c-make-font-lock-search-function
1416 (concat "\\<\\("
1417 (regexp-opt (c-lang-const c-typeless-decl-kwds))
1418 "\\)\\>")
1419 '((c-font-lock-declarators limit t nil)
1420 (save-match-data
1421 (goto-char (match-end 1))
1422 (c-forward-syntactic-ws))
1423 (goto-char (match-end 1)))))))
1424
1425 ;; Fontify generic colon labels in languages that support them.
1426 ,@(when (c-lang-const c-recognize-colon-labels)
1427 `(c-font-lock-labels))))
1428
1429 (c-lang-defconst c-complex-decl-matchers
1430 "Complex font lock matchers for types and declarations. Used on level
1431 3 and higher."
1432
1433 ;; Note: This code in this form dumps a number of functions into the
1434 ;; resulting constant, `c-matchers-3'. At run time, font lock will call
1435 ;; each of them as a "FUNCTION" (see Elisp page "Search-based
1436 ;; Fontification"). The font lock region is delimited by POINT and the
1437 ;; single parameter, LIMIT. Each of these functions returns NIL (thus
1438 ;; inhibiting spurious font-lock-keyword-face highlighting and another
1439 ;; call).
1440
1441 t `(;; Initialize some things before the search functions below.
1442 c-font-lock-complex-decl-prepare
1443
1444 ,@(if (c-major-mode-is 'objc-mode)
1445 ;; Fontify method declarations in Objective-C, but first
1446 ;; we have to put the `c-decl-end' `c-type' property on
1447 ;; all the @-style directives that haven't been handled in
1448 ;; `c-basic-matchers-before'.
1449 `(,(c-make-font-lock-search-function
1450 (c-make-keywords-re t
1451 ;; Exclude "@class" since that directive ends with a
1452 ;; semicolon anyway.
1453 (delete "@class"
1454 (append (c-lang-const c-protection-kwds)
1455 (c-lang-const c-other-decl-kwds)
1456 nil)))
1457 '((c-put-char-property (1- (match-end 1))
1458 'c-type 'c-decl-end)))
1459 c-font-lock-objc-methods))
1460
1461 ;; Fontify all declarations, casts and normal labels.
1462 c-font-lock-declarations
1463
1464 ;; Fontify angle bracket arglists like templates in C++.
1465 ,@(when (c-lang-const c-recognize-<>-arglists)
1466 `(c-font-lock-<>-arglists))
1467
1468 ;; The first two rules here mostly find occurrences that
1469 ;; `c-font-lock-declarations' has found already, but not
1470 ;; declarations containing blocks in the type (see note below).
1471 ;; It's also useful to fontify these everywhere to show e.g. when
1472 ;; a type keyword is accidentally used as an identifier.
1473
1474 ;; Fontify basic types.
1475 ,(let ((re (c-make-keywords-re nil
1476 (c-lang-const c-primitive-type-kwds))))
1477 (if (c-major-mode-is 'pike-mode)
1478 ;; No symbol is a keyword after "->" in Pike.
1479 `(,(concat "\\(\\=.?\\|[^>]\\|[^-]>\\)"
1480 "\\<\\(" re "\\)\\>")
1481 2 font-lock-type-face)
1482 `(,(concat "\\<\\(" re "\\)\\>")
1483 1 'font-lock-type-face)))
1484
1485 ;; Fontify types preceded by `c-type-prefix-kwds' (e.g. "struct").
1486 ,@(when (c-lang-const c-type-prefix-kwds)
1487 `((,(byte-compile
1488 `(lambda (limit)
1489 (c-fontify-types-and-refs
1490 ((c-promote-possible-types t)
1491 ;; The font-lock package in Emacs is known to clobber
1492 ;; `parse-sexp-lookup-properties' (when it exists).
1493 (parse-sexp-lookup-properties
1494 (cc-eval-when-compile
1495 (boundp 'parse-sexp-lookup-properties))))
1496 (save-restriction
1497 ;; Narrow to avoid going past the limit in
1498 ;; `c-forward-type'.
1499 (narrow-to-region (point) limit)
1500 (while (re-search-forward
1501 ,(concat "\\<\\("
1502 (c-make-keywords-re nil
1503 (c-lang-const c-type-prefix-kwds))
1504 "\\)\\>")
1505 limit t)
1506 (unless (c-skip-comments-and-strings limit)
1507 (c-forward-syntactic-ws)
1508 ;; Handle prefix declaration specifiers.
1509 (when (looking-at c-prefix-spec-kwds-re)
1510 (c-forward-keyword-clause 1))
1511 ,(if (c-major-mode-is 'c++-mode)
1512 `(when (and (c-forward-type)
1513 (eq (char-after) ?=))
1514 ;; In C++ we additionally check for a "class
1515 ;; X = Y" construct which is used in
1516 ;; templates, to fontify Y as a type.
1517 (forward-char)
1518 (c-forward-syntactic-ws)
1519 (c-forward-type))
1520 `(c-forward-type))
1521 )))))))))
1522
1523 ;; Fontify symbols after closing braces as declaration
1524 ;; identifiers under the assumption that they are part of
1525 ;; declarations like "class Foo { ... } foo;". It's too
1526 ;; expensive to check this accurately by skipping past the
1527 ;; brace block, so we use the heuristic that it's such a
1528 ;; declaration if the first identifier is on the same line as
1529 ;; the closing brace. `c-font-lock-declarations' will later
1530 ;; override it if it turns out to be an new declaration, but
1531 ;; it will be wrong if it's an expression (see the test
1532 ;; decls-8.cc).
1533 ;; ,@(when (c-lang-const c-opt-block-decls-with-vars-key)
1534 ;; `((,(c-make-font-lock-search-function
1535 ;; (concat "}"
1536 ;; (c-lang-const c-single-line-syntactic-ws)
1537 ;; "\\(" ; 1 + c-single-line-syntactic-ws-depth
1538 ;; (c-lang-const c-type-decl-prefix-key)
1539 ;; "\\|"
1540 ;; (c-lang-const c-symbol-key)
1541 ;; "\\)")
1542 ;; `((c-font-lock-declarators limit t nil) ; That `nil' says use `font-lock-variable-name-face';
1543 ;; ; `t' would mean `font-lock-function-name-face'.
1544 ;; (progn
1545 ;; (c-put-char-property (match-beginning 0) 'c-type
1546 ;; 'c-decl-id-start)
1547 ;; ; 'c-decl-type-start)
1548 ;; (goto-char (match-beginning
1549 ;; ,(1+ (c-lang-const
1550 ;; c-single-line-syntactic-ws-depth)))))
1551 ;; (goto-char (match-end 0)))))))
1552
1553 ;; Fontify the type in C++ "new" expressions.
1554 ,@(when (c-major-mode-is 'c++-mode)
1555 ;; This pattern is a probably a "(MATCHER . ANCHORED-HIGHLIGHTER)"
1556 ;; (see Elisp page "Search-based Fontification").
1557 `(("\\<new\\>"
1558 (c-font-lock-c++-new))))
1559 ))
1560
1561 (defun c-font-lock-labels (limit)
1562 ;; Fontify all statement labels from the point to LIMIT. Assumes
1563 ;; that strings and comments have been fontified already. Nil is
1564 ;; always returned.
1565 ;;
1566 ;; Note: This function is only used on decoration level 2; this is
1567 ;; taken care of directly by the gargantuan
1568 ;; `c-font-lock-declarations' on higher levels.
1569 ;;
1570 ;; This function might do hidden buffer changes.
1571
1572 (let (continue-pos id-start
1573 ;; The font-lock package in Emacs is known to clobber
1574 ;; `parse-sexp-lookup-properties' (when it exists).
1575 (parse-sexp-lookup-properties
1576 (cc-eval-when-compile
1577 (boundp 'parse-sexp-lookup-properties))))
1578
1579 (while (re-search-forward ":[^:]" limit t)
1580 (setq continue-pos (point))
1581 (goto-char (match-beginning 0))
1582 (unless (c-skip-comments-and-strings limit)
1583
1584 (c-backward-syntactic-ws)
1585 (and (setq id-start (c-on-identifier))
1586
1587 (not (get-text-property id-start 'face))
1588
1589 (progn
1590 (goto-char id-start)
1591 (c-backward-syntactic-ws)
1592 (or
1593 ;; Check for a char that precedes a statement.
1594 (memq (char-before) '(?\} ?\{ ?\;))
1595 ;; Check for a preceding label. We exploit the font
1596 ;; locking made earlier by this function.
1597 (and (eq (char-before) ?:)
1598 (progn
1599 (backward-char)
1600 (c-backward-syntactic-ws)
1601 (not (bobp)))
1602 (eq (get-text-property (1- (point)) 'face)
1603 c-label-face-name))
1604 ;; Check for a keyword that precedes a statement.
1605 (c-after-conditional)))
1606
1607 (progn
1608 ;; Got a label.
1609 (goto-char id-start)
1610 (looking-at c-symbol-key)
1611 (c-put-font-lock-face (match-beginning 0) (match-end 0)
1612 c-label-face-name)))
1613
1614 (goto-char continue-pos))))
1615 nil)
1616
1617 (c-lang-defconst c-basic-matchers-after
1618 "Font lock matchers for various things that should be fontified after
1619 generic casts and declarations are fontified. Used on level 2 and
1620 higher."
1621
1622 t `(,@(when (c-lang-const c-brace-id-list-kwds)
1623 ;; Fontify the remaining identifiers inside an enum list when we start
1624 ;; inside it.
1625 `(c-font-lock-enum-tail
1626 ;; Fontify the identifiers inside enum lists. (The enum type
1627 ;; name is handled by `c-simple-decl-matchers' or
1628 ;; `c-complex-decl-matchers' below.
1629 (,(c-make-font-lock-search-function
1630 (concat
1631 "\\<\\("
1632 (c-make-keywords-re nil (c-lang-const c-brace-id-list-kwds))
1633 "\\)\\>"
1634 ;; Disallow various common punctuation chars that can't come
1635 ;; before the '{' of the enum list, to avoid searching too far.
1636 "[^\]\[{}();,/#=]*"
1637 "{")
1638 '((c-font-lock-declarators limit t nil)
1639 (save-match-data
1640 (goto-char (match-end 0))
1641 (c-put-char-property (1- (point)) 'c-type
1642 'c-decl-id-start)
1643 (c-forward-syntactic-ws))
1644 (goto-char (match-end 0)))))))
1645
1646 ;; Fontify labels after goto etc.
1647 ,@(when (c-lang-const c-before-label-kwds)
1648 `(;; (Got three different interpretation levels here,
1649 ;; which makes it a bit complicated: 1) The backquote
1650 ;; stuff is expanded when compiled or loaded, 2) the
1651 ;; eval form is evaluated at font-lock setup (to
1652 ;; substitute c-label-face-name correctly), and 3) the
1653 ;; resulting structure is interpreted during
1654 ;; fontification.)
1655 (eval
1656 . ,(let* ((c-before-label-re
1657 (c-make-keywords-re nil
1658 (c-lang-const c-before-label-kwds))))
1659 `(list
1660 ,(concat "\\<\\(" c-before-label-re "\\)\\>"
1661 "\\s *"
1662 "\\(" ; identifier-offset
1663 (c-lang-const c-symbol-key)
1664 "\\)")
1665 (list ,(+ (regexp-opt-depth c-before-label-re) 2)
1666 c-label-face-name nil t))))))
1667
1668 ;; Fontify the clauses after various keywords.
1669 ,@(when (or (c-lang-const c-type-list-kwds)
1670 (c-lang-const c-ref-list-kwds)
1671 (c-lang-const c-colon-type-list-kwds)
1672 (c-lang-const c-paren-type-kwds))
1673 `((,(c-make-font-lock-search-function
1674 (concat "\\<\\("
1675 (c-make-keywords-re nil
1676 (append (c-lang-const c-type-list-kwds)
1677 (c-lang-const c-ref-list-kwds)
1678 (c-lang-const c-colon-type-list-kwds)
1679 (c-lang-const c-paren-type-kwds)))
1680 "\\)\\>")
1681 '((c-fontify-types-and-refs ((c-promote-possible-types t))
1682 (c-forward-keyword-clause 1)
1683 (if (> (point) limit) (goto-char limit))))))))
1684
1685 ,@(when (c-major-mode-is 'java-mode)
1686 `((eval . (list "\\<\\(@[a-zA-Z0-9]+\\)\\>" 1 c-annotation-face))))
1687 ))
1688
1689 (c-lang-defconst c-matchers-1
1690 t (c-lang-const c-cpp-matchers))
1691
1692 (c-lang-defconst c-matchers-2
1693 t (append (c-lang-const c-matchers-1)
1694 (c-lang-const c-basic-matchers-before)
1695 (c-lang-const c-simple-decl-matchers)
1696 (c-lang-const c-basic-matchers-after)))
1697
1698 (c-lang-defconst c-matchers-3
1699 t (append (c-lang-const c-matchers-1)
1700 (c-lang-const c-basic-matchers-before)
1701 (c-lang-const c-complex-decl-matchers)
1702 (c-lang-const c-basic-matchers-after)))
1703
1704 (defun c-compose-keywords-list (base-list)
1705 ;; Incorporate the font lock keyword lists according to
1706 ;; `c-doc-comment-style' on the given keyword list and return it.
1707 ;; This is used in the function bindings of the
1708 ;; `*-font-lock-keywords-*' symbols since we have to build the list
1709 ;; when font-lock is initialized.
1710
1711 (unless (memq c-doc-face-name c-literal-faces)
1712 (setq c-literal-faces (cons c-doc-face-name c-literal-faces)))
1713
1714 (let* ((doc-keywords
1715 (if (consp (car-safe c-doc-comment-style))
1716 (cdr-safe (or (assq c-buffer-is-cc-mode c-doc-comment-style)
1717 (assq 'other c-doc-comment-style)))
1718 c-doc-comment-style))
1719 (list (nconc (apply 'nconc
1720 (mapcar
1721 (lambda (doc-style)
1722 (let ((sym (intern
1723 (concat (symbol-name doc-style)
1724 "-font-lock-keywords"))))
1725 (cond ((fboundp sym)
1726 (funcall sym))
1727 ((boundp sym)
1728 (append (eval sym) nil)))))
1729 (if (listp doc-keywords)
1730 doc-keywords
1731 (list doc-keywords))))
1732 base-list)))
1733
1734 ;; Kludge: If `c-font-lock-complex-decl-prepare' is on the list we
1735 ;; move it first since the doc comment font lockers might add
1736 ;; `c-type' text properties, so they have to be cleared before that.
1737 (when (memq 'c-font-lock-complex-decl-prepare list)
1738 (setq list (cons 'c-font-lock-complex-decl-prepare
1739 (delq 'c-font-lock-complex-decl-prepare
1740 (append list nil)))))
1741
1742 list))
1743
1744 (defun c-override-default-keywords (def-var)
1745 ;; This is used to override the value on a `*-font-lock-keywords'
1746 ;; variable only if it's nil or has the same value as one of the
1747 ;; `*-font-lock-keywords-*' variables. Older font-lock packages
1748 ;; define a default value for `*-font-lock-keywords' which we want
1749 ;; to override, but we should otoh avoid clobbering a user setting.
1750 ;; This heuristic for that isn't perfect, but I can't think of any
1751 ;; better. /mast
1752 (when (and (boundp def-var)
1753 (memq (symbol-value def-var)
1754 (cons nil
1755 (mapcar
1756 (lambda (suffix)
1757 (let ((sym (intern (concat (symbol-name def-var)
1758 suffix))))
1759 (and (boundp sym) (symbol-value sym))))
1760 '("-1" "-2" "-3")))))
1761 ;; The overriding is done by unbinding the variable so that the normal
1762 ;; defvar will install its default value later on.
1763 (makunbound def-var)))
1764
1765 \f
1766 ;;; C.
1767
1768 (c-override-default-keywords 'c-font-lock-keywords)
1769
1770 (defconst c-font-lock-keywords-1 (c-lang-const c-matchers-1 c)
1771 "Minimal font locking for C mode.
1772 Fontifies only preprocessor directives (in addition to the syntactic
1773 fontification of strings and comments).")
1774
1775 (defconst c-font-lock-keywords-2 (c-lang-const c-matchers-2 c)
1776 "Fast normal font locking for C mode.
1777 In addition to `c-font-lock-keywords-1', this adds fontification of
1778 keywords, simple types, declarations that are easy to recognize, the
1779 user defined types on `c-font-lock-extra-types', and the doc comment
1780 styles specified by `c-doc-comment-style'.")
1781
1782 (defconst c-font-lock-keywords-3 (c-lang-const c-matchers-3 c)
1783 "Accurate normal font locking for C mode.
1784 Like `c-font-lock-keywords-2' but detects declarations in a more
1785 accurate way that works in most cases for arbitrary types without the
1786 need for `c-font-lock-extra-types'.")
1787
1788 (defvar c-font-lock-keywords c-font-lock-keywords-3
1789 "Default expressions to highlight in C mode.")
1790
1791 (defun c-font-lock-keywords-2 ()
1792 (c-compose-keywords-list c-font-lock-keywords-2))
1793 (defun c-font-lock-keywords-3 ()
1794 (c-compose-keywords-list c-font-lock-keywords-3))
1795 (defun c-font-lock-keywords ()
1796 (c-compose-keywords-list c-font-lock-keywords))
1797
1798 \f
1799 ;;; C++.
1800
1801 (defun c-font-lock-c++-new (limit)
1802 ;; FIXME!!! Put in a comment about the context of this function's
1803 ;; invocation. I think it's called as an ANCHORED-MATCHER within an
1804 ;; ANCHORED-HIGHLIGHTER. (2007/2/10).
1805 ;;
1806 ;; Assuming point is after a "new" word, check that it isn't inside
1807 ;; a string or comment, and if so try to fontify the type in the
1808 ;; allocation expression. Nil is always returned.
1809 ;;
1810 ;; As usual, C++ takes the prize in coming up with a hard to parse
1811 ;; syntax. :P
1812 ;;
1813 ;; This function might do hidden buffer changes.
1814
1815 (unless (c-skip-comments-and-strings limit)
1816 (save-excursion
1817 (catch 'false-alarm
1818 ;; A "new" keyword is followed by one to three expressions, where
1819 ;; the type is the middle one, and the only required part.
1820 (let (expr1-pos expr2-pos
1821 ;; Enable recording of identifier ranges in `c-forward-type'
1822 ;; etc for later fontification. Not using
1823 ;; `c-fontify-types-and-refs' here since the ranges should
1824 ;; be fontified selectively only when an allocation
1825 ;; expression is successfully recognized.
1826 (c-record-type-identifiers t)
1827 c-record-ref-identifiers
1828 ;; The font-lock package in Emacs is known to clobber
1829 ;; `parse-sexp-lookup-properties' (when it exists).
1830 (parse-sexp-lookup-properties
1831 (cc-eval-when-compile
1832 (boundp 'parse-sexp-lookup-properties))))
1833 (c-forward-syntactic-ws)
1834
1835 ;; The first placement arglist is always parenthesized, if it
1836 ;; exists.
1837 (when (eq (char-after) ?\()
1838 (setq expr1-pos (1+ (point)))
1839 (condition-case nil
1840 (c-forward-sexp)
1841 (scan-error (throw 'false-alarm t)))
1842 (c-forward-syntactic-ws))
1843
1844 ;; The second expression is either a type followed by some "*" or
1845 ;; "[...]" or similar, or a parenthesized type followed by a full
1846 ;; identifierless declarator.
1847 (setq expr2-pos (1+ (point)))
1848 (cond ((eq (char-after) ?\())
1849 ((let ((c-promote-possible-types t))
1850 (c-forward-type)))
1851 (t (setq expr2-pos nil)))
1852
1853 (when expr1-pos
1854 (cond
1855 ((not expr2-pos)
1856 ;; No second expression, so the first has to be a
1857 ;; parenthesized type.
1858 (goto-char expr1-pos)
1859 (let ((c-promote-possible-types t))
1860 (c-forward-type)))
1861
1862 ((eq (char-before expr2-pos) ?\()
1863 ;; Got two parenthesized expressions, so we have to look
1864 ;; closer at them to decide which is the type. No need to
1865 ;; handle `c-record-ref-identifiers' since all references
1866 ;; has already been handled by other fontification rules.
1867 (let (expr1-res expr2-res)
1868
1869 (goto-char expr1-pos)
1870 (when (setq expr1-res (c-forward-type))
1871 (unless (looking-at
1872 (cc-eval-when-compile
1873 (concat (c-lang-const c-symbol-start c++)
1874 "\\|[*:\)\[]")))
1875 ;; There's something after the would-be type that
1876 ;; can't be there, so this is a placement arglist.
1877 (setq expr1-res nil)))
1878
1879 (goto-char expr2-pos)
1880 (when (setq expr2-res (c-forward-type))
1881 (unless (looking-at
1882 (cc-eval-when-compile
1883 (concat (c-lang-const c-symbol-start c++)
1884 "\\|[*:\)\[]")))
1885 ;; There's something after the would-be type that can't
1886 ;; be there, so this is an initialization expression.
1887 (setq expr2-res nil))
1888 (when (and (c-go-up-list-forward)
1889 (progn (c-forward-syntactic-ws)
1890 (eq (char-after) ?\()))
1891 ;; If there's a third initialization expression
1892 ;; then the second one is the type, so demote the
1893 ;; first match.
1894 (setq expr1-res nil)))
1895
1896 ;; We fontify the most likely type, with a preference for
1897 ;; the first argument since a placement arglist is more
1898 ;; unusual than an initializer.
1899 (cond ((memq expr1-res '(t known prefix)))
1900 ((memq expr2-res '(t known prefix)))
1901 ((eq expr1-res 'found)
1902 (let ((c-promote-possible-types t))
1903 (goto-char expr1-pos)
1904 (c-forward-type)))
1905 ((eq expr2-res 'found)
1906 (let ((c-promote-possible-types t))
1907 (goto-char expr2-pos)
1908 (c-forward-type)))
1909 ((and (eq expr1-res 'maybe) (not expr2-res))
1910 (let ((c-promote-possible-types t))
1911 (goto-char expr1-pos)
1912 (c-forward-type)))
1913 ((and (not expr1-res) (eq expr2-res 'maybe))
1914 (let ((c-promote-possible-types t))
1915 (goto-char expr2-pos)
1916 (c-forward-type)))
1917 ;; If both type matches are 'maybe then we're
1918 ;; too uncertain to promote either of them.
1919 )))))
1920
1921 ;; Fontify the type that now is recorded in
1922 ;; `c-record-type-identifiers', if any.
1923 (c-fontify-recorded-types-and-refs)))))
1924 nil)
1925
1926 (c-override-default-keywords 'c++-font-lock-keywords)
1927
1928 (defconst c++-font-lock-keywords-1 (c-lang-const c-matchers-1 c++)
1929 "Minimal font locking for C++ mode.
1930 Fontifies only preprocessor directives (in addition to the syntactic
1931 fontification of strings and comments).")
1932
1933 (defconst c++-font-lock-keywords-2 (c-lang-const c-matchers-2 c++)
1934 "Fast normal font locking for C++ mode.
1935 In addition to `c++-font-lock-keywords-1', this adds fontification of
1936 keywords, simple types, declarations that are easy to recognize, the
1937 user defined types on `c++-font-lock-extra-types', and the doc comment
1938 styles specified by `c-doc-comment-style'.")
1939
1940 (defconst c++-font-lock-keywords-3 (c-lang-const c-matchers-3 c++)
1941 "Accurate normal font locking for C++ mode.
1942 Like `c++-font-lock-keywords-2' but detects declarations in a more
1943 accurate way that works in most cases for arbitrary types without the
1944 need for `c++-font-lock-extra-types'.")
1945
1946 (defvar c++-font-lock-keywords c++-font-lock-keywords-3
1947 "Default expressions to highlight in C++ mode.")
1948
1949 (defun c++-font-lock-keywords-2 ()
1950 (c-compose-keywords-list c++-font-lock-keywords-2))
1951 (defun c++-font-lock-keywords-3 ()
1952 (c-compose-keywords-list c++-font-lock-keywords-3))
1953 (defun c++-font-lock-keywords ()
1954 (c-compose-keywords-list c++-font-lock-keywords))
1955
1956 \f
1957 ;;; Objective-C.
1958
1959 (defun c-font-lock-objc-method ()
1960 ;; Assuming the point is after the + or - that starts an Objective-C
1961 ;; method declaration, fontify it. This must be done before normal
1962 ;; casts, declarations and labels are fontified since they will get
1963 ;; false matches in these things.
1964 ;;
1965 ;; This function might do hidden buffer changes.
1966
1967 (c-fontify-types-and-refs
1968 ((first t)
1969 (c-promote-possible-types t))
1970
1971 (while (and
1972 (progn
1973 (c-forward-syntactic-ws)
1974
1975 ;; An optional method type.
1976 (if (eq (char-after) ?\()
1977 (progn
1978 (forward-char)
1979 (c-forward-syntactic-ws)
1980 (c-forward-type)
1981 (prog1 (c-go-up-list-forward)
1982 (c-forward-syntactic-ws)))
1983 t))
1984
1985 ;; The name. The first time it's the first part of
1986 ;; the function name, the rest of the time it's an
1987 ;; argument name.
1988 (looking-at c-symbol-key)
1989 (progn
1990 (goto-char (match-end 0))
1991 (c-put-font-lock-face (match-beginning 0)
1992 (point)
1993 (if first
1994 'font-lock-function-name-face
1995 'font-lock-variable-name-face))
1996 (c-forward-syntactic-ws)
1997
1998 ;; Another optional part of the function name.
1999 (when (looking-at c-symbol-key)
2000 (goto-char (match-end 0))
2001 (c-put-font-lock-face (match-beginning 0)
2002 (point)
2003 'font-lock-function-name-face)
2004 (c-forward-syntactic-ws))
2005
2006 ;; There's another argument if a colon follows.
2007 (eq (char-after) ?:)))
2008 (forward-char)
2009 (setq first nil))))
2010
2011 (defun c-font-lock-objc-methods (limit)
2012 ;; Fontify method declarations in Objective-C. Nil is always
2013 ;; returned.
2014 ;;
2015 ;; This function might do hidden buffer changes.
2016
2017 (let (;; The font-lock package in Emacs is known to clobber
2018 ;; `parse-sexp-lookup-properties' (when it exists).
2019 (parse-sexp-lookup-properties
2020 (cc-eval-when-compile
2021 (boundp 'parse-sexp-lookup-properties))))
2022
2023 (c-find-decl-spots
2024 limit
2025 "[-+]"
2026 nil
2027 (lambda (match-pos inside-macro)
2028 (forward-char)
2029 (c-font-lock-objc-method))))
2030 nil)
2031
2032 (c-override-default-keywords 'objc-font-lock-keywords)
2033
2034 (defconst objc-font-lock-keywords-1 (c-lang-const c-matchers-1 objc)
2035 "Minimal font locking for Objective-C mode.
2036 Fontifies only compiler directives (in addition to the syntactic
2037 fontification of strings and comments).")
2038
2039 (defconst objc-font-lock-keywords-2 (c-lang-const c-matchers-2 objc)
2040 "Fast normal font locking for Objective-C mode.
2041 In addition to `objc-font-lock-keywords-1', this adds fontification of
2042 keywords, simple types, declarations that are easy to recognize, the
2043 user defined types on `objc-font-lock-extra-types', and the doc
2044 comment styles specified by `c-doc-comment-style'.")
2045
2046 (defconst objc-font-lock-keywords-3 (c-lang-const c-matchers-3 objc)
2047 "Accurate normal font locking for Objective-C mode.
2048 Like `objc-font-lock-keywords-2' but detects declarations in a more
2049 accurate way that works in most cases for arbitrary types without the
2050 need for `objc-font-lock-extra-types'.")
2051
2052 (defvar objc-font-lock-keywords objc-font-lock-keywords-3
2053 "Default expressions to highlight in Objective-C mode.")
2054
2055 (defun objc-font-lock-keywords-2 ()
2056 (c-compose-keywords-list objc-font-lock-keywords-2))
2057 (defun objc-font-lock-keywords-3 ()
2058 (c-compose-keywords-list objc-font-lock-keywords-3))
2059 (defun objc-font-lock-keywords ()
2060 (c-compose-keywords-list objc-font-lock-keywords))
2061
2062 ;; Kludge to override the default value that
2063 ;; `objc-font-lock-extra-types' might have gotten from the font-lock
2064 ;; package. The value replaced here isn't relevant now anyway since
2065 ;; those types are builtin and therefore listed directly in
2066 ;; `c-primitive-type-kwds'.
2067 (when (equal (sort (append objc-font-lock-extra-types nil) 'string-lessp)
2068 '("BOOL" "Class" "IMP" "SEL"))
2069 (setq objc-font-lock-extra-types
2070 (cc-eval-when-compile (list (concat "[" c-upper "]\\sw*")))))
2071
2072 \f
2073 ;;; Java.
2074
2075 (c-override-default-keywords 'java-font-lock-keywords)
2076
2077 (defconst java-font-lock-keywords-1 (c-lang-const c-matchers-1 java)
2078 "Minimal font locking for Java mode.
2079 Fontifies nothing except the syntactic fontification of strings and
2080 comments.")
2081
2082 (defconst java-font-lock-keywords-2 (c-lang-const c-matchers-2 java)
2083 "Fast normal font locking for Java mode.
2084 In addition to `java-font-lock-keywords-1', this adds fontification of
2085 keywords, simple types, declarations that are easy to recognize, the
2086 user defined types on `java-font-lock-extra-types', and the doc
2087 comment styles specified by `c-doc-comment-style'.")
2088
2089 (defconst java-font-lock-keywords-3 (c-lang-const c-matchers-3 java)
2090 "Accurate normal font locking for Java mode.
2091 Like `java-font-lock-keywords-2' but detects declarations in a more
2092 accurate way that works in most cases for arbitrary types without the
2093 need for `java-font-lock-extra-types'.")
2094
2095 (defvar java-font-lock-keywords java-font-lock-keywords-3
2096 "Default expressions to highlight in Java mode.")
2097
2098 (defun java-font-lock-keywords-2 ()
2099 (c-compose-keywords-list java-font-lock-keywords-2))
2100 (defun java-font-lock-keywords-3 ()
2101 (c-compose-keywords-list java-font-lock-keywords-3))
2102 (defun java-font-lock-keywords ()
2103 (c-compose-keywords-list java-font-lock-keywords))
2104
2105 \f
2106 ;;; CORBA IDL.
2107
2108 (c-override-default-keywords 'idl-font-lock-keywords)
2109
2110 (defconst idl-font-lock-keywords-1 (c-lang-const c-matchers-1 idl)
2111 "Minimal font locking for CORBA IDL mode.
2112 Fontifies nothing except the syntactic fontification of strings and
2113 comments.")
2114
2115 (defconst idl-font-lock-keywords-2 (c-lang-const c-matchers-2 idl)
2116 "Fast normal font locking for CORBA IDL mode.
2117 In addition to `idl-font-lock-keywords-1', this adds fontification of
2118 keywords, simple types, declarations that are easy to recognize, the
2119 user defined types on `idl-font-lock-extra-types', and the doc comment
2120 styles specified by `c-doc-comment-style'.")
2121
2122 (defconst idl-font-lock-keywords-3 (c-lang-const c-matchers-3 idl)
2123 "Accurate normal font locking for CORBA IDL mode.
2124 Like `idl-font-lock-keywords-2' but detects declarations in a more
2125 accurate way that works in most cases for arbitrary types without the
2126 need for `idl-font-lock-extra-types'.")
2127
2128 (defvar idl-font-lock-keywords idl-font-lock-keywords-3
2129 "Default expressions to highlight in CORBA IDL mode.")
2130
2131 (defun idl-font-lock-keywords-2 ()
2132 (c-compose-keywords-list idl-font-lock-keywords-2))
2133 (defun idl-font-lock-keywords-3 ()
2134 (c-compose-keywords-list idl-font-lock-keywords-3))
2135 (defun idl-font-lock-keywords ()
2136 (c-compose-keywords-list idl-font-lock-keywords))
2137
2138 \f
2139 ;;; Pike.
2140
2141 (c-override-default-keywords 'pike-font-lock-keywords)
2142
2143 (defconst pike-font-lock-keywords-1 (c-lang-const c-matchers-1 pike)
2144 "Minimal font locking for Pike mode.
2145 Fontifies only preprocessor directives (in addition to the syntactic
2146 fontification of strings and comments).")
2147
2148 (defconst pike-font-lock-keywords-2 (c-lang-const c-matchers-2 pike)
2149 "Fast normal font locking for Pike mode.
2150 In addition to `pike-font-lock-keywords-1', this adds fontification of
2151 keywords, simple types, declarations that are easy to recognize, the
2152 user defined types on `pike-font-lock-extra-types', and the doc
2153 comment styles specified by `c-doc-comment-style'.")
2154
2155 (defconst pike-font-lock-keywords-3 (c-lang-const c-matchers-3 pike)
2156 "Accurate normal font locking for Pike mode.
2157 Like `pike-font-lock-keywords-2' but detects declarations in a more
2158 accurate way that works in most cases for arbitrary types without the
2159 need for `pike-font-lock-extra-types'.")
2160
2161 (defvar pike-font-lock-keywords pike-font-lock-keywords-3
2162 "Default expressions to highlight in Pike mode.")
2163
2164 (defun pike-font-lock-keywords-2 ()
2165 (c-compose-keywords-list pike-font-lock-keywords-2))
2166 (defun pike-font-lock-keywords-3 ()
2167 (c-compose-keywords-list pike-font-lock-keywords-3))
2168 (defun pike-font-lock-keywords ()
2169 (c-compose-keywords-list pike-font-lock-keywords))
2170
2171 \f
2172 ;;; Doc comments.
2173
2174 (defun c-font-lock-doc-comments (prefix limit keywords)
2175 ;; Fontify the comments between the point and LIMIT whose start
2176 ;; matches PREFIX with `c-doc-face-name'. Assumes comments have been
2177 ;; fontified with `font-lock-comment-face' already. nil is always
2178 ;; returned.
2179 ;;
2180 ;; After the fontification of a matching comment, fontification
2181 ;; according to KEYWORDS is applied inside it. It's a list like
2182 ;; `font-lock-keywords' except that anchored matches and eval
2183 ;; clauses aren't supported and that some abbreviated forms can't be
2184 ;; used. The buffer is narrowed to the comment while KEYWORDS is
2185 ;; applied; leading comment starters are included but trailing
2186 ;; comment enders for block comment are not.
2187 ;;
2188 ;; Note that faces added through KEYWORDS should never replace the
2189 ;; existing `c-doc-face-name' face since the existence of that face
2190 ;; is used as a flag in other code to skip comments.
2191 ;;
2192 ;; This function might do hidden buffer changes.
2193
2194 (let (comment-beg region-beg)
2195 (if (eq (get-text-property (point) 'face)
2196 'font-lock-comment-face)
2197 ;; Handle the case when the fontified region starts inside a
2198 ;; comment.
2199 (let ((range (c-literal-limits)))
2200 (setq region-beg (point))
2201 (when range
2202 (goto-char (car range)))
2203 (when (looking-at prefix)
2204 (setq comment-beg (point)))))
2205
2206 (while (or
2207 comment-beg
2208
2209 ;; Search for the prefix until a match is found at the start
2210 ;; of a comment.
2211 (while (when (re-search-forward prefix limit t)
2212 (setq comment-beg (match-beginning 0))
2213 (or (not (c-got-face-at comment-beg
2214 c-literal-faces))
2215 (and (/= comment-beg (point-min))
2216 (c-got-face-at (1- comment-beg)
2217 c-literal-faces))))
2218 (setq comment-beg nil))
2219 (setq region-beg comment-beg))
2220
2221 (if (eq (elt (parse-partial-sexp comment-beg (+ comment-beg 2)) 7) t)
2222 ;; Collect a sequence of doc style line comments.
2223 (progn
2224 (goto-char comment-beg)
2225 (while (and (progn
2226 (c-forward-single-comment)
2227 (skip-syntax-forward " ")
2228 (< (point) limit))
2229 (looking-at prefix))))
2230 (goto-char comment-beg)
2231 (c-forward-single-comment))
2232 (if (> (point) limit) (goto-char limit))
2233 (setq comment-beg nil)
2234
2235 (let ((region-end (point))
2236 (keylist keywords) keyword matcher highlights)
2237 (c-put-font-lock-face region-beg region-end c-doc-face-name)
2238 (save-restriction
2239 ;; Narrow to the doc comment. Among other things, this
2240 ;; helps by making "^" match at the start of the comment.
2241 ;; Do not include a trailing block comment ender, though.
2242 (and (> region-end (1+ region-beg))
2243 (progn (goto-char region-end)
2244 (backward-char 2)
2245 (looking-at "\\*/"))
2246 (setq region-end (point)))
2247 (narrow-to-region region-beg region-end)
2248
2249 (while keylist
2250 (setq keyword (car keylist)
2251 keylist (cdr keylist)
2252 matcher (car keyword))
2253 (goto-char region-beg)
2254 (while (if (stringp matcher)
2255 (re-search-forward matcher region-end t)
2256 (funcall matcher region-end))
2257 (setq highlights (cdr keyword))
2258 (if (consp (car highlights))
2259 (while highlights
2260 (font-lock-apply-highlight (car highlights))
2261 (setq highlights (cdr highlights)))
2262 (font-lock-apply-highlight highlights))))
2263
2264 (goto-char region-end)))))
2265 nil)
2266 (put 'c-font-lock-doc-comments 'lisp-indent-function 2)
2267
2268 (defun c-find-invalid-doc-markup (regexp limit)
2269 ;; Used to fontify invalid markup in doc comments after the correct
2270 ;; ones have been fontified: Find the first occurrence of REGEXP
2271 ;; between the point and LIMIT that only is fontified with
2272 ;; `c-doc-face-name'. If a match is found then submatch 0 surrounds
2273 ;; the first char and t is returned, otherwise nil is returned.
2274 ;;
2275 ;; This function might do hidden buffer changes.
2276 (let (start)
2277 (while (if (re-search-forward regexp limit t)
2278 (not (eq (get-text-property
2279 (setq start (match-beginning 0)) 'face)
2280 c-doc-face-name))
2281 (setq start nil)))
2282 (when start
2283 (store-match-data (list (copy-marker start)
2284 (copy-marker (1+ start))))
2285 t)))
2286
2287 ;; GtkDoc patterns contributed by Masatake YAMATO <jet@gyve.org>.
2288
2289 (defconst gtkdoc-font-lock-doc-comments
2290 (let ((symbol "[a-zA-Z0-9_]+")
2291 (header "^ \\* "))
2292 `((,(concat header "\\(" symbol "\\):[ \t]*$")
2293 1 ,c-doc-markup-face-name prepend nil)
2294 (,(concat symbol "()")
2295 0 ,c-doc-markup-face-name prepend nil)
2296 (,(concat header "\\(" "@" symbol "\\):")
2297 1 ,c-doc-markup-face-name prepend nil)
2298 (,(concat "[#%@]" symbol)
2299 0 ,c-doc-markup-face-name prepend nil))
2300 ))
2301
2302 (defconst gtkdoc-font-lock-doc-protection
2303 `(("< \\(public\\|private\\|protected\\) >"
2304 1 ,c-doc-markup-face-name prepend nil)))
2305
2306 (defconst gtkdoc-font-lock-keywords
2307 `((,(lambda (limit)
2308 (c-font-lock-doc-comments "/\\*\\*$" limit
2309 gtkdoc-font-lock-doc-comments)
2310 (c-font-lock-doc-comments "/\\*< " limit
2311 gtkdoc-font-lock-doc-protection)
2312 ))))
2313
2314 ;; Javadoc.
2315
2316 (defconst javadoc-font-lock-doc-comments
2317 `(("{@[a-z]+[^}\n\r]*}" ; "{@foo ...}" markup.
2318 0 ,c-doc-markup-face-name prepend nil)
2319 ("^\\(/\\*\\)?\\(\\s \\|\\*\\)*\\(@[a-z]+\\)" ; "@foo ..." markup.
2320 3 ,c-doc-markup-face-name prepend nil)
2321 (,(concat "</?\\sw" ; HTML tags.
2322 "\\("
2323 (concat "\\sw\\|\\s \\|[=\n\r*.:]\\|"
2324 "\"[^\"]*\"\\|'[^']*'")
2325 "\\)*>")
2326 0 ,c-doc-markup-face-name prepend nil)
2327 ("&\\(\\sw\\|[.:]\\)+;" ; HTML entities.
2328 0 ,c-doc-markup-face-name prepend nil)
2329 ;; Fontify remaining markup characters as invalid. Note
2330 ;; that the Javadoc spec is hazy about when "@" is
2331 ;; allowed in non-markup use.
2332 (,(lambda (limit)
2333 (c-find-invalid-doc-markup "[<>&]\\|{@" limit))
2334 0 'font-lock-warning-face prepend nil)))
2335
2336 (defconst javadoc-font-lock-keywords
2337 `((,(lambda (limit)
2338 (c-font-lock-doc-comments "/\\*\\*" limit
2339 javadoc-font-lock-doc-comments)))))
2340
2341 ;; Pike autodoc.
2342
2343 (defconst autodoc-decl-keywords
2344 ;; Adorned regexp matching the keywords that introduce declarations
2345 ;; in Pike Autodoc.
2346 (cc-eval-when-compile
2347 (c-make-keywords-re t '("@decl" "@elem" "@index" "@member") 'pike-mode)))
2348
2349 (defconst autodoc-decl-type-keywords
2350 ;; Adorned regexp matching the keywords that are followed by a type.
2351 (cc-eval-when-compile
2352 (c-make-keywords-re t '("@elem" "@member") 'pike-mode)))
2353
2354 (defun autodoc-font-lock-line-markup (limit)
2355 ;; Fontify all line oriented keywords between the point and LIMIT.
2356 ;; Nil is always returned.
2357 ;;
2358 ;; This function might do hidden buffer changes.
2359
2360 (let ((line-re (concat "^\\(\\(/\\*!\\|\\s *\\("
2361 c-current-comment-prefix
2362 "\\)\\)\\s *\\)@[A-Za-z_-]+\\(\\s \\|$\\)"))
2363 (markup-faces (list c-doc-markup-face-name c-doc-face-name)))
2364
2365 (while (re-search-forward line-re limit t)
2366 (goto-char (match-end 1))
2367
2368 (if (looking-at autodoc-decl-keywords)
2369 (let* ((kwd-pos (point))
2370 (start (match-end 1))
2371 (pos start)
2372 end)
2373
2374 (c-put-font-lock-face (point) pos markup-faces)
2375
2376 ;; Put a declaration end mark at the markup keyword and
2377 ;; remove the faces from the rest of the line so that it
2378 ;; gets refontified as a declaration later on by
2379 ;; `c-font-lock-declarations'.
2380 (c-put-char-property (1- pos) 'c-type 'c-decl-end)
2381 (goto-char pos)
2382 (while (progn
2383 (end-of-line)
2384 (setq end (point))
2385 (and (eq (char-before) ?@)
2386 (not (eobp))
2387 (progn (forward-char)
2388 (skip-syntax-forward " ")
2389 (looking-at c-current-comment-prefix))))
2390 (goto-char (match-end 0))
2391 (c-remove-font-lock-face pos (1- end))
2392 (c-put-font-lock-face (1- end) end markup-faces)
2393 (setq pos (point)))
2394
2395 ;; Include the final newline in the removed area. This
2396 ;; has no visual effect but it avoids some tricky special
2397 ;; cases in the testsuite wrt the differences in string
2398 ;; fontification in Emacs vs XEmacs.
2399 (c-remove-font-lock-face pos (min (1+ (point)) (point-max)))
2400
2401 ;; Must handle string literals explicitly inside the declaration.
2402 (goto-char start)
2403 (while (re-search-forward
2404 "\"\\([^\\\"]\\|\\\\.\\)*\"\\|'\\([^\\']\\|\\\\.\\)*'"
2405 end 'move)
2406 (c-put-font-lock-string-face (match-beginning 0)
2407 (point)))
2408
2409 ;; Fontify types after keywords that always are followed
2410 ;; by them.
2411 (goto-char kwd-pos)
2412 (when (looking-at autodoc-decl-type-keywords)
2413 (c-fontify-types-and-refs ((c-promote-possible-types t))
2414 (goto-char start)
2415 (c-forward-syntactic-ws)
2416 (c-forward-type))))
2417
2418 ;; Mark each whole line as markup, as long as the logical line
2419 ;; continues.
2420 (while (progn
2421 (c-put-font-lock-face (point)
2422 (progn (end-of-line) (point))
2423 markup-faces)
2424 (and (eq (char-before) ?@)
2425 (not (eobp))
2426 (progn (forward-char)
2427 (skip-syntax-forward " ")
2428 (looking-at c-current-comment-prefix))))
2429 (goto-char (match-end 0))))))
2430
2431 nil)
2432
2433 (defconst autodoc-font-lock-doc-comments
2434 `(("@\\(\\w+{\\|\\[\\([^\]@\n\r]\\|@@\\)*\\]\\|[@}]\\|$\\)"
2435 ;; In-text markup.
2436 0 ,c-doc-markup-face-name prepend nil)
2437 (autodoc-font-lock-line-markup)
2438 ;; Fontify remaining markup characters as invalid.
2439 (,(lambda (limit)
2440 (c-find-invalid-doc-markup "@" limit))
2441 0 'font-lock-warning-face prepend nil)
2442 ))
2443
2444 (defun autodoc-font-lock-keywords ()
2445 ;; Note that we depend on that `c-current-comment-prefix' has got
2446 ;; its proper value here.
2447 ;;
2448 ;; This function might do hidden buffer changes.
2449
2450 ;; The `c-type' text property with `c-decl-end' is used to mark the
2451 ;; end of the `autodoc-decl-keywords' occurrences to fontify the
2452 ;; following declarations.
2453 (setq c-type-decl-end-used t)
2454
2455 `((,(lambda (limit)
2456 (c-font-lock-doc-comments "/[*/]!" limit
2457 autodoc-font-lock-doc-comments)))))
2458
2459 \f
2460 ;; 2006-07-10: awk-font-lock-keywords has been moved back to cc-awk.el.
2461 (cc-provide 'cc-fonts)
2462
2463 ;;; cc-fonts.el ends here