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