Make get-buffer-window-list take MINIBUF arg.
[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
100 "*If non-nil, the maximum decoration level for fontifying.
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)
112 "*If non-nil, the maximum size for buffers for fontifying.
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).
431 (let ((on-p (and (not noninteractive)
432 (not (eq (aref (buffer-name) 0) ?\ ))
433 (if arg
434 (> (prefix-numeric-value arg) 0)
435 (not font-lock-mode))))
9bfbb130
SM
436 (maximum-size (if (not (consp font-lock-maximum-size))
437 font-lock-maximum-size
438 (cdr (or (assq major-mode font-lock-maximum-size)
439 (assq t font-lock-maximum-size))))))
a1eb1cf1 440 (if (not on-p)
876f2438
SM
441 (remove-hook 'after-change-functions 'font-lock-after-change-function
442 t)
443 (make-local-hook 'after-change-functions)
444 (add-hook 'after-change-functions 'font-lock-after-change-function
445 nil t))
030f4a35
RS
446 (set (make-local-variable 'font-lock-mode) on-p)
447 (cond (on-p
448 (font-lock-set-defaults)
a2b8e66b 449 ;; If buffer is reverted, must clean up the state.
876f2438
SM
450 (make-local-hook 'before-revert-hook)
451 (make-local-hook 'after-revert-hook)
876f2438
SM
452 (add-hook 'before-revert-hook 'font-lock-revert-setup nil t)
453 (add-hook 'after-revert-hook 'font-lock-revert-cleanup nil t)
030f4a35 454 (run-hooks 'font-lock-mode-hook)
b89e1134
SM
455 (cond (font-lock-fontified
456 nil)
a2b8e66b
SM
457 ((or (null maximum-size) (<= (buffer-size) maximum-size)
458 (not (eq font-lock-fontify-buffer-function
459 (default-value
460 'font-lock-fontify-buffer-function))))
b89e1134
SM
461 (font-lock-fontify-buffer))
462 (font-lock-verbose
463 (message "Fontifying %s... buffer too big." (buffer-name)))))
030f4a35 464 (font-lock-fontified
a2b8e66b 465 (font-lock-unfontify-buffer)
876f2438
SM
466 (remove-hook 'before-revert-hook 'font-lock-revert-setup t)
467 (remove-hook 'after-revert-hook 'font-lock-revert-cleanup t)
a2b8e66b
SM
468 (font-lock-thing-lock-cleanup)
469 (font-lock-unset-defaults))
799761f0 470 (t
876f2438
SM
471 (remove-hook 'before-revert-hook 'font-lock-revert-setup t)
472 (remove-hook 'after-revert-hook 'font-lock-revert-cleanup t)
a2b8e66b
SM
473 (font-lock-thing-lock-cleanup)
474 (font-lock-unset-defaults)))
030f4a35
RS
475 (force-mode-line-update)))
476
a1eb1cf1
RS
477;;;###autoload
478(defun turn-on-font-lock ()
a465832f
SM
479 "Turn on Font Lock mode conditionally.
480Turn on only if the buffer mode supports it and the terminal can display it."
481 (if (and window-system
482 (not font-lock-mode)
483 (or font-lock-defaults (assq major-mode font-lock-defaults-alist)))
484 (font-lock-mode t)))
a2b8e66b
SM
485\f
486;; Code for Global Font Lock mode.
487
488;; A few people have hassled in the past for a way to make it easier to turn on
489;; Font Lock mode, perhaps the same way hilit19.el/hl319.el does. I've always
490;; balked at that way, as I see it as just re-moulding the same problem in
491;; another form. That is; some person would still have to keep track of which
492;; modes (which may not even be distributed with Emacs) support Font Lock mode.
493;; The list would always be out of date. And that person might have to be me.
494
495;; In the latest of these discussions the following hack came to mind. It is a
496;; gross hack, but it generally works. We use the convention that major modes
497;; start by calling the function `kill-all-local-variables', which in turn runs
498;; functions on the hook variable `change-major-mode-hook'. We attach our
499;; function `font-lock-change-major-mode' to that hook. Of course, when this
500;; hook is run, the major mode is in the process of being changed and we do not
501;; know what the final major mode will be. So, `font-lock-change-major-mode'
502;; only (a) notes the name of the current buffer, and (b) adds our function
a465832f 503;; `turn-on-font-lock-if-enabled' to the hook variable `post-command-hook'.
a2b8e66b
SM
504;; By the time the functions on `post-command-hook' are run, the new major mode
505;; is assumed to be in place.
506
507;; Naturally this requires that (a) major modes run `kill-all-local-variables',
508;; as they are supposed to do, and (b) the major mode is in place after the
509;; command that ran `kill-all-local-variables' has finished. Arguably, any
510;; major mode that does not follow the convension (a) is broken, and I can't
511;; think of any reason why (b) would not be met. I don't know of any major
512;; modes that do not follow the convension (a), but I'm sure there are some
513;; obscure ones out there somewhere. Even if it works, it is still not clean.
514
515;; Probably the cleanest solution is to have each major mode function run some
516;; hook, e.g., `major-mode-hook', but maybe implementing that change is
517;; impractical. I am personally against making `setq' a macro or be advised
518;; (space'n'speed), or have a special function such as `set-major-mode' (a
519;; `major-mode-hook' is simpler), but maybe someone can come up with another
520;; solution? --sm.
521
a078558d
SM
522(defvar font-lock-cache-buffers nil) ; For remembering buffers.
523(defvar change-major-mode-hook nil) ; Make sure it's not void.
524
a2b8e66b
SM
525;;;###autoload
526(defvar font-lock-global-modes t
527 "*List of modes for which Font Lock mode is automatically turned on.
528Global Font Lock mode is controlled by the `global-font-lock-mode' command.
529If nil, means no modes have Font Lock mode automatically turned on.
530If t, all modes that support Font Lock mode have it automatically turned on.
531If a list, each element should be a major mode symbol name such as `c-mode'.
532Font Lock is automatically turned on if the buffer major mode supports it and
533is in this list. The sense of the list is negated if it begins with `not'.")
534
535;;;###autoload
536(defun global-font-lock-mode (&optional arg)
537 "Toggle Global Font Lock mode.
538With arg, turn Global Font Lock mode on if and only if arg is positive.
539
540When Global Font Lock mode is enabled, Font Lock mode is automagically
541turned on in a buffer if its major mode is one of `font-lock-global-modes'."
542 (interactive "P")
543 (if (if arg
544 (<= (prefix-numeric-value arg) 0)
545 (memq 'font-lock-change-major-mode change-major-mode-hook))
546 (remove-hook 'change-major-mode-hook 'font-lock-change-major-mode)
547 (add-hook 'change-major-mode-hook 'font-lock-change-major-mode)
a465832f 548 (add-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
a2b8e66b
SM
549 (setq font-lock-cache-buffers (buffer-list))))
550
a2b8e66b
SM
551(defun font-lock-change-major-mode ()
552 ;; Gross hack warning: Delicate readers should avert eyes now.
553 ;; Something is running `kill-all-local-variables', which generally means
a465832f
SM
554 ;; the major mode is being changed. Run `turn-on-font-lock-if-enabled' after
555 ;; the current command has finished.
556 (add-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
a2b8e66b
SM
557 (add-to-list 'font-lock-cache-buffers (current-buffer)))
558
a465832f 559(defun turn-on-font-lock-if-enabled ()
a2b8e66b 560 ;; Gross hack warning: Delicate readers should avert eyes now.
a465832f
SM
561 ;; Turn on Font Lock mode if it's one of `font-lock-global-modes'.
562 (remove-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
a2b8e66b 563 (while font-lock-cache-buffers
a465832f 564 (if (buffer-live-p (car font-lock-cache-buffers))
a2b8e66b
SM
565 (save-excursion
566 (set-buffer (car font-lock-cache-buffers))
a465832f
SM
567 (if (or (eq font-lock-global-modes t)
568 (if (eq (car-safe font-lock-global-modes) 'not)
569 (not (memq major-mode (cdr font-lock-global-modes)))
570 (memq major-mode font-lock-global-modes)))
a2b8e66b
SM
571 (turn-on-font-lock))))
572 (setq font-lock-cache-buffers (cdr font-lock-cache-buffers))))
573
574;; End of Global Font Lock mode.
575\f
576;; Fontification functions.
a1eb1cf1 577
a1eb1cf1 578;;;###autoload
030f4a35 579(defun font-lock-fontify-buffer ()
a1eb1cf1 580 "Fontify the current buffer the way `font-lock-mode' would."
030f4a35 581 (interactive)
a2b8e66b
SM
582 (let ((font-lock-verbose (or font-lock-verbose (interactive-p))))
583 (funcall font-lock-fontify-buffer-function)))
584
585(defun font-lock-unfontify-buffer ()
586 (funcall font-lock-unfontify-buffer-function))
587
588(defun font-lock-fontify-region (beg end &optional loudly)
589 (funcall font-lock-fontify-region-function beg end loudly))
590
591(defun font-lock-unfontify-region (beg end)
592 (funcall font-lock-unfontify-region-function beg end))
593
594(defun font-lock-default-fontify-buffer ()
595 (let ((verbose (and font-lock-verbose (> (buffer-size) 0))))
a1eb1cf1 596 (if verbose (message "Fontifying %s..." (buffer-name)))
7d7d915a
SM
597 ;; Make sure we have the right `font-lock-keywords' etc.
598 (if (not font-lock-mode) (font-lock-set-defaults))
599 ;; Make sure we fontify etc. in the whole buffer.
600 (save-restriction
601 (widen)
602 (condition-case nil
603 (save-excursion
604 (save-match-data
605 (font-lock-fontify-region (point-min) (point-max) verbose)
271c888a 606 (font-lock-after-fontify-buffer)
7d7d915a
SM
607 (setq font-lock-fontified t)))
608 ;; We don't restore the old fontification, so it's best to unfontify.
a078558d
SM
609 (quit (font-lock-unfontify-buffer))))
610 (if verbose (message "Fontifying %s... %s." (buffer-name)
611 (if font-lock-fontified "done" "aborted")))))
7d7d915a 612
a2b8e66b
SM
613(defun font-lock-default-unfontify-buffer ()
614 (save-restriction
615 (widen)
616 (font-lock-unfontify-region (point-min) (point-max))
271c888a 617 (font-lock-after-unfontify-buffer)
a2b8e66b 618 (setq font-lock-fontified nil)))
9bfbb130
SM
619
620;; We use this wrapper. However, `font-lock-fontify-region' used to be the
621;; name used for `font-lock-fontify-syntactically-region', so a change isn't
622;; back-compatible. But you shouldn't be calling these directly, should you?
a2b8e66b 623(defun font-lock-default-fontify-region (beg end loudly)
876f2438
SM
624 (let ((modified (buffer-modified-p))
625 (buffer-undo-list t) (inhibit-read-only t)
626 (old-syntax-table (syntax-table))
7d7d915a 627 before-change-functions after-change-functions
876f2438
SM
628 buffer-file-name buffer-file-truename)
629 (unwind-protect
a078558d
SM
630 (save-restriction
631 (widen)
876f2438
SM
632 ;; Use the fontification syntax table, if any.
633 (if font-lock-syntax-table (set-syntax-table font-lock-syntax-table))
634 ;; Now do the fontification.
635 (if font-lock-keywords-only
636 (font-lock-unfontify-region beg end)
637 (font-lock-fontify-syntactically-region beg end loudly))
638 (font-lock-fontify-keywords-region beg end loudly))
639 ;; Clean up.
640 (set-syntax-table old-syntax-table)
641 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil)))))
9bfbb130
SM
642
643;; The following must be rethought, since keywords can override fontification.
644; ;; Now scan for keywords, but not if we are inside a comment now.
645; (or (and (not font-lock-keywords-only)
646; (let ((state (parse-partial-sexp beg end nil nil
647; font-lock-cache-state)))
648; (or (nth 4 state) (nth 7 state))))
649; (font-lock-fontify-keywords-region beg end))
650
a2b8e66b 651(defun font-lock-default-unfontify-region (beg end)
9bfbb130
SM
652 (let ((modified (buffer-modified-p))
653 (buffer-undo-list t) (inhibit-read-only t)
7d7d915a 654 before-change-functions after-change-functions
9bfbb130
SM
655 buffer-file-name buffer-file-truename)
656 (remove-text-properties beg end '(face nil))
876f2438 657 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil))))
9bfbb130
SM
658
659;; Called when any modification is made to buffer text.
660(defun font-lock-after-change-function (beg end old-len)
661 (save-excursion
662 (save-match-data
663 ;; Rescan between start of line from `beg' and start of line after `end'.
664 (font-lock-fontify-region
665 (progn (goto-char beg) (beginning-of-line) (point))
666 (progn (goto-char end) (forward-line 1) (point))))))
a2b8e66b 667
a078558d
SM
668(defun font-lock-fontify-block (&optional arg)
669 "Fontify some lines the way `font-lock-fontify-buffer' would.
670The lines could be a function or paragraph, or a specified number of lines.
a078558d 671If ARG is given, fontify that many lines before and after point, or 16 lines if
a465832f
SM
672no ARG is given and `font-lock-mark-block-function' is nil.
673If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
674delimit the region to fontify."
a078558d 675 (interactive "P")
a465832f 676 (let (font-lock-beginning-of-syntax-function deactivate-mark)
a078558d
SM
677 ;; Make sure we have the right `font-lock-keywords' etc.
678 (if (not font-lock-mode) (font-lock-set-defaults))
a2b8e66b
SM
679 (save-excursion
680 (save-match-data
681 (condition-case error-data
a078558d
SM
682 (if (or arg (not font-lock-mark-block-function))
683 (let ((lines (if arg (prefix-numeric-value arg) 16)))
684 (font-lock-fontify-region
685 (save-excursion (forward-line (- lines)) (point))
686 (save-excursion (forward-line lines) (point))))
687 (funcall font-lock-mark-block-function)
688 (font-lock-fontify-region (point) (mark)))
689 ((error quit) (message "Fontifying block... %s" error-data)))))))
690
691(define-key esc-map "\C-g" 'font-lock-fontify-block)
9bfbb130
SM
692\f
693;; Syntactic fontification functions.
694
a078558d
SM
695;; These record the parse state at a particular position, always the start of a
696;; line. Used to make `font-lock-fontify-syntactically-region' faster.
697(defvar font-lock-cache-position nil)
698(defvar font-lock-cache-state nil)
699(make-variable-buffer-local 'font-lock-cache-position)
700(make-variable-buffer-local 'font-lock-cache-state)
701
9bfbb130
SM
702(defun font-lock-fontify-syntactically-region (start end &optional loudly)
703 "Put proper face on each string and comment between START and END.
704START should be at the beginning of a line."
876f2438 705 (let ((synstart (if comment-start-skip
9bfbb130
SM
706 (concat "\\s\"\\|" comment-start-skip)
707 "\\s\""))
708 (comstart (if comment-start-skip
709 (concat "\\s<\\|" comment-start-skip)
710 "\\s<"))
9bfbb130
SM
711 state prev prevstate)
712 (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
a078558d
SM
713 (goto-char start)
714 ;;
715 ;; Find the state at the `beginning-of-line' before `start'.
716 (if (eq start font-lock-cache-position)
717 ;; Use the cache for the state of `start'.
718 (setq state font-lock-cache-state)
719 ;; Find the state of `start'.
720 (if (null font-lock-beginning-of-syntax-function)
721 ;; Use the state at the previous cache position, if any, or
722 ;; otherwise calculate from `point-min'.
723 (if (or (null font-lock-cache-position)
724 (< start font-lock-cache-position))
725 (setq state (parse-partial-sexp (point-min) start))
726 (setq state (parse-partial-sexp font-lock-cache-position start
727 nil nil font-lock-cache-state)))
728 ;; Call the function to move outside any syntactic block.
729 (funcall font-lock-beginning-of-syntax-function)
730 (setq state (parse-partial-sexp (point) start)))
731 ;; Cache the state and position of `start'.
732 (setq font-lock-cache-state state
733 font-lock-cache-position start))
734 ;;
735 ;; If the region starts inside a string, show the extent of it.
736 (if (nth 3 state)
737 (let ((beg (point)))
738 (while (and (re-search-forward "\\s\"" end 'move)
739 (nth 3 (parse-partial-sexp beg (point) nil nil state))))
740 (put-text-property beg (point) 'face font-lock-string-face)
741 (setq state (parse-partial-sexp beg (point) nil nil state))))
742 ;;
743 ;; Likewise for a comment.
744 (if (or (nth 4 state) (nth 7 state))
745 (let ((beg (point)))
746 (save-restriction
747 (narrow-to-region (point-min) end)
748 (condition-case nil
749 (progn
750 (re-search-backward comstart (point-min) 'move)
751 (forward-comment 1)
752 ;; forward-comment skips all whitespace,
753 ;; so go back to the real end of the comment.
754 (skip-chars-backward " \t"))
755 (error (goto-char end))))
756 (put-text-property beg (point) 'face font-lock-comment-face)
757 (setq state (parse-partial-sexp beg (point) nil nil state))))
758 ;;
759 ;; Find each interesting place between here and `end'.
760 (while (and (< (point) end)
761 (setq prev (point) prevstate state)
762 (re-search-forward synstart end t)
763 (progn
764 ;; Clear out the fonts of what we skip over.
765 (remove-text-properties prev (point) '(face nil))
766 ;; Verify the state at that place
767 ;; so we don't get fooled by \" or \;.
768 (setq state (parse-partial-sexp prev (point)
769 nil nil state))))
770 (let ((here (point)))
771 (if (or (nth 4 state) (nth 7 state))
772 ;;
773 ;; We found a real comment start.
774 (let ((beg (match-beginning 0)))
775 (goto-char beg)
776 (save-restriction
777 (narrow-to-region (point-min) end)
778 (condition-case nil
779 (progn
780 (forward-comment 1)
781 ;; forward-comment skips all whitespace,
782 ;; so go back to the real end of the comment.
783 (skip-chars-backward " \t"))
784 (error (goto-char end))))
785 (put-text-property beg (point) 'face font-lock-comment-face)
786 (setq state (parse-partial-sexp here (point) nil nil state)))
787 (if (nth 3 state)
876f2438 788 ;;
a078558d 789 ;; We found a real string start.
876f2438 790 (let ((beg (match-beginning 0)))
a078558d
SM
791 (while (and (re-search-forward "\\s\"" end 'move)
792 (nth 3 (parse-partial-sexp here (point)
793 nil nil state))))
794 (put-text-property beg (point) 'face font-lock-string-face)
795 (setq state (parse-partial-sexp here (point)
796 nil nil state))))))
797 ;;
798 ;; Make sure `prev' is non-nil after the loop
799 ;; only if it was set on the very last iteration.
800 (setq prev nil))
876f2438
SM
801 ;;
802 ;; Clean up.
803 (and prev (remove-text-properties prev end '(face nil)))))
9bfbb130
SM
804\f
805;;; Additional text property functions.
806
807;; The following three text property functions are not generally available (and
808;; it's not certain that they should be) so they are inlined for speed.
809;; The case for `fillin-text-property' is simple; it may or not be generally
810;; useful. (Since it is used here, it is useful in at least one place.;-)
811;; However, the case for `append-text-property' and `prepend-text-property' is
812;; more complicated. Should they remove duplicate property values or not? If
813;; so, should the first or last duplicate item remain? Or the one that was
814;; added? In our implementation, the first duplicate remains.
815
816(defsubst font-lock-fillin-text-property (start end prop value &optional object)
817 "Fill in one property of the text from START to END.
818Arguments PROP and VALUE specify the property and value to put where none are
819already in place. Therefore existing property values are not overwritten.
820Optional argument OBJECT is the string or buffer containing the text."
821 (let ((start (text-property-any start end prop nil object)) next)
822 (while start
823 (setq next (next-single-property-change start prop object end))
824 (put-text-property start next prop value object)
825 (setq start (text-property-any next end prop nil object)))))
826
827;; This function (from simon's unique.el) is rewritten and inlined for speed.
828;(defun unique (list function)
829; "Uniquify LIST, deleting elements using FUNCTION.
830;Return the list with subsequent duplicate items removed by side effects.
831;FUNCTION is called with an element of LIST and a list of elements from LIST,
832;and should return the list of elements with occurrences of the element removed,
833;i.e., a function such as `delete' or `delq'.
834;This function will work even if LIST is unsorted. See also `uniq'."
835; (let ((list list))
836; (while list
837; (setq list (setcdr list (funcall function (car list) (cdr list))))))
838; list)
839
840(defsubst font-lock-unique (list)
841 "Uniquify LIST, deleting elements using `delq'.
842Return the list with subsequent duplicate items removed by side effects."
843 (let ((list list))
844 (while list
845 (setq list (setcdr list (delq (car list) (cdr list))))))
846 list)
847
848;; A generalisation of `facemenu-add-face' for any property, but without the
849;; removal of inactive faces via `facemenu-discard-redundant-faces' and special
850;; treatment of `default'. Uses `unique' to remove duplicate property values.
851(defsubst font-lock-prepend-text-property (start end prop value &optional object)
852 "Prepend to one property of the text from START to END.
853Arguments PROP and VALUE specify the property and value to prepend to the value
854already in place. The resulting property values are always lists, and unique.
855Optional argument OBJECT is the string or buffer containing the text."
856 (let ((val (if (listp value) value (list value))) next prev)
857 (while (/= start end)
858 (setq next (next-single-property-change start prop object end)
859 prev (get-text-property start prop object))
860 (put-text-property
861 start next prop
862 (font-lock-unique (append val (if (listp prev) prev (list prev))))
863 object)
864 (setq start next))))
865
866(defsubst font-lock-append-text-property (start end prop value &optional object)
867 "Append to one property of the text from START to END.
868Arguments PROP and VALUE specify the property and value to append to the value
869already in place. The resulting property values are always lists, and unique.
870Optional argument OBJECT is the string or buffer containing the text."
871 (let ((val (if (listp value) value (list value))) next prev)
872 (while (/= start end)
873 (setq next (next-single-property-change start prop object end)
874 prev (get-text-property start prop object))
875 (put-text-property
876 start next prop
877 (font-lock-unique (append (if (listp prev) prev (list prev)) val))
878 object)
879 (setq start next))))
880\f
881;;; Regexp fontification functions.
882
883(defsubst font-lock-apply-highlight (highlight)
884 "Apply HIGHLIGHT following a match.
885HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
886 (let* ((match (nth 0 highlight))
887 (start (match-beginning match)) (end (match-end match))
888 (override (nth 2 highlight)))
889 (cond ((not start)
890 ;; No match but we might not signal an error.
891 (or (nth 3 highlight)
892 (error "No match %d in highlight %S" match highlight)))
893 ((not override)
894 ;; Cannot override existing fontification.
895 (or (text-property-not-all start end 'face nil)
896 (put-text-property start end 'face (eval (nth 1 highlight)))))
897 ((eq override t)
898 ;; Override existing fontification.
899 (put-text-property start end 'face (eval (nth 1 highlight))))
900 ((eq override 'keep)
901 ;; Keep existing fontification.
902 (font-lock-fillin-text-property start end 'face
903 (eval (nth 1 highlight))))
904 ((eq override 'prepend)
905 ;; Prepend to existing fontification.
906 (font-lock-prepend-text-property start end 'face
907 (eval (nth 1 highlight))))
908 ((eq override 'append)
909 ;; Append to existing fontification.
910 (font-lock-append-text-property start end 'face
911 (eval (nth 1 highlight)))))))
912
913(defsubst font-lock-fontify-anchored-keywords (keywords limit)
914 "Fontify according to KEYWORDS until LIMIT.
915KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords'."
916 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights)
876f2438
SM
917 ;; Until we come up with a cleaner solution, we make LIMIT the end of line.
918 (save-excursion (end-of-line) (setq limit (min limit (point))))
919 ;; Evaluate PRE-MATCH-FORM.
9bfbb130
SM
920 (eval (nth 1 keywords))
921 (save-match-data
876f2438 922 ;; Find an occurrence of `matcher' before `limit'.
9bfbb130
SM
923 (while (if (stringp matcher)
924 (re-search-forward matcher limit t)
925 (funcall matcher limit))
876f2438 926 ;; Apply each highlight to this instance of `matcher'.
9bfbb130
SM
927 (setq highlights lowdarks)
928 (while highlights
929 (font-lock-apply-highlight (car highlights))
930 (setq highlights (cdr highlights)))))
876f2438 931 ;; Evaluate POST-MATCH-FORM.
9bfbb130
SM
932 (eval (nth 2 keywords))))
933
934(defun font-lock-fontify-keywords-region (start end &optional loudly)
935 "Fontify according to `font-lock-keywords' between START and END.
936START should be at the beginning of a line."
937 (let ((case-fold-search font-lock-keywords-case-fold-search)
938 (keywords (cdr (if (eq (car-safe font-lock-keywords) t)
939 font-lock-keywords
940 (font-lock-compile-keywords))))
9bfbb130 941 (bufname (buffer-name)) (count 0)
876f2438
SM
942 keyword matcher highlights)
943 ;;
944 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
945 (while keywords
946 (if loudly (message "Fontifying %s... (regexps..%s)" bufname
947 (make-string (setq count (1+ count)) ?.)))
9bfbb130 948 ;;
876f2438
SM
949 ;; Find an occurrence of `matcher' from `start' to `end'.
950 (setq keyword (car keywords) matcher (car keyword))
951 (goto-char start)
952 (while (if (stringp matcher)
953 (re-search-forward matcher end t)
954 (funcall matcher end))
955 ;; Apply each highlight to this instance of `matcher', which may be
956 ;; specific highlights or more keywords anchored to `matcher'.
957 (setq highlights (cdr keyword))
958 (while highlights
959 (if (numberp (car (car highlights)))
960 (font-lock-apply-highlight (car highlights))
961 (font-lock-fontify-anchored-keywords (car highlights) end))
962 (setq highlights (cdr highlights))))
963 (setq keywords (cdr keywords)))))
9bfbb130
SM
964\f
965;; Various functions.
966
967;; Turn off other related packages if they're on. I prefer a hook. --sm.
968;; These explicit calls are easier to understand
969;; because people know what they will do.
970;; A hook is a mystery because it might do anything whatever. --rms.
971(defun font-lock-thing-lock-cleanup ()
972 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
973 (fast-lock-mode -1))
974 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
975 (lazy-lock-mode -1))))
976
271c888a 977;; Do something special for these packages after fontifying; I prefer a hook.
9bfbb130
SM
978(defun font-lock-after-fontify-buffer ()
979 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
980 (fast-lock-after-fontify-buffer))
981 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
982 (lazy-lock-after-fontify-buffer))))
983
271c888a
SM
984;; Do something special for these packages after unfontifying; I prefer a hook.
985(defun font-lock-after-unfontify-buffer ()
986 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
987 (fast-lock-after-unfontify-buffer))
988 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
989 (lazy-lock-after-unfontify-buffer))))
990
9bfbb130
SM
991;; If the buffer is about to be reverted, it won't be fontified afterward.
992(defun font-lock-revert-setup ()
993 (setq font-lock-fontified nil))
994
995;; If the buffer has just been reverted, normally that turns off
996;; Font Lock mode. So turn the mode back on if necessary.
7d7d915a
SM
997(defalias 'font-lock-revert-cleanup
998 'turn-on-font-lock)
9bfbb130
SM
999
1000(defun font-lock-compile-keywords (&optional keywords)
1001 ;; Compile `font-lock-keywords' into the form (t KEYWORD ...) where KEYWORD
1002 ;; is the (MATCHER HIGHLIGHT ...) shown in the variable's doc string.
1003 (let ((keywords (or keywords font-lock-keywords)))
1004 (setq font-lock-keywords
a2b8e66b
SM
1005 (if (eq (car-safe keywords) t)
1006 keywords
1007 (cons t (mapcar 'font-lock-compile-keyword keywords))))))
1008
1009(defun font-lock-compile-keyword (keyword)
1010 (cond ((nlistp keyword) ; Just MATCHER
1011 (list keyword '(0 font-lock-keyword-face)))
1012 ((eq (car keyword) 'eval) ; Specified (eval . FORM)
1013 (font-lock-compile-keyword (eval (cdr keyword))))
1014 ((numberp (cdr keyword)) ; Specified (MATCHER . MATCH)
1015 (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
1016 ((symbolp (cdr keyword)) ; Specified (MATCHER . FACENAME)
1017 (list (car keyword) (list 0 (cdr keyword))))
1018 ((nlistp (nth 1 keyword)) ; Specified (MATCHER . HIGHLIGHT)
1019 (list (car keyword) (cdr keyword)))
1020 (t ; Hopefully (MATCHER HIGHLIGHT ...)
1021 keyword)))
d46c21ec
SM
1022
1023(defun font-lock-choose-keywords (keywords level)
1024 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1025 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
9bfbb130
SM
1026 (let ((level (if (not (consp level))
1027 level
1028 (cdr (or (assq major-mode level) (assq t level))))))
1029 (cond ((symbolp keywords)
1030 keywords)
1031 ((numberp level)
1032 (or (nth level keywords) (car (reverse keywords))))
1033 ((eq level t)
1034 (car (reverse keywords)))
1035 (t
1036 (car keywords)))))
d46c21ec
SM
1037
1038(defun font-lock-set-defaults ()
1039 "Set fontification defaults appropriately for this mode.
a2b8e66b
SM
1040Sets various variables using `font-lock-defaults' (or, if nil, using
1041`font-lock-defaults-alist') and `font-lock-maximum-decoration'."
d46c21ec
SM
1042 ;; Set face defaults.
1043 (font-lock-make-faces)
1044 ;; Set fontification defaults.
a2b8e66b
SM
1045 (make-local-variable 'font-lock-fontified)
1046 (if font-lock-keywords
1047 nil
1048 (let* ((defaults (or font-lock-defaults
1049 (cdr (assq major-mode font-lock-defaults-alist))))
1050 (keywords (font-lock-choose-keywords
1051 (nth 0 defaults) font-lock-maximum-decoration)))
1052 ;; Regexp fontification?
1053 (setq font-lock-keywords (if (fboundp keywords)
1054 (funcall keywords)
1055 (eval keywords)))
1056 ;; Syntactic fontification?
1057 (if (nth 1 defaults)
1058 (set (make-local-variable 'font-lock-keywords-only) t))
1059 ;; Case fold during regexp fontification?
1060 (if (nth 2 defaults)
1061 (set (make-local-variable 'font-lock-keywords-case-fold-search) t))
1062 ;; Syntax table for regexp and syntactic fontification?
1063 (if (nth 3 defaults)
1064 (let ((slist (nth 3 defaults)))
1065 (set (make-local-variable 'font-lock-syntax-table)
1066 (copy-syntax-table (syntax-table)))
1067 (while slist
1068 (modify-syntax-entry (car (car slist)) (cdr (car slist))
1069 font-lock-syntax-table)
1070 (setq slist (cdr slist)))))
1071 ;; Syntax function for syntactic fontification?
1072 (if (nth 4 defaults)
1073 (set (make-local-variable 'font-lock-beginning-of-syntax-function)
1074 (nth 4 defaults)))
a078558d
SM
1075 ;; Variable alist?
1076 (let ((alist (nthcdr 5 defaults)))
1077 (while alist
1078 (set (make-local-variable (car (car alist))) (cdr (car alist)))
1079 (setq alist (cdr alist)))))))
a2b8e66b
SM
1080
1081(defun font-lock-unset-defaults ()
1082 "Unset fontification defaults. See `font-lock-set-defaults'."
1083 (setq font-lock-keywords nil
1084 font-lock-keywords-only nil
1085 font-lock-keywords-case-fold-search nil
1086 font-lock-syntax-table nil
a078558d
SM
1087 font-lock-beginning-of-syntax-function nil)
1088 (let* ((defaults (or font-lock-defaults
1089 (cdr (assq major-mode font-lock-defaults-alist))))
1090 (alist (nthcdr 5 defaults)))
1091 (while alist
1092 (set (car (car alist)) (default-value (car (car alist))))
1093 (setq alist (cdr alist)))))
030f4a35 1094\f
9bfbb130
SM
1095;; Colour etc. support.
1096
a078558d
SM
1097;; This section of code is crying out for revision.
1098
1099;; To begin with, `display-type' and `background-mode' are `frame-parameters'
1100;; so we don't have to calculate them here anymore. But all the face stuff
1101;; should be frame-local (and thus display-local) anyway. Because we're not
1102;; sure what support Emacs is going to have for general frame-local face
1103;; attributes, we leave this section of code as it is. For now. --sm.
1104
9bfbb130
SM
1105(defvar font-lock-display-type nil
1106 "A symbol indicating the display Emacs is running under.
1107The symbol should be one of `color', `grayscale' or `mono'.
1108If Emacs guesses this display attribute wrongly, either set this variable in
1109your `~/.emacs' or set the resource `Emacs.displayType' in your `~/.Xdefaults'.
1110See also `font-lock-background-mode' and `font-lock-face-attributes'.")
1111
1112(defvar font-lock-background-mode nil
1113 "A symbol indicating the Emacs background brightness.
1114The symbol should be one of `light' or `dark'.
1115If Emacs guesses this frame attribute wrongly, either set this variable in
1116your `~/.emacs' or set the resource `Emacs.backgroundMode' in your
1117`~/.Xdefaults'.
1118See also `font-lock-display-type' and `font-lock-face-attributes'.")
1119
1120(defvar font-lock-face-attributes nil
1121 "A list of default attributes to use for face attributes.
1122Each element of the list should be of the form
1123
1124 (FACE FOREGROUND BACKGROUND BOLD-P ITALIC-P UNDERLINE-P)
1125
1126where FACE should be one of the face symbols `font-lock-comment-face',
1127`font-lock-string-face', `font-lock-keyword-face', `font-lock-type-face',
1128`font-lock-function-name-face', `font-lock-variable-name-face', and
1129`font-lock-reference-face'. A form for each of these face symbols should be
1130provided in the list, but other face symbols and attributes may be given and
1131used in highlighting. See `font-lock-keywords'.
1132
1133Subsequent element items should be the attributes for the corresponding
1134Font Lock mode faces. Attributes FOREGROUND and BACKGROUND should be strings
1135\(default if nil), while BOLD-P, ITALIC-P, and UNDERLINE-P should specify the
1136corresponding face attributes (yes if non-nil).
1137
1138Emacs uses default attributes based on display type and background brightness.
1139See variables `font-lock-display-type' and `font-lock-background-mode'.
1140
1141Resources can be used to over-ride these face attributes. For example, the
1142resource `Emacs.font-lock-comment-face.attributeUnderline' can be used to
1143specify the UNDERLINE-P attribute for face `font-lock-comment-face'.")
1144
1145(defun font-lock-make-faces (&optional override)
1146 "Make faces from `font-lock-face-attributes'.
1147A default list is used if this is nil.
1148If optional OVERRIDE is non-nil, faces that already exist are reset.
1149See `font-lock-make-face' and `list-faces-display'."
1150 ;; We don't need to `setq' any of these variables, but the user can see what
1151 ;; is being used if we do.
1152 (if (null font-lock-display-type)
1153 (setq font-lock-display-type
1154 (let ((display-resource (x-get-resource ".displayType"
1155 "DisplayType")))
1156 (cond (display-resource (intern (downcase display-resource)))
1157 ((x-display-color-p) 'color)
1158 ((x-display-grayscale-p) 'grayscale)
1159 (t 'mono)))))
1160 (if (null font-lock-background-mode)
1161 (setq font-lock-background-mode
1162 (let ((bg-resource (x-get-resource ".backgroundMode"
1163 "BackgroundMode"))
1164 (params (frame-parameters)))
1165 (cond (bg-resource (intern (downcase bg-resource)))
03a84c34
RS
1166 ((eq system-type 'ms-dos)
1167 (if (string-match "light"
1168 (cdr (assq 'background-color params)))
1169 'light
1170 'dark))
9bfbb130
SM
1171 ((< (apply '+ (x-color-values
1172 (cdr (assq 'background-color params))))
1173 (/ (apply '+ (x-color-values "white")) 3))
1174 'dark)
1175 (t 'light)))))
1176 (if (null font-lock-face-attributes)
1177 (setq font-lock-face-attributes
1178 (let ((light-bg (eq font-lock-background-mode 'light)))
1179 (cond ((memq font-lock-display-type '(mono monochrome))
1180 ;; Emacs 19.25's font-lock defaults:
1181 ;;'((font-lock-comment-face nil nil nil t nil)
1182 ;; (font-lock-string-face nil nil nil nil t)
1183 ;; (font-lock-keyword-face nil nil t nil nil)
1184 ;; (font-lock-function-name-face nil nil t t nil)
1185 ;; (font-lock-type-face nil nil nil t nil))
1186 (list '(font-lock-comment-face nil nil t t nil)
1187 '(font-lock-string-face nil nil nil t nil)
1188 '(font-lock-keyword-face nil nil t nil nil)
1189 (list
1190 'font-lock-function-name-face
1191 (cdr (assq 'background-color (frame-parameters)))
1192 (cdr (assq 'foreground-color (frame-parameters)))
1193 t nil nil)
1194 '(font-lock-variable-name-face nil nil t t nil)
1195 '(font-lock-type-face nil nil t nil t)
1196 '(font-lock-reference-face nil nil t nil t)))
1197 ((memq font-lock-display-type '(grayscale greyscale
1198 grayshade greyshade))
1199 (list
1200 (list 'font-lock-comment-face
1201 nil (if light-bg "Gray80" "DimGray") t t nil)
1202 (list 'font-lock-string-face
1203 nil (if light-bg "Gray50" "LightGray") nil t nil)
1204 (list 'font-lock-keyword-face
1205 nil (if light-bg "Gray90" "DimGray") t nil nil)
1206 (list 'font-lock-function-name-face
1207 (cdr (assq 'background-color (frame-parameters)))
1208 (cdr (assq 'foreground-color (frame-parameters)))
1209 t nil nil)
1210 (list 'font-lock-variable-name-face
1211 nil (if light-bg "Gray90" "DimGray") t t nil)
1212 (list 'font-lock-type-face
1213 nil (if light-bg "Gray80" "DimGray") t nil t)
1214 (list 'font-lock-reference-face
1215 nil (if light-bg "LightGray" "Gray50") t nil t)))
1216 (light-bg ; light colour background
1217 '((font-lock-comment-face "Firebrick")
1218 (font-lock-string-face "RosyBrown")
1219 (font-lock-keyword-face "Purple")
1220 (font-lock-function-name-face "Blue")
1221 (font-lock-variable-name-face "DarkGoldenrod")
1222 (font-lock-type-face "DarkOliveGreen")
1223 (font-lock-reference-face "CadetBlue")))
1224 (t ; dark colour background
1225 '((font-lock-comment-face "OrangeRed")
1226 (font-lock-string-face "LightSalmon")
1227 (font-lock-keyword-face "LightSteelBlue")
1228 (font-lock-function-name-face "LightSkyBlue")
1229 (font-lock-variable-name-face "LightGoldenrod")
1230 (font-lock-type-face "PaleGreen")
1231 (font-lock-reference-face "Aquamarine")))))))
1232 ;; Now make the faces if we have to.
1233 (mapcar (function
1234 (lambda (face-attributes)
1235 (let ((face (nth 0 face-attributes)))
1236 (cond (override
1237 ;; We can stomp all over it anyway. Get outta my face!
1238 (font-lock-make-face face-attributes))
1239 ((and (boundp face) (facep (symbol-value face)))
1240 ;; The variable exists and is already bound to a face.
1241 nil)
1242 ((facep face)
1243 ;; We already have a face so we bind the variable to it.
1244 (set face face))
1245 (t
1246 ;; No variable or no face.
1247 (font-lock-make-face face-attributes))))))
1248 font-lock-face-attributes))
1249
1250(defun font-lock-make-face (face-attributes)
1251 "Make a face from FACE-ATTRIBUTES.
1252FACE-ATTRIBUTES should be like an element `font-lock-face-attributes', so that
1253the face name is the first item in the list. A variable with the same name as
1254the face is also set; its value is the face name."
1255 (let* ((face (nth 0 face-attributes))
1256 (face-name (symbol-name face))
1257 (set-p (function (lambda (face-name resource)
1258 (x-get-resource (concat face-name ".attribute" resource)
1259 (concat "Face.Attribute" resource)))))
1260 (on-p (function (lambda (face-name resource)
1261 (let ((set (funcall set-p face-name resource)))
1262 (and set (member (downcase set) '("on" "true"))))))))
1263 (make-face face)
876f2438 1264 (add-to-list 'facemenu-unlisted-faces face)
9bfbb130
SM
1265 ;; Set attributes not set from X resources (and therefore `make-face').
1266 (or (funcall set-p face-name "Foreground")
1267 (condition-case nil
1268 (set-face-foreground face (nth 1 face-attributes))
1269 (error nil)))
1270 (or (funcall set-p face-name "Background")
1271 (condition-case nil
1272 (set-face-background face (nth 2 face-attributes))
1273 (error nil)))
1274 (if (funcall set-p face-name "Bold")
1275 (and (funcall on-p face-name "Bold") (make-face-bold face nil t))
1276 (and (nth 3 face-attributes) (make-face-bold face nil t)))
1277 (if (funcall set-p face-name "Italic")
1278 (and (funcall on-p face-name "Italic") (make-face-italic face nil t))
1279 (and (nth 4 face-attributes) (make-face-italic face nil t)))
1280 (or (funcall set-p face-name "Underline")
1281 (set-face-underline-p face (nth 5 face-attributes)))
1282 (set face face)))
1283\f
1284;;; Various regexp information shared by several modes.
a1eb1cf1 1285;;; Information specific to a single mode should go in its load library.
030f4a35 1286
030f4a35 1287(defconst lisp-font-lock-keywords-1
a1eb1cf1 1288 (list
9bfbb130 1289 ;; Anything not a variable or type declaration is fontified as a function.
d46c21ec
SM
1290 ;; It would be cleaner to allow preceding whitespace, but it would also be
1291 ;; about five times slower.
1292 (list (concat "^(\\(def\\("
1293 ;; Variable declarations.
1294 "\\(const\\(\\|ant\\)\\|ine-key\\(\\|-after\\)\\|var\\)\\|"
1295 ;; Structure declarations.
1296 "\\(class\\|struct\\|type\\)\\|"
1297 ;; Everything else is a function declaration.
1298 "\\([^ \t\n\(\)]+\\)"
1299 "\\)\\)\\>"
1300 ;; Any whitespace and declared object.
1301 "[ \t'\(]*"
7d7d915a 1302 "\\(\\sw+\\)?")
d46c21ec
SM
1303 '(1 font-lock-keyword-face)
1304 '(8 (cond ((match-beginning 3) font-lock-variable-name-face)
1305 ((match-beginning 6) font-lock-type-face)
1306 (t font-lock-function-name-face))
9bfbb130
SM
1307 nil t))
1308 )
7d7d915a 1309 "Subdued level highlighting for Lisp modes.")
030f4a35
RS
1310
1311(defconst lisp-font-lock-keywords-2
799761f0 1312 (append lisp-font-lock-keywords-1
9bfbb130
SM
1313 (list
1314 ;;
1315 ;; Control structures. ELisp and CLisp combined.
d46c21ec 1316; (make-regexp
7d7d915a 1317; '("cond" "if" "while" "let\\*?" "prog[nv12*]?" "inline" "catch" "throw"
d46c21ec
SM
1318; "save-restriction" "save-excursion" "save-window-excursion"
1319; "save-selected-window" "save-match-data" "unwind-protect"
1320; "condition-case" "track-mouse"
1321; "eval-after-load" "eval-and-compile" "eval-when-compile"
a078558d
SM
1322; "when" "unless" "do" "flet" "labels" "return" "return-from"
1323; "with-output-to-temp-buffer" "with-timeout"))
9bfbb130
SM
1324 (cons
1325 (concat
1326 "(\\("
a078558d 1327 "c\\(atch\\|ond\\(\\|ition-case\\)\\)\\|do\\|"
9bfbb130 1328 "eval-\\(a\\(fter-load\\|nd-compile\\)\\|when-compile\\)\\|flet\\|"
7d7d915a 1329 "i\\(f\\|nline\\)\\|l\\(abels\\|et\\*?\\)\\|prog[nv12*]?\\|"
a078558d
SM
1330 "return\\(\\|-from\\)\\|save-\\(excursion\\|match-data\\|restriction\\|"
1331 "selected-window\\|window-excursion\\)\\|t\\(hrow\\|rack-mouse\\)\\|"
1332 "un\\(less\\|wind-protect\\)\\|"
1333 "w\\(h\\(en\\|ile\\)\\|ith-\\(output-to-temp-buffer\\|timeout\\)\\)"
9bfbb130
SM
1334 "\\)\\>") 1)
1335 ;;
7d7d915a
SM
1336 ;; Feature symbols as references.
1337 '("(\\(featurep\\|provide\\|require\\)\\>[ \t']*\\(\\sw+\\)?"
1338 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1339 ;;
9bfbb130
SM
1340 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1341 '("\\\\\\\\\\[\\(\\sw+\\)]" 1 font-lock-reference-face prepend)
1342 ;;
1343 ;; Words inside `' tend to be symbol names.
1344 '("`\\(\\sw\\sw+\\)'" 1 font-lock-reference-face prepend)
1345 ;;
1346 ;; CLisp `:' keywords as references.
1347 '("\\<:\\sw+\\>" 0 font-lock-reference-face prepend)
1348 ;;
1349 ;; ELisp and CLisp `&' keywords as types.
1350 '("\\<\\&\\(optional\\|rest\\|whole\\)\\>" . font-lock-type-face)
1351 ))
fb512de9 1352 "Gaudy level highlighting for Lisp modes.")
030f4a35 1353
fb512de9
SM
1354(defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
1355 "Default expressions to highlight in Lisp modes.")
030f4a35
RS
1356
1357
d46c21ec 1358(defvar scheme-font-lock-keywords
9bfbb130
SM
1359 (eval-when-compile
1360 (list
1361 ;;
1362 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1363 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1364 (list (concat "(\\(define\\("
1365 ;; Function names.
1366 "\\(\\|-\\(generic\\(\\|-procedure\\)\\|method\\)\\)\\|"
1367 ;; Macro names, as variable names. A bit dubious, this.
1368 "\\(-syntax\\)\\|"
1369 ;; Class names.
1370 "\\(-class\\)"
1371 "\\)\\)\\>"
1372 ;; Any whitespace and declared object.
1373 "[ \t]*(?"
1374 "\\(\\sw+\\)?")
1375 '(1 font-lock-keyword-face)
1376 '(8 (cond ((match-beginning 3) font-lock-function-name-face)
1377 ((match-beginning 6) font-lock-variable-name-face)
1378 (t font-lock-type-face))
1379 nil t))
1380 ;;
1381 ;; Control structures.
d46c21ec
SM
1382;(make-regexp '("begin" "call-with-current-continuation" "call/cc"
1383; "call-with-input-file" "call-with-output-file" "case" "cond"
9bfbb130
SM
1384; "do" "else" "for-each" "if" "lambda"
1385; "let\\*?" "let-syntax" "letrec" "letrec-syntax"
1386; ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1387; "and" "or" "delay"
1388; ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
d46c21ec
SM
1389; ;;"quasiquote" "quote" "unquote" "unquote-splicing"
1390; "map" "syntax" "syntax-rules"))
9bfbb130
SM
1391 (cons
1392 (concat "(\\("
1393 "and\\|begin\\|c\\(a\\(ll\\(-with-\\(current-continuation\\|"
1394 "input-file\\|output-file\\)\\|/cc\\)\\|se\\)\\|ond\\)\\|"
1395 "d\\(elay\\|o\\)\\|else\\|for-each\\|if\\|"
1396 "l\\(ambda\\|et\\(-syntax\\|\\*?\\|rec\\(\\|-syntax\\)\\)\\)\\|"
1397 "map\\|or\\|syntax\\(\\|-rules\\)"
1398 "\\)\\>") 1)
1399 ;;
1400 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
1401 '("\\<<\\sw+>\\>" . font-lock-type-face)
1402 ;;
1403 ;; Scheme `:' keywords as references.
1404 '("\\<:\\sw+\\>" . font-lock-reference-face)
1405 ))
1406"Default expressions to highlight in Scheme modes.")
d46c21ec
SM
1407
1408
030f4a35 1409(defconst c-font-lock-keywords-1 nil
fb512de9 1410 "Subdued level highlighting for C modes.")
030f4a35
RS
1411
1412(defconst c-font-lock-keywords-2 nil
9bfbb130
SM
1413 "Medium level highlighting for C modes.")
1414
1415(defconst c-font-lock-keywords-3 nil
fb512de9 1416 "Gaudy level highlighting for C modes.")
030f4a35 1417
1bd50840 1418(defconst c++-font-lock-keywords-1 nil
fb512de9 1419 "Subdued level highlighting for C++ modes.")
1bd50840
RS
1420
1421(defconst c++-font-lock-keywords-2 nil
9bfbb130
SM
1422 "Medium level highlighting for C++ modes.")
1423
1424(defconst c++-font-lock-keywords-3 nil
fb512de9 1425 "Gaudy level highlighting for C++ modes.")
1bd50840 1426
9bfbb130
SM
1427(defun font-lock-match-c++-style-declaration-item-and-skip-to-next (limit)
1428 ;; Match, and move over, any declaration/definition item after point.
1429 ;; The expect syntax of an item is "word" or "word::word", possibly ending
1430 ;; with optional whitespace and a "(". Everything following the item (but
1431 ;; belonging to it) is expected to by skip-able by `forward-sexp', and items
1432 ;; are expected to be separated with a "," or ";".
1433 (if (looking-at "[ \t*&]*\\(\\sw+\\)\\(::\\(\\sw+\\)\\)?[ \t]*\\((\\)?")
1434 (save-match-data
1435 (condition-case nil
1436 (save-restriction
876f2438
SM
1437 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
1438 (narrow-to-region (point-min) limit)
9bfbb130
SM
1439 (goto-char (match-end 1))
1440 ;; Move over any item value, etc., to the next item.
1441 (while (not (looking-at "[ \t]*\\([,;]\\|$\\)"))
1442 (goto-char (or (scan-sexps (point) 1) (point-max))))
1443 (goto-char (match-end 0)))
1444 (error t)))))
1445
b89e1134
SM
1446(let ((c-keywords
1447; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while")
1448 "break\\|continue\\|do\\|else\\|for\\|if\\|return\\|switch\\|while")
1449 (c-type-types
a1eb1cf1
RS
1450; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
1451; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
b89e1134
SM
1452; "void" "volatile" "const")
1453 (concat "auto\\|c\\(har\\|onst\\)\\|double\\|e\\(num\\|xtern\\)\\|"
1454 "float\\|int\\|long\\|register\\|"
1455 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|typedef\\|"
1456 "un\\(ion\\|signed\\)\\|vo\\(id\\|latile\\)")) ; 6 ()s deep.
1457 (c++-keywords
1458; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
1459; "asm" "catch" "delete" "new" "operator" "sizeof" "this" "throw" "try"
1460; "protected" "private" "public")
1461 (concat "asm\\|break\\|c\\(atch\\|ontinue\\)\\|d\\(elete\\|o\\)\\|"
9bfbb130 1462 "else\\|for\\|if\\|new\\|"
b89e1134
SM
1463 "p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|return\\|"
1464 "s\\(izeof\\|witch\\)\\|t\\(h\\(is\\|row\\)\\|ry\\)\\|while"))
1465 (c++-type-types
1466; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
1467; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
1468; "void" "volatile" "const" "class" "inline" "friend" "bool"
1469; "virtual" "complex" "template")
1470 (concat "auto\\|bool\\|c\\(har\\|lass\\|o\\(mplex\\|nst\\)\\)\\|"
1471 "double\\|e\\(num\\|xtern\\)\\|f\\(loat\\|riend\\)\\|"
1472 "in\\(line\\|t\\)\\|long\\|register\\|"
1473 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|"
1474 "t\\(emplate\\|ypedef\\)\\|un\\(ion\\|signed\\)\\|"
1475 "v\\(irtual\\|o\\(id\\|latile\\)\\)")) ; 11 ()s deep.
9bfbb130 1476 )
f60f18ae
KH
1477 (setq c-font-lock-keywords-1
1478 (list
f60f18ae 1479 ;;
9bfbb130
SM
1480 ;; These are all anchored at the beginning of line for speed.
1481 ;;
1482 ;; Fontify function name definitions (GNU style; without type on line).
1483 (list (concat "^\\(\\sw+\\)[ \t]*(") 1 'font-lock-function-name-face)
1484 ;;
1485 ;; Fontify filenames in #include <...> preprocessor directives as strings.
f60f18ae
KH
1486 '("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
1487 ;;
a1eb1cf1 1488 ;; Fontify function macro names.
7d7d915a 1489 '("^#[ \t]*define[ \t]+\\(\\sw+\\)(" 1 font-lock-function-name-face)
f60f18ae 1490 ;;
9bfbb130
SM
1491 ;; Fontify symbol names in #if ... defined preprocessor directives.
1492 '("^#[ \t]*if\\>"
1493 ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
1494 (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t)))
1495 ;;
a1eb1cf1 1496 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
7d7d915a 1497 '("^#[ \t]*\\(\\sw+\\)\\>[ \t]*\\(\\sw+\\)?"
a1eb1cf1 1498 (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t))
f60f18ae
KH
1499 ))
1500
1501 (setq c-font-lock-keywords-2
1502 (append c-font-lock-keywords-1
030f4a35 1503 (list
030f4a35 1504 ;;
9bfbb130 1505 ;; Simple regexps for speed.
b89e1134 1506 ;;
9bfbb130
SM
1507 ;; Fontify all type specifiers.
1508 (cons (concat "\\<\\(" c-type-types "\\)\\>") 'font-lock-type-face)
030f4a35 1509 ;;
b89e1134 1510 ;; Fontify all builtin keywords (except case, default and goto; see below).
9bfbb130 1511 (cons (concat "\\<\\(" c-keywords "\\)\\>") 'font-lock-keyword-face)
030f4a35 1512 ;;
9bfbb130 1513 ;; Fontify case/goto keywords and targets, and case default/goto tags.
7d7d915a 1514 '("\\<\\(case\\|goto\\)\\>[ \t]*\\(\\sw+\\)?"
a1eb1cf1
RS
1515 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1516 '("^[ \t]*\\(\\sw+\\)[ \t]*:" 1 font-lock-reference-face)
f60f18ae 1517 )))
1bd50840 1518
9bfbb130
SM
1519 (setq c-font-lock-keywords-3
1520 (append c-font-lock-keywords-2
1521 ;;
1522 ;; More complicated regexps for more complete highlighting for types.
1523 ;; We still have to fontify type specifiers individually, as C is so hairy.
1524 (list
1525 ;;
1526 ;; Fontify all storage classes and type specifiers, plus their items.
1527 (list (concat "\\<\\(" c-type-types "\\)\\>"
1528 "\\([ \t*&]+\\sw+\\>\\)*")
1529 ;; Fontify each declaration item.
1530 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
1531 ;; Start with point after all type specifiers.
1532 (goto-char (or (match-beginning 8) (match-end 1)))
1533 ;; Finish with point after first type specifier.
1534 (goto-char (match-end 1))
1535 ;; Fontify as a variable or function name.
1536 (1 (if (match-beginning 4)
1537 font-lock-function-name-face
1538 font-lock-variable-name-face))))
1539 ;;
1540 ;; Fontify structures, or typedef names, plus their items.
1541 '("\\(}\\)[ \t*]*\\sw"
1542 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1543 (goto-char (match-end 1)) nil
1544 (1 (if (match-beginning 4)
1545 font-lock-function-name-face
1546 font-lock-variable-name-face))))
1547 ;;
1548 ;; Fontify anything at beginning of line as a declaration or definition.
1549 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
1550 (1 font-lock-type-face)
1551 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1552 (goto-char (or (match-beginning 2) (match-end 1))) nil
1553 (1 (if (match-beginning 4)
1554 font-lock-function-name-face
1555 font-lock-variable-name-face))))
1556 )))
1557
1558 (setq c++-font-lock-keywords-1
1559 (append
1560 ;;
1561 ;; The list `c-font-lock-keywords-1' less that for function names.
1562 (cdr c-font-lock-keywords-1)
1563 ;;
1564 ;; Fontify function name definitions, possibly incorporating class name.
1565 (list
1566 '("^\\(\\sw+\\)\\(::\\(\\sw+\\)\\)?[ \t]*("
1567 (1 (if (match-beginning 2)
1568 font-lock-type-face
1569 font-lock-function-name-face))
1570 (3 (if (match-beginning 2) font-lock-function-name-face) nil t))
1571 )))
1572
1bd50840 1573 (setq c++-font-lock-keywords-2
b89e1134 1574 (append c++-font-lock-keywords-1
a1eb1cf1 1575 (list
9bfbb130
SM
1576 ;;
1577 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
b89e1134 1578 (cons (concat "\\<\\(" c++-type-types "\\)\\>") 'font-lock-type-face)
9bfbb130
SM
1579 ;;
1580 ;; Fontify operator function name overloading.
1581 '("\\<\\(operator\\)\\>[ \t]*\\([][)(><!=+-][][)(><!=+-]?\\)?"
1582 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
1583 ;;
1584 ;; Fontify case/goto keywords and targets, and case default/goto tags.
7d7d915a 1585 '("\\<\\(case\\|goto\\)\\>[ \t]*\\(\\sw+\\)?"
b89e1134 1586 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
9bfbb130
SM
1587 '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-reference-face)
1588 ;;
1589 ;; Fontify other builtin keywords.
1590 (cons (concat "\\<\\(" c++-keywords "\\)\\>") 'font-lock-keyword-face)
1591 )))
1592
1593 (setq c++-font-lock-keywords-3
1594 (append c++-font-lock-keywords-2
1595 ;;
1596 ;; More complicated regexps for more complete highlighting for types.
1597 (list
1598 ;;
1599 ;; Fontify all storage classes and type specifiers, plus their items.
1600 (list (concat "\\<\\(" c++-type-types "\\)\\>"
1601 "\\([ \t*&]+\\sw+\\>\\)*")
1602 ;; Fontify each declaration item.
1603 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
1604 ;; Start with point after all type specifiers.
1605 (goto-char (or (match-beginning 13) (match-end 1)))
1606 ;; Finish with point after first type specifier.
1607 (goto-char (match-end 1))
1608 ;; Fontify as a variable or function name.
1609 (1 (cond ((match-beginning 2) font-lock-type-face)
1610 ((match-beginning 4) font-lock-function-name-face)
1611 (t font-lock-variable-name-face)))
1612 (3 (if (match-beginning 4)
1613 font-lock-function-name-face
1614 font-lock-variable-name-face) nil t)))
1615 ;;
1616 ;; Fontify structures, or typedef names, plus their items.
1617 '("\\(}\\)[ \t*]*\\sw"
1618 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1619 (goto-char (match-end 1)) nil
1620 (1 (if (match-beginning 4)
1621 font-lock-function-name-face
1622 font-lock-variable-name-face))))
1623 ;;
1624 ;; Fontify anything at beginning of line as a declaration or definition.
1625 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
1626 (1 font-lock-type-face)
1627 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1628 (goto-char (or (match-beginning 2) (match-end 1))) nil
1629 (1 (cond ((match-beginning 2) font-lock-type-face)
1630 ((match-beginning 4) font-lock-function-name-face)
1631 (t font-lock-variable-name-face)))
1632 (3 (if (match-beginning 4)
1633 font-lock-function-name-face
1634 font-lock-variable-name-face) nil t)))
1635 )))
f60f18ae 1636 )
030f4a35 1637
fb512de9
SM
1638(defvar c-font-lock-keywords c-font-lock-keywords-1
1639 "Default expressions to highlight in C mode.")
030f4a35 1640
fb512de9
SM
1641(defvar c++-font-lock-keywords c++-font-lock-keywords-1
1642 "Default expressions to highlight in C++ mode.")
030f4a35 1643
d46c21ec 1644
030f4a35 1645(defvar tex-font-lock-keywords
d46c21ec
SM
1646; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
1647; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
1648; 2 font-lock-function-name-face)
1649; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
1650; 2 font-lock-reference-face)
1651; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1652; ;; not be able to display those fonts.
1653; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
1654; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
1655; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
1656; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
1657 ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
826b2925
SM
1658 '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
1659 2 font-lock-function-name-face)
1660 ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
1661 2 font-lock-reference-face)
d46c21ec 1662 ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
9bfbb130 1663 "\\\\\\([a-zA-Z@]+\\|.\\)"
826b2925
SM
1664 ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1665 ;; not be able to display those fonts.
d46c21ec
SM
1666 ;; LaTeX2e: \emph{This is emphasized}.
1667 ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
1668 ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
1669 ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
1670 3 (if (match-beginning 2) 'bold 'italic) keep)
1671 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables.
1672 ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
1673 3 (if (match-beginning 2) 'bold 'italic) keep))
9bfbb130 1674 "Default expressions to highlight in TeX modes.")
d46c21ec 1675\f
a1eb1cf1
RS
1676;; Install ourselves:
1677
a1eb1cf1
RS
1678(or (assq 'font-lock-mode minor-mode-alist)
1679 (setq minor-mode-alist (cons '(font-lock-mode " Font") minor-mode-alist)))
1680
1681;; Provide ourselves:
8f261d40 1682
030f4a35
RS
1683(provide 'font-lock)
1684
1685;;; font-lock.el ends here