(local-variables-section): Deleted.
[bpt/emacs.git] / lisp / font-lock.el
CommitLineData
876f2438
SM
1;;; font-lock.el --- Electric font lock mode
2
a2b8e66b 3;; Copyright (C) 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
030f4a35 4
9bfbb130 5;; Author: jwz, then rms, then sm <simon@gnu.ai.mit.edu>
030f4a35
RS
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
b578f267
EN
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.
030f4a35 25
030f4a35
RS
26;;; Commentary:
27
b89e1134
SM
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.
030f4a35
RS
30;;
31;; Comments will be displayed in `font-lock-comment-face'.
32;; Strings will be displayed in `font-lock-string-face'.
a1eb1cf1 33;; Regexps are used to display selected patterns in other faces.
030f4a35 34;;
9bfbb130
SM
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.
030f4a35 38;;
a2b8e66b 39;; To turn Font Lock mode on automatically, add this to your ~/.emacs file:
030f4a35 40;;
b89e1134 41;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock)
030f4a35 42;;
a2b8e66b
SM
43;; Or if you want to turn Font Lock mode on in many modes:
44;;
45;; (global-font-lock-mode t)
46;;
9bfbb130
SM
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'.
51
b89e1134
SM
52;; If you add patterns for a new mode, say foo.el's `foo-mode', say in which
53;; you don't want syntactic fontification to occur, you can make Font Lock mode
54;; use your regexps when turning on Font Lock by adding to `foo-mode-hook':
55;;
56;; (add-hook 'foo-mode-hook
57;; '(lambda () (make-local-variable 'font-lock-defaults)
58;; (setq font-lock-defaults '(foo-font-lock-keywords t))))
59;;
a1eb1cf1
RS
60;; Nasty regexps of the form "bar\\(\\|lo\\)\\|f\\(oo\\|u\\(\\|bar\\)\\)\\|lo"
61;; are made thusly: (make-regexp '("foo" "fu" "fubar" "bar" "barlo" "lo")) for
62;; efficiency. See /pub/gnu/emacs/elisp-archive/functions/make-regexp.el.Z on
63;; archive.cis.ohio-state.edu for this and other functions.
9bfbb130
SM
64
65;; What is fontification for? You might say, "It's to make my code look nice."
66;; I think it should be for adding information in the form of cues. These cues
67;; should provide you with enough information to both (a) distinguish between
68;; different items, and (b) identify the item meanings, without having to read
69;; the items and think about it. Therefore, fontification allows you to think
70;; less about, say, the structure of code, and more about, say, why the code
71;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
72;;
73;; So, here are my opinions/advice/guidelines:
74;;
7d7d915a
SM
75;; - Highlight conceptual objects, such as function and variable names, and
76;; different objects types differently, i.e., (a) and (b) above, highlight
77;; function names differently to variable names.
78;; - Keep the faces distinct from each other as far as possible.
79;; i.e., (a) above.
9bfbb130
SM
80;; - Use the same face for the same conceptual object, across all modes.
81;; i.e., (b) above, all modes that have items that can be thought of as, say,
82;; keywords, should be highlighted with the same face, etc.
9bfbb130
SM
83;; - Make the face attributes fit the concept as far as possible.
84;; i.e., function names might be a bold colour such as blue, comments might
85;; be a bright colour such as red, character strings might be brown, because,
86;; err, strings are brown (that was not the reason, please believe me).
87;; - Don't use a non-nil OVERRIDE unless you have a good reason.
88;; Only use OVERRIDE for special things that are easy to define, such as the
89;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
90;; Don't use it to, say, highlight keywords in commented out code or strings.
91;; - Err, that's it.
a1eb1cf1 92\f
9bfbb130
SM
93;; User variables.
94
95(defvar font-lock-verbose t
96 "*If non-nil, means show status messages when fontifying.")
97
98;;;###autoload
99(defvar font-lock-maximum-decoration nil
2d9cdda8 100 "*Maximum decoration level for fontification.
9bfbb130
SM
101If nil, use the default decoration (typically the minimum available).
102If t, use the maximum decoration available.
103If a number, use that level of decoration (or if not available the maximum).
104If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
105where MAJOR-MODE is a symbol or t (meaning the default). For example:
106 ((c++-mode . 2) (c-mode . t) (t . 1))
107means use level 2 decoration for buffers in `c++-mode', the maximum decoration
108available for buffers in `c-mode', and level 1 decoration otherwise.")
030f4a35 109
9bfbb130
SM
110;;;###autoload
111(defvar font-lock-maximum-size (* 250 1024)
2d9cdda8 112 "*Maximum size of a buffer for buffer fontification.
9bfbb130
SM
113Only buffers less than this can be fontified when Font Lock mode is turned on.
114If nil, means size is irrelevant.
115If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
116where MAJOR-MODE is a symbol or t (meaning the default). For example:
117 ((c++-mode . 256000) (c-mode . 256000) (rmail-mode . 1048576))
118means that the maximum size is 250K for buffers in `c++-mode' or `c-mode', one
119megabyte for buffers in `rmail-mode', and size is irrelevant otherwise.")
120\f
121;; Fontification variables:
122
123(defvar font-lock-comment-face 'font-lock-comment-face
a1eb1cf1 124 "Face to use for comments.")
030f4a35 125
9bfbb130 126(defvar font-lock-string-face 'font-lock-string-face
a1eb1cf1 127 "Face to use for strings.")
030f4a35 128
9bfbb130
SM
129(defvar font-lock-keyword-face 'font-lock-keyword-face
130 "Face to use for keywords.")
131
132(defvar font-lock-function-name-face 'font-lock-function-name-face
030f4a35
RS
133 "Face to use for function names.")
134
9bfbb130 135(defvar font-lock-variable-name-face 'font-lock-variable-name-face
a1eb1cf1
RS
136 "Face to use for variable names.")
137
9bfbb130
SM
138(defvar font-lock-type-face 'font-lock-type-face
139 "Face to use for type names.")
030f4a35 140
9bfbb130
SM
141(defvar font-lock-reference-face 'font-lock-reference-face
142 "Face to use for reference names.")
a1eb1cf1 143
030f4a35 144(defvar font-lock-keywords nil
d46c21ec
SM
145 "*A list of the keywords to highlight.
146Each element should be of the form:
a1eb1cf1 147
826b2925
SM
148 MATCHER
149 (MATCHER . MATCH)
150 (MATCHER . FACENAME)
151 (MATCHER . HIGHLIGHT)
152 (MATCHER HIGHLIGHT ...)
a078558d 153 (eval . FORM)
a1eb1cf1 154
9bfbb130
SM
155where HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
156
a078558d
SM
157FORM is an expression, whose value should be a keyword element, evaluated when
158the keyword is (first) used in a buffer. This feature can be used to provide a
159keyword that can only be generated when Font Lock mode is actually turned on.
160
9bfbb130 161For highlighting single items, typically only MATCH-HIGHLIGHT is required.
d9f7b2d3 162However, if an item or (typically) items are to be highlighted following the
9bfbb130
SM
163instance of another item (the anchor) then MATCH-ANCHORED may be required.
164
165MATCH-HIGHLIGHT should be of the form:
166
167 (MATCH FACENAME OVERRIDE LAXMATCH)
168
169Where MATCHER can be either the regexp to search for, or the function name to
170call to make the search (called with one argument, the limit of the search).
171MATCH is the subexpression of MATCHER to be highlighted. FACENAME is an
172expression whose value is the face name to use. FACENAME's default attributes
173may be defined in `font-lock-face-attributes'.
a1eb1cf1
RS
174
175OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification may
9bfbb130
SM
176be overwritten. If `keep', only parts not already fontified are highlighted.
177If `prepend' or `append', existing fontification is merged with the new, in
178which the new or existing fontification, respectively, takes precedence.
d9f7b2d3 179If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER.
a1eb1cf1 180
9bfbb130
SM
181For example, an element of the form highlights (if not already highlighted):
182
876f2438
SM
183 \"\\\\\\=<foo\\\\\\=>\" Discrete occurrences of \"foo\" in the value of the
184 variable `font-lock-keyword-face'.
9bfbb130
SM
185 (\"fu\\\\(bar\\\\)\" . 1) Substring \"bar\" within all occurrences of \"fubar\" in
186 the value of `font-lock-keyword-face'.
187 (\"fubar\" . fubar-face) Occurrences of \"fubar\" in the value of `fubar-face'.
188 (\"foo\\\\|bar\" 0 foo-bar-face t)
189 Occurrences of either \"foo\" or \"bar\" in the value
190 of `foo-bar-face', even if already highlighted.
191
192MATCH-ANCHORED should be of the form:
193
194 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
195
876f2438
SM
196Where MATCHER is as for MATCH-HIGHLIGHT with one exception. The limit of the
197search is currently guaranteed to be (no greater than) the end of the line.
198PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
199the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
200used to initialise before, and cleanup after, MATCHER is used. Typically,
201PRE-MATCH-FORM is used to move to some position relative to the original
202MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
203be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
9bfbb130
SM
204
205For example, an element of the form highlights (if not already highlighted):
206
876f2438 207 (\"\\\\\\=<anchor\\\\\\=>\" (0 anchor-face) (\"\\\\\\=<item\\\\\\=>\" nil nil (0 item-face)))
9bfbb130 208
876f2438
SM
209 Discrete occurrences of \"anchor\" in the value of `anchor-face', and subsequent
210 discrete occurrences of \"item\" (on the same line) in the value of `item-face'.
211 (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil. Therefore \"item\" is
212 initially searched for starting from the end of the match of \"anchor\", and
213 searching for subsequent instance of \"anchor\" resumes from where searching
214 for \"item\" concluded.)
9bfbb130
SM
215
216Note that the MATCH-ANCHORED feature is experimental; in the future, we may
217replace it with other ways of providing this functionality.
218
a1eb1cf1
RS
219These regular expressions should not match text which spans lines. While
220\\[font-lock-fontify-buffer] handles multi-line patterns correctly, updating
221when you edit the buffer does not, since it considers text one line at a time.
222
9bfbb130 223Be very careful composing regexps for this list;
a1eb1cf1 224the wrong pattern can dramatically slow things down!")
9bfbb130 225(make-variable-buffer-local 'font-lock-keywords)
030f4a35 226
b89e1134
SM
227(defvar font-lock-defaults nil
228 "If set by a major mode, should be the defaults for Font Lock mode.
9bfbb130 229The value should be like the `cdr' of an item in `font-lock-defaults-alist'.")
b89e1134
SM
230
231(defvar font-lock-defaults-alist
9bfbb130
SM
232 (let (;; For C and Lisp modes we use `beginning-of-defun', rather than nil,
233 ;; for SYNTAX-BEGIN. Thus the calculation of the cache is usually
234 ;; faster but not infallible, so we risk mis-fontification. --sm.
fb512de9 235 (c-mode-defaults
9bfbb130
SM
236 '((c-font-lock-keywords c-font-lock-keywords-1
237 c-font-lock-keywords-2 c-font-lock-keywords-3)
a078558d
SM
238 nil nil ((?_ . "w")) beginning-of-defun
239 (font-lock-mark-block-function . mark-defun)))
fb512de9
SM
240 (c++-mode-defaults
241 '((c++-font-lock-keywords c++-font-lock-keywords-1
9bfbb130 242 c++-font-lock-keywords-2 c++-font-lock-keywords-3)
a078558d
SM
243 nil nil ((?_ . "w") (?~ . "w")) beginning-of-defun
244 (font-lock-mark-block-function . mark-defun)))
fb512de9 245 (lisp-mode-defaults
9bfbb130
SM
246 '((lisp-font-lock-keywords
247 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
248 nil nil
249 ((?: . "w") (?- . "w") (?* . "w") (?+ . "w") (?. . "w") (?< . "w")
250 (?> . "w") (?= . "w") (?! . "w") (?? . "w") (?$ . "w") (?% . "w")
251 (?_ . "w") (?& . "w") (?~ . "w") (?^ . "w") (?/ . "w"))
a078558d 252 beginning-of-defun (font-lock-mark-block-function . mark-defun)))
d46c21ec 253 (scheme-mode-defaults
9bfbb130
SM
254 '(scheme-font-lock-keywords nil t
255 ((?: . "w") (?- . "w") (?* . "w") (?+ . "w") (?. . "w") (?< . "w")
256 (?> . "w") (?= . "w") (?! . "w") (?? . "w") (?$ . "w") (?% . "w")
257 (?_ . "w") (?& . "w") (?~ . "w") (?^ . "w") (?/ . "w"))
a078558d 258 beginning-of-defun (font-lock-mark-block-function . mark-defun)))
d46c21ec 259 ;; For TeX modes we could use `backward-paragraph' for the same reason.
a078558d
SM
260 ;; But we don't, because paragraph breaks are arguably likely enough to
261 ;; occur within a genuine syntactic block to make it too risky.
262 ;; However, we do specify a MARK-BLOCK function as that cannot result
263 ;; in a mis-fontification even if it might not fontify enough. --sm.
264 (tex-mode-defaults '(tex-font-lock-keywords nil nil ((?$ . "\"")) nil
265 (font-lock-mark-block-function . mark-paragraph)))
d46c21ec 266 )
826b2925 267 (list
d46c21ec
SM
268 (cons 'bibtex-mode tex-mode-defaults)
269 (cons 'c++-c-mode c-mode-defaults)
270 (cons 'c++-mode c++-mode-defaults)
271 (cons 'c-mode c-mode-defaults)
9bfbb130 272 (cons 'elec-c-mode c-mode-defaults)
d46c21ec
SM
273 (cons 'emacs-lisp-mode lisp-mode-defaults)
274 (cons 'inferior-scheme-mode scheme-mode-defaults)
275 (cons 'latex-mode tex-mode-defaults)
276 (cons 'lisp-mode lisp-mode-defaults)
277 (cons 'lisp-interaction-mode lisp-mode-defaults)
278 (cons 'plain-tex-mode tex-mode-defaults)
279 (cons 'scheme-mode scheme-mode-defaults)
280 (cons 'scheme-interaction-mode scheme-mode-defaults)
281 (cons 'slitex-mode tex-mode-defaults)
282 (cons 'tex-mode tex-mode-defaults)))
9bfbb130 283 "Alist of default major mode and Font Lock defaults.
b89e1134 284Each item should be a list of the form:
d46c21ec 285
a2b8e66b 286 (MAJOR-MODE . (KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN
a078558d 287 ...))
d46c21ec 288
9bfbb130
SM
289where MAJOR-MODE is a symbol. KEYWORDS may be a symbol (a variable or function
290whose value is the keywords to use for fontification) or a list of symbols.
291If KEYWORDS-ONLY is non-nil, syntactic fontification (strings and comments) is
292not performed. If CASE-FOLD is non-nil, the case of the keywords is ignored
293when fontifying. If SYNTAX-ALIST is non-nil, it should be a list of cons pairs
294of the form (CHAR . STRING) used to set the local Font Lock syntax table, for
295keyword and syntactic fontification (see `modify-syntax-entry').
296
297If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
298backwards outside any enclosing syntactic block, for syntactic fontification.
299Typical values are `beginning-of-line' (i.e., the start of the line is known to
300be outside a syntactic block), or `beginning-of-defun' for programming modes or
301`backward-paragraph' for textual modes (i.e., the mode-dependent function is
302known to move outside a syntactic block). If nil, the beginning of the buffer
303is used as a position outside of a syntactic block, in the worst case.
d46c21ec
SM
304
305These item elements are used by Font Lock mode to set the variables
9bfbb130 306`font-lock-keywords', `font-lock-keywords-only',
d46c21ec 307`font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
a2b8e66b
SM
308`font-lock-beginning-of-syntax-function', respectively.
309
a078558d
SM
310Further item elements are alists of the form (VARIABLE . VALUE) and are in no
311particular order. Each VARIABLE is made buffer-local before set to VALUE.
a2b8e66b 312
a078558d
SM
313Currently, appropriate variables include `font-lock-mark-block-function'.
314If this is non-nil, it should be a function with no args used to mark any
315enclosing block of text, for fontification via \\[font-lock-fontify-block].
316Typical values are `mark-defun' for programming modes or `mark-paragraph' for
317textual modes (i.e., the mode-dependent function is known to put point and mark
318around a text block relevant to that mode).
a2b8e66b 319
a078558d 320Other variables include those for buffer-specialised fontification functions,
a2b8e66b 321`font-lock-fontify-buffer-function', `font-lock-unfontify-buffer-function',
a078558d
SM
322`font-lock-fontify-region-function', `font-lock-unfontify-region-function' and
323`font-lock-inhibit-thing-lock'.")
d46c21ec 324
9bfbb130 325(defvar font-lock-keywords-only nil
d46c21ec
SM
326 "*Non-nil means Font Lock should not fontify comments or strings.
327This is normally set via `font-lock-defaults'.")
b89e1134 328
030f4a35 329(defvar font-lock-keywords-case-fold-search nil
d46c21ec
SM
330 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
331This is normally set via `font-lock-defaults'.")
030f4a35 332
b056da51 333(defvar font-lock-syntax-table nil
799761f0 334 "Non-nil means use this syntax table for fontifying.
d46c21ec
SM
335If this is nil, the major mode's syntax table is used.
336This is normally set via `font-lock-defaults'.")
337
9bfbb130
SM
338;; If this is nil, we only use the beginning of the buffer if we can't use
339;; `font-lock-cache-position' and `font-lock-cache-state'.
d46c21ec 340(defvar font-lock-beginning-of-syntax-function nil
9bfbb130 341 "*Non-nil means use this function to move back outside of a syntactic block.
a078558d
SM
342When called with no args it should leave point at the beginning of any
343enclosing syntactic block.
9bfbb130 344If this is nil, the beginning of the buffer is used (in the worst case).
d46c21ec 345This is normally set via `font-lock-defaults'.")
b056da51 346
a078558d
SM
347(defvar font-lock-mark-block-function nil
348 "*Non-nil means use this function to mark a block of text.
349When called with no args it should leave point at the beginning of any
350enclosing textual block and mark at the end.
351This is normally set via `font-lock-defaults'.")
352
a2b8e66b
SM
353(defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer
354 "Function to use for fontifying the buffer.
355This is normally set via `font-lock-defaults'.")
356
357(defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer
358 "Function to use for unfontifying the buffer.
359This is used when turning off Font Lock mode.
360This is normally set via `font-lock-defaults'.")
361
362(defvar font-lock-fontify-region-function 'font-lock-default-fontify-region
363 "Function to use for fontifying a region.
364It should take two args, the beginning and end of the region, and an optional
365third arg VERBOSE. If non-nil, the function should print status messages.
366This is normally set via `font-lock-defaults'.")
367
368(defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region
369 "Function to use for unfontifying a region.
370It should take two args, the beginning and end of the region.
371This is normally set via `font-lock-defaults'.")
372
373(defvar font-lock-inhibit-thing-lock nil
374 "List of Font Lock mode related modes that should not be turned on.
375Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'.
376This is normally set via `font-lock-defaults'.")
377
9bfbb130
SM
378(defvar font-lock-mode nil) ; For the modeline.
379(defvar font-lock-fontified nil) ; Whether we have fontified the buffer.
380(put 'font-lock-fontified 'permanent-local t)
826b2925 381
9bfbb130
SM
382;;;###autoload
383(defvar font-lock-mode-hook nil
384 "Function or functions to run on entry to Font Lock mode.")
030f4a35 385\f
a2b8e66b 386;; User commands.
030f4a35
RS
387
388;;;###autoload
389(defun font-lock-mode (&optional arg)
e595fa35 390 "Toggle Font Lock mode.
030f4a35
RS
391With arg, turn Font Lock mode on if and only if arg is positive.
392
393When Font Lock mode is enabled, text is fontified as you type it:
394
a1eb1cf1
RS
395 - Comments are displayed in `font-lock-comment-face';
396 - Strings are displayed in `font-lock-string-face';
397 - Certain other expressions are displayed in other faces according to the
398 value of the variable `font-lock-keywords'.
399
400You can enable Font Lock mode in any major mode automatically by turning on in
401the major mode's hook. For example, put in your ~/.emacs:
402
403 (add-hook 'c-mode-hook 'turn-on-font-lock)
404
a2b8e66b
SM
405Alternatively, you can use Global Font Lock mode to automagically turn on Font
406Lock mode in buffers whose major mode supports it, or in buffers whose major
407mode is one of `font-lock-global-modes'. For example, put in your ~/.emacs:
408
409 (global-font-lock-mode t)
410
a1eb1cf1
RS
411The default Font Lock mode faces and their attributes are defined in the
412variable `font-lock-face-attributes', and Font Lock mode default settings in
9bfbb130
SM
413the variable `font-lock-defaults-alist'. You can set your own default settings
414for some mode, by setting a buffer local value for `font-lock-defaults', via
415its mode hook.
030f4a35 416
826b2925 417Where modes support different levels of fontification, you can use the variable
fb512de9 418`font-lock-maximum-decoration' to specify which level you generally prefer.
b89e1134
SM
419When you turn Font Lock mode on/off the buffer is fontified/defontified, though
420fontification occurs only if the buffer is less than `font-lock-maximum-size'.
7d7d915a
SM
421
422To fontify a buffer, without turning on Font Lock mode and regardless of buffer
423size, you can use \\[font-lock-fontify-buffer].
a078558d
SM
424
425To fontify a block (the function or paragraph containing point, or a number of
426lines around point), perhaps because modification on the current line caused
427syntactic change on other lines, you can use \\[font-lock-fontify-block]."
030f4a35 428 (interactive "P")
a2b8e66b
SM
429 ;; Don't turn on Font Lock mode if we don't have a display (we're running a
430 ;; batch job) or if the buffer is invisible (the name starts with a space).
343204bd
SM
431 (let ((maximum-size (font-lock-value-in-major-mode font-lock-maximum-size))
432 (on-p (and (not noninteractive)
a2b8e66b
SM
433 (not (eq (aref (buffer-name) 0) ?\ ))
434 (if arg
435 (> (prefix-numeric-value arg) 0)
343204bd 436 (not font-lock-mode)))))
a1eb1cf1 437 (if (not on-p)
876f2438
SM
438 (remove-hook 'after-change-functions 'font-lock-after-change-function
439 t)
440 (make-local-hook 'after-change-functions)
441 (add-hook 'after-change-functions 'font-lock-after-change-function
442 nil t))
030f4a35
RS
443 (set (make-local-variable 'font-lock-mode) on-p)
444 (cond (on-p
445 (font-lock-set-defaults)
a2b8e66b 446 ;; If buffer is reverted, must clean up the state.
876f2438
SM
447 (make-local-hook 'before-revert-hook)
448 (make-local-hook 'after-revert-hook)
876f2438
SM
449 (add-hook 'before-revert-hook 'font-lock-revert-setup nil t)
450 (add-hook 'after-revert-hook 'font-lock-revert-cleanup nil t)
030f4a35 451 (run-hooks 'font-lock-mode-hook)
b89e1134
SM
452 (cond (font-lock-fontified
453 nil)
a2b8e66b
SM
454 ((or (null maximum-size) (<= (buffer-size) maximum-size)
455 (not (eq font-lock-fontify-buffer-function
456 (default-value
457 'font-lock-fontify-buffer-function))))
b89e1134
SM
458 (font-lock-fontify-buffer))
459 (font-lock-verbose
460 (message "Fontifying %s... buffer too big." (buffer-name)))))
030f4a35 461 (font-lock-fontified
a2b8e66b 462 (font-lock-unfontify-buffer)
876f2438
SM
463 (remove-hook 'before-revert-hook 'font-lock-revert-setup t)
464 (remove-hook 'after-revert-hook 'font-lock-revert-cleanup t)
a2b8e66b
SM
465 (font-lock-thing-lock-cleanup)
466 (font-lock-unset-defaults))
799761f0 467 (t
876f2438
SM
468 (remove-hook 'before-revert-hook 'font-lock-revert-setup t)
469 (remove-hook 'after-revert-hook 'font-lock-revert-cleanup t)
a2b8e66b
SM
470 (font-lock-thing-lock-cleanup)
471 (font-lock-unset-defaults)))
030f4a35
RS
472 (force-mode-line-update)))
473
a1eb1cf1
RS
474;;;###autoload
475(defun turn-on-font-lock ()
a465832f
SM
476 "Turn on Font Lock mode conditionally.
477Turn on only if the buffer mode supports it and the terminal can display it."
478 (if (and window-system
479 (not font-lock-mode)
480 (or font-lock-defaults (assq major-mode font-lock-defaults-alist)))
481 (font-lock-mode t)))
a2b8e66b
SM
482\f
483;; Code for Global Font Lock mode.
484
485;; A few people have hassled in the past for a way to make it easier to turn on
486;; Font Lock mode, perhaps the same way hilit19.el/hl319.el does. I've always
487;; balked at that way, as I see it as just re-moulding the same problem in
488;; another form. That is; some person would still have to keep track of which
489;; modes (which may not even be distributed with Emacs) support Font Lock mode.
490;; The list would always be out of date. And that person might have to be me.
491
492;; In the latest of these discussions the following hack came to mind. It is a
493;; gross hack, but it generally works. We use the convention that major modes
494;; start by calling the function `kill-all-local-variables', which in turn runs
495;; functions on the hook variable `change-major-mode-hook'. We attach our
496;; function `font-lock-change-major-mode' to that hook. Of course, when this
497;; hook is run, the major mode is in the process of being changed and we do not
498;; know what the final major mode will be. So, `font-lock-change-major-mode'
499;; only (a) notes the name of the current buffer, and (b) adds our function
a465832f 500;; `turn-on-font-lock-if-enabled' to the hook variable `post-command-hook'.
a2b8e66b
SM
501;; By the time the functions on `post-command-hook' are run, the new major mode
502;; is assumed to be in place.
503
504;; Naturally this requires that (a) major modes run `kill-all-local-variables',
505;; as they are supposed to do, and (b) the major mode is in place after the
506;; command that ran `kill-all-local-variables' has finished. Arguably, any
507;; major mode that does not follow the convension (a) is broken, and I can't
508;; think of any reason why (b) would not be met. I don't know of any major
509;; modes that do not follow the convension (a), but I'm sure there are some
510;; obscure ones out there somewhere. Even if it works, it is still not clean.
511
512;; Probably the cleanest solution is to have each major mode function run some
513;; hook, e.g., `major-mode-hook', but maybe implementing that change is
514;; impractical. I am personally against making `setq' a macro or be advised
515;; (space'n'speed), or have a special function such as `set-major-mode' (a
516;; `major-mode-hook' is simpler), but maybe someone can come up with another
517;; solution? --sm.
518
2d9cdda8
SM
519(defvar font-lock-buffers nil) ; For remembering buffers.
520(defvar change-major-mode-hook nil) ; Make sure it's not void.
a078558d 521
a2b8e66b
SM
522;;;###autoload
523(defvar font-lock-global-modes t
2d9cdda8 524 "*Modes for which Font Lock mode is automatically turned on.
a2b8e66b
SM
525Global Font Lock mode is controlled by the `global-font-lock-mode' command.
526If nil, means no modes have Font Lock mode automatically turned on.
527If t, all modes that support Font Lock mode have it automatically turned on.
528If a list, each element should be a major mode symbol name such as `c-mode'.
529Font Lock is automatically turned on if the buffer major mode supports it and
530is in this list. The sense of the list is negated if it begins with `not'.")
531
532;;;###autoload
343204bd 533(defun global-font-lock-mode (&optional arg message)
a2b8e66b 534 "Toggle Global Font Lock mode.
343204bd
SM
535With prefix ARG, turn Global Font Lock mode on if and only if ARG is positive.
536Displays a message saying whether the mode is on or off if MESSAGE is non-nil.
537Returns the new status of Global Font Lock mode (non-nil means on).
a2b8e66b
SM
538
539When Global Font Lock mode is enabled, Font Lock mode is automagically
540turned on in a buffer if its major mode is one of `font-lock-global-modes'."
343204bd
SM
541 (interactive "P\np")
542 (let ((off-p (if arg
543 (<= (prefix-numeric-value arg) 0)
544 (memq 'font-lock-change-major-mode change-major-mode-hook))))
545 (if off-p
546 (remove-hook 'change-major-mode-hook 'font-lock-change-major-mode)
547 (add-hook 'change-major-mode-hook 'font-lock-change-major-mode)
548 (add-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
2d9cdda8 549 (setq font-lock-buffers (buffer-list)))
343204bd
SM
550 (if message
551 (message "Global Font Lock mode is now %s." (if off-p "OFF" "ON")))
552 (not off-p)))
a2b8e66b 553
a2b8e66b
SM
554(defun font-lock-change-major-mode ()
555 ;; Gross hack warning: Delicate readers should avert eyes now.
343204bd
SM
556 ;; Something is running `kill-all-local-variables', which generally means the
557 ;; major mode is being changed. Run `turn-on-font-lock-if-enabled' after the
558 ;; current command has finished.
a465832f 559 (add-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
2d9cdda8 560 (add-to-list 'font-lock-buffers (current-buffer)))
a2b8e66b 561
a465832f 562(defun turn-on-font-lock-if-enabled ()
a2b8e66b 563 ;; Gross hack warning: Delicate readers should avert eyes now.
a465832f
SM
564 ;; Turn on Font Lock mode if it's one of `font-lock-global-modes'.
565 (remove-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
2d9cdda8
SM
566 (while font-lock-buffers
567 (if (buffer-live-p (car font-lock-buffers))
a2b8e66b 568 (save-excursion
2d9cdda8 569 (set-buffer (car font-lock-buffers))
a465832f
SM
570 (if (or (eq font-lock-global-modes t)
571 (if (eq (car-safe font-lock-global-modes) 'not)
572 (not (memq major-mode (cdr font-lock-global-modes)))
573 (memq major-mode font-lock-global-modes)))
343204bd
SM
574 (let (inhibit-quit)
575 (turn-on-font-lock)))))
2d9cdda8 576 (setq font-lock-buffers (cdr font-lock-buffers))))
a2b8e66b
SM
577
578;; End of Global Font Lock mode.
579\f
580;; Fontification functions.
a1eb1cf1 581
a1eb1cf1 582;;;###autoload
030f4a35 583(defun font-lock-fontify-buffer ()
a1eb1cf1 584 "Fontify the current buffer the way `font-lock-mode' would."
030f4a35 585 (interactive)
a2b8e66b
SM
586 (let ((font-lock-verbose (or font-lock-verbose (interactive-p))))
587 (funcall font-lock-fontify-buffer-function)))
588
589(defun font-lock-unfontify-buffer ()
590 (funcall font-lock-unfontify-buffer-function))
591
592(defun font-lock-fontify-region (beg end &optional loudly)
593 (funcall font-lock-fontify-region-function beg end loudly))
594
595(defun font-lock-unfontify-region (beg end)
596 (funcall font-lock-unfontify-region-function beg end))
597
598(defun font-lock-default-fontify-buffer ()
599 (let ((verbose (and font-lock-verbose (> (buffer-size) 0))))
a1eb1cf1 600 (if verbose (message "Fontifying %s..." (buffer-name)))
7d7d915a
SM
601 ;; Make sure we have the right `font-lock-keywords' etc.
602 (if (not font-lock-mode) (font-lock-set-defaults))
603 ;; Make sure we fontify etc. in the whole buffer.
604 (save-restriction
605 (widen)
606 (condition-case nil
607 (save-excursion
608 (save-match-data
609 (font-lock-fontify-region (point-min) (point-max) verbose)
271c888a 610 (font-lock-after-fontify-buffer)
7d7d915a
SM
611 (setq font-lock-fontified t)))
612 ;; We don't restore the old fontification, so it's best to unfontify.
a078558d
SM
613 (quit (font-lock-unfontify-buffer))))
614 (if verbose (message "Fontifying %s... %s." (buffer-name)
615 (if font-lock-fontified "done" "aborted")))))
7d7d915a 616
a2b8e66b
SM
617(defun font-lock-default-unfontify-buffer ()
618 (save-restriction
619 (widen)
620 (font-lock-unfontify-region (point-min) (point-max))
271c888a 621 (font-lock-after-unfontify-buffer)
a2b8e66b 622 (setq font-lock-fontified nil)))
9bfbb130
SM
623
624;; We use this wrapper. However, `font-lock-fontify-region' used to be the
625;; name used for `font-lock-fontify-syntactically-region', so a change isn't
626;; back-compatible. But you shouldn't be calling these directly, should you?
a2b8e66b 627(defun font-lock-default-fontify-region (beg end loudly)
876f2438
SM
628 (let ((modified (buffer-modified-p))
629 (buffer-undo-list t) (inhibit-read-only t)
630 (old-syntax-table (syntax-table))
7d7d915a 631 before-change-functions after-change-functions
876f2438
SM
632 buffer-file-name buffer-file-truename)
633 (unwind-protect
a078558d
SM
634 (save-restriction
635 (widen)
876f2438
SM
636 ;; Use the fontification syntax table, if any.
637 (if font-lock-syntax-table (set-syntax-table font-lock-syntax-table))
638 ;; Now do the fontification.
639 (if font-lock-keywords-only
640 (font-lock-unfontify-region beg end)
641 (font-lock-fontify-syntactically-region beg end loudly))
642 (font-lock-fontify-keywords-region beg end loudly))
643 ;; Clean up.
644 (set-syntax-table old-syntax-table)
645 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil)))))
9bfbb130
SM
646
647;; The following must be rethought, since keywords can override fontification.
648; ;; Now scan for keywords, but not if we are inside a comment now.
649; (or (and (not font-lock-keywords-only)
650; (let ((state (parse-partial-sexp beg end nil nil
651; font-lock-cache-state)))
652; (or (nth 4 state) (nth 7 state))))
653; (font-lock-fontify-keywords-region beg end))
654
a2b8e66b 655(defun font-lock-default-unfontify-region (beg end)
9bfbb130
SM
656 (let ((modified (buffer-modified-p))
657 (buffer-undo-list t) (inhibit-read-only t)
7d7d915a 658 before-change-functions after-change-functions
9bfbb130
SM
659 buffer-file-name buffer-file-truename)
660 (remove-text-properties beg end '(face nil))
876f2438 661 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil))))
9bfbb130
SM
662
663;; Called when any modification is made to buffer text.
664(defun font-lock-after-change-function (beg end old-len)
665 (save-excursion
666 (save-match-data
667 ;; Rescan between start of line from `beg' and start of line after `end'.
668 (font-lock-fontify-region
669 (progn (goto-char beg) (beginning-of-line) (point))
670 (progn (goto-char end) (forward-line 1) (point))))))
a2b8e66b 671
a078558d
SM
672(defun font-lock-fontify-block (&optional arg)
673 "Fontify some lines the way `font-lock-fontify-buffer' would.
674The lines could be a function or paragraph, or a specified number of lines.
a078558d 675If ARG is given, fontify that many lines before and after point, or 16 lines if
a465832f
SM
676no ARG is given and `font-lock-mark-block-function' is nil.
677If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
678delimit the region to fontify."
a078558d 679 (interactive "P")
a465832f 680 (let (font-lock-beginning-of-syntax-function deactivate-mark)
a078558d
SM
681 ;; Make sure we have the right `font-lock-keywords' etc.
682 (if (not font-lock-mode) (font-lock-set-defaults))
a2b8e66b
SM
683 (save-excursion
684 (save-match-data
685 (condition-case error-data
a078558d
SM
686 (if (or arg (not font-lock-mark-block-function))
687 (let ((lines (if arg (prefix-numeric-value arg) 16)))
688 (font-lock-fontify-region
689 (save-excursion (forward-line (- lines)) (point))
690 (save-excursion (forward-line lines) (point))))
691 (funcall font-lock-mark-block-function)
692 (font-lock-fontify-region (point) (mark)))
693 ((error quit) (message "Fontifying block... %s" error-data)))))))
694
94de9afe 695(define-key facemenu-keymap "\M-g" 'font-lock-fontify-block)
9bfbb130
SM
696\f
697;; Syntactic fontification functions.
698
a078558d
SM
699;; These record the parse state at a particular position, always the start of a
700;; line. Used to make `font-lock-fontify-syntactically-region' faster.
701(defvar font-lock-cache-position nil)
702(defvar font-lock-cache-state nil)
703(make-variable-buffer-local 'font-lock-cache-position)
704(make-variable-buffer-local 'font-lock-cache-state)
705
9bfbb130
SM
706(defun font-lock-fontify-syntactically-region (start end &optional loudly)
707 "Put proper face on each string and comment between START and END.
708START should be at the beginning of a line."
876f2438 709 (let ((synstart (if comment-start-skip
9bfbb130
SM
710 (concat "\\s\"\\|" comment-start-skip)
711 "\\s\""))
712 (comstart (if comment-start-skip
713 (concat "\\s<\\|" comment-start-skip)
714 "\\s<"))
9bfbb130
SM
715 state prev prevstate)
716 (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
a078558d
SM
717 (goto-char start)
718 ;;
719 ;; Find the state at the `beginning-of-line' before `start'.
720 (if (eq start font-lock-cache-position)
721 ;; Use the cache for the state of `start'.
722 (setq state font-lock-cache-state)
723 ;; Find the state of `start'.
724 (if (null font-lock-beginning-of-syntax-function)
725 ;; Use the state at the previous cache position, if any, or
726 ;; otherwise calculate from `point-min'.
727 (if (or (null font-lock-cache-position)
728 (< start font-lock-cache-position))
729 (setq state (parse-partial-sexp (point-min) start))
730 (setq state (parse-partial-sexp font-lock-cache-position start
731 nil nil font-lock-cache-state)))
732 ;; Call the function to move outside any syntactic block.
733 (funcall font-lock-beginning-of-syntax-function)
734 (setq state (parse-partial-sexp (point) start)))
735 ;; Cache the state and position of `start'.
736 (setq font-lock-cache-state state
737 font-lock-cache-position start))
738 ;;
739 ;; If the region starts inside a string, show the extent of it.
740 (if (nth 3 state)
741 (let ((beg (point)))
742 (while (and (re-search-forward "\\s\"" end 'move)
743 (nth 3 (parse-partial-sexp beg (point) nil nil state))))
744 (put-text-property beg (point) 'face font-lock-string-face)
745 (setq state (parse-partial-sexp beg (point) nil nil state))))
746 ;;
747 ;; Likewise for a comment.
748 (if (or (nth 4 state) (nth 7 state))
749 (let ((beg (point)))
750 (save-restriction
751 (narrow-to-region (point-min) end)
752 (condition-case nil
753 (progn
754 (re-search-backward comstart (point-min) 'move)
755 (forward-comment 1)
756 ;; forward-comment skips all whitespace,
757 ;; so go back to the real end of the comment.
758 (skip-chars-backward " \t"))
759 (error (goto-char end))))
760 (put-text-property beg (point) 'face font-lock-comment-face)
761 (setq state (parse-partial-sexp beg (point) nil nil state))))
762 ;;
763 ;; Find each interesting place between here and `end'.
764 (while (and (< (point) end)
765 (setq prev (point) prevstate state)
766 (re-search-forward synstart end t)
767 (progn
768 ;; Clear out the fonts of what we skip over.
769 (remove-text-properties prev (point) '(face nil))
770 ;; Verify the state at that place
771 ;; so we don't get fooled by \" or \;.
772 (setq state (parse-partial-sexp prev (point)
773 nil nil state))))
774 (let ((here (point)))
775 (if (or (nth 4 state) (nth 7 state))
776 ;;
777 ;; We found a real comment start.
778 (let ((beg (match-beginning 0)))
779 (goto-char beg)
780 (save-restriction
781 (narrow-to-region (point-min) end)
782 (condition-case nil
783 (progn
784 (forward-comment 1)
785 ;; forward-comment skips all whitespace,
786 ;; so go back to the real end of the comment.
787 (skip-chars-backward " \t"))
788 (error (goto-char end))))
789 (put-text-property beg (point) 'face font-lock-comment-face)
790 (setq state (parse-partial-sexp here (point) nil nil state)))
791 (if (nth 3 state)
876f2438 792 ;;
a078558d 793 ;; We found a real string start.
876f2438 794 (let ((beg (match-beginning 0)))
a078558d
SM
795 (while (and (re-search-forward "\\s\"" end 'move)
796 (nth 3 (parse-partial-sexp here (point)
797 nil nil state))))
798 (put-text-property beg (point) 'face font-lock-string-face)
799 (setq state (parse-partial-sexp here (point)
800 nil nil state))))))
801 ;;
802 ;; Make sure `prev' is non-nil after the loop
803 ;; only if it was set on the very last iteration.
804 (setq prev nil))
876f2438
SM
805 ;;
806 ;; Clean up.
807 (and prev (remove-text-properties prev end '(face nil)))))
9bfbb130
SM
808\f
809;;; Additional text property functions.
810
811;; The following three text property functions are not generally available (and
812;; it's not certain that they should be) so they are inlined for speed.
813;; The case for `fillin-text-property' is simple; it may or not be generally
814;; useful. (Since it is used here, it is useful in at least one place.;-)
815;; However, the case for `append-text-property' and `prepend-text-property' is
816;; more complicated. Should they remove duplicate property values or not? If
817;; so, should the first or last duplicate item remain? Or the one that was
818;; added? In our implementation, the first duplicate remains.
819
820(defsubst font-lock-fillin-text-property (start end prop value &optional object)
821 "Fill in one property of the text from START to END.
822Arguments PROP and VALUE specify the property and value to put where none are
823already in place. Therefore existing property values are not overwritten.
824Optional argument OBJECT is the string or buffer containing the text."
825 (let ((start (text-property-any start end prop nil object)) next)
826 (while start
827 (setq next (next-single-property-change start prop object end))
828 (put-text-property start next prop value object)
829 (setq start (text-property-any next end prop nil object)))))
830
831;; This function (from simon's unique.el) is rewritten and inlined for speed.
832;(defun unique (list function)
833; "Uniquify LIST, deleting elements using FUNCTION.
834;Return the list with subsequent duplicate items removed by side effects.
835;FUNCTION is called with an element of LIST and a list of elements from LIST,
836;and should return the list of elements with occurrences of the element removed,
837;i.e., a function such as `delete' or `delq'.
838;This function will work even if LIST is unsorted. See also `uniq'."
839; (let ((list list))
840; (while list
841; (setq list (setcdr list (funcall function (car list) (cdr list))))))
842; list)
843
844(defsubst font-lock-unique (list)
845 "Uniquify LIST, deleting elements using `delq'.
846Return the list with subsequent duplicate items removed by side effects."
847 (let ((list list))
848 (while list
849 (setq list (setcdr list (delq (car list) (cdr list))))))
850 list)
851
852;; A generalisation of `facemenu-add-face' for any property, but without the
853;; removal of inactive faces via `facemenu-discard-redundant-faces' and special
854;; treatment of `default'. Uses `unique' to remove duplicate property values.
855(defsubst font-lock-prepend-text-property (start end prop value &optional object)
856 "Prepend to one property of the text from START to END.
857Arguments PROP and VALUE specify the property and value to prepend to the value
858already in place. The resulting property values are always lists, and unique.
859Optional argument OBJECT is the string or buffer containing the text."
860 (let ((val (if (listp value) value (list value))) next prev)
861 (while (/= start end)
862 (setq next (next-single-property-change start prop object end)
863 prev (get-text-property start prop object))
864 (put-text-property
865 start next prop
866 (font-lock-unique (append val (if (listp prev) prev (list prev))))
867 object)
868 (setq start next))))
869
870(defsubst font-lock-append-text-property (start end prop value &optional object)
871 "Append to one property of the text from START to END.
872Arguments PROP and VALUE specify the property and value to append to the value
873already in place. The resulting property values are always lists, and unique.
874Optional argument OBJECT is the string or buffer containing the text."
875 (let ((val (if (listp value) value (list value))) next prev)
876 (while (/= start end)
877 (setq next (next-single-property-change start prop object end)
878 prev (get-text-property start prop object))
879 (put-text-property
880 start next prop
881 (font-lock-unique (append (if (listp prev) prev (list prev)) val))
882 object)
883 (setq start next))))
884\f
885;;; Regexp fontification functions.
886
887(defsubst font-lock-apply-highlight (highlight)
888 "Apply HIGHLIGHT following a match.
889HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
890 (let* ((match (nth 0 highlight))
891 (start (match-beginning match)) (end (match-end match))
892 (override (nth 2 highlight)))
893 (cond ((not start)
894 ;; No match but we might not signal an error.
895 (or (nth 3 highlight)
896 (error "No match %d in highlight %S" match highlight)))
897 ((not override)
898 ;; Cannot override existing fontification.
899 (or (text-property-not-all start end 'face nil)
900 (put-text-property start end 'face (eval (nth 1 highlight)))))
901 ((eq override t)
902 ;; Override existing fontification.
903 (put-text-property start end 'face (eval (nth 1 highlight))))
904 ((eq override 'keep)
905 ;; Keep existing fontification.
906 (font-lock-fillin-text-property start end 'face
907 (eval (nth 1 highlight))))
908 ((eq override 'prepend)
909 ;; Prepend to existing fontification.
910 (font-lock-prepend-text-property start end 'face
911 (eval (nth 1 highlight))))
912 ((eq override 'append)
913 ;; Append to existing fontification.
914 (font-lock-append-text-property start end 'face
915 (eval (nth 1 highlight)))))))
916
917(defsubst font-lock-fontify-anchored-keywords (keywords limit)
918 "Fontify according to KEYWORDS until LIMIT.
919KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords'."
920 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights)
876f2438
SM
921 ;; Until we come up with a cleaner solution, we make LIMIT the end of line.
922 (save-excursion (end-of-line) (setq limit (min limit (point))))
923 ;; Evaluate PRE-MATCH-FORM.
9bfbb130
SM
924 (eval (nth 1 keywords))
925 (save-match-data
876f2438 926 ;; Find an occurrence of `matcher' before `limit'.
9bfbb130
SM
927 (while (if (stringp matcher)
928 (re-search-forward matcher limit t)
929 (funcall matcher limit))
876f2438 930 ;; Apply each highlight to this instance of `matcher'.
9bfbb130
SM
931 (setq highlights lowdarks)
932 (while highlights
933 (font-lock-apply-highlight (car highlights))
934 (setq highlights (cdr highlights)))))
876f2438 935 ;; Evaluate POST-MATCH-FORM.
9bfbb130
SM
936 (eval (nth 2 keywords))))
937
938(defun font-lock-fontify-keywords-region (start end &optional loudly)
939 "Fontify according to `font-lock-keywords' between START and END.
940START should be at the beginning of a line."
941 (let ((case-fold-search font-lock-keywords-case-fold-search)
942 (keywords (cdr (if (eq (car-safe font-lock-keywords) t)
943 font-lock-keywords
944 (font-lock-compile-keywords))))
9bfbb130 945 (bufname (buffer-name)) (count 0)
876f2438
SM
946 keyword matcher highlights)
947 ;;
948 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
949 (while keywords
950 (if loudly (message "Fontifying %s... (regexps..%s)" bufname
951 (make-string (setq count (1+ count)) ?.)))
9bfbb130 952 ;;
876f2438
SM
953 ;; Find an occurrence of `matcher' from `start' to `end'.
954 (setq keyword (car keywords) matcher (car keyword))
955 (goto-char start)
956 (while (if (stringp matcher)
957 (re-search-forward matcher end t)
958 (funcall matcher end))
959 ;; Apply each highlight to this instance of `matcher', which may be
960 ;; specific highlights or more keywords anchored to `matcher'.
961 (setq highlights (cdr keyword))
962 (while highlights
963 (if (numberp (car (car highlights)))
964 (font-lock-apply-highlight (car highlights))
965 (font-lock-fontify-anchored-keywords (car highlights) end))
966 (setq highlights (cdr highlights))))
967 (setq keywords (cdr keywords)))))
9bfbb130
SM
968\f
969;; Various functions.
970
971;; Turn off other related packages if they're on. I prefer a hook. --sm.
972;; These explicit calls are easier to understand
973;; because people know what they will do.
974;; A hook is a mystery because it might do anything whatever. --rms.
975(defun font-lock-thing-lock-cleanup ()
976 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
977 (fast-lock-mode -1))
978 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
979 (lazy-lock-mode -1))))
980
271c888a 981;; Do something special for these packages after fontifying; I prefer a hook.
9bfbb130
SM
982(defun font-lock-after-fontify-buffer ()
983 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
984 (fast-lock-after-fontify-buffer))
985 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
986 (lazy-lock-after-fontify-buffer))))
987
271c888a
SM
988;; Do something special for these packages after unfontifying; I prefer a hook.
989(defun font-lock-after-unfontify-buffer ()
990 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
991 (fast-lock-after-unfontify-buffer))
992 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
993 (lazy-lock-after-unfontify-buffer))))
994
9bfbb130
SM
995;; If the buffer is about to be reverted, it won't be fontified afterward.
996(defun font-lock-revert-setup ()
997 (setq font-lock-fontified nil))
998
999;; If the buffer has just been reverted, normally that turns off
1000;; Font Lock mode. So turn the mode back on if necessary.
7d7d915a
SM
1001(defalias 'font-lock-revert-cleanup
1002 'turn-on-font-lock)
9bfbb130
SM
1003
1004(defun font-lock-compile-keywords (&optional keywords)
1005 ;; Compile `font-lock-keywords' into the form (t KEYWORD ...) where KEYWORD
1006 ;; is the (MATCHER HIGHLIGHT ...) shown in the variable's doc string.
1007 (let ((keywords (or keywords font-lock-keywords)))
1008 (setq font-lock-keywords
a2b8e66b
SM
1009 (if (eq (car-safe keywords) t)
1010 keywords
1011 (cons t (mapcar 'font-lock-compile-keyword keywords))))))
1012
1013(defun font-lock-compile-keyword (keyword)
1014 (cond ((nlistp keyword) ; Just MATCHER
1015 (list keyword '(0 font-lock-keyword-face)))
1016 ((eq (car keyword) 'eval) ; Specified (eval . FORM)
1017 (font-lock-compile-keyword (eval (cdr keyword))))
1018 ((numberp (cdr keyword)) ; Specified (MATCHER . MATCH)
1019 (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
1020 ((symbolp (cdr keyword)) ; Specified (MATCHER . FACENAME)
1021 (list (car keyword) (list 0 (cdr keyword))))
1022 ((nlistp (nth 1 keyword)) ; Specified (MATCHER . HIGHLIGHT)
1023 (list (car keyword) (cdr keyword)))
1024 (t ; Hopefully (MATCHER HIGHLIGHT ...)
1025 keyword)))
d46c21ec 1026
343204bd
SM
1027(defun font-lock-value-in-major-mode (alist)
1028 ;; Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1029 ;; Alist structure is ((MAJOR-MODE . VALUE)) where MAJOR-MODE may be t.
1030 (if (consp alist)
1031 (cdr (or (assq major-mode alist) (assq t alist)))
1032 alist))
1033
d46c21ec
SM
1034(defun font-lock-choose-keywords (keywords level)
1035 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1036 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
343204bd
SM
1037 (cond ((symbolp keywords)
1038 keywords)
1039 ((numberp level)
1040 (or (nth level keywords) (car (reverse keywords))))
1041 ((eq level t)
1042 (car (reverse keywords)))
1043 (t
1044 (car keywords))))
d46c21ec
SM
1045
1046(defun font-lock-set-defaults ()
1047 "Set fontification defaults appropriately for this mode.
a2b8e66b
SM
1048Sets various variables using `font-lock-defaults' (or, if nil, using
1049`font-lock-defaults-alist') and `font-lock-maximum-decoration'."
d46c21ec
SM
1050 ;; Set face defaults.
1051 (font-lock-make-faces)
1052 ;; Set fontification defaults.
a2b8e66b 1053 (make-local-variable 'font-lock-fontified)
2d9cdda8
SM
1054 (if (member font-lock-keywords '(nil (t)))
1055 (let* ((defaults (or font-lock-defaults
1056 (cdr (assq major-mode font-lock-defaults-alist))))
1057 (keywords
1058 (font-lock-choose-keywords (nth 0 defaults)
1059 (font-lock-value-in-major-mode font-lock-maximum-decoration))))
1060 ;; Regexp fontification?
1061 (setq font-lock-keywords (if (fboundp keywords)
1062 (funcall keywords)
1063 (eval keywords)))
1064 ;; Syntactic fontification?
1065 (if (nth 1 defaults)
1066 (set (make-local-variable 'font-lock-keywords-only) t))
1067 ;; Case fold during regexp fontification?
1068 (if (nth 2 defaults)
1069 (set (make-local-variable 'font-lock-keywords-case-fold-search) t))
1070 ;; Syntax table for regexp and syntactic fontification?
1071 (if (nth 3 defaults)
1072 (let ((slist (nth 3 defaults)))
1073 (set (make-local-variable 'font-lock-syntax-table)
1074 (copy-syntax-table (syntax-table)))
1075 (while slist
1076 (modify-syntax-entry (car (car slist)) (cdr (car slist))
1077 font-lock-syntax-table)
1078 (setq slist (cdr slist)))))
1079 ;; Syntax function for syntactic fontification?
1080 (if (nth 4 defaults)
1081 (set (make-local-variable 'font-lock-beginning-of-syntax-function)
1082 (nth 4 defaults)))
1083 ;; Variable alist?
1084 (let ((alist (nthcdr 5 defaults)))
1085 (while alist
1086 (set (make-local-variable (car (car alist))) (cdr (car alist)))
1087 (setq alist (cdr alist)))))))
a2b8e66b
SM
1088
1089(defun font-lock-unset-defaults ()
1090 "Unset fontification defaults. See `font-lock-set-defaults'."
1091 (setq font-lock-keywords nil
1092 font-lock-keywords-only nil
1093 font-lock-keywords-case-fold-search nil
1094 font-lock-syntax-table nil
a078558d
SM
1095 font-lock-beginning-of-syntax-function nil)
1096 (let* ((defaults (or font-lock-defaults
1097 (cdr (assq major-mode font-lock-defaults-alist))))
1098 (alist (nthcdr 5 defaults)))
1099 (while alist
1100 (set (car (car alist)) (default-value (car (car alist))))
1101 (setq alist (cdr alist)))))
030f4a35 1102\f
9bfbb130
SM
1103;; Colour etc. support.
1104
a078558d
SM
1105;; This section of code is crying out for revision.
1106
1107;; To begin with, `display-type' and `background-mode' are `frame-parameters'
1108;; so we don't have to calculate them here anymore. But all the face stuff
1109;; should be frame-local (and thus display-local) anyway. Because we're not
1110;; sure what support Emacs is going to have for general frame-local face
1111;; attributes, we leave this section of code as it is. For now. --sm.
1112
9bfbb130
SM
1113(defvar font-lock-display-type nil
1114 "A symbol indicating the display Emacs is running under.
1115The symbol should be one of `color', `grayscale' or `mono'.
1116If Emacs guesses this display attribute wrongly, either set this variable in
1117your `~/.emacs' or set the resource `Emacs.displayType' in your `~/.Xdefaults'.
1118See also `font-lock-background-mode' and `font-lock-face-attributes'.")
1119
1120(defvar font-lock-background-mode nil
1121 "A symbol indicating the Emacs background brightness.
1122The symbol should be one of `light' or `dark'.
1123If Emacs guesses this frame attribute wrongly, either set this variable in
1124your `~/.emacs' or set the resource `Emacs.backgroundMode' in your
1125`~/.Xdefaults'.
1126See also `font-lock-display-type' and `font-lock-face-attributes'.")
1127
1128(defvar font-lock-face-attributes nil
1129 "A list of default attributes to use for face attributes.
1130Each element of the list should be of the form
1131
1132 (FACE FOREGROUND BACKGROUND BOLD-P ITALIC-P UNDERLINE-P)
1133
1134where FACE should be one of the face symbols `font-lock-comment-face',
1135`font-lock-string-face', `font-lock-keyword-face', `font-lock-type-face',
1136`font-lock-function-name-face', `font-lock-variable-name-face', and
1137`font-lock-reference-face'. A form for each of these face symbols should be
1138provided in the list, but other face symbols and attributes may be given and
1139used in highlighting. See `font-lock-keywords'.
1140
1141Subsequent element items should be the attributes for the corresponding
1142Font Lock mode faces. Attributes FOREGROUND and BACKGROUND should be strings
1143\(default if nil), while BOLD-P, ITALIC-P, and UNDERLINE-P should specify the
1144corresponding face attributes (yes if non-nil).
1145
1146Emacs uses default attributes based on display type and background brightness.
1147See variables `font-lock-display-type' and `font-lock-background-mode'.
1148
1149Resources can be used to over-ride these face attributes. For example, the
1150resource `Emacs.font-lock-comment-face.attributeUnderline' can be used to
1151specify the UNDERLINE-P attribute for face `font-lock-comment-face'.")
1152
1153(defun font-lock-make-faces (&optional override)
1154 "Make faces from `font-lock-face-attributes'.
1155A default list is used if this is nil.
1156If optional OVERRIDE is non-nil, faces that already exist are reset.
1157See `font-lock-make-face' and `list-faces-display'."
1158 ;; We don't need to `setq' any of these variables, but the user can see what
1159 ;; is being used if we do.
1160 (if (null font-lock-display-type)
1161 (setq font-lock-display-type
1162 (let ((display-resource (x-get-resource ".displayType"
1163 "DisplayType")))
1164 (cond (display-resource (intern (downcase display-resource)))
1165 ((x-display-color-p) 'color)
1166 ((x-display-grayscale-p) 'grayscale)
1167 (t 'mono)))))
1168 (if (null font-lock-background-mode)
1169 (setq font-lock-background-mode
1170 (let ((bg-resource (x-get-resource ".backgroundMode"
1171 "BackgroundMode"))
1172 (params (frame-parameters)))
1173 (cond (bg-resource (intern (downcase bg-resource)))
03a84c34
RS
1174 ((eq system-type 'ms-dos)
1175 (if (string-match "light"
1176 (cdr (assq 'background-color params)))
1177 'light
1178 'dark))
9bfbb130
SM
1179 ((< (apply '+ (x-color-values
1180 (cdr (assq 'background-color params))))
1181 (/ (apply '+ (x-color-values "white")) 3))
1182 'dark)
1183 (t 'light)))))
1184 (if (null font-lock-face-attributes)
1185 (setq font-lock-face-attributes
1186 (let ((light-bg (eq font-lock-background-mode 'light)))
1187 (cond ((memq font-lock-display-type '(mono monochrome))
1188 ;; Emacs 19.25's font-lock defaults:
1189 ;;'((font-lock-comment-face nil nil nil t nil)
1190 ;; (font-lock-string-face nil nil nil nil t)
1191 ;; (font-lock-keyword-face nil nil t nil nil)
1192 ;; (font-lock-function-name-face nil nil t t nil)
1193 ;; (font-lock-type-face nil nil nil t nil))
1194 (list '(font-lock-comment-face nil nil t t nil)
1195 '(font-lock-string-face nil nil nil t nil)
1196 '(font-lock-keyword-face nil nil t nil nil)
1197 (list
1198 'font-lock-function-name-face
1199 (cdr (assq 'background-color (frame-parameters)))
1200 (cdr (assq 'foreground-color (frame-parameters)))
1201 t nil nil)
1202 '(font-lock-variable-name-face nil nil t t nil)
1203 '(font-lock-type-face nil nil t nil t)
1204 '(font-lock-reference-face nil nil t nil t)))
1205 ((memq font-lock-display-type '(grayscale greyscale
1206 grayshade greyshade))
1207 (list
1208 (list 'font-lock-comment-face
1209 nil (if light-bg "Gray80" "DimGray") t t nil)
1210 (list 'font-lock-string-face
1211 nil (if light-bg "Gray50" "LightGray") nil t nil)
1212 (list 'font-lock-keyword-face
1213 nil (if light-bg "Gray90" "DimGray") t nil nil)
1214 (list 'font-lock-function-name-face
1215 (cdr (assq 'background-color (frame-parameters)))
1216 (cdr (assq 'foreground-color (frame-parameters)))
1217 t nil nil)
1218 (list 'font-lock-variable-name-face
1219 nil (if light-bg "Gray90" "DimGray") t t nil)
1220 (list 'font-lock-type-face
1221 nil (if light-bg "Gray80" "DimGray") t nil t)
1222 (list 'font-lock-reference-face
1223 nil (if light-bg "LightGray" "Gray50") t nil t)))
1224 (light-bg ; light colour background
1225 '((font-lock-comment-face "Firebrick")
1226 (font-lock-string-face "RosyBrown")
1227 (font-lock-keyword-face "Purple")
1228 (font-lock-function-name-face "Blue")
1229 (font-lock-variable-name-face "DarkGoldenrod")
1230 (font-lock-type-face "DarkOliveGreen")
1231 (font-lock-reference-face "CadetBlue")))
1232 (t ; dark colour background
1233 '((font-lock-comment-face "OrangeRed")
1234 (font-lock-string-face "LightSalmon")
1235 (font-lock-keyword-face "LightSteelBlue")
1236 (font-lock-function-name-face "LightSkyBlue")
1237 (font-lock-variable-name-face "LightGoldenrod")
1238 (font-lock-type-face "PaleGreen")
1239 (font-lock-reference-face "Aquamarine")))))))
1240 ;; Now make the faces if we have to.
1241 (mapcar (function
1242 (lambda (face-attributes)
1243 (let ((face (nth 0 face-attributes)))
1244 (cond (override
1245 ;; We can stomp all over it anyway. Get outta my face!
1246 (font-lock-make-face face-attributes))
1247 ((and (boundp face) (facep (symbol-value face)))
1248 ;; The variable exists and is already bound to a face.
1249 nil)
1250 ((facep face)
1251 ;; We already have a face so we bind the variable to it.
1252 (set face face))
1253 (t
1254 ;; No variable or no face.
1255 (font-lock-make-face face-attributes))))))
1256 font-lock-face-attributes))
1257
1258(defun font-lock-make-face (face-attributes)
1259 "Make a face from FACE-ATTRIBUTES.
1260FACE-ATTRIBUTES should be like an element `font-lock-face-attributes', so that
1261the face name is the first item in the list. A variable with the same name as
1262the face is also set; its value is the face name."
1263 (let* ((face (nth 0 face-attributes))
1264 (face-name (symbol-name face))
1265 (set-p (function (lambda (face-name resource)
1266 (x-get-resource (concat face-name ".attribute" resource)
1267 (concat "Face.Attribute" resource)))))
1268 (on-p (function (lambda (face-name resource)
1269 (let ((set (funcall set-p face-name resource)))
1270 (and set (member (downcase set) '("on" "true"))))))))
1271 (make-face face)
876f2438 1272 (add-to-list 'facemenu-unlisted-faces face)
9bfbb130
SM
1273 ;; Set attributes not set from X resources (and therefore `make-face').
1274 (or (funcall set-p face-name "Foreground")
1275 (condition-case nil
1276 (set-face-foreground face (nth 1 face-attributes))
1277 (error nil)))
1278 (or (funcall set-p face-name "Background")
1279 (condition-case nil
1280 (set-face-background face (nth 2 face-attributes))
1281 (error nil)))
1282 (if (funcall set-p face-name "Bold")
1283 (and (funcall on-p face-name "Bold") (make-face-bold face nil t))
1284 (and (nth 3 face-attributes) (make-face-bold face nil t)))
1285 (if (funcall set-p face-name "Italic")
1286 (and (funcall on-p face-name "Italic") (make-face-italic face nil t))
1287 (and (nth 4 face-attributes) (make-face-italic face nil t)))
1288 (or (funcall set-p face-name "Underline")
1289 (set-face-underline-p face (nth 5 face-attributes)))
1290 (set face face)))
1291\f
1292;;; Various regexp information shared by several modes.
a1eb1cf1 1293;;; Information specific to a single mode should go in its load library.
030f4a35 1294
030f4a35 1295(defconst lisp-font-lock-keywords-1
a1eb1cf1 1296 (list
9bfbb130 1297 ;; Anything not a variable or type declaration is fontified as a function.
d46c21ec
SM
1298 ;; It would be cleaner to allow preceding whitespace, but it would also be
1299 ;; about five times slower.
1300 (list (concat "^(\\(def\\("
1301 ;; Variable declarations.
1302 "\\(const\\(\\|ant\\)\\|ine-key\\(\\|-after\\)\\|var\\)\\|"
1303 ;; Structure declarations.
1304 "\\(class\\|struct\\|type\\)\\|"
1305 ;; Everything else is a function declaration.
1306 "\\([^ \t\n\(\)]+\\)"
1307 "\\)\\)\\>"
1308 ;; Any whitespace and declared object.
1309 "[ \t'\(]*"
7d7d915a 1310 "\\(\\sw+\\)?")
d46c21ec
SM
1311 '(1 font-lock-keyword-face)
1312 '(8 (cond ((match-beginning 3) font-lock-variable-name-face)
1313 ((match-beginning 6) font-lock-type-face)
1314 (t font-lock-function-name-face))
9bfbb130
SM
1315 nil t))
1316 )
7d7d915a 1317 "Subdued level highlighting for Lisp modes.")
030f4a35
RS
1318
1319(defconst lisp-font-lock-keywords-2
799761f0 1320 (append lisp-font-lock-keywords-1
9bfbb130
SM
1321 (list
1322 ;;
1323 ;; Control structures. ELisp and CLisp combined.
d46c21ec 1324; (make-regexp
7d7d915a 1325; '("cond" "if" "while" "let\\*?" "prog[nv12*]?" "inline" "catch" "throw"
d46c21ec
SM
1326; "save-restriction" "save-excursion" "save-window-excursion"
1327; "save-selected-window" "save-match-data" "unwind-protect"
1328; "condition-case" "track-mouse"
1329; "eval-after-load" "eval-and-compile" "eval-when-compile"
a078558d
SM
1330; "when" "unless" "do" "flet" "labels" "return" "return-from"
1331; "with-output-to-temp-buffer" "with-timeout"))
9bfbb130
SM
1332 (cons
1333 (concat
1334 "(\\("
a078558d 1335 "c\\(atch\\|ond\\(\\|ition-case\\)\\)\\|do\\|"
9bfbb130 1336 "eval-\\(a\\(fter-load\\|nd-compile\\)\\|when-compile\\)\\|flet\\|"
7d7d915a 1337 "i\\(f\\|nline\\)\\|l\\(abels\\|et\\*?\\)\\|prog[nv12*]?\\|"
a078558d
SM
1338 "return\\(\\|-from\\)\\|save-\\(excursion\\|match-data\\|restriction\\|"
1339 "selected-window\\|window-excursion\\)\\|t\\(hrow\\|rack-mouse\\)\\|"
1340 "un\\(less\\|wind-protect\\)\\|"
1341 "w\\(h\\(en\\|ile\\)\\|ith-\\(output-to-temp-buffer\\|timeout\\)\\)"
9bfbb130
SM
1342 "\\)\\>") 1)
1343 ;;
7d7d915a
SM
1344 ;; Feature symbols as references.
1345 '("(\\(featurep\\|provide\\|require\\)\\>[ \t']*\\(\\sw+\\)?"
1346 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1347 ;;
9bfbb130
SM
1348 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1349 '("\\\\\\\\\\[\\(\\sw+\\)]" 1 font-lock-reference-face prepend)
1350 ;;
1351 ;; Words inside `' tend to be symbol names.
1352 '("`\\(\\sw\\sw+\\)'" 1 font-lock-reference-face prepend)
1353 ;;
1354 ;; CLisp `:' keywords as references.
1355 '("\\<:\\sw+\\>" 0 font-lock-reference-face prepend)
1356 ;;
1357 ;; ELisp and CLisp `&' keywords as types.
343204bd 1358 '("\\<\\&\\sw+\\>" . font-lock-type-face)
9bfbb130 1359 ))
fb512de9 1360 "Gaudy level highlighting for Lisp modes.")
030f4a35 1361
fb512de9
SM
1362(defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
1363 "Default expressions to highlight in Lisp modes.")
030f4a35
RS
1364
1365
d46c21ec 1366(defvar scheme-font-lock-keywords
9bfbb130
SM
1367 (eval-when-compile
1368 (list
1369 ;;
1370 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1371 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1372 (list (concat "(\\(define\\("
1373 ;; Function names.
1374 "\\(\\|-\\(generic\\(\\|-procedure\\)\\|method\\)\\)\\|"
1375 ;; Macro names, as variable names. A bit dubious, this.
1376 "\\(-syntax\\)\\|"
1377 ;; Class names.
1378 "\\(-class\\)"
1379 "\\)\\)\\>"
1380 ;; Any whitespace and declared object.
1381 "[ \t]*(?"
1382 "\\(\\sw+\\)?")
1383 '(1 font-lock-keyword-face)
1384 '(8 (cond ((match-beginning 3) font-lock-function-name-face)
1385 ((match-beginning 6) font-lock-variable-name-face)
1386 (t font-lock-type-face))
1387 nil t))
1388 ;;
1389 ;; Control structures.
d46c21ec
SM
1390;(make-regexp '("begin" "call-with-current-continuation" "call/cc"
1391; "call-with-input-file" "call-with-output-file" "case" "cond"
9bfbb130
SM
1392; "do" "else" "for-each" "if" "lambda"
1393; "let\\*?" "let-syntax" "letrec" "letrec-syntax"
1394; ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1395; "and" "or" "delay"
1396; ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
d46c21ec
SM
1397; ;;"quasiquote" "quote" "unquote" "unquote-splicing"
1398; "map" "syntax" "syntax-rules"))
9bfbb130
SM
1399 (cons
1400 (concat "(\\("
1401 "and\\|begin\\|c\\(a\\(ll\\(-with-\\(current-continuation\\|"
1402 "input-file\\|output-file\\)\\|/cc\\)\\|se\\)\\|ond\\)\\|"
1403 "d\\(elay\\|o\\)\\|else\\|for-each\\|if\\|"
1404 "l\\(ambda\\|et\\(-syntax\\|\\*?\\|rec\\(\\|-syntax\\)\\)\\)\\|"
1405 "map\\|or\\|syntax\\(\\|-rules\\)"
1406 "\\)\\>") 1)
1407 ;;
1408 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
1409 '("\\<<\\sw+>\\>" . font-lock-type-face)
1410 ;;
1411 ;; Scheme `:' keywords as references.
1412 '("\\<:\\sw+\\>" . font-lock-reference-face)
1413 ))
1414"Default expressions to highlight in Scheme modes.")
d46c21ec
SM
1415
1416
030f4a35 1417(defconst c-font-lock-keywords-1 nil
fb512de9 1418 "Subdued level highlighting for C modes.")
030f4a35
RS
1419
1420(defconst c-font-lock-keywords-2 nil
9bfbb130
SM
1421 "Medium level highlighting for C modes.")
1422
1423(defconst c-font-lock-keywords-3 nil
fb512de9 1424 "Gaudy level highlighting for C modes.")
030f4a35 1425
1bd50840 1426(defconst c++-font-lock-keywords-1 nil
fb512de9 1427 "Subdued level highlighting for C++ modes.")
1bd50840
RS
1428
1429(defconst c++-font-lock-keywords-2 nil
9bfbb130
SM
1430 "Medium level highlighting for C++ modes.")
1431
1432(defconst c++-font-lock-keywords-3 nil
fb512de9 1433 "Gaudy level highlighting for C++ modes.")
1bd50840 1434
9bfbb130
SM
1435(defun font-lock-match-c++-style-declaration-item-and-skip-to-next (limit)
1436 ;; Match, and move over, any declaration/definition item after point.
1437 ;; The expect syntax of an item is "word" or "word::word", possibly ending
1438 ;; with optional whitespace and a "(". Everything following the item (but
1439 ;; belonging to it) is expected to by skip-able by `forward-sexp', and items
1440 ;; are expected to be separated with a "," or ";".
1441 (if (looking-at "[ \t*&]*\\(\\sw+\\)\\(::\\(\\sw+\\)\\)?[ \t]*\\((\\)?")
1442 (save-match-data
1443 (condition-case nil
1444 (save-restriction
876f2438
SM
1445 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
1446 (narrow-to-region (point-min) limit)
9bfbb130
SM
1447 (goto-char (match-end 1))
1448 ;; Move over any item value, etc., to the next item.
1449 (while (not (looking-at "[ \t]*\\([,;]\\|$\\)"))
1450 (goto-char (or (scan-sexps (point) 1) (point-max))))
1451 (goto-char (match-end 0)))
1452 (error t)))))
1453
b89e1134
SM
1454(let ((c-keywords
1455; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while")
1456 "break\\|continue\\|do\\|else\\|for\\|if\\|return\\|switch\\|while")
1457 (c-type-types
a1eb1cf1
RS
1458; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
1459; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
b89e1134
SM
1460; "void" "volatile" "const")
1461 (concat "auto\\|c\\(har\\|onst\\)\\|double\\|e\\(num\\|xtern\\)\\|"
1462 "float\\|int\\|long\\|register\\|"
1463 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|typedef\\|"
1464 "un\\(ion\\|signed\\)\\|vo\\(id\\|latile\\)")) ; 6 ()s deep.
1465 (c++-keywords
1466; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
1467; "asm" "catch" "delete" "new" "operator" "sizeof" "this" "throw" "try"
1468; "protected" "private" "public")
1469 (concat "asm\\|break\\|c\\(atch\\|ontinue\\)\\|d\\(elete\\|o\\)\\|"
9bfbb130 1470 "else\\|for\\|if\\|new\\|"
b89e1134
SM
1471 "p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|return\\|"
1472 "s\\(izeof\\|witch\\)\\|t\\(h\\(is\\|row\\)\\|ry\\)\\|while"))
1473 (c++-type-types
1474; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
1475; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
1476; "void" "volatile" "const" "class" "inline" "friend" "bool"
1477; "virtual" "complex" "template")
1478 (concat "auto\\|bool\\|c\\(har\\|lass\\|o\\(mplex\\|nst\\)\\)\\|"
1479 "double\\|e\\(num\\|xtern\\)\\|f\\(loat\\|riend\\)\\|"
1480 "in\\(line\\|t\\)\\|long\\|register\\|"
1481 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|"
1482 "t\\(emplate\\|ypedef\\)\\|un\\(ion\\|signed\\)\\|"
1483 "v\\(irtual\\|o\\(id\\|latile\\)\\)")) ; 11 ()s deep.
9bfbb130 1484 )
f60f18ae
KH
1485 (setq c-font-lock-keywords-1
1486 (list
f60f18ae 1487 ;;
9bfbb130
SM
1488 ;; These are all anchored at the beginning of line for speed.
1489 ;;
1490 ;; Fontify function name definitions (GNU style; without type on line).
1491 (list (concat "^\\(\\sw+\\)[ \t]*(") 1 'font-lock-function-name-face)
1492 ;;
1493 ;; Fontify filenames in #include <...> preprocessor directives as strings.
f60f18ae
KH
1494 '("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
1495 ;;
a1eb1cf1 1496 ;; Fontify function macro names.
7d7d915a 1497 '("^#[ \t]*define[ \t]+\\(\\sw+\\)(" 1 font-lock-function-name-face)
f60f18ae 1498 ;;
9bfbb130
SM
1499 ;; Fontify symbol names in #if ... defined preprocessor directives.
1500 '("^#[ \t]*if\\>"
1501 ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
1502 (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t)))
1503 ;;
a1eb1cf1 1504 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
7d7d915a 1505 '("^#[ \t]*\\(\\sw+\\)\\>[ \t]*\\(\\sw+\\)?"
a1eb1cf1 1506 (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t))
f60f18ae
KH
1507 ))
1508
1509 (setq c-font-lock-keywords-2
1510 (append c-font-lock-keywords-1
030f4a35 1511 (list
030f4a35 1512 ;;
9bfbb130 1513 ;; Simple regexps for speed.
b89e1134 1514 ;;
9bfbb130
SM
1515 ;; Fontify all type specifiers.
1516 (cons (concat "\\<\\(" c-type-types "\\)\\>") 'font-lock-type-face)
030f4a35 1517 ;;
b89e1134 1518 ;; Fontify all builtin keywords (except case, default and goto; see below).
9bfbb130 1519 (cons (concat "\\<\\(" c-keywords "\\)\\>") 'font-lock-keyword-face)
030f4a35 1520 ;;
9bfbb130 1521 ;; Fontify case/goto keywords and targets, and case default/goto tags.
7d7d915a 1522 '("\\<\\(case\\|goto\\)\\>[ \t]*\\(\\sw+\\)?"
a1eb1cf1
RS
1523 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1524 '("^[ \t]*\\(\\sw+\\)[ \t]*:" 1 font-lock-reference-face)
f60f18ae 1525 )))
1bd50840 1526
9bfbb130
SM
1527 (setq c-font-lock-keywords-3
1528 (append c-font-lock-keywords-2
1529 ;;
1530 ;; More complicated regexps for more complete highlighting for types.
1531 ;; We still have to fontify type specifiers individually, as C is so hairy.
1532 (list
1533 ;;
1534 ;; Fontify all storage classes and type specifiers, plus their items.
1535 (list (concat "\\<\\(" c-type-types "\\)\\>"
1536 "\\([ \t*&]+\\sw+\\>\\)*")
1537 ;; Fontify each declaration item.
1538 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
1539 ;; Start with point after all type specifiers.
1540 (goto-char (or (match-beginning 8) (match-end 1)))
1541 ;; Finish with point after first type specifier.
1542 (goto-char (match-end 1))
1543 ;; Fontify as a variable or function name.
1544 (1 (if (match-beginning 4)
1545 font-lock-function-name-face
1546 font-lock-variable-name-face))))
1547 ;;
1548 ;; Fontify structures, or typedef names, plus their items.
1549 '("\\(}\\)[ \t*]*\\sw"
1550 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1551 (goto-char (match-end 1)) nil
1552 (1 (if (match-beginning 4)
1553 font-lock-function-name-face
1554 font-lock-variable-name-face))))
1555 ;;
1556 ;; Fontify anything at beginning of line as a declaration or definition.
1557 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
1558 (1 font-lock-type-face)
1559 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1560 (goto-char (or (match-beginning 2) (match-end 1))) nil
1561 (1 (if (match-beginning 4)
1562 font-lock-function-name-face
1563 font-lock-variable-name-face))))
1564 )))
1565
1566 (setq c++-font-lock-keywords-1
1567 (append
1568 ;;
1569 ;; The list `c-font-lock-keywords-1' less that for function names.
1570 (cdr c-font-lock-keywords-1)
1571 ;;
1572 ;; Fontify function name definitions, possibly incorporating class name.
1573 (list
1574 '("^\\(\\sw+\\)\\(::\\(\\sw+\\)\\)?[ \t]*("
1575 (1 (if (match-beginning 2)
1576 font-lock-type-face
1577 font-lock-function-name-face))
1578 (3 (if (match-beginning 2) font-lock-function-name-face) nil t))
1579 )))
1580
1bd50840 1581 (setq c++-font-lock-keywords-2
b89e1134 1582 (append c++-font-lock-keywords-1
a1eb1cf1 1583 (list
9bfbb130
SM
1584 ;;
1585 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
b89e1134 1586 (cons (concat "\\<\\(" c++-type-types "\\)\\>") 'font-lock-type-face)
9bfbb130
SM
1587 ;;
1588 ;; Fontify operator function name overloading.
1589 '("\\<\\(operator\\)\\>[ \t]*\\([][)(><!=+-][][)(><!=+-]?\\)?"
1590 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
1591 ;;
1592 ;; Fontify case/goto keywords and targets, and case default/goto tags.
7d7d915a 1593 '("\\<\\(case\\|goto\\)\\>[ \t]*\\(\\sw+\\)?"
b89e1134 1594 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
9bfbb130
SM
1595 '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-reference-face)
1596 ;;
1597 ;; Fontify other builtin keywords.
1598 (cons (concat "\\<\\(" c++-keywords "\\)\\>") 'font-lock-keyword-face)
1599 )))
1600
1601 (setq c++-font-lock-keywords-3
1602 (append c++-font-lock-keywords-2
1603 ;;
1604 ;; More complicated regexps for more complete highlighting for types.
1605 (list
1606 ;;
1607 ;; Fontify all storage classes and type specifiers, plus their items.
1608 (list (concat "\\<\\(" c++-type-types "\\)\\>"
1609 "\\([ \t*&]+\\sw+\\>\\)*")
1610 ;; Fontify each declaration item.
1611 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
1612 ;; Start with point after all type specifiers.
1613 (goto-char (or (match-beginning 13) (match-end 1)))
1614 ;; Finish with point after first type specifier.
1615 (goto-char (match-end 1))
1616 ;; Fontify as a variable or function name.
1617 (1 (cond ((match-beginning 2) font-lock-type-face)
1618 ((match-beginning 4) font-lock-function-name-face)
1619 (t font-lock-variable-name-face)))
1620 (3 (if (match-beginning 4)
1621 font-lock-function-name-face
1622 font-lock-variable-name-face) nil t)))
1623 ;;
1624 ;; Fontify structures, or typedef names, plus their items.
1625 '("\\(}\\)[ \t*]*\\sw"
1626 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1627 (goto-char (match-end 1)) nil
1628 (1 (if (match-beginning 4)
1629 font-lock-function-name-face
1630 font-lock-variable-name-face))))
1631 ;;
1632 ;; Fontify anything at beginning of line as a declaration or definition.
1633 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
1634 (1 font-lock-type-face)
1635 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1636 (goto-char (or (match-beginning 2) (match-end 1))) nil
1637 (1 (cond ((match-beginning 2) font-lock-type-face)
1638 ((match-beginning 4) font-lock-function-name-face)
1639 (t font-lock-variable-name-face)))
1640 (3 (if (match-beginning 4)
1641 font-lock-function-name-face
1642 font-lock-variable-name-face) nil t)))
1643 )))
f60f18ae 1644 )
030f4a35 1645
fb512de9
SM
1646(defvar c-font-lock-keywords c-font-lock-keywords-1
1647 "Default expressions to highlight in C mode.")
030f4a35 1648
fb512de9
SM
1649(defvar c++-font-lock-keywords c++-font-lock-keywords-1
1650 "Default expressions to highlight in C++ mode.")
030f4a35 1651
d46c21ec 1652
030f4a35 1653(defvar tex-font-lock-keywords
d46c21ec
SM
1654; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
1655; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
1656; 2 font-lock-function-name-face)
1657; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
1658; 2 font-lock-reference-face)
1659; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1660; ;; not be able to display those fonts.
1661; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
1662; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
1663; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
1664; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
1665 ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
826b2925
SM
1666 '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
1667 2 font-lock-function-name-face)
1668 ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
1669 2 font-lock-reference-face)
d46c21ec 1670 ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
9bfbb130 1671 "\\\\\\([a-zA-Z@]+\\|.\\)"
826b2925
SM
1672 ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1673 ;; not be able to display those fonts.
d46c21ec
SM
1674 ;; LaTeX2e: \emph{This is emphasized}.
1675 ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
1676 ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
1677 ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
1678 3 (if (match-beginning 2) 'bold 'italic) keep)
1679 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables.
1680 ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
1681 3 (if (match-beginning 2) 'bold 'italic) keep))
9bfbb130 1682 "Default expressions to highlight in TeX modes.")
d46c21ec 1683\f
a1eb1cf1
RS
1684;; Install ourselves:
1685
a1eb1cf1
RS
1686(or (assq 'font-lock-mode minor-mode-alist)
1687 (setq minor-mode-alist (cons '(font-lock-mode " Font") minor-mode-alist)))
1688
1689;; Provide ourselves:
8f261d40 1690
030f4a35
RS
1691(provide 'font-lock)
1692
1693;;; font-lock.el ends here