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