(hexlify-buffer, dehexlify-buffer):
[bpt/emacs.git] / lisp / font-lock.el
1 ;;; font-lock.el --- Electric font lock mode
2
3 ;; Copyright (C) 1992, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
4
5 ;; Author: jwz, then rms, then sm <simon@gnu.ai.mit.edu>
6 ;; Maintainer: FSF
7 ;; Keywords: languages, faces
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Commentary:
27
28 ;; Font Lock mode is a minor mode that causes your comments to be displayed in
29 ;; one face, strings in another, reserved words in another, and so on.
30 ;;
31 ;; Comments will be displayed in `font-lock-comment-face'.
32 ;; Strings will be displayed in `font-lock-string-face'.
33 ;; Regexps are used to display selected patterns in other faces.
34 ;;
35 ;; To make the text you type be fontified, use M-x font-lock-mode RET.
36 ;; When this minor mode is on, the faces of the current line are updated with
37 ;; every insertion or deletion.
38 ;;
39 ;; To turn Font Lock mode on automatically, add this to your ~/.emacs file:
40 ;;
41 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock)
42 ;;
43 ;; Or if you want to turn Font Lock mode on in many modes:
44 ;;
45 ;; (global-font-lock-mode t)
46 ;;
47 ;; Fontification for a particular mode may be available in a number of levels
48 ;; of decoration. The higher the level, the more decoration, but the more time
49 ;; it takes to fontify. See the variable `font-lock-maximum-decoration', and
50 ;; also the variable `font-lock-maximum-size'. Support modes for Font Lock
51 ;; mode can be used to speed up Font Lock mode. See `font-lock-support-mode'.
52 \f
53 ;;; How Font Lock mode fontifies:
54
55 ;; When Font Lock mode is turned on in a buffer, it (a) fontifies the entire
56 ;; buffer and (b) installs one of its fontification functions on one of the
57 ;; hook variables that are run by Emacs after every buffer change (i.e., an
58 ;; insertion or deletion). Fontification means the replacement of `face' text
59 ;; properties in a given region; Emacs displays text with these `face' text
60 ;; properties appropriately.
61 ;;
62 ;; Fontification normally involves syntactic (i.e., strings and comments) and
63 ;; regexp (i.e., keywords and everything else) passes. There are actually
64 ;; three passes; (a) the syntactic keyword pass, (b) the syntactic pass and (c)
65 ;; the keyword pass. Confused?
66 ;;
67 ;; The syntactic keyword pass places `syntax-table' text properties in the
68 ;; buffer according to the variable `font-lock-syntactic-keywords'. It is
69 ;; necessary because Emacs' syntax table is not powerful enough to describe all
70 ;; the different syntactic constructs required by the sort of people who decide
71 ;; that a single quote can be syntactic or not depending on the time of day.
72 ;; (What sort of person could decide to overload the meaning of a quote?)
73 ;; Obviously the syntactic keyword pass must occur before the syntactic pass.
74 ;;
75 ;; The syntactic pass places `face' text properties in the buffer according to
76 ;; syntactic context, i.e., according to the buffer's syntax table and buffer
77 ;; text's `syntax-table' text properties. It involves using a syntax parsing
78 ;; function to determine the context of different parts of a region of text. A
79 ;; syntax parsing function is necessary because generally strings and/or
80 ;; comments can span lines, and so the context of a given region is not
81 ;; necessarily apparent from the content of that region. Because the keyword
82 ;; pass only works within a given region, it is not generally appropriate for
83 ;; syntactic fontification. This is the first fontification pass that makes
84 ;; changes visible to the user; it fontifies strings and comments.
85 ;;
86 ;; The keyword pass places `face' text properties in the buffer according to
87 ;; the variable `font-lock-keywords'. It involves searching for given regexps
88 ;; (or calling given search functions) within the given region. This is the
89 ;; second fontification pass that makes changes visible to the user; it
90 ;; fontifies language reserved words, etc.
91 ;;
92 ;; Oh, and the answer is, "Yes, obviously just about everything should be done
93 ;; in a single syntactic pass, but the only syntactic parser available
94 ;; understands only strings and comments." Perhaps one day someone will write
95 ;; some syntactic parsers for common languages and a son-of-font-lock.el could
96 ;; use them rather then relying so heavily on the keyword (regexp) pass.
97
98 ;;; How Font Lock mode supports modes or is supported by modes:
99
100 ;; Modes that support Font Lock mode do so by defining one or more variables
101 ;; whose values specify the fontification. Font Lock mode knows of these
102 ;; variable names from (a) the buffer local variable `font-lock-defaults', if
103 ;; non-nil, or (b) the global variable `font-lock-defaults-alist', if the major
104 ;; mode has an entry. (Font Lock mode is set up via (a) where a mode's
105 ;; patterns are distributed with the mode's package library, and (b) where a
106 ;; mode's patterns are distributed with font-lock.el itself. An example of (a)
107 ;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is
108 ;; (a); (b) is used where it is not clear which package library should contain
109 ;; the pattern definitions.) Font Lock mode chooses which variable to use for
110 ;; fontification based on `font-lock-maximum-decoration'.
111 ;;
112 ;; Font Lock mode fontification behaviour can be modified in a number of ways.
113 ;; See the below comments and the comments distributed throughout this file.
114
115 ;;; Constructing patterns:
116
117 ;; See the documentation for the variable `font-lock-keywords'.
118 ;;
119 ;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and
120 ;; `font-lock-syntactic-keywords' can be generated via the function
121 ;; `regexp-opt', and their depth counted via the function `regexp-opt-depth'.
122
123 ;;; Adding patterns for modes that already support Font Lock:
124
125 ;; Though Font Lock highlighting patterns already exist for many modes, it's
126 ;; likely there's something that you want fontified that currently isn't, even
127 ;; at the maximum fontification level. You can add highlighting patterns via
128 ;; `font-lock-add-keywords'. For example, say in some C
129 ;; header file you #define the token `and' to expand to `&&', etc., to make
130 ;; your C code almost readable. In your ~/.emacs there could be:
131 ;;
132 ;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>"))
133 ;;
134 ;; Some modes provide specific ways to modify patterns based on the values of
135 ;; other variables. For example, additional C types can be specified via the
136 ;; variable `c-font-lock-extra-types'.
137
138 ;;; Adding patterns for modes that do not support Font Lock:
139
140 ;; Not all modes support Font Lock mode. If you (as a user of the mode) add
141 ;; patterns for a new mode, you must define in your ~/.emacs a variable or
142 ;; variables that specify regexp fontification. Then, you should indicate to
143 ;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what
144 ;; support is required. For example, say Foo mode should have the following
145 ;; regexps fontified case-sensitively, and comments and strings should not be
146 ;; fontified automagically. In your ~/.emacs there could be:
147 ;;
148 ;; (defvar foo-font-lock-keywords
149 ;; '(("\\<\\(one\\|two\\|three\\)\\>" . font-lock-keyword-face)
150 ;; ("\\<\\(four\\|five\\|six\\)\\>" . font-lock-type-face))
151 ;; "Default expressions to highlight in Foo mode.")
152 ;;
153 ;; (add-hook 'foo-mode-hook
154 ;; (function (lambda ()
155 ;; (make-local-variable 'font-lock-defaults)
156 ;; (setq font-lock-defaults '(foo-font-lock-keywords t)))))
157
158 ;;; Adding Font Lock support for modes:
159
160 ;; Of course, it would be better that the mode already supports Font Lock mode.
161 ;; The package author would do something similar to above. The mode must
162 ;; define at the top-level a variable or variables that specify regexp
163 ;; fontification. Then, the mode command should indicate to Font Lock mode,
164 ;; via `font-lock-defaults', exactly what support is required. For example,
165 ;; say Bar mode should have the following regexps fontified case-insensitively,
166 ;; and comments and strings should be fontified automagically. In bar.el there
167 ;; could be:
168 ;;
169 ;; (defvar bar-font-lock-keywords
170 ;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . font-lock-keyword-face)
171 ;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . font-lock-type-face))
172 ;; "Default expressions to highlight in Bar mode.")
173 ;;
174 ;; and within `bar-mode' there could be:
175 ;;
176 ;; (make-local-variable 'font-lock-defaults)
177 ;; (setq font-lock-defaults '(bar-font-lock-keywords nil t))
178 \f
179 ;; What is fontification for? You might say, "It's to make my code look nice."
180 ;; I think it should be for adding information in the form of cues. These cues
181 ;; should provide you with enough information to both (a) distinguish between
182 ;; different items, and (b) identify the item meanings, without having to read
183 ;; the items and think about it. Therefore, fontification allows you to think
184 ;; less about, say, the structure of code, and more about, say, why the code
185 ;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
186 ;;
187 ;; So, here are my opinions/advice/guidelines:
188 ;;
189 ;; - Highlight conceptual objects, such as function and variable names, and
190 ;; different objects types differently, i.e., (a) and (b) above, highlight
191 ;; function names differently to variable names.
192 ;; - Keep the faces distinct from each other as far as possible.
193 ;; i.e., (a) above.
194 ;; - Use the same face for the same conceptual object, across all modes.
195 ;; i.e., (b) above, all modes that have items that can be thought of as, say,
196 ;; keywords, should be highlighted with the same face, etc.
197 ;; - Make the face attributes fit the concept as far as possible.
198 ;; i.e., function names might be a bold colour such as blue, comments might
199 ;; be a bright colour such as red, character strings might be brown, because,
200 ;; err, strings are brown (that was not the reason, please believe me).
201 ;; - Don't use a non-nil OVERRIDE unless you have a good reason.
202 ;; Only use OVERRIDE for special things that are easy to define, such as the
203 ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
204 ;; Don't use it to, say, highlight keywords in commented out code or strings.
205 ;; - Err, that's it.
206 \f
207 ;;; Code:
208
209 ;; Define core `font-lock' group.
210 (defgroup font-lock nil
211 "Font Lock mode text highlighting package."
212 :link '(custom-manual "(emacs)Font Lock")
213 :group 'faces)
214
215 (defgroup font-lock-highlighting-faces nil
216 "Faces for highlighting text."
217 :prefix "font-lock-"
218 :group 'font-lock)
219
220 (defgroup font-lock-extra-types nil
221 "Extra mode-specific type names for highlighting declarations."
222 :group 'font-lock)
223
224 ;; Define support mode groups here to impose `font-lock' group order.
225 (defgroup fast-lock nil
226 "Font Lock support mode to cache fontification."
227 :link '(custom-manual "(emacs)Support Modes")
228 :load 'fast-lock
229 :group 'font-lock)
230
231 (defgroup lazy-lock nil
232 "Font Lock support mode to fontify lazily."
233 :link '(custom-manual "(emacs)Support Modes")
234 :load 'lazy-lock
235 :group 'font-lock)
236 \f
237 ;; User variables.
238
239 (defcustom font-lock-maximum-size (* 250 1024)
240 "*Maximum size of a buffer for buffer fontification.
241 Only buffers less than this can be fontified when Font Lock mode is turned on.
242 If nil, means size is irrelevant.
243 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
244 where MAJOR-MODE is a symbol or t (meaning the default). For example:
245 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
246 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
247 for buffers in Rmail mode, and size is irrelevant otherwise."
248 :type '(choice (const :tag "none" nil)
249 (integer :tag "size")
250 (repeat :menu-tag "mode specific" :tag "mode specific"
251 :value ((t . nil))
252 (cons :tag "Instance"
253 (radio :tag "Mode"
254 (const :tag "all" t)
255 (symbol :tag "name"))
256 (radio :tag "Size"
257 (const :tag "none" nil)
258 (integer :tag "size")))))
259 :group 'font-lock)
260
261 (defcustom font-lock-maximum-decoration t
262 "*Maximum decoration level for fontification.
263 If nil, use the default decoration (typically the minimum available).
264 If t, use the maximum decoration available.
265 If a number, use that level of decoration (or if not available the maximum).
266 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
267 where MAJOR-MODE is a symbol or t (meaning the default). For example:
268 ((c-mode . t) (c++-mode . 2) (t . 1))
269 means use the maximum decoration available for buffers in C mode, level 2
270 decoration for buffers in C++ mode, and level 1 decoration otherwise."
271 :type '(choice (const :tag "default" nil)
272 (const :tag "maximum" t)
273 (integer :tag "level" 1)
274 (repeat :menu-tag "mode specific" :tag "mode specific"
275 :value ((t . t))
276 (cons :tag "Instance"
277 (radio :tag "Mode"
278 (const :tag "all" t)
279 (symbol :tag "name"))
280 (radio :tag "Decoration"
281 (const :tag "default" nil)
282 (const :tag "maximum" t)
283 (integer :tag "level" 1)))))
284 :group 'font-lock)
285
286 (defcustom font-lock-verbose (* 0 1024)
287 "*If non-nil, means show status messages for buffer fontification.
288 If a number, only buffers greater than this size have fontification messages."
289 :type '(choice (const :tag "never" nil)
290 (const :tag "always" t)
291 (integer :tag "size"))
292 :group 'font-lock)
293 \f
294 ;; Fontification variables:
295
296 (defvar font-lock-keywords nil
297 "A list of the keywords to highlight.
298 Each element should be of the form:
299
300 MATCHER
301 (MATCHER . MATCH)
302 (MATCHER . FACENAME)
303 (MATCHER . HIGHLIGHT)
304 (MATCHER HIGHLIGHT ...)
305 (eval . FORM)
306
307 where HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
308
309 FORM is an expression, whose value should be a keyword element, evaluated when
310 the keyword is (first) used in a buffer. This feature can be used to provide a
311 keyword that can only be generated when Font Lock mode is actually turned on.
312
313 For highlighting single items, typically only MATCH-HIGHLIGHT is required.
314 However, if an item or (typically) items are to be highlighted following the
315 instance of another item (the anchor) then MATCH-ANCHORED may be required.
316
317 MATCH-HIGHLIGHT should be of the form:
318
319 (MATCH FACENAME OVERRIDE LAXMATCH)
320
321 Where MATCHER can be either the regexp to search for, or the function name to
322 call to make the search (called with one argument, the limit of the search).
323 MATCHER regexps can be generated via the function `regexp-opt'. MATCH is the
324 subexpression of MATCHER to be highlighted. MATCH can be calculated via the
325 function `regexp-opt-depth'. FACENAME is an expression whose value is the face
326 name to use. Face default attributes can be modified via \\[customize].
327
328 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
329 be overwritten. If `keep', only parts not already fontified are highlighted.
330 If `prepend' or `append', existing fontification is merged with the new, in
331 which the new or existing fontification, respectively, takes precedence.
332 If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER.
333
334 For example, an element of the form highlights (if not already highlighted):
335
336 \"\\\\\\=<foo\\\\\\=>\" Discrete occurrences of \"foo\" in the value of the
337 variable `font-lock-keyword-face'.
338 (\"fu\\\\(bar\\\\)\" . 1) Substring \"bar\" within all occurrences of \"fubar\" in
339 the value of `font-lock-keyword-face'.
340 (\"fubar\" . fubar-face) Occurrences of \"fubar\" in the value of `fubar-face'.
341 (\"foo\\\\|bar\" 0 foo-bar-face t)
342 Occurrences of either \"foo\" or \"bar\" in the value
343 of `foo-bar-face', even if already highlighted.
344
345 MATCH-ANCHORED should be of the form:
346
347 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
348
349 Where MATCHER is as for MATCH-HIGHLIGHT with one exception; see below.
350 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
351 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
352 used to initialise before, and cleanup after, MATCHER is used. Typically,
353 PRE-MATCH-FORM is used to move to some position relative to the original
354 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
355 be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
356
357 For example, an element of the form highlights (if not already highlighted):
358
359 (\"\\\\\\=<anchor\\\\\\=>\" (0 anchor-face) (\"\\\\\\=<item\\\\\\=>\" nil nil (0 item-face)))
360
361 Discrete occurrences of \"anchor\" in the value of `anchor-face', and subsequent
362 discrete occurrences of \"item\" (on the same line) in the value of `item-face'.
363 (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil. Therefore \"item\" is
364 initially searched for starting from the end of the match of \"anchor\", and
365 searching for subsequent instance of \"anchor\" resumes from where searching
366 for \"item\" concluded.)
367
368 The above-mentioned exception is as follows. The limit of the MATCHER search
369 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
370 However, if PRE-MATCH-FORM returns a position greater than the position after
371 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
372 It is generally a bad idea to return a position greater than the end of the
373 line, i.e., cause the MATCHER search to span lines.
374
375 Note that the MATCH-ANCHORED feature is experimental; in the future, we may
376 replace it with other ways of providing this functionality.
377
378 These regular expressions should not match text which spans lines. While
379 \\[font-lock-fontify-buffer] handles multi-line patterns correctly, updating
380 when you edit the buffer does not, since it considers text one line at a time.
381
382 This variable is set by major modes via the variable `font-lock-defaults'.
383 Be careful when composing regexps for this list; a poorly written pattern can
384 dramatically slow things down!")
385
386 ;; This variable is used by mode packages that support Font Lock mode by
387 ;; defining their own keywords to use for `font-lock-keywords'. (The mode
388 ;; command should make it buffer-local and set it to provide the set up.)
389 (defvar font-lock-defaults nil
390 "Defaults for Font Lock mode specified by the major mode.
391 Defaults should be of the form:
392
393 (KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN ...)
394
395 KEYWORDS may be a symbol (a variable or function whose value is the keywords to
396 use for fontification) or a list of symbols. If KEYWORDS-ONLY is non-nil,
397 syntactic fontification (strings and comments) is not performed.
398 If CASE-FOLD is non-nil, the case of the keywords is ignored when fontifying.
399 If SYNTAX-ALIST is non-nil, it should be a list of cons pairs of the form
400 \(CHAR-OR-STRING . STRING) used to set the local Font Lock syntax table, for
401 keyword and syntactic fontification (see `modify-syntax-entry').
402
403 If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
404 backwards outside any enclosing syntactic block, for syntactic fontification.
405 Typical values are `beginning-of-line' (i.e., the start of the line is known to
406 be outside a syntactic block), or `beginning-of-defun' for programming modes or
407 `backward-paragraph' for textual modes (i.e., the mode-dependent function is
408 known to move outside a syntactic block). If nil, the beginning of the buffer
409 is used as a position outside of a syntactic block, in the worst case.
410
411 These item elements are used by Font Lock mode to set the variables
412 `font-lock-keywords', `font-lock-keywords-only',
413 `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
414 `font-lock-beginning-of-syntax-function', respectively.
415
416 Further item elements are alists of the form (VARIABLE . VALUE) and are in no
417 particular order. Each VARIABLE is made buffer-local before set to VALUE.
418
419 Currently, appropriate variables include `font-lock-mark-block-function'.
420 If this is non-nil, it should be a function with no args used to mark any
421 enclosing block of text, for fontification via \\[font-lock-fontify-block].
422 Typical values are `mark-defun' for programming modes or `mark-paragraph' for
423 textual modes (i.e., the mode-dependent function is known to put point and mark
424 around a text block relevant to that mode).
425
426 Other variables include those for buffer-specialised fontification functions,
427 `font-lock-fontify-buffer-function', `font-lock-unfontify-buffer-function',
428 `font-lock-fontify-region-function', `font-lock-unfontify-region-function',
429 `font-lock-inhibit-thing-lock' and `font-lock-maximum-size'.")
430
431 ;; This variable is used where font-lock.el itself supplies the keywords.
432 (defvar font-lock-defaults-alist
433 (let (;; We use `beginning-of-defun', rather than nil, for SYNTAX-BEGIN.
434 ;; Thus the calculation of the cache is usually faster but not
435 ;; infallible, so we risk mis-fontification. sm.
436 (c-mode-defaults
437 '((c-font-lock-keywords c-font-lock-keywords-1
438 c-font-lock-keywords-2 c-font-lock-keywords-3)
439 nil nil ((?_ . "w")) beginning-of-defun
440 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
441 ;(font-lock-comment-start-regexp . "/[*/]")
442 (font-lock-mark-block-function . mark-defun)))
443 (c++-mode-defaults
444 '((c++-font-lock-keywords c++-font-lock-keywords-1
445 c++-font-lock-keywords-2 c++-font-lock-keywords-3)
446 nil nil ((?_ . "w")) beginning-of-defun
447 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
448 ;(font-lock-comment-start-regexp . "/[*/]")
449 (font-lock-mark-block-function . mark-defun)))
450 (objc-mode-defaults
451 '((objc-font-lock-keywords objc-font-lock-keywords-1
452 objc-font-lock-keywords-2 objc-font-lock-keywords-3)
453 nil nil ((?_ . "w") (?$ . "w")) nil
454 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
455 ;(font-lock-comment-start-regexp . "/[*/]")
456 (font-lock-mark-block-function . mark-defun)))
457 (java-mode-defaults
458 '((java-font-lock-keywords java-font-lock-keywords-1
459 java-font-lock-keywords-2 java-font-lock-keywords-3)
460 nil nil ((?_ . "w") (?$ . "w") (?. . "w")) nil
461 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
462 ;(font-lock-comment-start-regexp . "/[*/]")
463 (font-lock-mark-block-function . mark-defun)))
464 (lisp-mode-defaults
465 '((lisp-font-lock-keywords
466 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
467 nil nil (("+-*/.<>=!?$%_&~^:" . "w")) beginning-of-defun
468 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
469 ;(font-lock-comment-start-regexp . ";")
470 (font-lock-mark-block-function . mark-defun)))
471 (scheme-mode-defaults
472 '((scheme-font-lock-keywords
473 scheme-font-lock-keywords-1 scheme-font-lock-keywords-2)
474 nil t (("+-*/.<>=!?$%_&~^:" . "w")) beginning-of-defun
475 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
476 ;(font-lock-comment-start-regexp . ";")
477 (font-lock-mark-block-function . mark-defun)))
478 ;; For TeX modes we could use `backward-paragraph' for the same reason.
479 ;; But we don't, because paragraph breaks are arguably likely enough to
480 ;; occur within a genuine syntactic block to make it too risky.
481 ;; However, we do specify a MARK-BLOCK function as that cannot result
482 ;; in a mis-fontification even if it might not fontify enough. --sm.
483 (tex-mode-defaults
484 '((tex-font-lock-keywords
485 tex-font-lock-keywords-1 tex-font-lock-keywords-2)
486 nil nil ((?$ . "\"")) nil
487 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
488 ;(font-lock-comment-start-regexp . "%")
489 (font-lock-mark-block-function . mark-paragraph)))
490 )
491 (list
492 (cons 'c-mode c-mode-defaults)
493 (cons 'c++-mode c++-mode-defaults)
494 (cons 'objc-mode objc-mode-defaults)
495 (cons 'java-mode java-mode-defaults)
496 (cons 'emacs-lisp-mode lisp-mode-defaults)
497 (cons 'inferior-scheme-mode scheme-mode-defaults)
498 (cons 'latex-mode tex-mode-defaults)
499 (cons 'lisp-mode lisp-mode-defaults)
500 (cons 'lisp-interaction-mode lisp-mode-defaults)
501 (cons 'plain-tex-mode tex-mode-defaults)
502 (cons 'scheme-mode scheme-mode-defaults)
503 (cons 'scheme-interaction-mode scheme-mode-defaults)
504 (cons 'slitex-mode tex-mode-defaults)
505 (cons 'tex-mode tex-mode-defaults)))
506 "Alist of fall-back Font Lock defaults for major modes.
507 Each item should be a list of the form:
508
509 (MAJOR-MODE . FONT-LOCK-DEFAULTS)
510
511 where MAJOR-MODE is a symbol and FONT-LOCK-DEFAULTS is a list of default
512 settings. See the variable `font-lock-defaults', which takes precedence.")
513
514 (defvar font-lock-keywords-alist nil
515 "*Alist of `font-lock-keywords' local to a `major-mode'.
516 This is normally set via `font-lock-add-keywords'.")
517
518 (defvar font-lock-keywords-only nil
519 "*Non-nil means Font Lock should not fontify comments or strings.
520 This is normally set via `font-lock-defaults'.")
521
522 (defvar font-lock-keywords-case-fold-search nil
523 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
524 This is normally set via `font-lock-defaults'.")
525
526 (defvar font-lock-syntactic-keywords nil
527 "A list of the syntactic keywords to highlight.
528 Can be the list or the name of a function or variable whose value is the list.
529 See `font-lock-keywords' for a description of the form of this list;
530 the differences are listed below. MATCH-HIGHLIGHT should be of the form:
531
532 (MATCH SYNTAX OVERRIDE LAXMATCH)
533
534 where SYNTAX can be of the form (SYNTAX-CODE . MATCHING-CHAR), the name of a
535 syntax table, or an expression whose value is such a form or a syntax table.
536 OVERRIDE cannot be `prepend' or `append'.
537
538 This is normally set via `font-lock-defaults'.")
539
540 (defvar font-lock-syntax-table nil
541 "Non-nil means use this syntax table for fontifying.
542 If this is nil, the major mode's syntax table is used.
543 This is normally set via `font-lock-defaults'.")
544
545 ;; If this is nil, we only use the beginning of the buffer if we can't use
546 ;; `font-lock-cache-position' and `font-lock-cache-state'.
547 (defvar font-lock-beginning-of-syntax-function nil
548 "*Non-nil means use this function to move back outside of a syntactic block.
549 When called with no args it should leave point at the beginning of any
550 enclosing syntactic block.
551 If this is nil, the beginning of the buffer is used (in the worst case).
552 This is normally set via `font-lock-defaults'.")
553
554 (defvar font-lock-mark-block-function nil
555 "*Non-nil means use this function to mark a block of text.
556 When called with no args it should leave point at the beginning of any
557 enclosing textual block and mark at the end.
558 This is normally set via `font-lock-defaults'.")
559
560 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
561 ;(defvar font-lock-comment-start-regexp nil
562 ; "*Regexp to match the start of a comment.
563 ;This need not discriminate between genuine comments and quoted comment
564 ;characters or comment characters within strings.
565 ;If nil, `comment-start-skip' is used instead; see that variable for more info.
566 ;This is normally set via `font-lock-defaults'.")
567
568 (defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer
569 "Function to use for fontifying the buffer.
570 This is normally set via `font-lock-defaults'.")
571
572 (defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer
573 "Function to use for unfontifying the buffer.
574 This is used when turning off Font Lock mode.
575 This is normally set via `font-lock-defaults'.")
576
577 (defvar font-lock-fontify-region-function 'font-lock-default-fontify-region
578 "Function to use for fontifying a region.
579 It should take two args, the beginning and end of the region, and an optional
580 third arg VERBOSE. If non-nil, the function should print status messages.
581 This is normally set via `font-lock-defaults'.")
582
583 (defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region
584 "Function to use for unfontifying a region.
585 It should take two args, the beginning and end of the region.
586 This is normally set via `font-lock-defaults'.")
587
588 (defvar font-lock-inhibit-thing-lock nil
589 "List of Font Lock mode related modes that should not be turned on.
590 Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'.
591 This is normally set via `font-lock-defaults'.")
592
593 (defvar font-lock-mode nil) ; Whether we are turned on/modeline.
594 (defvar font-lock-fontified nil) ; Whether we have fontified the buffer.
595
596 ;;;###autoload
597 (defvar font-lock-mode-hook nil
598 "Function or functions to run on entry to Font Lock mode.")
599 \f
600 ;; Font Lock mode.
601
602 (eval-when-compile
603 ;;
604 ;; We don't do this at the top-level as we only use non-autoloaded macros.
605 (require 'cl)
606 ;;
607 ;; Borrowed from lazy-lock.el.
608 ;; We use this to preserve or protect things when modifying text properties.
609 (defmacro save-buffer-state (varlist &rest body)
610 "Bind variables according to VARLIST and eval BODY restoring buffer state."
611 (` (let* ((,@ (append varlist
612 '((modified (buffer-modified-p)) (buffer-undo-list t)
613 (inhibit-read-only t) (inhibit-point-motion-hooks t)
614 before-change-functions after-change-functions
615 deactivate-mark buffer-file-name buffer-file-truename))))
616 (,@ body)
617 (when (and (not modified) (buffer-modified-p))
618 (set-buffer-modified-p nil)))))
619 (put 'save-buffer-state 'lisp-indent-function 1))
620
621 ;;;###autoload
622 (defun font-lock-mode (&optional arg)
623 "Toggle Font Lock mode.
624 With arg, turn Font Lock mode on if and only if arg is positive.
625
626 When Font Lock mode is enabled, text is fontified as you type it:
627
628 - Comments are displayed in `font-lock-comment-face';
629 - Strings are displayed in `font-lock-string-face';
630 - Certain other expressions are displayed in other faces according to the
631 value of the variable `font-lock-keywords'.
632
633 You can enable Font Lock mode in any major mode automatically by turning on in
634 the major mode's hook. For example, put in your ~/.emacs:
635
636 (add-hook 'c-mode-hook 'turn-on-font-lock)
637
638 Alternatively, you can use Global Font Lock mode to automagically turn on Font
639 Lock mode in buffers whose major mode supports it and whose major mode is one
640 of `font-lock-global-modes'. For example, put in your ~/.emacs:
641
642 (global-font-lock-mode t)
643
644 There are a number of support modes that may be used to speed up Font Lock mode
645 in various ways, specified via the variable `font-lock-support-mode'. Where
646 major modes support different levels of fontification, you can use the variable
647 `font-lock-maximum-decoration' to specify which level you generally prefer.
648 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
649 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
650
651 For example, to specify that Font Lock mode use use Lazy Lock mode as a support
652 mode and use maximum levels of fontification, put in your ~/.emacs:
653
654 (setq font-lock-support-mode 'lazy-lock-mode)
655 (setq font-lock-maximum-decoration t)
656
657 To add your own highlighting for some major mode, and modify the highlighting
658 selected automatically via the variable `font-lock-maximum-decoration', you can
659 use `font-lock-add-keywords'.
660
661 To fontify a buffer, without turning on Font Lock mode and regardless of buffer
662 size, you can use \\[font-lock-fontify-buffer].
663
664 To fontify a block (the function or paragraph containing point, or a number of
665 lines around point), perhaps because modification on the current line caused
666 syntactic change on other lines, you can use \\[font-lock-fontify-block].
667
668 See the variable `font-lock-defaults-alist' for the Font Lock mode default
669 settings. You can set your own default settings for some mode, by setting a
670 buffer local value for `font-lock-defaults', via its mode hook."
671 (interactive "P")
672 ;; Don't turn on Font Lock mode if we don't have a display (we're running a
673 ;; batch job) or if the buffer is invisible (the name starts with a space).
674 (let ((on-p (and (not noninteractive)
675 (not (eq (aref (buffer-name) 0) ?\ ))
676 (if arg
677 (> (prefix-numeric-value arg) 0)
678 (not font-lock-mode)))))
679 (set (make-local-variable 'font-lock-mode) on-p)
680 ;; Turn on Font Lock mode.
681 (when on-p
682 (make-local-hook 'after-change-functions)
683 (add-hook 'after-change-functions 'font-lock-after-change-function nil t)
684 (font-lock-set-defaults)
685 (font-lock-turn-on-thing-lock)
686 (run-hooks 'font-lock-mode-hook)
687 ;; Fontify the buffer if we have to.
688 (let ((max-size (font-lock-value-in-major-mode font-lock-maximum-size)))
689 (cond (font-lock-fontified
690 nil)
691 ((or (null max-size) (> max-size (buffer-size)))
692 (font-lock-fontify-buffer))
693 (font-lock-verbose
694 (message "Fontifying %s...buffer too big" (buffer-name))))))
695 ;; Turn off Font Lock mode.
696 (unless on-p
697 (remove-hook 'after-change-functions 'font-lock-after-change-function t)
698 (font-lock-unfontify-buffer)
699 (font-lock-turn-off-thing-lock)
700 (font-lock-unset-defaults))
701 (force-mode-line-update)))
702
703 ;;;###autoload
704 (defun turn-on-font-lock ()
705 "Turn on Font Lock mode conditionally.
706 Turn on only if the terminal can display it."
707 (when (and (not font-lock-mode) window-system)
708 (font-lock-mode)))
709
710 ;;;###autoload
711 (defun font-lock-add-keywords (major-mode keywords &optional append)
712 "Add highlighting KEYWORDS for MAJOR-MODE.
713 MAJOR-MODE should be a symbol, the major mode command name, such as `c-mode'
714 or nil. If nil, highlighting keywords are added for the current buffer.
715 KEYWORDS should be a list; see the variable `font-lock-keywords'.
716 By default they are added at the beginning of the current highlighting list.
717 If optional argument APPEND is `set', they are used to replace the current
718 highlighting list. If APPEND is any other non-nil value, they are added at the
719 end of the current highlighting list.
720
721 For example:
722
723 (font-lock-add-keywords 'c-mode
724 '((\"\\\\\\=<\\\\(FIXME\\\\):\" 1 font-lock-warning-face prepend)
725 (\"\\\\\\=<\\\\(and\\\\|or\\\\|not\\\\)\\\\\\=>\" . font-lock-keyword-face)))
726
727 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
728 comments, and to fontify `and', `or' and `not' words as keywords.
729
730 Note that some modes have specialised support for additional patterns, e.g.,
731 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
732 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
733 (cond (major-mode
734 ;; If MAJOR-MODE is non-nil, add the KEYWORDS and APPEND spec to
735 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
736 (let ((spec (cons keywords append)) cell)
737 (if (setq cell (assq major-mode font-lock-keywords-alist))
738 (setcdr cell (append (cdr cell) (list spec)))
739 (push (list major-mode spec) font-lock-keywords-alist))))
740 (font-lock-mode
741 ;; Otherwise if Font Lock mode is on, set or add the keywords now.
742 (if (eq append 'set)
743 (setq font-lock-keywords keywords)
744 (let ((old (if (eq (car-safe font-lock-keywords) t)
745 (cdr font-lock-keywords)
746 font-lock-keywords)))
747 (setq font-lock-keywords (if append
748 (append old keywords)
749 (append keywords old))))))))
750 \f
751 ;;; Global Font Lock mode.
752
753 ;; A few people have hassled in the past for a way to make it easier to turn on
754 ;; Font Lock mode, without the user needing to know for which modes s/he has to
755 ;; turn it on, perhaps the same way hilit19.el/hl319.el does. I've always
756 ;; balked at that way, as I see it as just re-moulding the same problem in
757 ;; another form. That is; some person would still have to keep track of which
758 ;; modes (which may not even be distributed with Emacs) support Font Lock mode.
759 ;; The list would always be out of date. And that person might have to be me.
760
761 ;; Implementation.
762 ;;
763 ;; In a previous discussion the following hack came to mind. It is a gross
764 ;; hack, but it generally works. We use the convention that major modes start
765 ;; by calling the function `kill-all-local-variables', which in turn runs
766 ;; functions on the hook variable `change-major-mode-hook'. We attach our
767 ;; function `font-lock-change-major-mode' to that hook. Of course, when this
768 ;; hook is run, the major mode is in the process of being changed and we do not
769 ;; know what the final major mode will be. So, `font-lock-change-major-mode'
770 ;; only (a) notes the name of the current buffer, and (b) adds our function
771 ;; `turn-on-font-lock-if-enabled' to the hook variables `find-file-hooks' and
772 ;; `post-command-hook' (for buffers that are not visiting files). By the time
773 ;; the functions on the first of these hooks to be run are run, the new major
774 ;; mode is assumed to be in place. This way we get a Font Lock function run
775 ;; when a major mode is turned on, without knowing major modes or their hooks.
776 ;;
777 ;; Naturally this requires that (a) major modes run `kill-all-local-variables',
778 ;; as they are supposed to do, and (b) the major mode is in place after the
779 ;; file is visited or the command that ran `kill-all-local-variables' has
780 ;; finished, whichever the sooner. Arguably, any major mode that does not
781 ;; follow the convension (a) is broken, and I can't think of any reason why (b)
782 ;; would not be met (except `gnudoit' on non-files). However, it is not clean.
783 ;;
784 ;; Probably the cleanest solution is to have each major mode function run some
785 ;; hook, e.g., `major-mode-hook', but maybe implementing that change is
786 ;; impractical. I am personally against making `setq' a macro or be advised,
787 ;; or have a special function such as `set-major-mode', but maybe someone can
788 ;; come up with another solution?
789
790 ;; User interface.
791 ;;
792 ;; Although Global Font Lock mode is a pseudo-mode, I think that the user
793 ;; interface should conform to the usual Emacs convention for modes, i.e., a
794 ;; command to toggle the feature (`global-font-lock-mode') with a variable for
795 ;; finer control of the mode's behaviour (`font-lock-global-modes').
796 ;;
797 ;; The feature should not be enabled by loading font-lock.el, since other
798 ;; mechanisms for turning on Font Lock mode, such as M-x font-lock-mode RET or
799 ;; (add-hook 'c-mode-hook 'turn-on-font-lock), would cause Font Lock mode to be
800 ;; turned on everywhere. That would not be intuitive or informative because
801 ;; loading a file tells you nothing about the feature or how to control it. It
802 ;; would also be contrary to the Principle of Least Surprise. sm.
803
804 (defvar font-lock-buffers nil) ; For remembering buffers.
805
806 ;;;###autoload
807 (defun global-font-lock-mode (&optional arg message)
808 "Toggle Global Font Lock mode.
809 With prefix ARG, turn Global Font Lock mode on if and only if ARG is positive.
810 Displays a message saying whether the mode is on or off if MESSAGE is non-nil.
811 Returns the new status of Global Font Lock mode (non-nil means on).
812
813 When Global Font Lock mode is enabled, Font Lock mode is automagically
814 turned on in a buffer if its major mode is one of `font-lock-global-modes'."
815 (interactive "P\np")
816 (let ((off-p (if arg
817 (<= (prefix-numeric-value arg) 0)
818 global-font-lock-mode)))
819 (if off-p
820 (remove-hook 'find-file-hooks 'turn-on-font-lock-if-enabled)
821 (add-hook 'find-file-hooks 'turn-on-font-lock-if-enabled)
822 (add-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
823 (setq font-lock-buffers (buffer-list)))
824 (when message
825 (message "Global Font Lock mode is now %s." (if off-p "OFF" "ON")))
826 (setq global-font-lock-mode (not off-p))))
827
828 ;; Naughty hack. This variable was originally a `defvar' to keep track of
829 ;; whether Global Font Lock mode was turned on or not. As a `defcustom' with
830 ;; special `:set' and `:require' forms, we can provide custom mode control.
831 (defcustom global-font-lock-mode nil
832 "Toggle Global Font Lock mode.
833 When Global Font Lock mode is enabled, Font Lock mode is automagically
834 turned on in a buffer if its major mode is one of `font-lock-global-modes'.
835 You must modify via \\[customize] for this variable to have an effect."
836 :set (lambda (symbol value)
837 (global-font-lock-mode (or value 0)))
838 :type 'boolean
839 :group 'font-lock
840 :require 'font-lock)
841
842 (defcustom font-lock-global-modes t
843 "*Modes for which Font Lock mode is automagically turned on.
844 Global Font Lock mode is controlled by the `global-font-lock-mode' command.
845 If nil, means no modes have Font Lock mode automatically turned on.
846 If t, all modes that support Font Lock mode have it automatically turned on.
847 If a list, it should be a list of `major-mode' symbol names for which Font Lock
848 mode should be automatically turned on. The sense of the list is negated if it
849 begins with `not'. For example:
850 (c-mode c++-mode)
851 means that Font Lock mode is turned on for buffers in C and C++ modes only."
852 :type '(choice (const :tag "none" nil)
853 (const :tag "all" t)
854 (set :menu-tag "mode specific" :tag "modes"
855 :value (not)
856 (const :tag "Except" not)
857 (repeat :inline t (symbol :tag "mode"))))
858 :group 'font-lock)
859
860 (defun font-lock-change-major-mode ()
861 ;; Turn off Font Lock mode if it's on.
862 (when font-lock-mode
863 (font-lock-mode))
864 ;; Gross hack warning: Delicate readers should avert eyes now.
865 ;; Something is running `kill-all-local-variables', which generally means the
866 ;; major mode is being changed. Run `turn-on-font-lock-if-enabled' after the
867 ;; file is visited or the current command has finished.
868 (when global-font-lock-mode
869 (add-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
870 (add-to-list 'font-lock-buffers (current-buffer))))
871
872 (defun turn-on-font-lock-if-enabled ()
873 ;; Gross hack warning: Delicate readers should avert eyes now.
874 ;; Turn on Font Lock mode if it's supported by the major mode and enabled by
875 ;; the user.
876 (remove-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
877 (while font-lock-buffers
878 (when (buffer-live-p (car font-lock-buffers))
879 (save-excursion
880 (set-buffer (car font-lock-buffers))
881 (when (and (or font-lock-defaults
882 (assq major-mode font-lock-defaults-alist))
883 (or (eq font-lock-global-modes t)
884 (if (eq (car-safe font-lock-global-modes) 'not)
885 (not (memq major-mode (cdr font-lock-global-modes)))
886 (memq major-mode font-lock-global-modes))))
887 (let (inhibit-quit)
888 (turn-on-font-lock)))))
889 (setq font-lock-buffers (cdr font-lock-buffers))))
890
891 (add-hook 'change-major-mode-hook 'font-lock-change-major-mode)
892
893 ;;; End of Global Font Lock mode.
894 \f
895 ;;; Font Lock Support mode.
896
897 ;; This is the code used to interface font-lock.el with any of its add-on
898 ;; packages, and provide the user interface. Packages that have their own
899 ;; local buffer fontification functions (see below) may have to call
900 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
901 ;; themselves.
902
903 (defcustom font-lock-support-mode nil
904 "*Support mode for Font Lock mode.
905 Support modes speed up Font Lock mode by being choosy about when fontification
906 occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode') and
907 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
908 If nil, means support for Font Lock mode is never performed.
909 If a symbol, use that support mode.
910 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
911 where MAJOR-MODE is a symbol or t (meaning the default). For example:
912 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
913 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
914 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
915
916 The value of this variable is used when Font Lock mode is turned on."
917 :type '(choice (const :tag "none" nil)
918 (const :tag "fast lock" fast-lock-mode)
919 (const :tag "lazy lock" lazy-lock-mode)
920 (repeat :menu-tag "mode specific" :tag "mode specific"
921 :value ((t . lazy-lock-mode))
922 (cons :tag "Instance"
923 (radio :tag "Mode"
924 (const :tag "all" t)
925 (symbol :tag "name"))
926 (radio :tag "Decoration"
927 (const :tag "fast lock" fast-lock-mode)
928 (const :tag "lazy lock" lazy-lock-mode)))
929 ))
930 :group 'font-lock)
931
932 (defvar fast-lock-mode nil)
933 (defvar lazy-lock-mode nil)
934
935 (defun font-lock-turn-on-thing-lock ()
936 (let ((thing-mode (font-lock-value-in-major-mode font-lock-support-mode)))
937 (cond ((eq thing-mode 'fast-lock-mode)
938 (fast-lock-mode t))
939 ((eq thing-mode 'lazy-lock-mode)
940 (lazy-lock-mode t)))))
941
942 (defun font-lock-turn-off-thing-lock ()
943 (cond (fast-lock-mode
944 (fast-lock-mode nil))
945 (lazy-lock-mode
946 (lazy-lock-mode nil))))
947
948 (defun font-lock-after-fontify-buffer ()
949 (cond (fast-lock-mode
950 (fast-lock-after-fontify-buffer))
951 (lazy-lock-mode
952 (lazy-lock-after-fontify-buffer))))
953
954 (defun font-lock-after-unfontify-buffer ()
955 (cond (fast-lock-mode
956 (fast-lock-after-unfontify-buffer))
957 (lazy-lock-mode
958 (lazy-lock-after-unfontify-buffer))))
959
960 ;;; End of Font Lock Support mode.
961 \f
962 ;;; Fontification functions.
963
964 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
965 ;; code to fontify a region, the function runs the function whose name is the
966 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
967 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
968 ;; which does contain the code to fontify a region. However, the value of the
969 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
970 ;; do anything. The indirection of the fontification functions gives major
971 ;; modes the capability of modifying the way font-lock.el fontifies. Major
972 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
973 ;; via the variable `font-lock-defaults'.
974 ;;
975 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
976 ;; font-lock.el uses its own function for buffer fontification. This function
977 ;; makes fontification be on a message-by-message basis and so visiting an
978 ;; RMAIL file is much faster. A clever implementation of the function might
979 ;; fontify the headers differently than the message body. (It should, and
980 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
981 ;; you?) This hints at a more interesting use...
982 ;;
983 ;; Languages that contain text normally contained in different major modes
984 ;; could define their own fontification functions that treat text differently
985 ;; depending on its context. For example, Perl mode could arrange that here
986 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
987 ;; rules one way and C code another. Neat!
988 ;;
989 ;; A further reason to use the fontification indirection feature is when the
990 ;; default syntactual fontification, or the default fontification in general,
991 ;; is not flexible enough for a particular major mode. For example, perhaps
992 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
993 ;; cope with. You need to write your own version of that function, e.g.,
994 ;; `hairy-fontify-syntactically-region', and make your own version of
995 ;; `hairy-fontify-region' call that function before calling
996 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
997 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
998 ;; would call your region fontification function instead of its own. For
999 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
1000 ;; directives correctly and cleanly. (It is the same problem as fontifying
1001 ;; multi-line strings and comments; regexps are not appropriate for the job.)
1002
1003 ;;;###autoload
1004 (defun font-lock-fontify-buffer ()
1005 "Fontify the current buffer the way `font-lock-mode' would."
1006 (interactive)
1007 (let ((font-lock-verbose (or font-lock-verbose (interactive-p))))
1008 (funcall font-lock-fontify-buffer-function)))
1009
1010 (defun font-lock-unfontify-buffer ()
1011 (funcall font-lock-unfontify-buffer-function))
1012
1013 (defun font-lock-fontify-region (beg end &optional loudly)
1014 (funcall font-lock-fontify-region-function beg end loudly))
1015
1016 (defun font-lock-unfontify-region (beg end)
1017 (funcall font-lock-unfontify-region-function beg end))
1018
1019 (defun font-lock-default-fontify-buffer ()
1020 (let ((verbose (if (numberp font-lock-verbose)
1021 (> (buffer-size) font-lock-verbose)
1022 font-lock-verbose)))
1023 (when verbose
1024 (message "Fontifying %s..." (buffer-name)))
1025 ;; Make sure we have the right `font-lock-keywords' etc.
1026 (unless font-lock-mode
1027 (font-lock-set-defaults))
1028 ;; Make sure we fontify etc. in the whole buffer.
1029 (save-restriction
1030 (widen)
1031 (condition-case nil
1032 (save-excursion
1033 (save-match-data
1034 (font-lock-fontify-region (point-min) (point-max) verbose)
1035 (font-lock-after-fontify-buffer)
1036 (setq font-lock-fontified t)))
1037 ;; We don't restore the old fontification, so it's best to unfontify.
1038 (quit (font-lock-unfontify-buffer))))
1039 ;; Make sure we undo `font-lock-keywords' etc.
1040 (unless font-lock-mode
1041 (font-lock-unset-defaults))
1042 (if verbose (message "Fontifying %s...%s" (buffer-name)
1043 (if font-lock-fontified "done" "quit")))))
1044
1045 (defun font-lock-default-unfontify-buffer ()
1046 ;; Make sure we unfontify etc. in the whole buffer.
1047 (save-restriction
1048 (widen)
1049 (font-lock-unfontify-region (point-min) (point-max))
1050 (font-lock-after-unfontify-buffer)
1051 (setq font-lock-fontified nil)))
1052
1053 (defun font-lock-default-fontify-region (beg end loudly)
1054 (save-buffer-state
1055 ((parse-sexp-lookup-properties font-lock-syntactic-keywords)
1056 (old-syntax-table (syntax-table)))
1057 (unwind-protect
1058 (save-restriction
1059 (widen)
1060 ;; Use the fontification syntax table, if any.
1061 (when font-lock-syntax-table
1062 (set-syntax-table font-lock-syntax-table))
1063 ;; Now do the fontification.
1064 (font-lock-unfontify-region beg end)
1065 (when font-lock-syntactic-keywords
1066 (font-lock-fontify-syntactic-keywords-region beg end))
1067 (unless font-lock-keywords-only
1068 (font-lock-fontify-syntactically-region beg end loudly))
1069 (font-lock-fontify-keywords-region beg end loudly))
1070 ;; Clean up.
1071 (set-syntax-table old-syntax-table))))
1072
1073 ;; The following must be rethought, since keywords can override fontification.
1074 ; ;; Now scan for keywords, but not if we are inside a comment now.
1075 ; (or (and (not font-lock-keywords-only)
1076 ; (let ((state (parse-partial-sexp beg end nil nil
1077 ; font-lock-cache-state)))
1078 ; (or (nth 4 state) (nth 7 state))))
1079 ; (font-lock-fontify-keywords-region beg end))
1080
1081 (defun font-lock-default-unfontify-region (beg end)
1082 (save-buffer-state nil
1083 (remove-text-properties beg end '(face nil syntax-table nil))))
1084
1085 ;; Called when any modification is made to buffer text.
1086 (defun font-lock-after-change-function (beg end old-len)
1087 (let ((inhibit-point-motion-hooks t))
1088 (save-excursion
1089 (save-match-data
1090 ;; Rescan between start of lines enclosing the region.
1091 (font-lock-fontify-region
1092 (progn (goto-char beg) (beginning-of-line) (point))
1093 (progn (goto-char end) (forward-line 1) (point)))))))
1094
1095 (defun font-lock-fontify-block (&optional arg)
1096 "Fontify some lines the way `font-lock-fontify-buffer' would.
1097 The lines could be a function or paragraph, or a specified number of lines.
1098 If ARG is given, fontify that many lines before and after point, or 16 lines if
1099 no ARG is given and `font-lock-mark-block-function' is nil.
1100 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1101 delimit the region to fontify."
1102 (interactive "P")
1103 (let ((inhibit-point-motion-hooks t) font-lock-beginning-of-syntax-function
1104 deactivate-mark)
1105 ;; Make sure we have the right `font-lock-keywords' etc.
1106 (if (not font-lock-mode) (font-lock-set-defaults))
1107 (save-excursion
1108 (save-match-data
1109 (condition-case error-data
1110 (if (or arg (not font-lock-mark-block-function))
1111 (let ((lines (if arg (prefix-numeric-value arg) 16)))
1112 (font-lock-fontify-region
1113 (save-excursion (forward-line (- lines)) (point))
1114 (save-excursion (forward-line lines) (point))))
1115 (funcall font-lock-mark-block-function)
1116 (font-lock-fontify-region (point) (mark)))
1117 ((error quit) (message "Fontifying block...%s" error-data)))))))
1118
1119 (define-key facemenu-keymap "\M-g" 'font-lock-fontify-block)
1120
1121 ;;; End of Fontification functions.
1122 \f
1123 ;;; Additional text property functions.
1124
1125 ;; The following text property functions should be builtins. This means they
1126 ;; should be written in C and put with all the other text property functions.
1127 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1128 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1129 ;; in Lisp below and commented out. sm.
1130
1131 (defun font-lock-prepend-text-property (start end prop value &optional object)
1132 "Prepend to one property of the text from START to END.
1133 Arguments PROP and VALUE specify the property and value to prepend to the value
1134 already in place. The resulting property values are always lists.
1135 Optional argument OBJECT is the string or buffer containing the text."
1136 (let ((val (if (listp value) value (list value))) next prev)
1137 (while (/= start end)
1138 (setq next (next-single-property-change start prop object end)
1139 prev (get-text-property start prop object))
1140 (put-text-property start next prop
1141 (append val (if (listp prev) prev (list prev)))
1142 object)
1143 (setq start next))))
1144
1145 (defun font-lock-append-text-property (start end prop value &optional object)
1146 "Append to one property of the text from START to END.
1147 Arguments PROP and VALUE specify the property and value to append to the value
1148 already in place. The resulting property values are always lists.
1149 Optional argument OBJECT is the string or buffer containing the text."
1150 (let ((val (if (listp value) value (list value))) next prev)
1151 (while (/= start end)
1152 (setq next (next-single-property-change start prop object end)
1153 prev (get-text-property start prop object))
1154 (put-text-property start next prop
1155 (append (if (listp prev) prev (list prev)) val)
1156 object)
1157 (setq start next))))
1158
1159 (defun font-lock-fillin-text-property (start end prop value &optional object)
1160 "Fill in one property of the text from START to END.
1161 Arguments PROP and VALUE specify the property and value to put where none are
1162 already in place. Therefore existing property values are not overwritten.
1163 Optional argument OBJECT is the string or buffer containing the text."
1164 (let ((start (text-property-any start end prop nil object)) next)
1165 (while start
1166 (setq next (next-single-property-change start prop object end))
1167 (put-text-property start next prop value object)
1168 (setq start (text-property-any next end prop nil object)))))
1169
1170 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1171 ;; is to `add-text-properties', etc.
1172 ;(defun remove-text-property (start end property &optional object)
1173 ; "Remove a property from text from START to END.
1174 ;Argument PROPERTY is the property to remove.
1175 ;Optional argument OBJECT is the string or buffer containing the text.
1176 ;Return t if the property was actually removed, nil otherwise."
1177 ; (remove-text-properties start end (list property) object))
1178
1179 ;; For consistency: maybe this should be called `remove-single-property' like
1180 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1181 ;(defun remove-single-text-property (start end prop value &optional object)
1182 ; "Remove a specific property value from text from START to END.
1183 ;Arguments PROP and VALUE specify the property and value to remove. The
1184 ;resulting property values are not equal to VALUE nor lists containing VALUE.
1185 ;Optional argument OBJECT is the string or buffer containing the text."
1186 ; (let ((start (text-property-not-all start end prop nil object)) next prev)
1187 ; (while start
1188 ; (setq next (next-single-property-change start prop object end)
1189 ; prev (get-text-property start prop object))
1190 ; (cond ((and (symbolp prev) (eq value prev))
1191 ; (remove-text-property start next prop object))
1192 ; ((and (listp prev) (memq value prev))
1193 ; (let ((new (delq value prev)))
1194 ; (cond ((null new)
1195 ; (remove-text-property start next prop object))
1196 ; ((= (length new) 1)
1197 ; (put-text-property start next prop (car new) object))
1198 ; (t
1199 ; (put-text-property start next prop new object))))))
1200 ; (setq start (text-property-not-all next end prop nil object)))))
1201
1202 ;;; End of Additional text property functions.
1203 \f
1204 ;;; Syntactic regexp fontification functions.
1205
1206 ;; These syntactic keyword pass functions are identical to those keyword pass
1207 ;; functions below, with the following exceptions; (a) they operate on
1208 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1209 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1210 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1211 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1212 ;; LOUDLY as it is not likely to be intensive.
1213
1214 (defun font-lock-apply-syntactic-highlight (highlight)
1215 "Apply HIGHLIGHT following a match.
1216 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1217 see `font-lock-syntactic-keywords'."
1218 (let* ((match (nth 0 highlight))
1219 (start (match-beginning match)) (end (match-end match))
1220 (value (nth 1 highlight))
1221 (override (nth 2 highlight)))
1222 (unless (numberp (car value))
1223 (setq value (eval value)))
1224 (cond ((not start)
1225 ;; No match but we might not signal an error.
1226 (or (nth 3 highlight)
1227 (error "No match %d in highlight %S" match highlight)))
1228 ((not override)
1229 ;; Cannot override existing fontification.
1230 (or (text-property-not-all start end 'syntax-table nil)
1231 (put-text-property start end 'syntax-table value)))
1232 ((eq override t)
1233 ;; Override existing fontification.
1234 (put-text-property start end 'syntax-table value))
1235 ((eq override 'keep)
1236 ;; Keep existing fontification.
1237 (font-lock-fillin-text-property start end 'syntax-table value)))))
1238
1239 (defun font-lock-fontify-syntactic-anchored-keywords (keywords limit)
1240 "Fontify according to KEYWORDS until LIMIT.
1241 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1242 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1243 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
1244 ;; Evaluate PRE-MATCH-FORM.
1245 (pre-match-value (eval (nth 1 keywords))))
1246 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1247 (if (and (numberp pre-match-value) (> pre-match-value (point)))
1248 (setq limit pre-match-value)
1249 (save-excursion (end-of-line) (setq limit (point))))
1250 (save-match-data
1251 ;; Find an occurrence of `matcher' before `limit'.
1252 (while (if (stringp matcher)
1253 (re-search-forward matcher limit t)
1254 (funcall matcher limit))
1255 ;; Apply each highlight to this instance of `matcher'.
1256 (setq highlights lowdarks)
1257 (while highlights
1258 (font-lock-apply-syntactic-highlight (car highlights))
1259 (setq highlights (cdr highlights)))))
1260 ;; Evaluate POST-MATCH-FORM.
1261 (eval (nth 2 keywords))))
1262
1263 (defun font-lock-fontify-syntactic-keywords-region (start end)
1264 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1265 START should be at the beginning of a line."
1266 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1267 (when (symbolp font-lock-syntactic-keywords)
1268 (setq font-lock-syntactic-keywords (font-lock-eval-keywords
1269 font-lock-syntactic-keywords)))
1270 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1271 (unless (eq (car font-lock-syntactic-keywords) t)
1272 (setq font-lock-syntactic-keywords (font-lock-compile-keywords
1273 font-lock-syntactic-keywords)))
1274 ;; Get down to business.
1275 (let ((case-fold-search font-lock-keywords-case-fold-search)
1276 (keywords (cdr font-lock-syntactic-keywords))
1277 keyword matcher highlights)
1278 (while keywords
1279 ;; Find an occurrence of `matcher' from `start' to `end'.
1280 (setq keyword (car keywords) matcher (car keyword))
1281 (goto-char start)
1282 (while (if (stringp matcher)
1283 (re-search-forward matcher end t)
1284 (funcall matcher end))
1285 ;; Apply each highlight to this instance of `matcher', which may be
1286 ;; specific highlights or more keywords anchored to `matcher'.
1287 (setq highlights (cdr keyword))
1288 (while highlights
1289 (if (numberp (car (car highlights)))
1290 (font-lock-apply-syntactic-highlight (car highlights))
1291 (font-lock-fontify-syntactic-anchored-keywords (car highlights)
1292 end))
1293 (setq highlights (cdr highlights))))
1294 (setq keywords (cdr keywords)))))
1295
1296 ;;; End of Syntactic regexp fontification functions.
1297 \f
1298 ;;; Syntactic fontification functions.
1299
1300 ;; These record the parse state at a particular position, always the start of a
1301 ;; line. Used to make `font-lock-fontify-syntactically-region' faster.
1302 ;; Previously, `font-lock-cache-position' was just a buffer position. However,
1303 ;; under certain situations, this occasionally resulted in mis-fontification.
1304 ;; I think the "situations" were deletion with Lazy Lock mode's deferral. sm.
1305 (defvar font-lock-cache-state nil)
1306 (defvar font-lock-cache-position nil)
1307
1308 (defun font-lock-fontify-syntactically-region (start end &optional loudly)
1309 "Put proper face on each string and comment between START and END.
1310 START should be at the beginning of a line."
1311 (let ((cache (marker-position font-lock-cache-position))
1312 state string beg)
1313 (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
1314 (goto-char start)
1315 ;;
1316 ;; Find the state at the `beginning-of-line' before `start'.
1317 (if (eq start cache)
1318 ;; Use the cache for the state of `start'.
1319 (setq state font-lock-cache-state)
1320 ;; Find the state of `start'.
1321 (if (null font-lock-beginning-of-syntax-function)
1322 ;; Use the state at the previous cache position, if any, or
1323 ;; otherwise calculate from `point-min'.
1324 (if (or (null cache) (< start cache))
1325 (setq state (parse-partial-sexp (point-min) start))
1326 (setq state (parse-partial-sexp cache start nil nil
1327 font-lock-cache-state)))
1328 ;; Call the function to move outside any syntactic block.
1329 (funcall font-lock-beginning-of-syntax-function)
1330 (setq state (parse-partial-sexp (point) start)))
1331 ;; Cache the state and position of `start'.
1332 (setq font-lock-cache-state state)
1333 (set-marker font-lock-cache-position start))
1334 ;;
1335 ;; If the region starts inside a string or comment, show the extent of it.
1336 (when (or (nth 3 state) (nth 4 state))
1337 (setq string (nth 3 state) beg (point))
1338 (setq state (parse-partial-sexp (point) end nil nil state 'syntax-table))
1339 (put-text-property beg (point) 'face
1340 (if string
1341 font-lock-string-face
1342 font-lock-comment-face)))
1343 ;;
1344 ;; Find each interesting place between here and `end'.
1345 (while (and (< (point) end)
1346 (progn
1347 (setq state (parse-partial-sexp (point) end nil nil state
1348 'syntax-table))
1349 (or (nth 3 state) (nth 4 state))))
1350 (setq string (nth 3 state) beg (nth 8 state))
1351 (setq state (parse-partial-sexp (point) end nil nil state 'syntax-table))
1352 (put-text-property beg (point) 'face
1353 (if string
1354 font-lock-string-face
1355 font-lock-comment-face)))))
1356
1357 ;;; End of Syntactic fontification functions.
1358 \f
1359 ;;; Keyword regexp fontification functions.
1360
1361 (defsubst font-lock-apply-highlight (highlight)
1362 "Apply HIGHLIGHT following a match.
1363 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1364 (let* ((match (nth 0 highlight))
1365 (start (match-beginning match)) (end (match-end match))
1366 (override (nth 2 highlight)))
1367 (cond ((not start)
1368 ;; No match but we might not signal an error.
1369 (or (nth 3 highlight)
1370 (error "No match %d in highlight %S" match highlight)))
1371 ((not override)
1372 ;; Cannot override existing fontification.
1373 (or (text-property-not-all start end 'face nil)
1374 (put-text-property start end 'face (eval (nth 1 highlight)))))
1375 ((eq override t)
1376 ;; Override existing fontification.
1377 (put-text-property start end 'face (eval (nth 1 highlight))))
1378 ((eq override 'prepend)
1379 ;; Prepend to existing fontification.
1380 (font-lock-prepend-text-property start end 'face (eval (nth 1 highlight))))
1381 ((eq override 'append)
1382 ;; Append to existing fontification.
1383 (font-lock-append-text-property start end 'face (eval (nth 1 highlight))))
1384 ((eq override 'keep)
1385 ;; Keep existing fontification.
1386 (font-lock-fillin-text-property start end 'face (eval (nth 1 highlight)))))))
1387
1388 (defsubst font-lock-fontify-anchored-keywords (keywords limit)
1389 "Fontify according to KEYWORDS until LIMIT.
1390 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1391 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1392 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
1393 ;; Evaluate PRE-MATCH-FORM.
1394 (pre-match-value (eval (nth 1 keywords))))
1395 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1396 (if (and (numberp pre-match-value) (> pre-match-value (point)))
1397 (setq limit pre-match-value)
1398 (save-excursion (end-of-line) (setq limit (point))))
1399 (save-match-data
1400 ;; Find an occurrence of `matcher' before `limit'.
1401 (while (if (stringp matcher)
1402 (re-search-forward matcher limit t)
1403 (funcall matcher limit))
1404 ;; Apply each highlight to this instance of `matcher'.
1405 (setq highlights lowdarks)
1406 (while highlights
1407 (font-lock-apply-highlight (car highlights))
1408 (setq highlights (cdr highlights)))))
1409 ;; Evaluate POST-MATCH-FORM.
1410 (eval (nth 2 keywords))))
1411
1412 (defun font-lock-fontify-keywords-region (start end &optional loudly)
1413 "Fontify according to `font-lock-keywords' between START and END.
1414 START should be at the beginning of a line."
1415 (unless (eq (car font-lock-keywords) t)
1416 (setq font-lock-keywords (font-lock-compile-keywords font-lock-keywords)))
1417 (let ((case-fold-search font-lock-keywords-case-fold-search)
1418 (keywords (cdr font-lock-keywords))
1419 (bufname (buffer-name)) (count 0)
1420 keyword matcher highlights)
1421 ;;
1422 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1423 (while keywords
1424 (if loudly (message "Fontifying %s... (regexps..%s)" bufname
1425 (make-string (incf count) ?.)))
1426 ;;
1427 ;; Find an occurrence of `matcher' from `start' to `end'.
1428 (setq keyword (car keywords) matcher (car keyword))
1429 (goto-char start)
1430 (while (if (stringp matcher)
1431 (re-search-forward matcher end t)
1432 (funcall matcher end))
1433 ;; Apply each highlight to this instance of `matcher', which may be
1434 ;; specific highlights or more keywords anchored to `matcher'.
1435 (setq highlights (cdr keyword))
1436 (while highlights
1437 (if (numberp (car (car highlights)))
1438 (font-lock-apply-highlight (car highlights))
1439 (font-lock-fontify-anchored-keywords (car highlights) end))
1440 (setq highlights (cdr highlights))))
1441 (setq keywords (cdr keywords)))))
1442
1443 ;;; End of Keyword regexp fontification functions.
1444 \f
1445 ;; Various functions.
1446
1447 (defun font-lock-compile-keywords (keywords)
1448 ;; Compile KEYWORDS into the form (t KEYWORD ...) where KEYWORD is of the
1449 ;; form (MATCHER HIGHLIGHT ...) as shown in `font-lock-keywords' doc string.
1450 (if (eq (car-safe keywords) t)
1451 keywords
1452 (cons t (mapcar 'font-lock-compile-keyword keywords))))
1453
1454 (defun font-lock-compile-keyword (keyword)
1455 (cond ((nlistp keyword) ; MATCHER
1456 (list keyword '(0 font-lock-keyword-face)))
1457 ((eq (car keyword) 'eval) ; (eval . FORM)
1458 (font-lock-compile-keyword (eval (cdr keyword))))
1459 ((eq (car-safe (cdr keyword)) 'quote) ; (MATCHER . 'FORM)
1460 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1461 (if (symbolp (nth 2 keyword))
1462 (list (car keyword) (list 0 (cdr keyword)))
1463 (font-lock-compile-keyword (cons (car keyword) (nth 2 keyword)))))
1464 ((numberp (cdr keyword)) ; (MATCHER . MATCH)
1465 (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
1466 ((symbolp (cdr keyword)) ; (MATCHER . FACENAME)
1467 (list (car keyword) (list 0 (cdr keyword))))
1468 ((nlistp (nth 1 keyword)) ; (MATCHER . HIGHLIGHT)
1469 (list (car keyword) (cdr keyword)))
1470 (t ; (MATCHER HIGHLIGHT ...)
1471 keyword)))
1472
1473 (defun font-lock-eval-keywords (keywords)
1474 ;; Evalulate KEYWORDS if a function (funcall) or variable (eval) name.
1475 (if (listp keywords)
1476 keywords
1477 (font-lock-eval-keywords (if (fboundp keywords)
1478 (funcall keywords)
1479 (eval keywords)))))
1480
1481 (defun font-lock-value-in-major-mode (alist)
1482 ;; Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1483 ;; Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t.
1484 (if (consp alist)
1485 (cdr (or (assq major-mode alist) (assq t alist)))
1486 alist))
1487
1488 (defun font-lock-choose-keywords (keywords level)
1489 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1490 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
1491 (cond ((symbolp keywords)
1492 keywords)
1493 ((numberp level)
1494 (or (nth level keywords) (car (reverse keywords))))
1495 ((eq level t)
1496 (car (reverse keywords)))
1497 (t
1498 (car keywords))))
1499
1500 (defvar font-lock-set-defaults nil) ; Whether we have set up defaults.
1501
1502 (defun font-lock-set-defaults ()
1503 "Set fontification defaults appropriately for this mode.
1504 Sets various variables using `font-lock-defaults' (or, if nil, using
1505 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1506 ;; Set fontification defaults.
1507 (make-local-variable 'font-lock-fontified)
1508 ;; Set iff not previously set.
1509 (unless font-lock-set-defaults
1510 (set (make-local-variable 'font-lock-set-defaults) t)
1511 (set (make-local-variable 'font-lock-cache-state) nil)
1512 (set (make-local-variable 'font-lock-cache-position) (make-marker))
1513 (let* ((defaults (or font-lock-defaults
1514 (cdr (assq major-mode font-lock-defaults-alist))))
1515 (keywords
1516 (font-lock-choose-keywords (nth 0 defaults)
1517 (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1518 (local (cdr (assq major-mode font-lock-keywords-alist))))
1519 ;; Regexp fontification?
1520 (set (make-local-variable 'font-lock-keywords)
1521 (font-lock-compile-keywords (font-lock-eval-keywords keywords)))
1522 ;; Local fontification?
1523 (while local
1524 (font-lock-add-keywords nil (car (car local)) (cdr (car local)))
1525 (setq local (cdr local)))
1526 ;; Syntactic fontification?
1527 (when (nth 1 defaults)
1528 (set (make-local-variable 'font-lock-keywords-only) t))
1529 ;; Case fold during regexp fontification?
1530 (when (nth 2 defaults)
1531 (set (make-local-variable 'font-lock-keywords-case-fold-search) t))
1532 ;; Syntax table for regexp and syntactic fontification?
1533 (when (nth 3 defaults)
1534 (let ((slist (nth 3 defaults)))
1535 (set (make-local-variable 'font-lock-syntax-table)
1536 (copy-syntax-table (syntax-table)))
1537 (while slist
1538 ;; The character to modify may be a single CHAR or a STRING.
1539 (let ((chars (if (numberp (car (car slist)))
1540 (list (car (car slist)))
1541 (mapcar 'identity (car (car slist)))))
1542 (syntax (cdr (car slist))))
1543 (while chars
1544 (modify-syntax-entry (car chars) syntax
1545 font-lock-syntax-table)
1546 (setq chars (cdr chars)))
1547 (setq slist (cdr slist))))))
1548 ;; Syntax function for syntactic fontification?
1549 (when (nth 4 defaults)
1550 (set (make-local-variable 'font-lock-beginning-of-syntax-function)
1551 (nth 4 defaults)))
1552 ;; Variable alist?
1553 (let ((alist (nthcdr 5 defaults)))
1554 (while alist
1555 (let ((variable (car (car alist))) (value (cdr (car alist))))
1556 (unless (boundp variable)
1557 (set variable nil))
1558 (set (make-local-variable variable) value)
1559 (setq alist (cdr alist))))))))
1560
1561 (defun font-lock-unset-defaults ()
1562 "Unset fontification defaults. See `font-lock-set-defaults'."
1563 (setq font-lock-set-defaults nil
1564 font-lock-keywords nil
1565 font-lock-keywords-only nil
1566 font-lock-keywords-case-fold-search nil
1567 font-lock-syntax-table nil
1568 font-lock-beginning-of-syntax-function nil)
1569 (let* ((defaults (or font-lock-defaults
1570 (cdr (assq major-mode font-lock-defaults-alist))))
1571 (alist (nthcdr 5 defaults)))
1572 (while alist
1573 (set (car (car alist)) (default-value (car (car alist))))
1574 (setq alist (cdr alist)))))
1575 \f
1576 ;;; Colour etc. support.
1577
1578 ;; Originally these variable values were face names such as `bold' etc.
1579 ;; Now we create our own faces, but we keep these variables for compatibility
1580 ;; and they give users another mechanism for changing face appearance.
1581 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
1582 ;; returns a face. So the easiest thing is to continue using these variables,
1583 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
1584 (defvar font-lock-comment-face 'font-lock-comment-face
1585 "Face name to use for comments.")
1586
1587 (defvar font-lock-string-face 'font-lock-string-face
1588 "Face name to use for strings.")
1589
1590 (defvar font-lock-keyword-face 'font-lock-keyword-face
1591 "Face name to use for keywords.")
1592
1593 (defvar font-lock-builtin-face 'font-lock-builtin-face
1594 "Face name to use for builtins.")
1595
1596 (defvar font-lock-function-name-face 'font-lock-function-name-face
1597 "Face name to use for function names.")
1598
1599 (defvar font-lock-variable-name-face 'font-lock-variable-name-face
1600 "Face name to use for variable names.")
1601
1602 (defvar font-lock-type-face 'font-lock-type-face
1603 "Face name to use for type names.")
1604
1605 (defvar font-lock-reference-face 'font-lock-reference-face
1606 "Face name to use for reference names.")
1607
1608 (defvar font-lock-warning-face 'font-lock-warning-face
1609 "Face name to use for things that should stand out.")
1610
1611 ;; Originally face attributes were specified via `font-lock-face-attributes'.
1612 ;; Users then changed the default face attributes by setting that variable.
1613 ;; However, we try and be back-compatible and respect its value if set except
1614 ;; for faces where M-x customize has been used to save changes for the face.
1615 (when (boundp 'font-lock-face-attributes)
1616 (let ((face-attributes font-lock-face-attributes))
1617 (while face-attributes
1618 (let* ((face-attribute (pop face-attributes))
1619 (face (car face-attribute)))
1620 ;; Rustle up a `defface' SPEC from a `font-lock-face-attributes' entry.
1621 (unless (get face 'saved-face)
1622 (let ((foreground (nth 1 face-attribute))
1623 (background (nth 2 face-attribute))
1624 (bold-p (nth 3 face-attribute))
1625 (italic-p (nth 4 face-attribute))
1626 (underline-p (nth 5 face-attribute))
1627 face-spec)
1628 (when foreground
1629 (setq face-spec (cons ':foreground (cons foreground face-spec))))
1630 (when background
1631 (setq face-spec (cons ':background (cons background face-spec))))
1632 (when bold-p
1633 (setq face-spec (append '(:bold t) face-spec)))
1634 (when italic-p
1635 (setq face-spec (append '(:italic t) face-spec)))
1636 (when underline-p
1637 (setq face-spec (append '(:underline t) face-spec)))
1638 (custom-declare-face face (list (list t face-spec)) nil)))))))
1639
1640 ;; But now we do it the custom way. Note that `defface' will not overwrite any
1641 ;; faces declared above via `custom-declare-face'.
1642 (defface font-lock-comment-face
1643 '((((class grayscale) (background light))
1644 (:foreground "DimGray" :bold t :italic t))
1645 (((class grayscale) (background dark))
1646 (:foreground "LightGray" :bold t :italic t))
1647 (((class color) (background light)) (:foreground "Firebrick"))
1648 (((class color) (background dark)) (:foreground "OrangeRed"))
1649 (t (:bold t :italic t)))
1650 "Font Lock mode face used to highlight comments."
1651 :group 'font-lock-highlighting-faces)
1652
1653 (defface font-lock-string-face
1654 '((((class grayscale) (background light)) (:foreground "DimGray" :italic t))
1655 (((class grayscale) (background dark)) (:foreground "LightGray" :italic t))
1656 (((class color) (background light)) (:foreground "RosyBrown"))
1657 (((class color) (background dark)) (:foreground "LightSalmon"))
1658 (t (:italic t)))
1659 "Font Lock mode face used to highlight strings."
1660 :group 'font-lock-highlighting-faces)
1661
1662 (defface font-lock-keyword-face
1663 '((((class grayscale) (background light)) (:foreground "LightGray" :bold t))
1664 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
1665 (((class color) (background light)) (:foreground "Purple"))
1666 (((class color) (background dark)) (:foreground "Cyan"))
1667 (t (:bold t)))
1668 "Font Lock mode face used to highlight keywords."
1669 :group 'font-lock-highlighting-faces)
1670
1671 (defface font-lock-builtin-face
1672 '((((class grayscale) (background light)) (:foreground "LightGray" :bold t))
1673 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
1674 (((class color) (background light)) (:foreground "Orchid"))
1675 (((class color) (background dark)) (:foreground "LightSteelBlue"))
1676 (t (:bold t)))
1677 "Font Lock mode face used to highlight builtins."
1678 :group 'font-lock-highlighting-faces)
1679
1680 (defface font-lock-function-name-face
1681 '((((class color) (background light)) (:foreground "Blue"))
1682 (((class color) (background dark)) (:foreground "LightSkyBlue"))
1683 (t (:inverse-video t :bold t)))
1684 "Font Lock mode face used to highlight function names."
1685 :group 'font-lock-highlighting-faces)
1686
1687 (defface font-lock-variable-name-face
1688 '((((class grayscale) (background light))
1689 (:foreground "Gray90" :bold t :italic t))
1690 (((class grayscale) (background dark))
1691 (:foreground "DimGray" :bold t :italic t))
1692 (((class color) (background light)) (:foreground "DarkGoldenrod"))
1693 (((class color) (background dark)) (:foreground "LightGoldenrod"))
1694 (t (:bold t :italic t)))
1695 "Font Lock mode face used to highlight variable names."
1696 :group 'font-lock-highlighting-faces)
1697
1698 (defface font-lock-type-face
1699 '((((class grayscale) (background light)) (:foreground "Gray90" :bold t))
1700 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
1701 (((class color) (background light)) (:foreground "ForestGreen"))
1702 (((class color) (background dark)) (:foreground "PaleGreen"))
1703 (t (:bold t :underline t)))
1704 "Font Lock mode face used to highlight types."
1705 :group 'font-lock-highlighting-faces)
1706
1707 (defface font-lock-reference-face
1708 '((((class grayscale) (background light))
1709 (:foreground "LightGray" :bold t :underline t))
1710 (((class grayscale) (background dark))
1711 (:foreground "Gray50" :bold t :underline t))
1712 (((class color) (background light)) (:foreground "CadetBlue"))
1713 (((class color) (background dark)) (:foreground "Aquamarine"))
1714 (t (:bold t :underline t)))
1715 "Font Lock mode face used to highlight references."
1716 :group 'font-lock-highlighting-faces)
1717
1718 (defface font-lock-warning-face
1719 '((((class color) (background light)) (:foreground "Red" :bold t))
1720 (((class color) (background dark)) (:foreground "Pink" :bold t))
1721 (t (:inverse-video t :bold t)))
1722 "Font Lock mode face used to highlight warnings."
1723 :group 'font-lock-highlighting-faces)
1724
1725 ;;; End of Colour etc. support.
1726 \f
1727 ;;; Menu support.
1728
1729 ;; This section of code is commented out because Emacs does not have real menu
1730 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1731 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1732 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1733 ;; the entry for "Text Properties" something like:
1734 ;;
1735 ;; (define-key menu-bar-edit-menu [font-lock]
1736 ;; '("Syntax Highlighting" . font-lock-menu))
1737 ;;
1738 ;; and remove a single ";" from the beginning of each line in the rest of this
1739 ;; section. Probably the mechanism for telling the menu code what are menu
1740 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1741 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1742
1743 ;;;;###autoload
1744 ;(progn
1745 ; ;; Make the Font Lock menu.
1746 ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1747 ; ;; Add the menu items in reverse order.
1748 ; (define-key font-lock-menu [fontify-less]
1749 ; '("Less In Current Buffer" . font-lock-fontify-less))
1750 ; (define-key font-lock-menu [fontify-more]
1751 ; '("More In Current Buffer" . font-lock-fontify-more))
1752 ; (define-key font-lock-menu [font-lock-sep]
1753 ; '("--"))
1754 ; (define-key font-lock-menu [font-lock-mode]
1755 ; '("In Current Buffer" . font-lock-mode))
1756 ; (define-key font-lock-menu [global-font-lock-mode]
1757 ; '("In All Buffers" . global-font-lock-mode)))
1758 ;
1759 ;;;;###autoload
1760 ;(progn
1761 ; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1762 ; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1763 ; (put 'global-font-lock-mode 'menu-toggle t)
1764 ; (put 'font-lock-mode 'menu-toggle t)
1765 ; (put 'font-lock-fontify-more 'menu-enable '(identity))
1766 ; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1767 ;
1768 ;;; Put the appropriate symbol property values on now. See above.
1769 ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode))
1770 ;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1771 ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1772 ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1773 ;
1774 ;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1775 ;
1776 ;(defun font-lock-fontify-level (level)
1777 ; (let ((font-lock-maximum-decoration level))
1778 ; (when font-lock-mode
1779 ; (font-lock-mode))
1780 ; (font-lock-mode)
1781 ; (when font-lock-verbose
1782 ; (message "Fontifying %s... level %d" (buffer-name) level))))
1783 ;
1784 ;(defun font-lock-fontify-less ()
1785 ; "Fontify the current buffer with less decoration.
1786 ;See `font-lock-maximum-decoration'."
1787 ; (interactive)
1788 ; ;; Check in case we get called interactively.
1789 ; (if (nth 1 font-lock-fontify-level)
1790 ; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1791 ; (error "No less decoration")))
1792 ;
1793 ;(defun font-lock-fontify-more ()
1794 ; "Fontify the current buffer with more decoration.
1795 ;See `font-lock-maximum-decoration'."
1796 ; (interactive)
1797 ; ;; Check in case we get called interactively.
1798 ; (if (nth 2 font-lock-fontify-level)
1799 ; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1800 ; (error "No more decoration")))
1801 ;
1802 ;;; This should be called by `font-lock-set-defaults'.
1803 ;(defun font-lock-set-menu ()
1804 ; ;; Activate less/more fontification entries if there are multiple levels for
1805 ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
1806 ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
1807 ; (let ((keywords (or (nth 0 font-lock-defaults)
1808 ; (nth 1 (assq major-mode font-lock-defaults-alist))))
1809 ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1810 ; (make-local-variable 'font-lock-fontify-level)
1811 ; (if (or (symbolp keywords) (= (length keywords) 1))
1812 ; (font-lock-unset-menu)
1813 ; (cond ((eq level t)
1814 ; (setq level (1- (length keywords))))
1815 ; ((or (null level) (zerop level))
1816 ; ;; The default level is usually, but not necessarily, level 1.
1817 ; (setq level (- (length keywords)
1818 ; (length (member (eval (car keywords))
1819 ; (mapcar 'eval (cdr keywords))))))))
1820 ; (setq font-lock-fontify-level (list level (> level 1)
1821 ; (< level (1- (length keywords))))))))
1822 ;
1823 ;;; This should be called by `font-lock-unset-defaults'.
1824 ;(defun font-lock-unset-menu ()
1825 ; ;; Deactivate less/more fontification entries.
1826 ; (setq font-lock-fontify-level nil))
1827
1828 ;;; End of Menu support.
1829 \f
1830 ;;; Various regexp information shared by several modes.
1831 ;;; Information specific to a single mode should go in its load library.
1832
1833 ;; Font Lock support for C, C++, Objective-C and Java modes will one day be in
1834 ;; some cc-font.el (and required by cc-mode.el). However, the below function
1835 ;; should stay in font-lock.el, since it is used by other libraries. sm.
1836
1837 (defun font-lock-match-c-style-declaration-item-and-skip-to-next (limit)
1838 "Match, and move over, any declaration/definition item after point.
1839 Matches after point, but ignores leading whitespace and `*' characters.
1840 Does not move further than LIMIT.
1841
1842 The expected syntax of a declaration/definition item is `word' (preceded by
1843 optional whitespace and `*' characters and proceeded by optional whitespace)
1844 optionally followed by a `('. Everything following the item (but belonging to
1845 it) is expected to by skip-able by `scan-sexps', and items are expected to be
1846 separated with a `,' and to be terminated with a `;'.
1847
1848 Thus the regexp matches after point: word (
1849 ^^^^ ^
1850 Where the match subexpressions are: 1 2
1851
1852 The item is delimited by (match-beginning 1) and (match-end 1).
1853 If (match-beginning 2) is non-nil, the item is followed by a `('.
1854
1855 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
1856 (when (looking-at "[ \t*]*\\(\\sw+\\)[ \t]*\\((\\)?")
1857 (save-match-data
1858 (condition-case nil
1859 (save-restriction
1860 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
1861 (narrow-to-region (point-min) limit)
1862 (goto-char (match-end 1))
1863 ;; Move over any item value, etc., to the next item.
1864 (while (not (looking-at "[ \t]*\\(\\(,\\)\\|;\\|$\\)"))
1865 (goto-char (or (scan-sexps (point) 1) (point-max))))
1866 (goto-char (match-end 2)))
1867 (error t)))))
1868 \f
1869 ;; Lisp.
1870
1871 (defconst lisp-font-lock-keywords-1
1872 (eval-when-compile
1873 (list
1874 ;;
1875 ;; Definitions.
1876 (list (concat "(\\(def\\("
1877 ;; Function declarations.
1878 "\\(advice\\|alias\\|"
1879 "ine-\\(derived-mode\\|function\\|skeleton\\|widget\\)\\|"
1880 "macro\\|subst\\|un\\)\\|"
1881 ;; Variable declarations.
1882 "\\(const\\|custom\\|face\\|var\\)\\|"
1883 ;; Structure declarations.
1884 "\\(class\\|group\\|struct\\|type\\)"
1885 "\\)\\)\\>"
1886 ;; Any whitespace and defined object.
1887 "[ \t'\(]*"
1888 "\\(\\sw+\\)?")
1889 '(1 font-lock-keyword-face)
1890 '(7 (cond ((match-beginning 3) font-lock-function-name-face)
1891 ((match-beginning 5) font-lock-variable-name-face)
1892 (t font-lock-type-face))
1893 nil t))
1894 ;;
1895 ;; Emacs Lisp autoload cookies.
1896 '("^;;;\\(###\\)\\(autoload\\)\\>"
1897 (1 font-lock-reference-face prepend)
1898 (2 font-lock-warning-face prepend))
1899 ))
1900 "Subdued level highlighting for Lisp modes.")
1901
1902 (defconst lisp-font-lock-keywords-2
1903 (append lisp-font-lock-keywords-1
1904 (eval-when-compile
1905 (list
1906 ;;
1907 ;; Control structures. Emacs Lisp forms.
1908 (cons (concat
1909 "(" (regexp-opt
1910 '("cond" "if" "while" "catch" "throw" "let" "let*"
1911 "prog" "progn" "progv" "prog1" "prog2" "prog*"
1912 "closure" "preparse-closure" "make-closure"
1913 "inline" "save-restriction" "save-excursion"
1914 "save-window-excursion" "save-selected-window"
1915 "save-match-data" "save-current-buffer" "unwind-protect"
1916 "condition-case" "track-mouse" "dont-compile"
1917 "eval-after-load" "eval-and-compile" "eval-when-compile"
1918 "eval-when" "with-output-to-temp-buffer" "with-timeout"
1919 "with-current-buffer" "with-temp-buffer"
1920 "with-temp-file") t)
1921 "\\>")
1922 1)
1923 ;;
1924 ;; Control structures. Common Lisp forms.
1925 (cons (concat
1926 "(" (regexp-opt
1927 '("when" "unless" "case" "ecase" "typecase" "etypecase"
1928 "loop" "do" "do*" "dotimes" "dolist"
1929 "proclaim" "declaim" "declare"
1930 "lexical-let" "lexical-let*" "flet" "labels"
1931 "return" "return-from") t)
1932 "\\>")
1933 1)
1934 ;;
1935 ;; Feature symbols as references.
1936 '("(\\(featurep\\|provide\\|require\\)\\>[ \t']*\\(\\sw+\\)?"
1937 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1938 ;;
1939 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1940 '("\\\\\\\\\\[\\(\\sw+\\)]" 1 font-lock-reference-face prepend)
1941 ;;
1942 ;; Words inside `' tend to be symbol names.
1943 '("`\\(\\sw\\sw+\\)'" 1 font-lock-reference-face prepend)
1944 ;;
1945 ;; CLisp `:' keywords as builtins.
1946 '("\\<:\\sw\\sw+\\>" 0 font-lock-builtin-face)
1947 ;;
1948 ;; ELisp and CLisp `&' keywords as types.
1949 '("\\<\\&\\sw+\\>" . font-lock-type-face)
1950 )))
1951 "Gaudy level highlighting for Lisp modes.")
1952
1953 (defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
1954 "Default expressions to highlight in Lisp modes.")
1955 \f
1956 ;; Scheme.
1957
1958 (defconst scheme-font-lock-keywords-1
1959 (eval-when-compile
1960 (list
1961 ;;
1962 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1963 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1964 (list (concat "(\\(define\\("
1965 ;; Function names.
1966 "\\(\\|-\\(generic\\(\\|-procedure\\)\\|method\\)\\)\\|"
1967 ;; Macro names, as variable names. A bit dubious, this.
1968 "\\(-syntax\\)\\|"
1969 ;; Class names.
1970 "-class"
1971 "\\)\\)\\>"
1972 ;; Any whitespace and declared object.
1973 "[ \t]*(?"
1974 "\\(\\sw+\\)?")
1975 '(1 font-lock-keyword-face)
1976 '(7 (cond ((match-beginning 3) font-lock-function-name-face)
1977 ((match-beginning 6) font-lock-variable-name-face)
1978 (t font-lock-type-face))
1979 nil t))
1980 ))
1981 "Subdued expressions to highlight in Scheme modes.")
1982
1983 (defconst scheme-font-lock-keywords-2
1984 (append scheme-font-lock-keywords-1
1985 (eval-when-compile
1986 (list
1987 ;;
1988 ;; Control structures.
1989 (cons
1990 (concat
1991 "(" (regexp-opt
1992 '("begin" "call-with-current-continuation" "call/cc"
1993 "call-with-input-file" "call-with-output-file" "case" "cond"
1994 "do" "else" "for-each" "if" "lambda"
1995 "let" "let*" "let-syntax" "letrec" "letrec-syntax"
1996 ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1997 "and" "or" "delay"
1998 ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
1999 ;;"quasiquote" "quote" "unquote" "unquote-splicing"
2000 "map" "syntax" "syntax-rules") t)
2001 "\\>") 1)
2002 ;;
2003 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
2004 '("\\<<\\sw+>\\>" . font-lock-type-face)
2005 ;;
2006 ;; Scheme `:' keywords as references.
2007 '("\\<:\\sw+\\>" . font-lock-reference-face)
2008 )))
2009 "Gaudy expressions to highlight in Scheme modes.")
2010
2011 (defvar scheme-font-lock-keywords scheme-font-lock-keywords-1
2012 "Default expressions to highlight in Scheme modes.")
2013 \f
2014 ;; TeX.
2015
2016 ;(defvar tex-font-lock-keywords
2017 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
2018 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2019 ; 2 font-lock-function-name-face)
2020 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2021 ; 2 font-lock-reference-face)
2022 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2023 ; ;; not be able to display those fonts.
2024 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
2025 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
2026 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
2027 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
2028 ; ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
2029 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2030 ; 2 font-lock-function-name-face)
2031 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2032 ; 2 font-lock-reference-face)
2033 ; ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
2034 ; "\\\\\\([a-zA-Z@]+\\|.\\)"
2035 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2036 ; ;; not be able to display those fonts.
2037 ; ;; LaTeX2e: \emph{This is emphasized}.
2038 ; ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
2039 ; ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
2040 ; ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
2041 ; 3 (if (match-beginning 2) 'bold 'italic) keep)
2042 ; ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
2043 ; ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
2044 ; 3 (if (match-beginning 2) 'bold 'italic) keep))
2045
2046 ;; Rewritten with the help of Alexandra Bac <abac@welcome.disi.unige.it>.
2047 (defconst tex-font-lock-keywords-1
2048 (eval-when-compile
2049 (let* (;;
2050 ;; Names of commands whose arg should be fontified as heading, etc.
2051 (headings (regexp-opt '("title" "begin" "end") t))
2052 ;; These commands have optional args.
2053 (headings-opt (regexp-opt
2054 '("chapter" "part"
2055 "section" "subsection" "subsubsection"
2056 "section*" "subsection*" "subsubsection*"
2057 "paragraph" "subparagraph" "subsubparagraph"
2058 "paragraph*" "subparagraph*" "subsubparagraph*"
2059 "newcommand" "renewcommand" "newenvironment"
2060 "newtheorem"
2061 "newcommand*" "renewcommand*" "newenvironment*"
2062 "newtheorem*")
2063 t))
2064 (variables (regexp-opt
2065 '("newcounter" "newcounter*" "setcounter" "addtocounter"
2066 "setlength" "addtolength" "settowidth")
2067 t))
2068 (includes (regexp-opt
2069 '("input" "include" "includeonly" "bibliography"
2070 "epsfig" "psfig" "epsf")
2071 t))
2072 (includes-opt (regexp-opt
2073 '("nofiles" "usepackage"
2074 "includegraphics" "includegraphics*")
2075 t))
2076 ;; Miscellany.
2077 (slash "\\\\")
2078 (opt "\\(\\[[^]]*\\]\\)?")
2079 (arg "{\\([^}]+\\)")
2080 (opt-depth (regexp-opt-depth opt))
2081 (arg-depth (regexp-opt-depth arg))
2082 )
2083 (list
2084 ;;
2085 ;; Heading args.
2086 (list (concat slash headings arg)
2087 (+ (regexp-opt-depth headings) arg-depth)
2088 'font-lock-function-name-face)
2089 (list (concat slash headings-opt opt arg)
2090 (+ (regexp-opt-depth headings-opt) opt-depth arg-depth)
2091 'font-lock-function-name-face)
2092 ;;
2093 ;; Variable args.
2094 (list (concat slash variables arg)
2095 (+ (regexp-opt-depth variables) arg-depth)
2096 'font-lock-variable-name-face)
2097 ;;
2098 ;; Include args.
2099 (list (concat slash includes arg)
2100 (+ (regexp-opt-depth includes) arg-depth)
2101 'font-lock-builtin-face)
2102 (list (concat slash includes-opt opt arg)
2103 (+ (regexp-opt-depth includes-opt) opt-depth arg-depth)
2104 'font-lock-builtin-face)
2105 ;;
2106 ;; Definitions. I think.
2107 '("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)"
2108 1 font-lock-function-name-face)
2109 )))
2110 "Subdued expressions to highlight in TeX modes.")
2111
2112 (defconst tex-font-lock-keywords-2
2113 (append tex-font-lock-keywords-1
2114 (eval-when-compile
2115 (let* (;;
2116 ;; Names of commands whose arg should be fontified with fonts.
2117 (bold (regexp-opt '("bf" "textbf" "textsc" "textup"
2118 "boldsymbol" "pmb") t))
2119 (italic (regexp-opt '("it" "textit" "textsl" "emph") t))
2120 (type (regexp-opt '("texttt" "textmd" "textrm" "textsf") t))
2121 ;;
2122 ;; Names of commands whose arg should be fontified as a citation.
2123 (citations (regexp-opt
2124 '("label" "ref" "pageref" "vref" "eqref")
2125 t))
2126 (citations-opt (regexp-opt
2127 '("cite" "caption" "index" "glossary"
2128 "footnote" "footnotemark" "footnotetext")
2129 t))
2130 ;;
2131 ;; Names of commands that should be fontified.
2132 (specials (regexp-opt
2133 '("\\"
2134 "linebreak" "nolinebreak" "pagebreak" "nopagebreak"
2135 "newline" "newpage" "clearpage" "cleardoublepage"
2136 "displaybreak" "allowdisplaybreaks" "enlargethispage")
2137 t))
2138 (general "\\([a-zA-Z@]+\\**\\|[^ \t\n]\\)")
2139 ;;
2140 ;; Miscellany.
2141 (slash "\\\\")
2142 (opt "\\(\\[[^]]*\\]\\)?")
2143 (arg "{\\([^}]+\\)")
2144 (opt-depth (regexp-opt-depth opt))
2145 (arg-depth (regexp-opt-depth arg))
2146 )
2147 (list
2148 ;;
2149 ;; Citation args.
2150 (list (concat slash citations arg)
2151 (+ (regexp-opt-depth citations) arg-depth)
2152 'font-lock-reference-face)
2153 (list (concat slash citations-opt opt arg)
2154 (+ (regexp-opt-depth citations-opt) opt-depth arg-depth)
2155 'font-lock-reference-face)
2156 ;;
2157 ;; Command names, special and general.
2158 (cons (concat slash specials) 'font-lock-warning-face)
2159 (concat slash general)
2160 ;;
2161 ;; Font environments. It seems a bit dubious to use `bold' etc. faces
2162 ;; since we might not be able to display those fonts.
2163 (list (concat slash bold arg)
2164 (+ (regexp-opt-depth bold) arg-depth)
2165 '(quote bold) 'keep)
2166 (list (concat slash italic arg)
2167 (+ (regexp-opt-depth italic) arg-depth)
2168 '(quote italic) 'keep)
2169 (list (concat slash type arg)
2170 (+ (regexp-opt-depth type) arg-depth)
2171 '(quote bold-italic) 'keep)
2172 ;;
2173 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
2174 (list (concat "\\\\\\(\\(bf\\)\\|em\\|it\\(em\\)?\\|sl\\)\\>"
2175 "\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)")
2176 4 '(if (match-beginning 2) 'bold 'italic) 'keep)
2177 ))))
2178 "Gaudy expressions to highlight in TeX modes.")
2179
2180 (defvar tex-font-lock-keywords tex-font-lock-keywords-1
2181 "Default expressions to highlight in TeX modes.")
2182 \f
2183 ;;; User choices.
2184
2185 ;; These provide a means to fontify types not defined by the language. Those
2186 ;; types might be the user's own or they might be generally accepted and used.
2187 ;; Generally accepted types are used to provide default variable values.
2188
2189 (define-widget 'font-lock-extra-types-widget 'radio
2190 "Widget `:type' for members of the custom group `font-lock-extra-types'.
2191 Members should `:load' the package `font-lock' to use this widget."
2192 :args '((const :tag "none" nil)
2193 (repeat :tag "types" regexp)))
2194
2195 (defcustom c-font-lock-extra-types '("FILE" "\\sw+_t")
2196 "*List of extra types to fontify in C mode.
2197 Each list item should be a regexp not containing word-delimiters.
2198 For example, a value of (\"FILE\" \"\\\\sw+_t\") means the word FILE and words
2199 ending in _t are treated as type names.
2200
2201 The value of this variable is used when Font Lock mode is turned on."
2202 :type 'font-lock-extra-types-widget
2203 :group 'font-lock-extra-types)
2204
2205 (defcustom c++-font-lock-extra-types '("string" "wchar_t")
2206 "*List of extra types to fontify in C++ mode.
2207 Each list item should be a regexp not containing word-delimiters.
2208 For example, a value of (\"string\" \"wchar_t\") means the words string and
2209 wchar_t are treated as type names.
2210
2211 The value of this variable is used when Font Lock mode is turned on."
2212 :type 'font-lock-extra-types-widget
2213 :group 'font-lock-extra-types)
2214
2215 (defcustom objc-font-lock-extra-types '("Class" "BOOL" "IMP" "SEL")
2216 "*List of extra types to fontify in Objective-C mode.
2217 Each list item should be a regexp not containing word-delimiters.
2218 For example, a value of (\"Class\" \"BOOL\" \"IMP\" \"SEL\") means the words
2219 Class, BOOL, IMP and SEL are treated as type names.
2220
2221 The value of this variable is used when Font Lock mode is turned on."
2222 :type 'font-lock-extra-types-widget
2223 :group 'font-lock-extra-types)
2224
2225 (defcustom java-font-lock-extra-types '("[A-Z\300-\326\330-\337]\\sw+")
2226 "*List of extra types to fontify in Java mode.
2227 Each list item should be a regexp not containing word-delimiters.
2228 For example, a value of (\"[A-Z\300-\326\330-\337]\\\\sw+\") means capitalised
2229 words (and words conforming to the Java id spec) are treated as type names.
2230
2231 The value of this variable is used when Font Lock mode is turned on."
2232 :type 'font-lock-extra-types-widget
2233 :group 'font-lock-extra-types)
2234 \f
2235 ;;; C.
2236
2237 ;; [Murmur murmur murmur] Maestro, drum-roll please... [Murmur murmur murmur.]
2238 ;; Ahem. [Murmur murmur murmur] Lay-dees an Gennel-men. [Murmur murmur shhh!]
2239 ;; I am most proud and humbly honoured today [murmur murmur cough] to present
2240 ;; to you good people, the winner of the Second Millennium Award for The Most
2241 ;; Hairy Language Syntax. [Ahhh!] All rise please. [Shuffle shuffle
2242 ;; shuffle.] And a round of applause please. For... The C Language! [Roar.]
2243 ;;
2244 ;; Thank you... You are too kind... It is with a feeling of great privilege
2245 ;; and indeed emotion [sob] that I accept this award. It has been a long hard
2246 ;; road. But we know our destiny. And our future. For we must not rest.
2247 ;; There are more tokens to overload, more shoehorn, more methodologies. But
2248 ;; more is a plus! [Ha ha ha.] And more means plus! [Ho ho ho.] The future
2249 ;; is C++! [Ohhh!] The Third Millennium Award... Will be ours! [Roar.]
2250
2251 (defconst c-font-lock-keywords-1 nil
2252 "Subdued level highlighting for C mode.")
2253
2254 (defconst c-font-lock-keywords-2 nil
2255 "Medium level highlighting for C mode.
2256 See also `c-font-lock-extra-types'.")
2257
2258 (defconst c-font-lock-keywords-3 nil
2259 "Gaudy level highlighting for C mode.
2260 See also `c-font-lock-extra-types'.")
2261
2262 (let* ((c-keywords
2263 (eval-when-compile
2264 (regexp-opt '("break" "continue" "do" "else" "for" "if" "return"
2265 "switch" "while") t)))
2266 (c-type-types
2267 `(mapconcat 'identity
2268 (cons
2269 (,@ (eval-when-compile
2270 (regexp-opt
2271 '("auto" "extern" "register" "static" "typedef" "struct"
2272 "union" "enum" "signed" "unsigned" "short" "long"
2273 "int" "char" "float" "double" "void" "volatile" "const"))))
2274 c-font-lock-extra-types)
2275 "\\|"))
2276 (c-type-depth `(regexp-opt-depth (,@ c-type-types)))
2277 )
2278 (setq c-font-lock-keywords-1
2279 (list
2280 ;;
2281 ;; These are all anchored at the beginning of line for speed.
2282 ;; Note that `c++-font-lock-keywords-1' depends on `c-font-lock-keywords-1'.
2283 ;;
2284 ;; Fontify function name definitions (GNU style; without type on line).
2285 '("^\\(\\sw+\\)[ \t]*(" 1 font-lock-function-name-face)
2286 ;;
2287 ;; Fontify error directives.
2288 '("^#[ \t]*error[ \t]+\\(.+\\)" 1 font-lock-warning-face prepend)
2289 ;;
2290 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2291 '("^#[ \t]*\\(import\\|include\\)[ \t]+\\(<[^>\"\n]*>?\\)"
2292 2 font-lock-string-face)
2293 ;;
2294 ;; Fontify function macro names.
2295 '("^#[ \t]*define[ \t]+\\(\\sw+\\)(" 1 font-lock-function-name-face)
2296 ;;
2297 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2298 '("^#[ \t]*\\(elif\\|if\\)\\>"
2299 ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
2300 (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t)))
2301 ;;
2302 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2303 '("^#[ \t]*\\(\\sw+\\)\\>[ \t]*\\(\\sw+\\)?"
2304 (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t))
2305 ))
2306
2307 (setq c-font-lock-keywords-2
2308 (append c-font-lock-keywords-1
2309 (list
2310 ;;
2311 ;; Simple regexps for speed.
2312 ;;
2313 ;; Fontify all type specifiers.
2314 `(eval .
2315 (cons (concat "\\<\\(" (,@ c-type-types) "\\)\\>") 'font-lock-type-face))
2316 ;;
2317 ;; Fontify all builtin keywords (except case, default and goto; see below).
2318 (concat "\\<" c-keywords "\\>")
2319 ;;
2320 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2321 '("\\<\\(case\\|goto\\)\\>[ \t]*\\(-?\\sw+\\)?"
2322 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2323 ;; Anders Lindgren <andersl@csd.uu.se> points out that it is quicker to use
2324 ;; MATCH-ANCHORED to effectively anchor the regexp on the left.
2325 '(":" ("^[ \t]*\\(\\sw+\\)[ \t]*:"
2326 (beginning-of-line) (end-of-line)
2327 (1 font-lock-reference-face)))
2328 )))
2329
2330 (setq c-font-lock-keywords-3
2331 (append c-font-lock-keywords-2
2332 ;;
2333 ;; More complicated regexps for more complete highlighting for types.
2334 ;; We still have to fontify type specifiers individually, as C is so hairy.
2335 (list
2336 ;;
2337 ;; Fontify all storage classes and type specifiers, plus their items.
2338 `(eval .
2339 (list (concat "\\<\\(" (,@ c-type-types) "\\)\\>"
2340 "\\([ \t*&]+\\sw+\\>\\)*")
2341 ;; Fontify each declaration item.
2342 (list 'font-lock-match-c-style-declaration-item-and-skip-to-next
2343 ;; Start with point after all type specifiers.
2344 (list 'goto-char (list 'or (list 'match-beginning
2345 (+ (,@ c-type-depth) 2))
2346 '(match-end 1)))
2347 ;; Finish with point after first type specifier.
2348 '(goto-char (match-end 1))
2349 ;; Fontify as a variable or function name.
2350 '(1 (if (match-beginning 2)
2351 font-lock-function-name-face
2352 font-lock-variable-name-face)))))
2353 ;;
2354 ;; Fontify structures, or typedef names, plus their items.
2355 '("\\(}\\)[ \t*]*\\sw"
2356 (font-lock-match-c-style-declaration-item-and-skip-to-next
2357 (goto-char (match-end 1)) nil
2358 (1 (if (match-beginning 2)
2359 font-lock-function-name-face
2360 font-lock-variable-name-face))))
2361 ;;
2362 ;; Fontify anything at beginning of line as a declaration or definition.
2363 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
2364 (1 font-lock-type-face)
2365 (font-lock-match-c-style-declaration-item-and-skip-to-next
2366 (goto-char (or (match-beginning 2) (match-end 1))) nil
2367 (1 (if (match-beginning 2)
2368 font-lock-function-name-face
2369 font-lock-variable-name-face))))
2370 )))
2371 )
2372
2373 (defvar c-font-lock-keywords c-font-lock-keywords-1
2374 "Default expressions to highlight in C mode.
2375 See also `c-font-lock-extra-types'.")
2376 \f
2377 ;;; C++.
2378
2379 (defconst c++-font-lock-keywords-1 nil
2380 "Subdued level highlighting for C++ mode.")
2381
2382 (defconst c++-font-lock-keywords-2 nil
2383 "Medium level highlighting for C++ mode.
2384 See also `c++-font-lock-extra-types'.")
2385
2386 (defconst c++-font-lock-keywords-3 nil
2387 "Gaudy level highlighting for C++ mode.
2388 See also `c++-font-lock-extra-types'.")
2389
2390 (defun font-lock-match-c++-style-declaration-item-and-skip-to-next (limit)
2391 ;; Regexp matches after point: word<word>::word (
2392 ;; ^^^^ ^^^^ ^^^^ ^
2393 ;; Where the match subexpressions are: 1 3 5 6
2394 ;;
2395 ;; Item is delimited by (match-beginning 1) and (match-end 1).
2396 ;; If (match-beginning 3) is non-nil, that part of the item incloses a `<>'.
2397 ;; If (match-beginning 5) is non-nil, that part of the item follows a `::'.
2398 ;; If (match-beginning 6) is non-nil, the item is followed by a `('.
2399 (when (looking-at (eval-when-compile
2400 (concat
2401 ;; Skip any leading whitespace.
2402 "[ \t*&]*"
2403 ;; This is `c++-type-spec' from below. (Hint hint!)
2404 "\\(\\sw+\\)" ; The instance?
2405 "\\([ \t]*<\\([^>\n]+\\)[ \t*&]*>\\)?" ; Or template?
2406 "\\([ \t]*::[ \t*~]*\\(\\sw+\\)\\)?" ; Or member?
2407 ;; Match any trailing parenthesis.
2408 "[ \t]*\\((\\)?")))
2409 (save-match-data
2410 (condition-case nil
2411 (save-restriction
2412 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2413 (narrow-to-region (point-min) limit)
2414 (goto-char (match-end 1))
2415 ;; Move over any item value, etc., to the next item.
2416 (while (not (looking-at "[ \t]*\\(\\(,\\)\\|;\\|$\\)"))
2417 (goto-char (or (scan-sexps (point) 1) (point-max))))
2418 (goto-char (match-end 2)))
2419 (error t)))))
2420
2421 (let* ((c++-keywords
2422 (eval-when-compile
2423 (regexp-opt
2424 '("break" "continue" "do" "else" "for" "if" "return" "switch"
2425 "while" "asm" "catch" "delete" "new" "operator" "sizeof" "this"
2426 "throw" "try"
2427 ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new.
2428 "static_cast" "dynamic_cast" "const_cast" "reinterpret_cast") t)))
2429 (c++-operators
2430 (eval-when-compile
2431 (regexp-opt
2432 ;; Taken from Stroustrup, minus keywords otherwise fontified.
2433 '("+" "-" "*" "/" "%" "^" "&" "|" "~" "!" "=" "<" ">" "+=" "-="
2434 "*=" "/=" "%=" "^=" "&=" "|=" "<<" ">>" ">>=" "<<=" "==" "!="
2435 "<=" ">=" "&&" "||" "++" "--" "->*" "," "->" "[]" "()"))))
2436 (c++-type-types
2437 `(mapconcat 'identity
2438 (cons
2439 (,@ (eval-when-compile
2440 (regexp-opt
2441 '("auto" "extern" "register" "static" "typedef" "struct"
2442 "union" "enum" "signed" "unsigned" "short" "long"
2443 "int" "char" "float" "double" "void" "volatile" "const"
2444 "inline" "friend" "bool" "virtual" "complex" "template"
2445 "namespace" "using"
2446 ;; Mark Mitchell <mmitchell@usa.net> says these are new.
2447 "explicit" "mutable"))))
2448 c++-font-lock-extra-types)
2449 "\\|"))
2450 ;;
2451 ;; A brave attempt to match templates following a type and/or match
2452 ;; class membership. See and sync the above function
2453 ;; `font-lock-match-c++-style-declaration-item-and-skip-to-next'.
2454 (c++-type-suffix (concat "\\([ \t]*<\\([^>\n]+\\)[ \t*&]*>\\)?"
2455 "\\([ \t]*::[ \t*~]*\\(\\sw+\\)\\)?"))
2456 ;; If the string is a type, it may be followed by the cruft above.
2457 (c++-type-spec (concat "\\(\\sw+\\)\\>" c++-type-suffix))
2458 ;;
2459 ;; Parenthesis depth of user-defined types not forgetting their cruft.
2460 (c++-type-depth `(regexp-opt-depth
2461 (concat (,@ c++-type-types) (,@ c++-type-suffix))))
2462 )
2463 (setq c++-font-lock-keywords-1
2464 (append
2465 ;;
2466 ;; The list `c-font-lock-keywords-1' less that for function names.
2467 (cdr c-font-lock-keywords-1)
2468 (list
2469 ;;
2470 ;; Class names etc.
2471 (list (concat "\\<\\(class\\|public\\|private\\|protected\\)\\>[ \t]*"
2472 "\\(" c++-type-spec "\\)?")
2473 '(1 font-lock-type-face)
2474 '(3 (if (match-beginning 6)
2475 font-lock-type-face
2476 font-lock-function-name-face) nil t)
2477 '(5 font-lock-function-name-face nil t)
2478 '(7 font-lock-function-name-face nil t))
2479 ;;
2480 ;; Fontify function name definitions, possibly incorporating class names.
2481 (list (concat "^" c++-type-spec "[ \t]*(")
2482 '(1 (if (or (match-beginning 2) (match-beginning 4))
2483 font-lock-type-face
2484 font-lock-function-name-face))
2485 '(3 font-lock-function-name-face nil t)
2486 '(5 font-lock-function-name-face nil t))
2487 )))
2488
2489 (setq c++-font-lock-keywords-2
2490 (append c++-font-lock-keywords-1
2491 (list
2492 ;;
2493 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2494 `(eval .
2495 (cons (concat "\\<\\(" (,@ c++-type-types) "\\)\\>")
2496 'font-lock-type-face))
2497 ;;
2498 ;; Fontify operator overloading.
2499 (list (concat "\\<\\(operator\\)\\>[ \t]*\\(" c++-operators "\\)?")
2500 '(1 font-lock-keyword-face)
2501 '(2 font-lock-builtin-face nil t))
2502 ;;
2503 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2504 '("\\<\\(case\\|goto\\)\\>[ \t]*\\(-?\\sw+\\)?"
2505 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2506 '(":" ("^[ \t]*\\(\\sw+\\)[ \t]*:\\($\\|[^:]\\)"
2507 (beginning-of-line) (end-of-line)
2508 (1 font-lock-reference-face)))
2509 ;;
2510 ;; Fontify other builtin keywords.
2511 (concat "\\<" c++-keywords "\\>")
2512 ;;
2513 ;; Eric Hopper <hopper@omnifarious.mn.org> says `true' and `false' are new.
2514 '("\\<\\(false\\|true\\)\\>" . font-lock-reference-face)
2515 )))
2516
2517 (setq c++-font-lock-keywords-3
2518 (append c++-font-lock-keywords-2
2519 ;;
2520 ;; More complicated regexps for more complete highlighting for types.
2521 (list
2522 ;;
2523 ;; Fontify all storage classes and type specifiers, plus their items.
2524 `(eval .
2525 (list (concat "\\<\\(" (,@ c++-type-types) "\\)\\>" (,@ c++-type-suffix)
2526 "\\([ \t*&]+" (,@ c++-type-spec) "\\)*")
2527 ;; Fontify each declaration item.
2528 (list 'font-lock-match-c++-style-declaration-item-and-skip-to-next
2529 ;; Start with point after all type specifiers.
2530 (list 'goto-char (list 'or (list 'match-beginning
2531 (+ (,@ c++-type-depth) 2))
2532 '(match-end 1)))
2533 ;; Finish with point after first type specifier.
2534 '(goto-char (match-end 1))
2535 ;; Fontify as a variable or function name.
2536 '(1 (cond ((or (match-beginning 2) (match-beginning 4))
2537 font-lock-type-face)
2538 ((match-beginning 6) font-lock-function-name-face)
2539 (t font-lock-variable-name-face)))
2540 '(3 font-lock-function-name-face nil t)
2541 '(5 (if (match-beginning 6)
2542 font-lock-function-name-face
2543 font-lock-variable-name-face) nil t))))
2544 ;;
2545 ;; Fontify structures, or typedef names, plus their items.
2546 '("\\(}\\)[ \t*]*\\sw"
2547 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2548 (goto-char (match-end 1)) nil
2549 (1 (if (match-beginning 6)
2550 font-lock-function-name-face
2551 font-lock-variable-name-face))))
2552 ;;
2553 ;; Fontify anything at beginning of line as a declaration or definition.
2554 (list (concat "^\\(" c++-type-spec "[ \t*&]*\\)+")
2555 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
2556 (goto-char (match-beginning 1))
2557 (goto-char (match-end 1))
2558 (1 (cond ((or (match-beginning 2) (match-beginning 4))
2559 font-lock-type-face)
2560 ((match-beginning 6) font-lock-function-name-face)
2561 (t font-lock-variable-name-face)))
2562 (3 font-lock-function-name-face nil t)
2563 (5 (if (match-beginning 6)
2564 font-lock-function-name-face
2565 font-lock-variable-name-face) nil t)))
2566 )))
2567 )
2568
2569 (defvar c++-font-lock-keywords c++-font-lock-keywords-1
2570 "Default expressions to highlight in C++ mode.
2571 See also `c++-font-lock-extra-types'.")
2572 \f
2573 ;;; Objective-C.
2574
2575 (defconst objc-font-lock-keywords-1 nil
2576 "Subdued level highlighting for Objective-C mode.")
2577
2578 (defconst objc-font-lock-keywords-2 nil
2579 "Medium level highlighting for Objective-C mode.
2580 See also `objc-font-lock-extra-types'.")
2581
2582 (defconst objc-font-lock-keywords-3 nil
2583 "Gaudy level highlighting for Objective-C mode.
2584 See also `objc-font-lock-extra-types'.")
2585
2586 ;; Regexps written with help from Stephen Peters <speters@us.oracle.com> and
2587 ;; Jacques Duthen Prestataire <duthen@cegelec-red.fr>.
2588 (let* ((objc-keywords
2589 (eval-when-compile
2590 (regexp-opt '("break" "continue" "do" "else" "for" "if" "return"
2591 "switch" "while" "sizeof" "self" "super") t)))
2592 (objc-type-types
2593 `(mapconcat 'identity
2594 (cons
2595 (,@ (eval-when-compile
2596 (regexp-opt
2597 '("auto" "extern" "register" "static" "typedef" "struct"
2598 "union" "enum" "signed" "unsigned" "short" "long"
2599 "int" "char" "float" "double" "void" "volatile" "const"
2600 "id" "oneway" "in" "out" "inout" "bycopy" "byref"))))
2601 objc-font-lock-extra-types)
2602 "\\|"))
2603 (objc-type-depth `(regexp-opt-depth (,@ objc-type-types)))
2604 )
2605 (setq objc-font-lock-keywords-1
2606 (append
2607 ;;
2608 ;; The list `c-font-lock-keywords-1' less that for function names.
2609 (cdr c-font-lock-keywords-1)
2610 (list
2611 ;;
2612 ;; Fontify compiler directives.
2613 '("@\\(\\sw+\\)\\>"
2614 (1 font-lock-keyword-face)
2615 ("\\=[ \t:<(,]*\\(\\sw+\\)" nil nil
2616 (1 font-lock-function-name-face)))
2617 ;;
2618 ;; Fontify method names and arguments. Oh Lordy!
2619 ;; First, on the same line as the function declaration.
2620 '("^[+-][ \t]*\\(PRIVATE\\)?[ \t]*\\((\\([^)\n]+\\))\\)?[ \t]*\\(\\sw+\\)"
2621 (1 font-lock-type-face nil t)
2622 (3 font-lock-type-face nil t)
2623 (4 font-lock-function-name-face)
2624 ("\\=[ \t]*\\(\\sw+\\)?:[ \t]*\\((\\([^)\n]+\\))\\)?[ \t]*\\(\\sw+\\)"
2625 nil nil
2626 (1 font-lock-function-name-face nil t)
2627 (3 font-lock-type-face nil t)
2628 (4 font-lock-variable-name-face)))
2629 ;; Second, on lines following the function declaration.
2630 '(":" ("^[ \t]*\\(\\sw+\\)?:[ \t]*\\((\\([^)\n]+\\))\\)?[ \t]*\\(\\sw+\\)"
2631 (beginning-of-line) (end-of-line)
2632 (1 font-lock-function-name-face nil t)
2633 (3 font-lock-type-face nil t)
2634 (4 font-lock-variable-name-face)))
2635 )))
2636
2637 (setq objc-font-lock-keywords-2
2638 (append objc-font-lock-keywords-1
2639 (list
2640 ;;
2641 ;; Simple regexps for speed.
2642 ;;
2643 ;; Fontify all type specifiers.
2644 `(eval .
2645 (cons (concat "\\<\\(" (,@ objc-type-types) "\\)\\>")
2646 'font-lock-type-face))
2647 ;;
2648 ;; Fontify all builtin keywords (except case, default and goto; see below).
2649 (concat "\\<" objc-keywords "\\>")
2650 ;;
2651 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2652 '("\\<\\(case\\|goto\\)\\>[ \t]*\\(-?\\sw+\\)?"
2653 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2654 ;; Fontify tags iff sole statement on line, otherwise we detect selectors.
2655 '(":" ("^[ \t]*\\(\\sw+\\)[ \t]*:[ \t]*$"
2656 (beginning-of-line) (end-of-line)
2657 (1 font-lock-reference-face)))
2658 ;;
2659 ;; Fontify null object pointers.
2660 '("\\<\\(Nil\\|nil\\)\\>" 1 font-lock-reference-face)
2661 )))
2662
2663 (setq objc-font-lock-keywords-3
2664 (append objc-font-lock-keywords-2
2665 ;;
2666 ;; More complicated regexps for more complete highlighting for types.
2667 ;; We still have to fontify type specifiers individually, as C is so hairy.
2668 (list
2669 ;;
2670 ;; Fontify all storage classes and type specifiers, plus their items.
2671 `(eval .
2672 (list (concat "\\<\\(" (,@ objc-type-types) "\\)\\>"
2673 "\\([ \t*&]+\\sw+\\>\\)*")
2674 ;; Fontify each declaration item.
2675 (list 'font-lock-match-c-style-declaration-item-and-skip-to-next
2676 ;; Start with point after all type specifiers.
2677 (list 'goto-char (list 'or (list 'match-beginning
2678 (+ (,@ objc-type-depth) 2))
2679 '(match-end 1)))
2680 ;; Finish with point after first type specifier.
2681 '(goto-char (match-end 1))
2682 ;; Fontify as a variable or function name.
2683 '(1 (if (match-beginning 2)
2684 font-lock-function-name-face
2685 font-lock-variable-name-face)))))
2686 ;;
2687 ;; Fontify structures, or typedef names, plus their items.
2688 '("\\(}\\)[ \t*]*\\sw"
2689 (font-lock-match-c-style-declaration-item-and-skip-to-next
2690 (goto-char (match-end 1)) nil
2691 (1 (if (match-beginning 2)
2692 font-lock-function-name-face
2693 font-lock-variable-name-face))))
2694 ;;
2695 ;; Fontify anything at beginning of line as a declaration or definition.
2696 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
2697 (1 font-lock-type-face)
2698 (font-lock-match-c-style-declaration-item-and-skip-to-next
2699 (goto-char (or (match-beginning 2) (match-end 1))) nil
2700 (1 (if (match-beginning 2)
2701 font-lock-function-name-face
2702 font-lock-variable-name-face))))
2703 )))
2704 )
2705
2706 (defvar objc-font-lock-keywords objc-font-lock-keywords-1
2707 "Default expressions to highlight in Objective-C mode.
2708 See also `objc-font-lock-extra-types'.")
2709 \f
2710 ;;; Java.
2711
2712 (defconst java-font-lock-keywords-1 nil
2713 "Subdued level highlighting for Java mode.")
2714
2715 (defconst java-font-lock-keywords-2 nil
2716 "Medium level highlighting for Java mode.
2717 See also `java-font-lock-extra-types'.")
2718
2719 (defconst java-font-lock-keywords-3 nil
2720 "Gaudy level highlighting for Java mode.
2721 See also `java-font-lock-extra-types'.")
2722
2723 ;; Regexps written with help from Fred White <fwhite@bbn.com> and
2724 ;; Anders Lindgren <andersl@csd.uu.se>.
2725 (let* ((java-keywords
2726 (eval-when-compile
2727 (regexp-opt
2728 '("catch" "do" "else" "super" "this" "finally" "for" "if"
2729 ;; Anders Lindgren <andersl@csd.uu.se> says these have gone.
2730 ;; "cast" "byvalue" "future" "generic" "operator" "var"
2731 ;; "inner" "outer" "rest"
2732 "interface" "return" "switch" "throw" "try" "while") t)))
2733 ;;
2734 ;; These are immediately followed by an object name.
2735 (java-minor-types
2736 (eval-when-compile
2737 (regexp-opt '("boolean" "char" "byte" "short" "int" "long"
2738 "float" "double" "void"))))
2739 ;;
2740 ;; These are eventually followed by an object name.
2741 (java-major-types
2742 (eval-when-compile
2743 (regexp-opt
2744 '("abstract" "const" "final" "synchronized" "transient" "static"
2745 ;; Anders Lindgren <andersl@csd.uu.se> says this has gone.
2746 ;; "threadsafe"
2747 "volatile" "public" "private" "protected" "native"))))
2748 ;;
2749 ;; Random types immediately followed by an object name.
2750 (java-other-types
2751 '(mapconcat 'identity (cons "\\sw+\\.\\sw+" java-font-lock-extra-types)
2752 "\\|"))
2753 (java-other-depth `(regexp-opt-depth (,@ java-other-types)))
2754 )
2755 (setq java-font-lock-keywords-1
2756 (list
2757 ;;
2758 ;; Fontify class names.
2759 '("\\<\\(class\\)\\>[ \t]*\\(\\sw+\\)?"
2760 (1 font-lock-type-face) (2 font-lock-function-name-face nil t))
2761 ;;
2762 ;; Fontify package names in import directives.
2763 '("\\<\\(import\\|package\\)\\>[ \t]*\\(\\sw+\\)?"
2764 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2765 ))
2766
2767 (setq java-font-lock-keywords-2
2768 (append java-font-lock-keywords-1
2769 (list
2770 ;;
2771 ;; Fontify all builtin type specifiers.
2772 (cons (concat "\\<\\(" java-minor-types "\\|" java-major-types "\\)\\>")
2773 'font-lock-type-face)
2774 ;;
2775 ;; Fontify all builtin keywords (except below).
2776 (concat "\\<" java-keywords "\\>")
2777 ;;
2778 ;; Fontify keywords and targets, and case default/goto tags.
2779 (list "\\<\\(break\\|case\\|continue\\|goto\\)\\>[ \t]*\\(-?\\sw+\\)?"
2780 '(1 font-lock-keyword-face) '(2 font-lock-reference-face nil t))
2781 '(":" ("^[ \t]*\\(\\sw+\\)[ \t]*:"
2782 (beginning-of-line) (end-of-line)
2783 (1 font-lock-reference-face)))
2784 ;;
2785 ;; Fontify keywords and types; the first can be followed by a type list.
2786 (list (concat "\\<\\("
2787 "implements\\|throws\\|"
2788 "\\(extends\\|instanceof\\|new\\)"
2789 "\\)\\>[ \t]*\\(\\sw+\\)?")
2790 '(1 font-lock-keyword-face) '(3 font-lock-type-face nil t)
2791 '("\\=[ \t]*,[ \t]*\\(\\sw+\\)"
2792 (if (match-beginning 2) (goto-char (match-end 2))) nil
2793 (1 font-lock-type-face)))
2794 ;;
2795 ;; Fontify all constants.
2796 '("\\<\\(false\\|null\\|true\\)\\>" . font-lock-reference-face)
2797 ;;
2798 ;; Javadoc tags within comments.
2799 '("@\\(author\\|exception\\|return\\|see\\|version\\)\\>"
2800 (1 font-lock-reference-face prepend))
2801 '("@\\(param\\)\\>[ \t]*\\(\\sw+\\)?"
2802 (1 font-lock-reference-face prepend)
2803 (2 font-lock-variable-name-face prepend t))
2804 )))
2805
2806 (setq java-font-lock-keywords-3
2807 (append java-font-lock-keywords-2
2808 ;;
2809 ;; More complicated regexps for more complete highlighting for types.
2810 ;; We still have to fontify type specifiers individually, as Java is hairy.
2811 (list
2812 ;;
2813 ;; Fontify random types in casts.
2814 `(eval .
2815 (list (concat "(\\(" (,@ java-other-types) "\\))"
2816 "[ \t]*\\(\\sw\\|[\"\(]\\)")
2817 ;; Fontify the type name.
2818 '(1 font-lock-type-face)))
2819 ;;
2820 ;; Fontify random types immediately followed by an item or items.
2821 `(eval .
2822 (list (concat "\\<\\(" (,@ java-other-types) "\\)\\>"
2823 "\\([ \t]*\\[[ \t]*\\]\\)*"
2824 "[ \t]*\\sw")
2825 ;; Fontify the type name.
2826 '(1 font-lock-type-face)))
2827 `(eval .
2828 (list (concat "\\<\\(" (,@ java-other-types) "\\)\\>"
2829 "\\([ \t]*\\[[ \t]*\\]\\)*"
2830 "\\([ \t]*\\sw\\)")
2831 ;; Fontify each declaration item.
2832 (list 'font-lock-match-c-style-declaration-item-and-skip-to-next
2833 ;; Start and finish with point after the type specifier.
2834 (list 'goto-char (list 'match-beginning
2835 (+ (,@ java-other-depth) 3)))
2836 (list 'goto-char (list 'match-beginning
2837 (+ (,@ java-other-depth) 3)))
2838 ;; Fontify as a variable or function name.
2839 '(1 (if (match-beginning 2)
2840 font-lock-function-name-face
2841 font-lock-variable-name-face)))))
2842 ;;
2843 ;; Fontify those that are immediately followed by an item or items.
2844 (list (concat "\\<\\(" java-minor-types "\\)\\>"
2845 "\\([ \t]*\\[[ \t]*\\]\\)*")
2846 ;; Fontify each declaration item.
2847 '(font-lock-match-c-style-declaration-item-and-skip-to-next
2848 ;; Start and finish with point after the type specifier.
2849 nil (goto-char (match-end 0))
2850 ;; Fontify as a variable or function name.
2851 (1 (if (match-beginning 2)
2852 font-lock-function-name-face
2853 font-lock-variable-name-face))))
2854 ;;
2855 ;; Fontify those that are eventually followed by an item or items.
2856 (list (concat "\\<\\(" java-major-types "\\)\\>"
2857 "\\([ \t]+\\sw+\\>"
2858 "\\([ \t]*\\[[ \t]*\\]\\)*"
2859 "\\)*")
2860 ;; Fontify each declaration item.
2861 '(font-lock-match-c-style-declaration-item-and-skip-to-next
2862 ;; Start with point after all type specifiers.
2863 (goto-char (or (match-beginning 5) (match-end 1)))
2864 ;; Finish with point after first type specifier.
2865 (goto-char (match-end 1))
2866 ;; Fontify as a variable or function name.
2867 (1 (if (match-beginning 2)
2868 font-lock-function-name-face
2869 font-lock-variable-name-face))))
2870 )))
2871 )
2872
2873 (defvar java-font-lock-keywords java-font-lock-keywords-1
2874 "Default expressions to highlight in Java mode.
2875 See also `java-font-lock-extra-types'.")
2876 \f
2877 ;; Install ourselves:
2878
2879 (unless (assq 'font-lock-mode minor-mode-alist)
2880 (push '(font-lock-mode nil) minor-mode-alist))
2881
2882 ;; Provide ourselves:
2883
2884 (provide 'font-lock)
2885
2886 ;;; font-lock.el ends here