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