New syntax-propertize functionality.
[bpt/emacs.git] / lisp / font-lock.el
CommitLineData
876f2438
SM
1;;; font-lock.el --- Electric font lock mode
2
7ae3cc71 3;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
114f9c96 4;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
071e6277 5;; Free Software Foundation, Inc.
030f4a35 6
eb2ffb18
GM
7;; Author: Jamie Zawinski
8;; Richard Stallman
9;; Stefan Monnier
030f4a35
RS
10;; Maintainer: FSF
11;; Keywords: languages, faces
bd78fa1d 12;; Package: emacs
030f4a35
RS
13
14;; This file is part of GNU Emacs.
15
eb3fa2cf 16;; GNU Emacs is free software: you can redistribute it and/or modify
030f4a35 17;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
18;; the Free Software Foundation, either version 3 of the License, or
19;; (at your option) any later version.
030f4a35
RS
20
21;; GNU Emacs is distributed in the hope that it will be useful,
22;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24;; GNU General Public License for more details.
25
26;; You should have received a copy of the GNU General Public License
eb3fa2cf 27;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
030f4a35 28
030f4a35
RS
29;;; Commentary:
30
b89e1134
SM
31;; Font Lock mode is a minor mode that causes your comments to be displayed in
32;; one face, strings in another, reserved words in another, and so on.
030f4a35
RS
33;;
34;; Comments will be displayed in `font-lock-comment-face'.
35;; Strings will be displayed in `font-lock-string-face'.
a1eb1cf1 36;; Regexps are used to display selected patterns in other faces.
030f4a35 37;;
9bfbb130
SM
38;; To make the text you type be fontified, use M-x font-lock-mode RET.
39;; When this minor mode is on, the faces of the current line are updated with
40;; every insertion or deletion.
030f4a35 41;;
a2b8e66b 42;; To turn Font Lock mode on automatically, add this to your ~/.emacs file:
030f4a35 43;;
b89e1134 44;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock)
030f4a35 45;;
a2b8e66b
SM
46;; Or if you want to turn Font Lock mode on in many modes:
47;;
48;; (global-font-lock-mode t)
49;;
9bfbb130
SM
50;; Fontification for a particular mode may be available in a number of levels
51;; of decoration. The higher the level, the more decoration, but the more time
52;; it takes to fontify. See the variable `font-lock-maximum-decoration', and
5aa29679
RS
53;; also the variable `font-lock-maximum-size'. Support modes for Font Lock
54;; mode can be used to speed up Font Lock mode. See `font-lock-support-mode'.
98f84f52 55\f
56fcbd7e
SM
56;;; How Font Lock mode fontifies:
57
58;; When Font Lock mode is turned on in a buffer, it (a) fontifies the entire
59;; buffer and (b) installs one of its fontification functions on one of the
60;; hook variables that are run by Emacs after every buffer change (i.e., an
61;; insertion or deletion). Fontification means the replacement of `face' text
62;; properties in a given region; Emacs displays text with these `face' text
63;; properties appropriately.
64;;
65;; Fontification normally involves syntactic (i.e., strings and comments) and
ac6e572c
SM
66;; regexp (i.e., keywords and everything else) passes. There are actually
67;; three passes; (a) the syntactic keyword pass, (b) the syntactic pass and (c)
68;; the keyword pass. Confused?
69;;
70;; The syntactic keyword pass places `syntax-table' text properties in the
71;; buffer according to the variable `font-lock-syntactic-keywords'. It is
72;; necessary because Emacs' syntax table is not powerful enough to describe all
73;; the different syntactic constructs required by the sort of people who decide
74;; that a single quote can be syntactic or not depending on the time of day.
75;; (What sort of person could decide to overload the meaning of a quote?)
76;; Obviously the syntactic keyword pass must occur before the syntactic pass.
77;;
78;; The syntactic pass places `face' text properties in the buffer according to
79;; syntactic context, i.e., according to the buffer's syntax table and buffer
80;; text's `syntax-table' text properties. It involves using a syntax parsing
81;; function to determine the context of different parts of a region of text. A
82;; syntax parsing function is necessary because generally strings and/or
83;; comments can span lines, and so the context of a given region is not
84;; necessarily apparent from the content of that region. Because the keyword
85;; pass only works within a given region, it is not generally appropriate for
86;; syntactic fontification. This is the first fontification pass that makes
87;; changes visible to the user; it fontifies strings and comments.
88;;
89;; The keyword pass places `face' text properties in the buffer according to
90;; the variable `font-lock-keywords'. It involves searching for given regexps
91;; (or calling given search functions) within the given region. This is the
92;; second fontification pass that makes changes visible to the user; it
93;; fontifies language reserved words, etc.
94;;
95;; Oh, and the answer is, "Yes, obviously just about everything should be done
96;; in a single syntactic pass, but the only syntactic parser available
97;; understands only strings and comments." Perhaps one day someone will write
98;; some syntactic parsers for common languages and a son-of-font-lock.el could
99;; use them rather then relying so heavily on the keyword (regexp) pass.
56fcbd7e 100
c1f2ffc8
SM
101;;; How Font Lock mode supports modes or is supported by modes:
102
103;; Modes that support Font Lock mode do so by defining one or more variables
104;; whose values specify the fontification. Font Lock mode knows of these
105;; variable names from (a) the buffer local variable `font-lock-defaults', if
106;; non-nil, or (b) the global variable `font-lock-defaults-alist', if the major
107;; mode has an entry. (Font Lock mode is set up via (a) where a mode's
108;; patterns are distributed with the mode's package library, and (b) where a
109;; mode's patterns are distributed with font-lock.el itself. An example of (a)
110;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is
111;; (a); (b) is used where it is not clear which package library should contain
112;; the pattern definitions.) Font Lock mode chooses which variable to use for
113;; fontification based on `font-lock-maximum-decoration'.
56fcbd7e 114;;
fffa137c 115;; Font Lock mode fontification behavior can be modified in a number of ways.
56fcbd7e 116;; See the below comments and the comments distributed throughout this file.
c1f2ffc8
SM
117
118;;; Constructing patterns:
119
98f84f52
SM
120;; See the documentation for the variable `font-lock-keywords'.
121;;
ac6e572c
SM
122;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and
123;; `font-lock-syntactic-keywords' can be generated via the function
afa18a4e 124;; `regexp-opt'.
98f84f52 125
c1f2ffc8
SM
126;;; Adding patterns for modes that already support Font Lock:
127
128;; Though Font Lock highlighting patterns already exist for many modes, it's
129;; likely there's something that you want fontified that currently isn't, even
130;; at the maximum fontification level. You can add highlighting patterns via
131;; `font-lock-add-keywords'. For example, say in some C
132;; header file you #define the token `and' to expand to `&&', etc., to make
133;; your C code almost readable. In your ~/.emacs there could be:
98f84f52 134;;
c1f2ffc8 135;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>"))
98f84f52 136;;
c1f2ffc8
SM
137;; Some modes provide specific ways to modify patterns based on the values of
138;; other variables. For example, additional C types can be specified via the
139;; variable `c-font-lock-extra-types'.
140
141;;; Adding patterns for modes that do not support Font Lock:
142
143;; Not all modes support Font Lock mode. If you (as a user of the mode) add
144;; patterns for a new mode, you must define in your ~/.emacs a variable or
145;; variables that specify regexp fontification. Then, you should indicate to
146;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what
147;; support is required. For example, say Foo mode should have the following
148;; regexps fontified case-sensitively, and comments and strings should not be
149;; fontified automagically. In your ~/.emacs there could be:
98f84f52 150;;
c1f2ffc8
SM
151;; (defvar foo-font-lock-keywords
152;; '(("\\<\\(one\\|two\\|three\\)\\>" . font-lock-keyword-face)
153;; ("\\<\\(four\\|five\\|six\\)\\>" . font-lock-type-face))
154;; "Default expressions to highlight in Foo mode.")
98f84f52 155;;
c1f2ffc8 156;; (add-hook 'foo-mode-hook
e9476ca8 157;; (lambda ()
e0be77f6
SM
158;; (set (make-local-variable 'font-lock-defaults)
159;; '(foo-font-lock-keywords t))))
c1f2ffc8
SM
160
161;;; Adding Font Lock support for modes:
162
163;; Of course, it would be better that the mode already supports Font Lock mode.
164;; The package author would do something similar to above. The mode must
165;; define at the top-level a variable or variables that specify regexp
166;; fontification. Then, the mode command should indicate to Font Lock mode,
167;; via `font-lock-defaults', exactly what support is required. For example,
168;; say Bar mode should have the following regexps fontified case-insensitively,
169;; and comments and strings should be fontified automagically. In bar.el there
170;; could be:
98f84f52 171;;
c1f2ffc8
SM
172;; (defvar bar-font-lock-keywords
173;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . font-lock-keyword-face)
174;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . font-lock-type-face))
175;; "Default expressions to highlight in Bar mode.")
98f84f52 176;;
c1f2ffc8 177;; and within `bar-mode' there could be:
98f84f52 178;;
e0be77f6
SM
179;; (set (make-local-variable 'font-lock-defaults)
180;; '(bar-font-lock-keywords nil t))
98f84f52 181\f
9bfbb130
SM
182;; What is fontification for? You might say, "It's to make my code look nice."
183;; I think it should be for adding information in the form of cues. These cues
184;; should provide you with enough information to both (a) distinguish between
185;; different items, and (b) identify the item meanings, without having to read
186;; the items and think about it. Therefore, fontification allows you to think
187;; less about, say, the structure of code, and more about, say, why the code
188;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
189;;
190;; So, here are my opinions/advice/guidelines:
5e9e032a 191;;
7d7d915a
SM
192;; - Highlight conceptual objects, such as function and variable names, and
193;; different objects types differently, i.e., (a) and (b) above, highlight
194;; function names differently to variable names.
195;; - Keep the faces distinct from each other as far as possible.
196;; i.e., (a) above.
9bfbb130
SM
197;; - Use the same face for the same conceptual object, across all modes.
198;; i.e., (b) above, all modes that have items that can be thought of as, say,
199;; keywords, should be highlighted with the same face, etc.
9bfbb130 200;; - Make the face attributes fit the concept as far as possible.
6772c8e1
GM
201;; i.e., function names might be a bold color such as blue, comments might
202;; be a bright color such as red, character strings might be brown, because,
9bfbb130
SM
203;; err, strings are brown (that was not the reason, please believe me).
204;; - Don't use a non-nil OVERRIDE unless you have a good reason.
205;; Only use OVERRIDE for special things that are easy to define, such as the
206;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
207;; Don't use it to, say, highlight keywords in commented out code or strings.
208;; - Err, that's it.
a1eb1cf1 209\f
2e6a15fc
SM
210;;; Code:
211
8259bf10 212(require 'syntax)
202ff0d6 213(eval-when-compile (require 'cl))
8259bf10 214
2273c36b 215;; Define core `font-lock' group.
6b61353c 216(defgroup font-lock '((jit-lock custom-group))
55015061 217 "Font Lock mode text highlighting package."
7667fa3a
LT
218 :link '(custom-manual :tag "Emacs Manual" "(emacs)Font Lock")
219 :link '(custom-manual :tag "Elisp Manual" "(elisp)Font Lock Mode")
55015061
SM
220 :group 'faces)
221
a4deefed 222(defgroup font-lock-faces nil
2273c36b 223 "Faces for highlighting text."
55015061 224 :prefix "font-lock-"
2273c36b
SM
225 :group 'font-lock)
226
227(defgroup font-lock-extra-types nil
228 "Extra mode-specific type names for highlighting declarations."
229 :group 'font-lock)
55015061 230\f
9bfbb130
SM
231;; User variables.
232
4fffc071 233(defcustom font-lock-maximum-size 256000
9201cc28 234 "Maximum size of a buffer for buffer fontification.
23a0e11b
SM
235Only buffers less than this can be fontified when Font Lock mode is turned on.
236If nil, means size is irrelevant.
237If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
238where MAJOR-MODE is a symbol or t (meaning the default). For example:
239 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
240means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
241for buffers in Rmail mode, and size is irrelevant otherwise."
242 :type '(choice (const :tag "none" nil)
243 (integer :tag "size")
244 (repeat :menu-tag "mode specific" :tag "mode specific"
245 :value ((t . nil))
246 (cons :tag "Instance"
247 (radio :tag "Mode"
248 (const :tag "all" t)
249 (symbol :tag "name"))
250 (radio :tag "Size"
251 (const :tag "none" nil)
252 (integer :tag "size")))))
55015061 253 :group 'font-lock)
9bfbb130 254
55015061 255(defcustom font-lock-maximum-decoration t
9201cc28 256 "Maximum decoration level for fontification.
9bfbb130
SM
257If nil, use the default decoration (typically the minimum available).
258If t, use the maximum decoration available.
259If a number, use that level of decoration (or if not available the maximum).
260If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
261where MAJOR-MODE is a symbol or t (meaning the default). For example:
5aa29679
RS
262 ((c-mode . t) (c++-mode . 2) (t . 1))
263means use the maximum decoration available for buffers in C mode, level 2
55015061 264decoration for buffers in C++ mode, and level 1 decoration otherwise."
b34aa0a3
SM
265 :type '(choice (const :tag "default" nil)
266 (const :tag "maximum" t)
267 (integer :tag "level" 1)
268 (repeat :menu-tag "mode specific" :tag "mode specific"
269 :value ((t . t))
270 (cons :tag "Instance"
271 (radio :tag "Mode"
272 (const :tag "all" t)
273 (symbol :tag "name"))
274 (radio :tag "Decoration"
275 (const :tag "default" nil)
019f00d8 276 (const :tag "maximum" t)
b34aa0a3 277 (integer :tag "level" 1)))))
55015061
SM
278 :group 'font-lock)
279
4fffc071 280(defcustom font-lock-verbose 0
9201cc28 281 "If non-nil, means show status messages for buffer fontification.
23a0e11b
SM
282If a number, only buffers greater than this size have fontification messages."
283 :type '(choice (const :tag "never" nil)
4fffc071
SM
284 (other :tag "always" t)
285 (integer :tag "size"))
55015061 286 :group 'font-lock)
9bfbb130 287\f
1c172af4
SM
288
289;; Originally these variable values were face names such as `bold' etc.
290;; Now we create our own faces, but we keep these variables for compatibility
291;; and they give users another mechanism for changing face appearance.
292;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
293;; returns a face. So the easiest thing is to continue using these variables,
294;; rather than sometimes evaling FACENAME and sometimes not. sm.
8230b7b3
GM
295
296;; Note that in new code, in the vast majority of cases there is no
297;; need to create variables that specify face names. Simply using
298;; faces directly is enough. Font-lock is not a template to be
299;; followed in this area.
1c172af4
SM
300(defvar font-lock-comment-face 'font-lock-comment-face
301 "Face name to use for comments.")
302
9177dd93 303(defvar font-lock-comment-delimiter-face 'font-lock-comment-delimiter-face
4403a969 304 "Face name to use for comment delimiters.")
9177dd93 305
1c172af4
SM
306(defvar font-lock-string-face 'font-lock-string-face
307 "Face name to use for strings.")
308
309(defvar font-lock-doc-face 'font-lock-doc-face
310 "Face name to use for documentation.")
311
312(defvar font-lock-keyword-face 'font-lock-keyword-face
313 "Face name to use for keywords.")
314
315(defvar font-lock-builtin-face 'font-lock-builtin-face
316 "Face name to use for builtins.")
317
318(defvar font-lock-function-name-face 'font-lock-function-name-face
319 "Face name to use for function names.")
320
321(defvar font-lock-variable-name-face 'font-lock-variable-name-face
322 "Face name to use for variable names.")
323
324(defvar font-lock-type-face 'font-lock-type-face
325 "Face name to use for type and class names.")
326
327(defvar font-lock-constant-face 'font-lock-constant-face
328 "Face name to use for constant and label names.")
329
330(defvar font-lock-warning-face 'font-lock-warning-face
331 "Face name to use for things that should stand out.")
332
5d27cf9f
DP
333(defvar font-lock-negation-char-face 'font-lock-negation-char-face
334 "Face name to use for easy to overlook negation.
335This can be an \"!\" or the \"n\" in \"ifndef\".")
336
d654cab8
SM
337(defvar font-lock-preprocessor-face 'font-lock-preprocessor-face
338 "Face name to use for preprocessor directives.")
339
9087b271 340(defvar font-lock-reference-face 'font-lock-constant-face)
7ee5f414 341(make-obsolete-variable 'font-lock-reference-face 'font-lock-constant-face "20.3")
1c172af4 342
9bfbb130
SM
343;; Fontification variables:
344
030f4a35 345(defvar font-lock-keywords nil
ac6e572c 346 "A list of the keywords to highlight.
69968400
RS
347There are two kinds of values: user-level, and compiled.
348
349A user-level keywords list is what a major mode or the user would
350set up. Normally the list would come from `font-lock-defaults'.
351through selection of a fontification level and evaluation of any
352contained expressions. You can also alter it by calling
353`font-lock-add-keywords' or `font-lock-remove-keywords' with MODE = nil.
354
355Each element in a user-level keywords list should have one of these forms:
a1eb1cf1 356
826b2925 357 MATCHER
9bab4985 358 (MATCHER . SUBEXP)
826b2925
SM
359 (MATCHER . FACENAME)
360 (MATCHER . HIGHLIGHT)
361 (MATCHER HIGHLIGHT ...)
a078558d 362 (eval . FORM)
a1eb1cf1 363
558371ba 364where MATCHER can be either the regexp to search for, or the function name to
f9c0bc2e 365call to make the search (called with one argument, the limit of the search;
4837b516 366it should return non-nil, move point, and set `match-data' appropriately if
f9c0bc2e 367it succeeds; like `re-search-forward' would).
558371ba 368MATCHER regexps can be generated via the function `regexp-opt'.
9bfbb130 369
a078558d
SM
370FORM is an expression, whose value should be a keyword element, evaluated when
371the keyword is (first) used in a buffer. This feature can be used to provide a
372keyword that can only be generated when Font Lock mode is actually turned on.
373
558371ba
SM
374HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
375
9c8de95c
SM
376For highlighting single items, for example each instance of the word \"foo\",
377typically only MATCH-HIGHLIGHT is required.
d9f7b2d3 378However, if an item or (typically) items are to be highlighted following the
9c8de95c
SM
379instance of another item (the anchor), for example each instance of the
380word \"bar\" following the word \"anchor\" then MATCH-ANCHORED may be required.
9bfbb130
SM
381
382MATCH-HIGHLIGHT should be of the form:
383
9bab4985 384 (SUBEXP FACENAME [OVERRIDE [LAXMATCH]])
9bfbb130 385
9bab4985
RS
386SUBEXP is the number of the subexpression of MATCHER to be highlighted.
387
388FACENAME is an expression whose value is the face name to use.
389Instead of a face, FACENAME can evaluate to a property list
390of the form (face FACE PROP1 VAL1 PROP2 VAL2 ...)
558371ba 391in which case all the listed text-properties will be set rather than
67b4790b 392just FACE. In such a case, you will most likely want to put those
558371ba
SM
393properties in `font-lock-extra-managed-props' or to override
394`font-lock-unfontify-region-function'.
a1eb1cf1 395
2d63aa67 396OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
9bfbb130
SM
397be overwritten. If `keep', only parts not already fontified are highlighted.
398If `prepend' or `append', existing fontification is merged with the new, in
399which the new or existing fontification, respectively, takes precedence.
9bab4985
RS
400If LAXMATCH is non-nil, that means don't signal an error if there is
401no match for SUBEXP in MATCHER.
a1eb1cf1 402
9bfbb130
SM
403For example, an element of the form highlights (if not already highlighted):
404
9c8de95c 405 \"\\\\\\=<foo\\\\\\=>\" discrete occurrences of \"foo\" in the value of the
876f2438 406 variable `font-lock-keyword-face'.
9c8de95c 407 (\"fu\\\\(bar\\\\)\" . 1) substring \"bar\" within all occurrences of \"fubar\" in
9bfbb130
SM
408 the value of `font-lock-keyword-face'.
409 (\"fubar\" . fubar-face) Occurrences of \"fubar\" in the value of `fubar-face'.
410 (\"foo\\\\|bar\" 0 foo-bar-face t)
9c8de95c 411 occurrences of either \"foo\" or \"bar\" in the value
9bfbb130 412 of `foo-bar-face', even if already highlighted.
844a6a46 413 (fubar-match 1 fubar-face)
9c8de95c 414 the first subexpression within all occurrences of
844a6a46
SM
415 whatever the function `fubar-match' finds and matches
416 in the value of `fubar-face'.
9bfbb130
SM
417
418MATCH-ANCHORED should be of the form:
419
420 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
421
9c8de95c
SM
422where MATCHER is a regexp to search for or the function name to call to make
423the search, as for MATCH-HIGHLIGHT above, but with one exception; see below.
876f2438
SM
424PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
425the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
97f38995 426used to initialize before, and cleanup after, MATCHER is used. Typically,
876f2438
SM
427PRE-MATCH-FORM is used to move to some position relative to the original
428MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
67b4790b 429be used to move back, before resuming with MATCH-ANCHORED's parent's MATCHER.
9bfbb130
SM
430
431For example, an element of the form highlights (if not already highlighted):
432
876f2438 433 (\"\\\\\\=<anchor\\\\\\=>\" (0 anchor-face) (\"\\\\\\=<item\\\\\\=>\" nil nil (0 item-face)))
9bfbb130 434
9c8de95c 435 discrete occurrences of \"anchor\" in the value of `anchor-face', and subsequent
876f2438
SM
436 discrete occurrences of \"item\" (on the same line) in the value of `item-face'.
437 (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil. Therefore \"item\" is
438 initially searched for starting from the end of the match of \"anchor\", and
67b4790b 439 searching for subsequent instances of \"anchor\" resumes from where searching
876f2438 440 for \"item\" concluded.)
9bfbb130 441
56fcbd7e
SM
442The above-mentioned exception is as follows. The limit of the MATCHER search
443defaults to the end of the line after PRE-MATCH-FORM is evaluated.
444However, if PRE-MATCH-FORM returns a position greater than the position after
445PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
446It is generally a bad idea to return a position greater than the end of the
447line, i.e., cause the MATCHER search to span lines.
448
6e1d0d15
SM
449These regular expressions can match text which spans lines, although
450it is better to avoid it if possible since updating them while editing
451text is slower, and it is not guaranteed to be always correct when using
452support modes like jit-lock or lazy-lock.
a1eb1cf1 453
2d63aa67
SM
454This variable is set by major modes via the variable `font-lock-defaults'.
455Be careful when composing regexps for this list; a poorly written pattern can
69968400
RS
456dramatically slow things down!
457
458A compiled keywords list starts with t. It is produced internal
459by `font-lock-compile-keywords' from a user-level keywords list.
460Its second element is the user-level keywords list that was
461compiled. The remaining elements have the same form as
462user-level keywords, but normally their values have been
463optimized.")
030f4a35 464
c1f2ffc8 465(defvar font-lock-keywords-alist nil
0003d2e3
LK
466 "Alist of additional `font-lock-keywords' elements for major modes.
467
28aa8148 468Each element has the form (MODE KEYWORDS . HOW).
0003d2e3
LK
469`font-lock-set-defaults' adds the elements in the list KEYWORDS to
470`font-lock-keywords' when Font Lock is turned on in major mode MODE.
471
28aa8148 472If HOW is nil, KEYWORDS are added at the beginning of
0003d2e3 473`font-lock-keywords'. If it is `set', they are used to replace the
28aa8148 474value of `font-lock-keywords'. If HOW is any other non-nil value,
0003d2e3
LK
475they are added at the end.
476
76f5e2af
GM
477This is normally set via `font-lock-add-keywords' and
478`font-lock-remove-keywords'.")
3b2d0d76 479(put 'font-lock-keywords-alist 'risky-local-variable t)
76f5e2af
GM
480
481(defvar font-lock-removed-keywords-alist nil
0003d2e3
LK
482 "Alist of `font-lock-keywords' elements to be removed for major modes.
483
484Each element has the form (MODE . KEYWORDS). `font-lock-set-defaults'
485removes the elements in the list KEYWORDS from `font-lock-keywords'
486when Font Lock is turned on in major mode MODE.
487
76f5e2af
GM
488This is normally set via `font-lock-add-keywords' and
489`font-lock-remove-keywords'.")
c1f2ffc8 490
9bfbb130 491(defvar font-lock-keywords-only nil
d46c21ec
SM
492 "*Non-nil means Font Lock should not fontify comments or strings.
493This is normally set via `font-lock-defaults'.")
b89e1134 494
030f4a35 495(defvar font-lock-keywords-case-fold-search nil
d46c21ec 496 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
8b7581e0
CY
497This is set via the function `font-lock-set-defaults', based on
498the CASE-FOLD argument of `font-lock-defaults'.")
1087f198 499(make-variable-buffer-local 'font-lock-keywords-case-fold-search)
030f4a35 500
c0a6a9fe
SM
501(defvar font-lock-syntactically-fontified 0
502 "Point up to which `font-lock-syntactic-keywords' has been applied.
503If nil, this is ignored, in which case the syntactic fontification may
504sometimes be slightly incorrect.")
505(make-variable-buffer-local 'font-lock-syntactically-fontified)
506
1c172af4
SM
507(defvar font-lock-syntactic-face-function
508 (lambda (state)
509 (if (nth 3 state) font-lock-string-face font-lock-comment-face))
510 "Function to determine which face to use when fontifying syntactically.
511The function is called with a single parameter (the state as returned by
512`parse-partial-sexp' at the beginning of the region to highlight) and
8ba81e93 513should return a face. This is normally set via `font-lock-defaults'.")
1c172af4 514
ac6e572c 515(defvar font-lock-syntactic-keywords nil
9bab4985
RS
516 "A list of the syntactic keywords to put syntax properties on.
517The value can be the list itself, or the name of a function or variable
518whose value is the list.
519
ac6e572c 520See `font-lock-keywords' for a description of the form of this list;
9bab4985 521only the differences are stated here. MATCH-HIGHLIGHT should be of the form:
ac6e572c 522
9bab4985 523 (SUBEXP SYNTAX OVERRIDE LAXMATCH)
ac6e572c 524
5299cb8e
SM
525where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax
526table, a cons cell (as returned by `string-to-syntax') or an expression whose
527value is such a form. OVERRIDE cannot be `prepend' or `append'.
ac6e572c 528
9bab4985
RS
529Here are two examples of elements of `font-lock-syntactic-keywords'
530and what they do:
9c8de95c 531
5299cb8e 532 (\"\\\\$\\\\(#\\\\)\" 1 \".\")
9c8de95c 533
9bab4985
RS
534 gives a hash character punctuation syntax (\".\") when following a
535 dollar-sign character. Hash characters in other contexts will still
536 follow whatever the syntax table says about the hash character.
9c8de95c
SM
537
538 (\"\\\\('\\\\).\\\\('\\\\)\"
5299cb8e
SM
539 (1 \"\\\"\")
540 (2 \"\\\"\"))
9c8de95c 541
9bab4985
RS
542 gives a pair single-quotes, which surround a single character, a SYNTAX of
543 \"\\\"\" (meaning string quote syntax). Single-quote characters in other
544 contexts will not be affected.
9c8de95c 545
ac6e572c 546This is normally set via `font-lock-defaults'.")
cf38dd42
SM
547(make-obsolete-variable 'font-lock-syntactic-keywords
548 'syntax-propertize-function "24.1")
ac6e572c 549
b056da51 550(defvar font-lock-syntax-table nil
799761f0 551 "Non-nil means use this syntax table for fontifying.
d46c21ec
SM
552If this is nil, the major mode's syntax table is used.
553This is normally set via `font-lock-defaults'.")
554
555(defvar font-lock-beginning-of-syntax-function nil
fc896a92
RS
556 "*Non-nil means use this function to move back outside all constructs.
557When called with no args it should move point backward to a place which
558is not in a string or comment and not within any bracket-pairs (or else,
559a place such that any bracket-pairs outside it can be ignored for Emacs
560syntax analysis and fontification).
561
822b23b0
LK
562If this is nil, Font Lock uses `syntax-begin-function' to move back
563outside of any comment, string, or sexp. This variable is semi-obsolete;
564we recommend setting `syntax-begin-function' instead.
565
566This is normally set via `font-lock-defaults'.")
b056da51 567
a078558d
SM
568(defvar font-lock-mark-block-function nil
569 "*Non-nil means use this function to mark a block of text.
570When called with no args it should leave point at the beginning of any
571enclosing textual block and mark at the end.
572This is normally set via `font-lock-defaults'.")
573
a2b8e66b
SM
574(defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer
575 "Function to use for fontifying the buffer.
576This is normally set via `font-lock-defaults'.")
577
578(defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer
579 "Function to use for unfontifying the buffer.
580This is used when turning off Font Lock mode.
581This is normally set via `font-lock-defaults'.")
582
583(defvar font-lock-fontify-region-function 'font-lock-default-fontify-region
584 "Function to use for fontifying a region.
585It should take two args, the beginning and end of the region, and an optional
0edd2744
LK
586third arg VERBOSE. If VERBOSE is non-nil, the function should print status
587messages. This is normally set via `font-lock-defaults'.")
a2b8e66b
SM
588
589(defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region
590 "Function to use for unfontifying a region.
591It should take two args, the beginning and end of the region.
592This is normally set via `font-lock-defaults'.")
593
594(defvar font-lock-inhibit-thing-lock nil
595 "List of Font Lock mode related modes that should not be turned on.
019f00d8 596Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
e7f07c2c 597`lazy-lock-mode'. This is normally set via `font-lock-defaults'.")
a2b8e66b 598
f8115798
SM
599(defvar font-lock-multiline nil
600 "Whether font-lock should cater to multiline keywords.
601If nil, don't try to handle multiline patterns.
602If t, always handle multiline patterns.
603If `undecided', don't try to handle multiline patterns until you see one.
604Major/minor modes can set this variable if they know which option applies.")
605
606(defvar font-lock-fontified nil) ; Whether we have fontified the buffer.
030f4a35 607\f
5aa29679
RS
608;; Font Lock mode.
609
610(eval-when-compile
2e6a15fc 611 ;;
5aa29679 612 ;; We don't do this at the top-level as we only use non-autoloaded macros.
2e6a15fc
SM
613 (require 'cl)
614 ;;
615 ;; Borrowed from lazy-lock.el.
616 ;; We use this to preserve or protect things when modifying text properties.
b073dc4b 617 (defmacro save-buffer-state (&rest body)
2e6a15fc 618 "Bind variables according to VARLIST and eval BODY restoring buffer state."
b073dc4b
SM
619 (declare (indent 0) (debug t))
620 `(let ((inhibit-point-motion-hooks t))
d36b74ca
SM
621 (with-silent-modifications
622 ,@body)))
e0e277ff
SM
623 ;;
624 ;; Shut up the byte compiler.
1c172af4 625 (defvar font-lock-face-attributes)) ; Obsolete but respected if set.
030f4a35 626
f8115798
SM
627(defun font-lock-mode-internal (arg)
628 ;; Turn on Font Lock mode.
629 (when arg
630 (add-hook 'after-change-functions 'font-lock-after-change-function t t)
631 (font-lock-set-defaults)
632 (font-lock-turn-on-thing-lock)
633 ;; Fontify the buffer if we have to.
634 (let ((max-size (font-lock-value-in-major-mode font-lock-maximum-size)))
635 (cond (font-lock-fontified
636 nil)
637 ((or (null max-size) (> max-size (buffer-size)))
638 (font-lock-fontify-buffer))
639 (font-lock-verbose
640 (message "Fontifying %s...buffer size greater than font-lock-maximum-size"
641 (buffer-name))))))
642 ;; Turn off Font Lock mode.
643 (unless font-lock-mode
644 (remove-hook 'after-change-functions 'font-lock-after-change-function t)
645 (font-lock-unfontify-buffer)
646 (font-lock-turn-off-thing-lock)))
647
28aa8148 648(defun font-lock-add-keywords (mode keywords &optional how)
041470d2 649 "Add highlighting KEYWORDS for MODE.
8ba81e93 650
041470d2 651MODE should be a symbol, the major mode command name, such as `c-mode'
1c626aaf 652or nil. If nil, highlighting keywords are added for the current buffer.
c1f2ffc8
SM
653KEYWORDS should be a list; see the variable `font-lock-keywords'.
654By default they are added at the beginning of the current highlighting list.
28aa8148
RF
655If optional argument HOW is `set', they are used to replace the current
656highlighting list. If HOW is any other non-nil value, they are added at the
2d63aa67 657end of the current highlighting list.
c1f2ffc8
SM
658
659For example:
660
661 (font-lock-add-keywords 'c-mode
662 '((\"\\\\\\=<\\\\(FIXME\\\\):\" 1 font-lock-warning-face prepend)
663 (\"\\\\\\=<\\\\(and\\\\|or\\\\|not\\\\)\\\\\\=>\" . font-lock-keyword-face)))
664
665adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
2d63aa67
SM
666comments, and to fontify `and', `or' and `not' words as keywords.
667
bed88438
LT
668The above procedure will only add the keywords for C mode, not
669for modes derived from C mode. To add them for derived modes too,
670pass nil for MODE and add the call to c-mode-hook.
671
672For example:
673
674 (add-hook 'c-mode-hook
675 (lambda ()
dd314c0f 676 (font-lock-add-keywords nil
bed88438
LT
677 '((\"\\\\\\=<\\\\(FIXME\\\\):\" 1 font-lock-warning-face prepend)
678 (\"\\\\\\=<\\\\(and\\\\|or\\\\|not\\\\)\\\\\\=>\" .
679 font-lock-keyword-face)))))
680
681The above procedure may fail to add keywords to derived modes if
682some involved major mode does not follow the standard conventions.
683File a bug report if this happens, so the major mode can be corrected.
558371ba 684
8c2d6a44 685Note that some modes have specialized support for additional patterns, e.g.,
2d63aa67
SM
686see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
687`objc-font-lock-extra-types' and `java-font-lock-extra-types'."
041470d2 688 (cond (mode
28aa8148 689 ;; If MODE is non-nil, add the KEYWORDS and HOW spec to
c1f2ffc8 690 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
28aa8148 691 (let ((spec (cons keywords how)) cell)
041470d2 692 (if (setq cell (assq mode font-lock-keywords-alist))
28aa8148 693 (if (eq how 'set)
76f5e2af
GM
694 (setcdr cell (list spec))
695 (setcdr cell (append (cdr cell) (list spec))))
696 (push (list mode spec) font-lock-keywords-alist)))
697 ;; Make sure that `font-lock-removed-keywords-alist' does not
698 ;; contain the new keywords.
28aa8148 699 (font-lock-update-removed-keyword-alist mode keywords how))
6e1d0d15 700 (t
72fa3278
SM
701 (when (and font-lock-mode
702 (not (or font-lock-keywords font-lock-defaults)))
703 ;; The major mode has not set any keywords, so when we enabled
704 ;; font-lock-mode it only enabled the font-core.el part, not the
705 ;; font-lock-mode-internal. Try again.
706 (font-lock-mode -1)
707 (set (make-local-variable 'font-lock-defaults) '(nil t))
708 (font-lock-mode 1))
6e1d0d15 709 ;; Otherwise set or add the keywords now.
bed88438
LT
710 ;; This is a no-op if it has been done already in this buffer
711 ;; for the correct major mode.
6e1d0d15 712 (font-lock-set-defaults)
69968400
RS
713 (let ((was-compiled (eq (car font-lock-keywords) t)))
714 ;; Bring back the user-level (uncompiled) keywords.
715 (if was-compiled
716 (setq font-lock-keywords (cadr font-lock-keywords)))
717 ;; Now modify or replace them.
28aa8148 718 (if (eq how 'set)
69968400
RS
719 (setq font-lock-keywords keywords)
720 (font-lock-remove-keywords nil keywords) ;to avoid duplicates
721 (let ((old (if (eq (car-safe font-lock-keywords) t)
722 (cdr font-lock-keywords)
723 font-lock-keywords)))
28aa8148 724 (setq font-lock-keywords (if how
69968400
RS
725 (append old keywords)
726 (append keywords old)))))
727 ;; If the keywords were compiled before, compile them again.
728 (if was-compiled
e0be77f6 729 (setq font-lock-keywords
533047c2 730 (font-lock-compile-keywords font-lock-keywords)))))))
3708dfe9 731
28aa8148 732(defun font-lock-update-removed-keyword-alist (mode keywords how)
95965740 733 "Update `font-lock-removed-keywords-alist' when adding new KEYWORDS to MODE."
76f5e2af
GM
734 ;; When font-lock is enabled first all keywords in the list
735 ;; `font-lock-keywords-alist' are added, then all keywords in the
736 ;; list `font-lock-removed-keywords-alist' are removed. If a
737 ;; keyword was once added, removed, and then added again it must be
738 ;; removed from the removed-keywords list. Otherwise the second add
739 ;; will not take effect.
6e1d0d15 740 (let ((cell (assq mode font-lock-removed-keywords-alist)))
76f5e2af 741 (if cell
28aa8148 742 (if (eq how 'set)
76f5e2af
GM
743 ;; A new set of keywords is defined. Forget all about
744 ;; our old keywords that should be removed.
745 (setq font-lock-removed-keywords-alist
746 (delq cell font-lock-removed-keywords-alist))
747 ;; Delete all previously removed keywords.
748 (dolist (kword keywords)
749 (setcdr cell (delete kword (cdr cell))))
6e1d0d15 750 ;; Delete the mode cell if empty.
76f5e2af
GM
751 (if (null (cdr cell))
752 (setq font-lock-removed-keywords-alist
753 (delq cell font-lock-removed-keywords-alist)))))))
754
755;; Written by Anders Lindgren <andersl@andersl.com>.
756;;
757;; Case study:
758;; (I) The keywords are removed from a major mode.
759;; In this case the keyword could be local (i.e. added earlier by
760;; `font-lock-add-keywords'), global, or both.
761;;
762;; (a) In the local case we remove the keywords from the variable
763;; `font-lock-keywords-alist'.
764;;
765;; (b) The actual global keywords are not known at this time.
766;; All keywords are added to `font-lock-removed-keywords-alist',
767;; when font-lock is enabled those keywords are removed.
768;;
769;; Note that added keywords are taken out of the list of removed
770;; keywords. This ensure correct operation when the same keyword
771;; is added and removed several times.
772;;
773;; (II) The keywords are removed from the current buffer.
6e1d0d15
SM
774(defun font-lock-remove-keywords (mode keywords)
775 "Remove highlighting KEYWORDS for MODE.
3708dfe9 776
6e1d0d15 777MODE should be a symbol, the major mode command name, such as `c-mode'
558371ba
SM
778or nil. If nil, highlighting keywords are removed for the current buffer.
779
bed88438
LT
780To make the removal apply to modes derived from MODE as well,
781pass nil for MODE and add the call to MODE-hook. This may fail
782for some derived modes if some involved major mode does not
783follow the standard conventions. File a bug report if this
784happens, so the major mode can be corrected."
6e1d0d15
SM
785 (cond (mode
786 ;; Remove one keyword at the time.
787 (dolist (keyword keywords)
788 (let ((top-cell (assq mode font-lock-keywords-alist)))
789 ;; If MODE is non-nil, remove the KEYWORD from
76f5e2af
GM
790 ;; `font-lock-keywords-alist'.
791 (when top-cell
28aa8148
RF
792 (dolist (keyword-list-how-pair (cdr top-cell))
793 ;; `keywords-list-how-pair' is a cons with a list of
794 ;; keywords in the car top-cell and the original how
76f5e2af 795 ;; argument in the cdr top-cell.
28aa8148
RF
796 (setcar keyword-list-how-pair
797 (delete keyword (car keyword-list-how-pair))))
798 ;; Remove keyword list/how pair when the keyword list
799 ;; is empty and how doesn't specify `set'. (If it
76f5e2af
GM
800 ;; should be deleted then previously deleted keywords
801 ;; would appear again.)
802 (let ((cell top-cell))
803 (while (cdr cell)
804 (if (and (null (car (car (cdr cell))))
805 (not (eq (cdr (car (cdr cell))) 'set)))
806 (setcdr cell (cdr (cdr cell)))
807 (setq cell (cdr cell)))))
808 ;; Final cleanup, remove major mode cell if last keyword
809 ;; was deleted.
810 (if (null (cdr top-cell))
811 (setq font-lock-keywords-alist
812 (delq top-cell font-lock-keywords-alist))))
813 ;; Remember the keyword in case it is not local.
6e1d0d15 814 (let ((cell (assq mode font-lock-removed-keywords-alist)))
76f5e2af
GM
815 (if cell
816 (unless (member keyword (cdr cell))
817 (nconc cell (list keyword)))
6e1d0d15
SM
818 (push (cons mode (list keyword))
819 font-lock-removed-keywords-alist))))))
820 (t
821 ;; Otherwise remove it immediately.
822 (font-lock-set-defaults)
69968400
RS
823 (let ((was-compiled (eq (car font-lock-keywords) t)))
824 ;; Bring back the user-level (uncompiled) keywords.
825 (if was-compiled
826 (setq font-lock-keywords (cadr font-lock-keywords)))
827
828 ;; Edit them.
829 (setq font-lock-keywords (copy-sequence font-lock-keywords))
830 (dolist (keyword keywords)
831 (setq font-lock-keywords
832 (delete keyword font-lock-keywords)))
833
834 ;; If the keywords were compiled before, compile them again.
835 (if was-compiled
e0be77f6 836 (setq font-lock-keywords
533047c2 837 (font-lock-compile-keywords font-lock-keywords)))))))
a2b8e66b 838\f
2d63aa67
SM
839;;; Font Lock Support mode.
840
5aa29679
RS
841;; This is the code used to interface font-lock.el with any of its add-on
842;; packages, and provide the user interface. Packages that have their own
843;; local buffer fontification functions (see below) may have to call
844;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
845;; themselves.
846
5f999b0b 847(defcustom font-lock-support-mode 'jit-lock-mode
9201cc28 848 "Support mode for Font Lock mode.
5aa29679 849Support modes speed up Font Lock mode by being choosy about when fontification
59442c80
RS
850occurs. The default support mode, Just-in-time Lock mode (symbol
851`jit-lock-mode'), is recommended.
852
853Other, older support modes are Fast Lock mode (symbol `fast-lock-mode') and
854Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
855However, they are no longer recommended, as Just-in-time Lock mode is better.
856
5aa29679
RS
857If nil, means support for Font Lock mode is never performed.
858If a symbol, use that support mode.
859If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
860where MAJOR-MODE is a symbol or t (meaning the default). For example:
861 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
862means that Fast Lock mode is used to support Font Lock mode for buffers in C or
863C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
864
55015061 865The value of this variable is used when Font Lock mode is turned on."
b34aa0a3
SM
866 :type '(choice (const :tag "none" nil)
867 (const :tag "fast lock" fast-lock-mode)
868 (const :tag "lazy lock" lazy-lock-mode)
e7f07c2c 869 (const :tag "jit lock" jit-lock-mode)
b34aa0a3 870 (repeat :menu-tag "mode specific" :tag "mode specific"
1c172af4 871 :value ((t . jit-lock-mode))
b34aa0a3
SM
872 (cons :tag "Instance"
873 (radio :tag "Mode"
874 (const :tag "all" t)
875 (symbol :tag "name"))
39df451b
SM
876 (radio :tag "Support"
877 (const :tag "none" nil)
b34aa0a3 878 (const :tag "fast lock" fast-lock-mode)
e7f07c2c
GM
879 (const :tag "lazy lock" lazy-lock-mode)
880 (const :tag "JIT lock" jit-lock-mode)))
b34aa0a3 881 ))
c69e5fcd 882 :version "21.1"
55015061 883 :group 'font-lock)
5aa29679 884
7f0d55f2
SM
885(defvar fast-lock-mode)
886(defvar lazy-lock-mode)
887(defvar jit-lock-mode)
2e6a15fc 888
2c52d7a3
GM
889(declare-function fast-lock-after-fontify-buffer "fast-lock")
890(declare-function fast-lock-after-unfontify-buffer "fast-lock")
891(declare-function fast-lock-mode "fast-lock")
892(declare-function lazy-lock-after-fontify-buffer "lazy-lock")
893(declare-function lazy-lock-after-unfontify-buffer "lazy-lock")
894(declare-function lazy-lock-mode "lazy-lock")
e8ffb999 895
5aa29679 896(defun font-lock-turn-on-thing-lock ()
202ff0d6
SM
897 (case (font-lock-value-in-major-mode font-lock-support-mode)
898 (fast-lock-mode (fast-lock-mode t))
899 (lazy-lock-mode (lazy-lock-mode t))
900 (jit-lock-mode
901 ;; Prepare for jit-lock
902 (remove-hook 'after-change-functions
903 'font-lock-after-change-function t)
904 (set (make-local-variable 'font-lock-fontify-buffer-function)
905 'jit-lock-refontify)
906 ;; Don't fontify eagerly (and don't abort if the buffer is large).
907 (set (make-local-variable 'font-lock-fontified) t)
908 ;; Use jit-lock.
909 (jit-lock-register 'font-lock-fontify-region
910 (not font-lock-keywords-only))
911 ;; Tell jit-lock how we extend the region to refontify.
912 (add-hook 'jit-lock-after-change-extend-region-functions
913 'font-lock-extend-jit-lock-region-after-change
914 nil t))))
5aa29679 915
5aa29679 916(defun font-lock-turn-off-thing-lock ()
2124318a 917 (cond ((bound-and-true-p fast-lock-mode)
1c172af4 918 (fast-lock-mode -1))
2124318a 919 ((bound-and-true-p jit-lock-mode)
28a53bc1
SM
920 (jit-lock-unregister 'font-lock-fontify-region)
921 ;; Reset local vars to the non-jit-lock case.
922 (kill-local-variable 'font-lock-fontify-buffer-function))
2124318a 923 ((bound-and-true-p lazy-lock-mode)
1c172af4 924 (lazy-lock-mode -1))))
5aa29679
RS
925
926(defun font-lock-after-fontify-buffer ()
2124318a 927 (cond ((bound-and-true-p fast-lock-mode)
5aa29679 928 (fast-lock-after-fontify-buffer))
13f0d185
SM
929 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
930 ;; (jit-lock-mode
931 ;; (jit-lock-after-fontify-buffer))
2124318a 932 ((bound-and-true-p lazy-lock-mode)
5aa29679
RS
933 (lazy-lock-after-fontify-buffer))))
934
935(defun font-lock-after-unfontify-buffer ()
2124318a 936 (cond ((bound-and-true-p fast-lock-mode)
5aa29679 937 (fast-lock-after-unfontify-buffer))
13f0d185
SM
938 ;; Useless as well. It's only called when:
939 ;; - turning off font-lock: it does not matter if we leave spurious
940 ;; `fontified' text props around since jit-lock-mode is also off.
941 ;; - font-lock-default-fontify-buffer fails: this is not run
942 ;; any more anyway. -sm
5e9e032a 943 ;;
13f0d185
SM
944 ;; (jit-lock-mode
945 ;; (jit-lock-after-unfontify-buffer))
2124318a 946 ((bound-and-true-p lazy-lock-mode)
5aa29679
RS
947 (lazy-lock-after-unfontify-buffer))))
948
2d63aa67 949;;; End of Font Lock Support mode.
5aa29679 950\f
2d63aa67 951;;; Fontification functions.
a1eb1cf1 952
56fcbd7e
SM
953;; Rather than the function, e.g., `font-lock-fontify-region' containing the
954;; code to fontify a region, the function runs the function whose name is the
955;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
956;; the value of this variable is, e.g., `font-lock-default-fontify-region'
957;; which does contain the code to fontify a region. However, the value of the
958;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
959;; do anything. The indirection of the fontification functions gives major
960;; modes the capability of modifying the way font-lock.el fontifies. Major
961;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
962;; via the variable `font-lock-defaults'.
963;;
964;; For example, Rmail mode sets the variable `font-lock-defaults' so that
965;; font-lock.el uses its own function for buffer fontification. This function
966;; makes fontification be on a message-by-message basis and so visiting an
967;; RMAIL file is much faster. A clever implementation of the function might
968;; fontify the headers differently than the message body. (It should, and
969;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
970;; you?) This hints at a more interesting use...
971;;
972;; Languages that contain text normally contained in different major modes
973;; could define their own fontification functions that treat text differently
974;; depending on its context. For example, Perl mode could arrange that here
975;; docs are fontified differently than Perl code. Or Yacc mode could fontify
976;; rules one way and C code another. Neat!
977;;
978;; A further reason to use the fontification indirection feature is when the
979;; default syntactual fontification, or the default fontification in general,
980;; is not flexible enough for a particular major mode. For example, perhaps
55015061
SM
981;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
982;; cope with. You need to write your own version of that function, e.g.,
983;; `hairy-fontify-syntactically-region', and make your own version of
984;; `hairy-fontify-region' call that function before calling
56fcbd7e
SM
985;; `font-lock-fontify-keywords-region' for the normal regexp fontification
986;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
987;; would call your region fontification function instead of its own. For
55015061 988;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
56fcbd7e
SM
989;; directives correctly and cleanly. (It is the same problem as fontifying
990;; multi-line strings and comments; regexps are not appropriate for the job.)
991
ab0dd59c 992(defvar font-lock-extend-after-change-region-function nil
1402611c 993 "A function that determines the region to refontify after a change.
2821e1b6
SM
994
995This variable is either nil, or is a function that determines the
996region to refontify after a change.
997It is usually set by the major mode via `font-lock-defaults'.
998Font-lock calls this function after each buffer change.
999
1000The function is given three parameters, the standard BEG, END, and OLD-LEN
1001from `after-change-functions'. It should return either a cons of the beginning
1402611c 1002and end buffer positions \(in that order) of the region to refontify, or nil
ab0dd59c
SM
1003\(which directs the caller to fontify a default region).
1004This function should preserve the match-data.
2821e1b6 1005The region it returns may start or end in the middle of a line.")
96bdb5cf 1006(make-variable-buffer-local 'font-lock-extend-after-change-region-function)
2821e1b6 1007
030f4a35 1008(defun font-lock-fontify-buffer ()
019f00d8 1009 "Fontify the current buffer the way the function `font-lock-mode' would."
030f4a35 1010 (interactive)
1c360af3 1011 (font-lock-set-defaults)
32226619
JB
1012 (let ((font-lock-verbose (or font-lock-verbose
1013 (called-interactively-p 'interactive))))
a2b8e66b
SM
1014 (funcall font-lock-fontify-buffer-function)))
1015
1016(defun font-lock-unfontify-buffer ()
1017 (funcall font-lock-unfontify-buffer-function))
1018
1019(defun font-lock-fontify-region (beg end &optional loudly)
1c360af3 1020 (font-lock-set-defaults)
a2b8e66b
SM
1021 (funcall font-lock-fontify-region-function beg end loudly))
1022
1023(defun font-lock-unfontify-region (beg end)
b073dc4b 1024 (save-buffer-state
516eb29c 1025 (funcall font-lock-unfontify-region-function beg end)))
a2b8e66b
SM
1026
1027(defun font-lock-default-fontify-buffer ()
5aa29679
RS
1028 (let ((verbose (if (numberp font-lock-verbose)
1029 (> (buffer-size) font-lock-verbose)
1030 font-lock-verbose)))
79f238c9 1031 (with-temp-message
1787769b
SM
1032 (when verbose
1033 (format "Fontifying %s..." (buffer-name)))
79f238c9
SM
1034 ;; Make sure we fontify etc. in the whole buffer.
1035 (save-restriction
1036 (widen)
1037 (condition-case nil
1038 (save-excursion
1039 (save-match-data
1040 (font-lock-fontify-region (point-min) (point-max) verbose)
1041 (font-lock-after-fontify-buffer)
1042 (setq font-lock-fontified t)))
1043 ;; We don't restore the old fontification, so it's best to unfontify.
8259bf10 1044 (quit (font-lock-unfontify-buffer)))))))
7d7d915a 1045
a2b8e66b 1046(defun font-lock-default-unfontify-buffer ()
56fcbd7e 1047 ;; Make sure we unfontify etc. in the whole buffer.
a2b8e66b
SM
1048 (save-restriction
1049 (widen)
1050 (font-lock-unfontify-region (point-min) (point-max))
271c888a 1051 (font-lock-after-unfontify-buffer)
a2b8e66b 1052 (setq font-lock-fontified nil)))
9bfbb130 1053
7f0d55f2
SM
1054(defvar font-lock-dont-widen nil
1055 "If non-nil, font-lock will work on the non-widened buffer.
1056Useful for things like RMAIL and Info where the whole buffer is not
1057a very meaningful entity to highlight.")
1058
05a1066f
SM
1059
1060(defvar font-lock-beg) (defvar font-lock-end)
1061(defvar font-lock-extend-region-functions
1062 '(font-lock-extend-region-wholelines
1402611c
SM
1063 ;; This use of font-lock-multiline property is unreliable but is just
1064 ;; a handy heuristic: in case you don't have a function that does
1065 ;; /identification/ of multiline elements, you may still occasionally
1066 ;; discover them by accident (or you may /identify/ them but not in all
1067 ;; cases), in which case the font-lock-multiline property can help make
1068 ;; sure you will properly *re*identify them during refontification.
05a1066f
SM
1069 font-lock-extend-region-multiline)
1070 "Special hook run just before proceeding to fontify a region.
1071This is used to allow major modes to help font-lock find safe buffer positions
1072as beginning and end of the fontified region. Its most common use is to solve
1073the problem of /identification/ of multiline elements by providing a function
1074that tries to find such elements and move the boundaries such that they do
1075not fall in the middle of one.
1076Each function is called with no argument; it is expected to adjust the
1077dynamically bound variables `font-lock-beg' and `font-lock-end'; and return
4837b516 1078non-nil if it did make such an adjustment.
05a1066f
SM
1079These functions are run in turn repeatedly until they all return nil.
1080Put first the functions more likely to cause a change and cheaper to compute.")
1081;; Mark it as a special hook which doesn't use any global setting
1082;; (i.e. doesn't obey the element t in the buffer-local value).
1083(make-variable-buffer-local 'font-lock-extend-region-functions)
1084
1085(defun font-lock-extend-region-multiline ()
1086 "Move fontification boundaries away from any `font-lock-multiline' property."
1087 (let ((changed nil))
1088 (when (and (> font-lock-beg (point-min))
1089 (get-text-property (1- font-lock-beg) 'font-lock-multiline))
1090 (setq changed t)
1091 (setq font-lock-beg (or (previous-single-property-change
1092 font-lock-beg 'font-lock-multiline)
1093 (point-min))))
ead4759c 1094 ;;
05a1066f
SM
1095 (when (get-text-property font-lock-end 'font-lock-multiline)
1096 (setq changed t)
1097 (setq font-lock-end (or (text-property-any font-lock-end (point-max)
1098 'font-lock-multiline nil)
1099 (point-max))))
1100 changed))
ead4759c 1101
05a1066f
SM
1102(defun font-lock-extend-region-wholelines ()
1103 "Move fontification boundaries to beginning of lines."
1104 (let ((changed nil))
1105 (goto-char font-lock-beg)
dfee9538 1106 (unless (bolp)
ead4759c 1107 (setq changed t font-lock-beg (line-beginning-position)))
05a1066f 1108 (goto-char font-lock-end)
a3609743
SM
1109 (unless (bolp)
1110 (unless (eq font-lock-end
1111 (setq font-lock-end (line-beginning-position 2)))
1112 (setq changed t)))
05a1066f
SM
1113 changed))
1114
a2b8e66b 1115(defun font-lock-default-fontify-region (beg end loudly)
ac6e572c 1116 (save-buffer-state
d36b74ca
SM
1117 ;; Use the fontification syntax table, if any.
1118 (with-syntax-table (or font-lock-syntax-table (syntax-table))
1119 (save-restriction
1120 (unless font-lock-dont-widen (widen))
1121 ;; Extend the region to fontify so that it starts and ends at
1122 ;; safe places.
1123 (let ((funs font-lock-extend-region-functions)
1124 (font-lock-beg beg)
1125 (font-lock-end end))
1126 (while funs
1127 (setq funs (if (or (not (funcall (car funs)))
1128 (eq funs font-lock-extend-region-functions))
1129 (cdr funs)
1130 ;; If there's been a change, we should go through
1131 ;; the list again since this new position may
1132 ;; warrant a different answer from one of the fun
1133 ;; we've already seen.
1134 font-lock-extend-region-functions)))
1135 (setq beg font-lock-beg end font-lock-end))
1136 ;; Now do the fontification.
1137 (font-lock-unfontify-region beg end)
cf38dd42
SM
1138 (when (and font-lock-syntactic-keywords
1139 (null syntax-propertize-function))
1140 ;; Ensure the beginning of the file is properly syntactic-fontified.
1141 (let ((start beg))
1142 (when (< font-lock-syntactically-fontified start)
1143 (setq start (max font-lock-syntactically-fontified (point-min)))
1144 (setq font-lock-syntactically-fontified end))
1145 (font-lock-fontify-syntactic-keywords-region start end)))
d36b74ca
SM
1146 (unless font-lock-keywords-only
1147 (font-lock-fontify-syntactically-region beg end loudly))
1148 (font-lock-fontify-keywords-region beg end loudly)))))
9bfbb130
SM
1149
1150;; The following must be rethought, since keywords can override fontification.
5d4247d3
SM
1151;; ;; Now scan for keywords, but not if we are inside a comment now.
1152;; (or (and (not font-lock-keywords-only)
1153;; (let ((state (parse-partial-sexp beg end nil nil
1154;; font-lock-cache-state)))
1155;; (or (nth 4 state) (nth 7 state))))
1156;; (font-lock-fontify-keywords-region beg end))
9bfbb130 1157
8259bf10
SM
1158(defvar font-lock-extra-managed-props nil
1159 "Additional text properties managed by font-lock.
1160This is used by `font-lock-default-unfontify-region' to decide
4c02ca46 1161what properties to clear before refontifying a region.")
8259bf10 1162
a2b8e66b 1163(defun font-lock-default-unfontify-region (beg end)
516eb29c
SM
1164 (remove-list-of-text-properties
1165 beg end (append
1166 font-lock-extra-managed-props
1167 (if font-lock-syntactic-keywords
1168 '(syntax-table face font-lock-multiline)
1169 '(face font-lock-multiline)))))
9bfbb130
SM
1170
1171;; Called when any modification is made to buffer text.
1172(defun font-lock-after-change-function (beg end old-len)
ab0dd59c
SM
1173 (save-excursion
1174 (let ((inhibit-point-motion-hooks t)
1175 (inhibit-quit t)
1176 (region (if font-lock-extend-after-change-region-function
1177 (funcall font-lock-extend-after-change-region-function
1178 beg end old-len))))
46f26fcf 1179 (save-match-data
ef008321
AM
1180 (if region
1181 ;; Fontify the region the major mode has specified.
1182 (setq beg (car region) end (cdr region))
1183 ;; Fontify the whole lines which enclose the region.
ab0dd59c
SM
1184 ;; Actually, this is not needed because
1185 ;; font-lock-default-fontify-region already rounds up to a whole
1186 ;; number of lines.
1187 ;; (setq beg (progn (goto-char beg) (line-beginning-position))
1188 ;; end (progn (goto-char end) (line-beginning-position 2)))
efa0c0ef
SM
1189 (unless (eq end (point-max))
1190 ;; Rounding up to a whole number of lines should include the
1191 ;; line right after `end'. Typical case: the first char of
1192 ;; the line was deleted. Or a \n was inserted in the middle
1193 ;; of a line.
1194 (setq end (1+ end))))
ef008321 1195 (font-lock-fontify-region beg end)))))
a2b8e66b 1196
4cffd221
SM
1197(defvar jit-lock-start) (defvar jit-lock-end)
1198(defun font-lock-extend-jit-lock-region-after-change (beg end old-len)
65c986aa
SM
1199 "Function meant for `jit-lock-after-change-extend-region-functions'.
1200This function does 2 things:
1201- extend the region so that it not only includes the part that was modified
1202 but also the surrounding text whose highlighting may change as a consequence.
1203- anticipate (part of) the region extension that will happen later in
1204 `font-lock-default-fontify-region', in order to avoid the need for
1205 double-redisplay in `jit-lock-fontify-now'."
ab0dd59c
SM
1206 (save-excursion
1207 ;; First extend the region as font-lock-after-change-function would.
1208 (let ((region (if font-lock-extend-after-change-region-function
1209 (funcall font-lock-extend-after-change-region-function
1210 beg end old-len))))
1211 (if region
1212 (setq beg (min jit-lock-start (car region))
1213 end (max jit-lock-end (cdr region))))
1214 ;; Then extend the region obeying font-lock-multiline properties,
1215 ;; indicating which part of the buffer needs to be refontified.
1402611c
SM
1216 ;; !!! This is the *main* user of font-lock-multiline property !!!
1217 ;; font-lock-after-change-function could/should also do that, but it
1218 ;; doesn't need to because font-lock-default-fontify-region does
1219 ;; it anyway. Here OTOH we have no guarantee that
1220 ;; font-lock-default-fontify-region will be executed on this region
1221 ;; any time soon.
10412e63
SM
1222 ;; Note: contrary to font-lock-default-fontify-region, we do not do
1223 ;; any loop here because we are not looking for a safe spot: we just
1224 ;; mark the text whose appearance may need to change as a result of
1225 ;; the buffer modification.
ab0dd59c
SM
1226 (when (and (> beg (point-min))
1227 (get-text-property (1- beg) 'font-lock-multiline))
1228 (setq beg (or (previous-single-property-change
1229 beg 'font-lock-multiline)
1230 (point-min))))
efa0c0ef
SM
1231 (when (< end (point-max))
1232 (setq end
1233 (if (get-text-property end 'font-lock-multiline)
1234 (or (text-property-any end (point-max)
1235 'font-lock-multiline nil)
1236 (point-max))
1237 ;; Rounding up to a whole number of lines should include the
1238 ;; line right after `end'. Typical case: the first char of
1239 ;; the line was deleted. Or a \n was inserted in the middle
1240 ;; of a line.
1241 (1+ end))))
ab0dd59c 1242 ;; Finally, pre-enlarge the region to a whole number of lines, to try
65c986aa 1243 ;; and anticipate what font-lock-default-fontify-region will do, so as to
ab0dd59c 1244 ;; avoid double-redisplay.
65c986aa
SM
1245 ;; We could just run `font-lock-extend-region-functions', but since
1246 ;; the only purpose is to avoid the double-redisplay, we prefer to
1247 ;; do here only the part that is cheap and most likely to be useful.
05a1066f
SM
1248 (when (memq 'font-lock-extend-region-wholelines
1249 font-lock-extend-region-functions)
1250 (goto-char beg)
efa0c0ef 1251 (setq jit-lock-start (min jit-lock-start (line-beginning-position)))
05a1066f 1252 (goto-char end)
efa0c0ef
SM
1253 (setq jit-lock-end
1254 (max jit-lock-end
1255 (if (bolp) (point) (line-beginning-position 2))))))))
4cffd221 1256
a078558d
SM
1257(defun font-lock-fontify-block (&optional arg)
1258 "Fontify some lines the way `font-lock-fontify-buffer' would.
1259The lines could be a function or paragraph, or a specified number of lines.
a078558d 1260If ARG is given, fontify that many lines before and after point, or 16 lines if
a465832f
SM
1261no ARG is given and `font-lock-mark-block-function' is nil.
1262If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1263delimit the region to fontify."
a078558d 1264 (interactive "P")
46f26fcf
SM
1265 (let ((inhibit-point-motion-hooks t) font-lock-beginning-of-syntax-function
1266 deactivate-mark)
a078558d
SM
1267 ;; Make sure we have the right `font-lock-keywords' etc.
1268 (if (not font-lock-mode) (font-lock-set-defaults))
a2b8e66b
SM
1269 (save-excursion
1270 (save-match-data
1271 (condition-case error-data
a078558d
SM
1272 (if (or arg (not font-lock-mark-block-function))
1273 (let ((lines (if arg (prefix-numeric-value arg) 16)))
1274 (font-lock-fontify-region
1275 (save-excursion (forward-line (- lines)) (point))
1276 (save-excursion (forward-line lines) (point))))
1277 (funcall font-lock-mark-block-function)
1278 (font-lock-fontify-region (point) (mark)))
6c0fc428 1279 ((error quit) (message "Fontifying block...%s" error-data)))))))
a078558d 1280
2d63aa67 1281;;; End of Fontification functions.
9bfbb130 1282\f
9bfbb130
SM
1283;;; Additional text property functions.
1284
1c626aaf
SM
1285;; The following text property functions should be builtins. This means they
1286;; should be written in C and put with all the other text property functions.
1287;; In the meantime, those that are used by font-lock.el are defined in Lisp
1288;; below and given a `font-lock-' prefix. Those that are not used are defined
1289;; in Lisp below and commented out. sm.
9bfbb130 1290
1c626aaf 1291(defun font-lock-prepend-text-property (start end prop value &optional object)
9bfbb130
SM
1292 "Prepend to one property of the text from START to END.
1293Arguments PROP and VALUE specify the property and value to prepend to the value
1c626aaf 1294already in place. The resulting property values are always lists.
9bfbb130
SM
1295Optional argument OBJECT is the string or buffer containing the text."
1296 (let ((val (if (listp value) value (list value))) next prev)
1297 (while (/= start end)
1298 (setq next (next-single-property-change start prop object end)
1299 prev (get-text-property start prop object))
4fed1740
RS
1300 ;; Canonicalize old forms of face property.
1301 (and (memq prop '(face font-lock-face))
1302 (listp prev)
1303 (or (keywordp (car prev))
1304 (memq (car prev) '(foreground-color background-color)))
1305 (setq prev (list prev)))
1c626aaf
SM
1306 (put-text-property start next prop
1307 (append val (if (listp prev) prev (list prev)))
1308 object)
9bfbb130
SM
1309 (setq start next))))
1310
1c626aaf 1311(defun font-lock-append-text-property (start end prop value &optional object)
9bfbb130
SM
1312 "Append to one property of the text from START to END.
1313Arguments PROP and VALUE specify the property and value to append to the value
1c626aaf 1314already in place. The resulting property values are always lists.
9bfbb130
SM
1315Optional argument OBJECT is the string or buffer containing the text."
1316 (let ((val (if (listp value) value (list value))) next prev)
1317 (while (/= start end)
1318 (setq next (next-single-property-change start prop object end)
1319 prev (get-text-property start prop object))
4fed1740
RS
1320 ;; Canonicalize old forms of face property.
1321 (and (memq prop '(face font-lock-face))
1322 (listp prev)
1323 (or (keywordp (car prev))
1324 (memq (car prev) '(foreground-color background-color)))
1325 (setq prev (list prev)))
1c626aaf
SM
1326 (put-text-property start next prop
1327 (append (if (listp prev) prev (list prev)) val)
1328 object)
9bfbb130 1329 (setq start next))))
1c626aaf
SM
1330
1331(defun font-lock-fillin-text-property (start end prop value &optional object)
1332 "Fill in one property of the text from START to END.
1333Arguments PROP and VALUE specify the property and value to put where none are
1334already in place. Therefore existing property values are not overwritten.
1335Optional argument OBJECT is the string or buffer containing the text."
1336 (let ((start (text-property-any start end prop nil object)) next)
1337 (while start
1338 (setq next (next-single-property-change start prop object end))
1339 (put-text-property start next prop value object)
1340 (setq start (text-property-any next end prop nil object)))))
1341
1342;; For completeness: this is to `remove-text-properties' as `put-text-property'
1343;; is to `add-text-properties', etc.
d55c4199
SM
1344;;(defun remove-text-property (start end property &optional object)
1345;; "Remove a property from text from START to END.
1346;;Argument PROPERTY is the property to remove.
1347;;Optional argument OBJECT is the string or buffer containing the text.
1348;;Return t if the property was actually removed, nil otherwise."
1349;; (remove-text-properties start end (list property) object))
1c626aaf
SM
1350
1351;; For consistency: maybe this should be called `remove-single-property' like
1352;; `next-single-property-change' (not `next-single-text-property-change'), etc.
d55c4199
SM
1353;;(defun remove-single-text-property (start end prop value &optional object)
1354;; "Remove a specific property value from text from START to END.
1355;;Arguments PROP and VALUE specify the property and value to remove. The
1356;;resulting property values are not equal to VALUE nor lists containing VALUE.
1357;;Optional argument OBJECT is the string or buffer containing the text."
1358;; (let ((start (text-property-not-all start end prop nil object)) next prev)
1359;; (while start
1360;; (setq next (next-single-property-change start prop object end)
1361;; prev (get-text-property start prop object))
1362;; (cond ((and (symbolp prev) (eq value prev))
1363;; (remove-text-property start next prop object))
1364;; ((and (listp prev) (memq value prev))
1365;; (let ((new (delq value prev)))
1366;; (cond ((null new)
1367;; (remove-text-property start next prop object))
1368;; ((= (length new) 1)
1369;; (put-text-property start next prop (car new) object))
1370;; (t
1371;; (put-text-property start next prop new object))))))
1372;; (setq start (text-property-not-all next end prop nil object)))))
2d63aa67
SM
1373
1374;;; End of Additional text property functions.
9bfbb130 1375\f
ac6e572c
SM
1376;;; Syntactic regexp fontification functions.
1377
1378;; These syntactic keyword pass functions are identical to those keyword pass
1379;; functions below, with the following exceptions; (a) they operate on
1380;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1381;; is less of an issue, (c) eval of property value does not occur JIT as speed
1382;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1383;; makes no sense for `syntax-table' property values, (e) they do not do it
1384;; LOUDLY as it is not likely to be intensive.
1385
1386(defun font-lock-apply-syntactic-highlight (highlight)
1387 "Apply HIGHLIGHT following a match.
1388HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1389see `font-lock-syntactic-keywords'."
1390 (let* ((match (nth 0 highlight))
1391 (start (match-beginning match)) (end (match-end match))
1392 (value (nth 1 highlight))
1393 (override (nth 2 highlight)))
8259bf10
SM
1394 (if (not start)
1395 ;; No match but we might not signal an error.
1396 (or (nth 3 highlight)
1397 (error "No match %d in highlight %S" match highlight))
1398 (when (and (consp value) (not (numberp (car value))))
1399 (setq value (eval value)))
1400 (when (stringp value) (setq value (string-to-syntax value)))
1401 ;; Flush the syntax-cache. I believe this is not necessary for
1402 ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can
1403 ;; still be necessary for other users of syntax-ppss anyway.
1404 (syntax-ppss-after-change-function start)
1405 (cond
1406 ((not override)
1407 ;; Cannot override existing fontification.
1408 (or (text-property-not-all start end 'syntax-table nil)
1409 (put-text-property start end 'syntax-table value)))
1410 ((eq override t)
1411 ;; Override existing fontification.
1412 (put-text-property start end 'syntax-table value))
1413 ((eq override 'keep)
1414 ;; Keep existing fontification.
1415 (font-lock-fillin-text-property start end 'syntax-table value))))))
ac6e572c
SM
1416
1417(defun font-lock-fontify-syntactic-anchored-keywords (keywords limit)
1418 "Fontify according to KEYWORDS until LIMIT.
1419KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1420LIMIT can be modified by the value of its PRE-MATCH-FORM."
1421 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
1422 ;; Evaluate PRE-MATCH-FORM.
1423 (pre-match-value (eval (nth 1 keywords))))
1424 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1425 (if (and (numberp pre-match-value) (> pre-match-value (point)))
1426 (setq limit pre-match-value)
6e1d0d15 1427 (setq limit (line-end-position)))
ac6e572c
SM
1428 (save-match-data
1429 ;; Find an occurrence of `matcher' before `limit'.
1430 (while (if (stringp matcher)
1431 (re-search-forward matcher limit t)
1432 (funcall matcher limit))
1433 ;; Apply each highlight to this instance of `matcher'.
1434 (setq highlights lowdarks)
1435 (while highlights
1436 (font-lock-apply-syntactic-highlight (car highlights))
1437 (setq highlights (cdr highlights)))))
1438 ;; Evaluate POST-MATCH-FORM.
1439 (eval (nth 2 keywords))))
1440
1441(defun font-lock-fontify-syntactic-keywords-region (start end)
1442 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1443START should be at the beginning of a line."
b073dc4b
SM
1444 (unless parse-sexp-lookup-properties
1445 ;; We wouldn't go through so much trouble if we didn't intend to use those
1446 ;; properties, would we?
1447 (set (make-local-variable 'parse-sexp-lookup-properties) t))
ac6e572c
SM
1448 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1449 (when (symbolp font-lock-syntactic-keywords)
1450 (setq font-lock-syntactic-keywords (font-lock-eval-keywords
1451 font-lock-syntactic-keywords)))
1452 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1453 (unless (eq (car font-lock-syntactic-keywords) t)
1454 (setq font-lock-syntactic-keywords (font-lock-compile-keywords
533047c2
RS
1455 font-lock-syntactic-keywords
1456 t)))
ac6e572c
SM
1457 ;; Get down to business.
1458 (let ((case-fold-search font-lock-keywords-case-fold-search)
0715d1a4 1459 (keywords (cddr font-lock-syntactic-keywords))
ac6e572c
SM
1460 keyword matcher highlights)
1461 (while keywords
1462 ;; Find an occurrence of `matcher' from `start' to `end'.
1463 (setq keyword (car keywords) matcher (car keyword))
1464 (goto-char start)
434f8c11
SM
1465 (while (and (< (point) end)
1466 (if (stringp matcher)
1467 (re-search-forward matcher end t)
1468 (funcall matcher end)))
ac6e572c
SM
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
7435a76b
RS
1484(defvar font-lock-comment-start-skip nil
1485 "If non-nil, Font Lock mode uses this instead of `comment-start-skip'.")
1486
1487(defvar font-lock-comment-end-skip nil
1488 "If non-nil, Font Lock mode uses this instead of `comment-end'.")
1489
b073dc4b 1490(defun font-lock-fontify-syntactically-region (start end &optional loudly)
ac6e572c
SM
1491 "Put proper face on each string and comment between START and END.
1492START should be at the beginning of a line."
cf38dd42 1493 (syntax-propertize end) ; Apply any needed syntax-table properties.
90cbc9cd 1494 (let ((comment-end-regexp
7435a76b
RS
1495 (or font-lock-comment-end-skip
1496 (regexp-quote
1497 (replace-regexp-in-string "^ *" "" comment-end))))
b073dc4b
SM
1498 ;; Find the `start' state.
1499 (state (syntax-ppss start))
1500 face beg)
ac6e572c 1501 (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
ac6e572c
SM
1502 ;;
1503 ;; Find each interesting place between here and `end'.
8259bf10
SM
1504 (while
1505 (progn
1506 (when (or (nth 3 state) (nth 4 state))
1507 (setq face (funcall font-lock-syntactic-face-function state))
1508 (setq beg (max (nth 8 state) start))
1509 (setq state (parse-partial-sexp (point) end nil nil state
1510 'syntax-table))
a4479657 1511 (when face (put-text-property beg (point) 'face face))
90cbc9cd 1512 (when (and (eq face 'font-lock-comment-face)
7435a76b
RS
1513 (or font-lock-comment-start-skip
1514 comment-start-skip))
a4479657
RS
1515 ;; Find the comment delimiters
1516 ;; and use font-lock-comment-delimiter-face for them.
1517 (save-excursion
1518 (goto-char beg)
7435a76b
RS
1519 (if (looking-at (or font-lock-comment-start-skip
1520 comment-start-skip))
a4479657 1521 (put-text-property beg (match-end 0) 'face
90cbc9cd 1522 font-lock-comment-delimiter-face)))
a1594703 1523 (if (looking-back comment-end-regexp (point-at-bol) t)
a4479657 1524 (put-text-property (match-beginning 0) (point) 'face
90cbc9cd 1525 font-lock-comment-delimiter-face))))
6ce66ffe
SM
1526 (< (point) end))
1527 (setq state (parse-partial-sexp (point) end nil nil state
1528 'syntax-table)))))
ac6e572c
SM
1529
1530;;; End of Syntactic fontification functions.
1531\f
1532;;; Keyword regexp fontification functions.
9bfbb130
SM
1533
1534(defsubst font-lock-apply-highlight (highlight)
1535 "Apply HIGHLIGHT following a match.
1536HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1537 (let* ((match (nth 0 highlight))
1538 (start (match-beginning match)) (end (match-end match))
1539 (override (nth 2 highlight)))
8259bf10
SM
1540 (if (not start)
1541 ;; No match but we might not signal an error.
1542 (or (nth 3 highlight)
1543 (error "No match %d in highlight %S" match highlight))
1544 (let ((val (eval (nth 1 highlight))))
1545 (when (eq (car-safe val) 'face)
1546 (add-text-properties start end (cddr val))
1547 (setq val (cadr val)))
1548 (cond
a5f48305 1549 ((not (or val (eq override t)))
6b7f3491
SM
1550 ;; If `val' is nil, don't do anything. It is important to do it
1551 ;; explicitly, because when adding nil via things like
1552 ;; font-lock-append-text-property, the property is actually
1553 ;; changed from <face> to (<face>) which is undesirable. --Stef
1554 nil)
8259bf10
SM
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 val)))
1559 ((eq override t)
1560 ;; Override existing fontification.
1561 (put-text-property start end 'face val))
1562 ((eq override 'prepend)
1563 ;; Prepend to existing fontification.
1564 (font-lock-prepend-text-property start end 'face val))
1565 ((eq override 'append)
1566 ;; Append to existing fontification.
1567 (font-lock-append-text-property start end 'face val))
1568 ((eq override 'keep)
1569 ;; Keep existing fontification.
1570 (font-lock-fillin-text-property start end 'face val)))))))
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)
ba22aeff 1584 (when (and font-lock-multiline (>= limit (line-beginning-position 2)))
fb0e4f8a 1585 ;; this is a multiline anchored match
ba22aeff
SM
1586 ;; (setq font-lock-multiline t)
1587 (put-text-property (if (= limit (line-beginning-position 2))
1588 (1- limit)
1589 (min lead-start (point)))
1590 limit
28a53bc1 1591 'font-lock-multiline t)))
9bfbb130 1592 (save-match-data
876f2438 1593 ;; Find an occurrence of `matcher' before `limit'.
afa18a4e
SM
1594 (while (and (< (point) limit)
1595 (if (stringp matcher)
1596 (re-search-forward matcher limit t)
1597 (funcall matcher limit)))
876f2438 1598 ;; Apply each highlight to this instance of `matcher'.
9bfbb130
SM
1599 (setq highlights lowdarks)
1600 (while highlights
1601 (font-lock-apply-highlight (car highlights))
1602 (setq highlights (cdr highlights)))))
876f2438 1603 ;; Evaluate POST-MATCH-FORM.
9bfbb130
SM
1604 (eval (nth 2 keywords))))
1605
1606(defun font-lock-fontify-keywords-region (start end &optional loudly)
1607 "Fontify according to `font-lock-keywords' between START and END.
7f0d55f2
SM
1608START should be at the beginning of a line.
1609LOUDLY, if non-nil, allows progress-meter bar."
ac6e572c 1610 (unless (eq (car font-lock-keywords) t)
2d5eba0e 1611 (setq font-lock-keywords
533047c2 1612 (font-lock-compile-keywords font-lock-keywords)))
9bfbb130 1613 (let ((case-fold-search font-lock-keywords-case-fold-search)
69968400 1614 (keywords (cddr font-lock-keywords))
9bfbb130 1615 (bufname (buffer-name)) (count 0)
b71813cb 1616 (pos (make-marker))
876f2438
SM
1617 keyword matcher highlights)
1618 ;;
1619 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1620 (while keywords
1621 (if loudly (message "Fontifying %s... (regexps..%s)" bufname
2e6a15fc 1622 (make-string (incf count) ?.)))
9bfbb130 1623 ;;
876f2438
SM
1624 ;; Find an occurrence of `matcher' from `start' to `end'.
1625 (setq keyword (car keywords) matcher (car keyword))
1626 (goto-char start)
e7f07c2c
GM
1627 (while (and (< (point) end)
1628 (if (stringp matcher)
1629 (re-search-forward matcher end t)
8a08764f
SM
1630 (funcall matcher end))
1631 ;; Beware empty string matches since they will
1632 ;; loop indefinitely.
1633 (or (> (point) (match-beginning 0))
1634 (progn (forward-char 1) t)))
041470d2 1635 (when (and font-lock-multiline
ba22aeff
SM
1636 (>= (point)
1637 (save-excursion (goto-char (match-beginning 0))
1638 (forward-line 1) (point))))
fb0e4f8a 1639 ;; this is a multiline regexp match
ba22aeff
SM
1640 ;; (setq font-lock-multiline t)
1641 (put-text-property (if (= (point)
1642 (save-excursion
1643 (goto-char (match-beginning 0))
1644 (forward-line 1) (point)))
1645 (1- (point))
1646 (match-beginning 0))
1647 (point)
fb0e4f8a 1648 'font-lock-multiline t))
876f2438
SM
1649 ;; Apply each highlight to this instance of `matcher', which may be
1650 ;; specific highlights or more keywords anchored to `matcher'.
1651 (setq highlights (cdr keyword))
1652 (while highlights
1653 (if (numberp (car (car highlights)))
1654 (font-lock-apply-highlight (car highlights))
b71813cb
SM
1655 (set-marker pos (point))
1656 (font-lock-fontify-anchored-keywords (car highlights) end)
1657 ;; Ensure forward progress. `pos' is a marker because anchored
1658 ;; keyword may add/delete text (this happens e.g. in grep.el).
1659 (if (< (point) pos) (goto-char pos)))
876f2438 1660 (setq highlights (cdr highlights))))
b71813cb
SM
1661 (setq keywords (cdr keywords)))
1662 (set-marker pos nil)))
2d63aa67 1663
ac6e572c 1664;;; End of Keyword regexp fontification functions.
9bfbb130
SM
1665\f
1666;; Various functions.
1667
533047c2 1668(defun font-lock-compile-keywords (keywords &optional syntactic-keywords)
69968400
RS
1669 "Compile KEYWORDS into the form (t KEYWORDS COMPILED...)
1670Here each COMPILED is of the form (MATCHER HIGHLIGHT ...) as shown in the
2d5eba0e 1671`font-lock-keywords' doc string.
533047c2
RS
1672If SYNTACTIC-KEYWORDS is non-nil, it means these keywords are used for
1673`font-lock-syntactic-keywords' rather than for `font-lock-keywords'."
af3d4246
SM
1674 (if (not font-lock-set-defaults)
1675 ;; This should never happen. But some external packages sometimes
1676 ;; call font-lock in unexpected and incorrect ways. It's important to
1677 ;; stop processing at this point, otherwise we may end up changing the
1678 ;; global value of font-lock-keywords and break highlighting in many
1679 ;; other buffers.
1680 (error "Font-lock trying to use keywords before setting them up"))
55015061
SM
1681 (if (eq (car-safe keywords) t)
1682 keywords
69968400
RS
1683 (setq keywords
1684 (cons t (cons keywords
1685 (mapcar 'font-lock-compile-keyword keywords))))
533047c2 1686 (if (and (not syntactic-keywords)
9595af7e
RS
1687 (let ((beg-function
1688 (or font-lock-beginning-of-syntax-function
1689 syntax-begin-function)))
1690 (or (eq beg-function 'beginning-of-defun)
1691 (get beg-function 'font-lock-syntax-paren-check)))
2d5eba0e
SM
1692 (not beginning-of-defun-function))
1693 ;; Try to detect when a string or comment contains something that
1694 ;; looks like a defun and would thus confuse font-lock.
1695 (nconc keywords
1696 `((,(if defun-prompt-regexp
1697 (concat "^\\(?:" defun-prompt-regexp "\\)?\\s(")
1698 "^\\s(")
1699 (0
048aac39 1700 (if (memq (get-text-property (match-beginning 0) 'face)
2d5eba0e
SM
1701 '(font-lock-string-face font-lock-doc-face
1702 font-lock-comment-face))
d55c4199
SM
1703 (list 'face font-lock-warning-face
1704 'help-echo "Looks like a toplevel defun: escape the parenthesis"))
2d5eba0e
SM
1705 prepend)))))
1706 keywords))
a2b8e66b
SM
1707
1708(defun font-lock-compile-keyword (keyword)
c1f2ffc8 1709 (cond ((nlistp keyword) ; MATCHER
a2b8e66b 1710 (list keyword '(0 font-lock-keyword-face)))
c1f2ffc8 1711 ((eq (car keyword) 'eval) ; (eval . FORM)
a2b8e66b 1712 (font-lock-compile-keyword (eval (cdr keyword))))
c1f2ffc8
SM
1713 ((eq (car-safe (cdr keyword)) 'quote) ; (MATCHER . 'FORM)
1714 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1715 (if (symbolp (nth 2 keyword))
1716 (list (car keyword) (list 0 (cdr keyword)))
1717 (font-lock-compile-keyword (cons (car keyword) (nth 2 keyword)))))
1718 ((numberp (cdr keyword)) ; (MATCHER . MATCH)
a2b8e66b 1719 (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
c1f2ffc8 1720 ((symbolp (cdr keyword)) ; (MATCHER . FACENAME)
a2b8e66b 1721 (list (car keyword) (list 0 (cdr keyword))))
c1f2ffc8 1722 ((nlistp (nth 1 keyword)) ; (MATCHER . HIGHLIGHT)
a2b8e66b 1723 (list (car keyword) (cdr keyword)))
c1f2ffc8 1724 (t ; (MATCHER HIGHLIGHT ...)
a2b8e66b 1725 keyword)))
d46c21ec 1726
ac6e572c 1727(defun font-lock-eval-keywords (keywords)
019f00d8 1728 "Evalulate KEYWORDS if a function (funcall) or variable (eval) name."
46f26fcf
SM
1729 (if (listp keywords)
1730 keywords
1731 (font-lock-eval-keywords (if (fboundp keywords)
1732 (funcall keywords)
1733 (eval keywords)))))
ac6e572c 1734
343204bd 1735(defun font-lock-value-in-major-mode (alist)
019f00d8
DL
1736 "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1737Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
343204bd
SM
1738 (if (consp alist)
1739 (cdr (or (assq major-mode alist) (assq t alist)))
1740 alist))
1741
d46c21ec 1742(defun font-lock-choose-keywords (keywords level)
019f00d8
DL
1743 "Return LEVELth element of KEYWORDS.
1744A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1745\(1- (length KEYWORDS))."
fd612dd9 1746 (cond ((not (and (listp keywords) (symbolp (car keywords))))
343204bd
SM
1747 keywords)
1748 ((numberp level)
e0be77f6 1749 (or (nth level keywords) (car (last keywords))))
343204bd 1750 ((eq level t)
e0be77f6 1751 (car (last keywords)))
343204bd
SM
1752 (t
1753 (car keywords))))
d46c21ec 1754
f8115798
SM
1755(defvar font-lock-set-defaults nil) ; Whether we have set up defaults.
1756
543f553a
TH
1757(defun font-lock-refresh-defaults ()
1758 "Restart fontification in current buffer after recomputing from defaults.
1759Recompute fontification variables using `font-lock-defaults' (or,
1760if nil, using `font-lock-defaults-alist') and
1761`font-lock-maximum-decoration'. Then restart fontification.
1762
1763Use this function when you have changed any of the above
1764variables directly.
1765
1766Note: This function will erase modifications done by
1767`font-lock-add-keywords' or `font-lock-remove-keywords', but will
1768preserve `hi-lock-mode' highlighting patterns."
1769 (let ((hi-lock--inhibit-font-lock-hook t))
1770 (font-lock-mode -1))
1771 (kill-local-variable 'font-lock-set-defaults)
1772 (font-lock-mode 1))
1773
36901266
SM
1774(defvar font-lock-major-mode nil
1775 "Major mode for which the font-lock settings have been setup.")
1776(make-variable-buffer-local 'font-lock-major-mode)
1777
f8115798
SM
1778(defun font-lock-set-defaults ()
1779 "Set fontification defaults appropriately for this mode.
1780Sets various variables using `font-lock-defaults' (or, if nil, using
1781`font-lock-defaults-alist') and `font-lock-maximum-decoration'."
4837b516 1782 ;; Set fontification defaults if not previously set for correct major mode.
bed88438 1783 (unless (and font-lock-set-defaults
36901266
SM
1784 (eq font-lock-major-mode major-mode))
1785 (setq font-lock-major-mode major-mode)
f8115798
SM
1786 (set (make-local-variable 'font-lock-set-defaults) t)
1787 (make-local-variable 'font-lock-fontified)
1788 (make-local-variable 'font-lock-multiline)
1789 (let* ((defaults (or font-lock-defaults
7ea820e9
RS
1790 (cdr (assq major-mode
1791 (with-no-warnings
d55c4199 1792 font-lock-defaults-alist)))))
f8115798
SM
1793 (keywords
1794 (font-lock-choose-keywords (nth 0 defaults)
1795 (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1796 (local (cdr (assq major-mode font-lock-keywords-alist)))
1797 (removed-keywords
1798 (cdr-safe (assq major-mode font-lock-removed-keywords-alist))))
1799 (set (make-local-variable 'font-lock-defaults) defaults)
1800 ;; Syntactic fontification?
558ca3c1
SM
1801 (if (nth 1 defaults)
1802 (set (make-local-variable 'font-lock-keywords-only) t)
1803 (kill-local-variable 'font-lock-keywords-only))
f8115798 1804 ;; Case fold during regexp fontification?
558ca3c1
SM
1805 (if (nth 2 defaults)
1806 (set (make-local-variable 'font-lock-keywords-case-fold-search) t)
1807 (kill-local-variable 'font-lock-keywords-case-fold-search))
f8115798 1808 ;; Syntax table for regexp and syntactic fontification?
558ca3c1
SM
1809 (if (null (nth 3 defaults))
1810 (kill-local-variable 'font-lock-syntax-table)
f8115798
SM
1811 (set (make-local-variable 'font-lock-syntax-table)
1812 (copy-syntax-table (syntax-table)))
1813 (dolist (selem (nth 3 defaults))
1814 ;; The character to modify may be a single CHAR or a STRING.
1815 (let ((syntax (cdr selem)))
1816 (dolist (char (if (numberp (car selem))
1817 (list (car selem))
1818 (mapcar 'identity (car selem))))
1819 (modify-syntax-entry char syntax font-lock-syntax-table)))))
1820 ;; Syntax function for syntactic fontification?
558ca3c1 1821 (if (nth 4 defaults)
f8115798 1822 (set (make-local-variable 'font-lock-beginning-of-syntax-function)
558ca3c1
SM
1823 (nth 4 defaults))
1824 (kill-local-variable 'font-lock-beginning-of-syntax-function))
f8115798
SM
1825 ;; Variable alist?
1826 (dolist (x (nthcdr 5 defaults))
1827 (set (make-local-variable (car x)) (cdr x)))
69968400 1828 ;; Set up `font-lock-keywords' last because its value might depend
f8115798
SM
1829 ;; on other settings (e.g. font-lock-compile-keywords uses
1830 ;; font-lock-beginning-of-syntax-function).
1831 (set (make-local-variable 'font-lock-keywords)
69968400 1832 (font-lock-eval-keywords keywords))
f8115798
SM
1833 ;; Local fontification?
1834 (while local
1835 (font-lock-add-keywords nil (car (car local)) (cdr (car local)))
1836 (setq local (cdr local)))
1837 (when removed-keywords
69968400
RS
1838 (font-lock-remove-keywords nil removed-keywords))
1839 ;; Now compile the keywords.
1840 (unless (eq (car font-lock-keywords) t)
e0be77f6 1841 (setq font-lock-keywords
533047c2 1842 (font-lock-compile-keywords font-lock-keywords))))))
030f4a35 1843\f
6772c8e1 1844;;; Color etc. support.
9bfbb130 1845
d60b49ac
DN
1846;; Note that `defface' will not overwrite any faces declared above via
1847;; `custom-declare-face'.
9177dd93
RS
1848(defface font-lock-comment-face
1849 '((((class grayscale) (background light))
1850 (:foreground "DimGray" :weight bold :slant italic))
1851 (((class grayscale) (background dark))
1852 (:foreground "LightGray" :weight bold :slant italic))
1853 (((class color) (min-colors 88) (background light))
1854 (:foreground "Firebrick"))
1855 (((class color) (min-colors 88) (background dark))
1856 (:foreground "chocolate1"))
1857 (((class color) (min-colors 16) (background light))
1858 (:foreground "red"))
1859 (((class color) (min-colors 16) (background dark))
1860 (:foreground "red1"))
1861 (((class color) (min-colors 8) (background light))
6eb61c70 1862 (:foreground "red"))
9177dd93
RS
1863 (((class color) (min-colors 8) (background dark))
1864 )
1865 (t (:weight bold :slant italic)))
55015061 1866 "Font Lock mode face used to highlight comments."
a4deefed 1867 :group 'font-lock-faces)
55015061 1868
bf2cea1d 1869(defface font-lock-comment-delimiter-face
3187cffc 1870 '((default :inherit font-lock-comment-face)
3989c3e7
SM
1871 (((class grayscale)))
1872 (((class color) (min-colors 16)))
3187cffc
SM
1873 (((class color) (min-colors 8) (background light))
1874 :foreground "red")
1875 (((class color) (min-colors 8) (background dark))
1876 :foreground "red1"))
bf2cea1d 1877 "Font Lock mode face used to highlight comment delimiters."
a4deefed 1878 :group 'font-lock-faces)
9177dd93 1879
55015061 1880(defface font-lock-string-face
6b61353c 1881 '((((class grayscale) (background light)) (:foreground "DimGray" :slant italic))
0cccb49d 1882 (((class grayscale) (background dark)) (:foreground "LightGray" :slant italic))
e094097c 1883 (((class color) (min-colors 88) (background light)) (:foreground "VioletRed4"))
6b61353c
KH
1884 (((class color) (min-colors 88) (background dark)) (:foreground "LightSalmon"))
1885 (((class color) (min-colors 16) (background light)) (:foreground "RosyBrown"))
1886 (((class color) (min-colors 16) (background dark)) (:foreground "LightSalmon"))
1887 (((class color) (min-colors 8)) (:foreground "green"))
0cccb49d 1888 (t (:slant italic)))
55015061 1889 "Font Lock mode face used to highlight strings."
a4deefed 1890 :group 'font-lock-faces)
55015061 1891
1c172af4
SM
1892(defface font-lock-doc-face
1893 '((t :inherit font-lock-string-face))
1894 "Font Lock mode face used to highlight documentation."
a4deefed 1895 :group 'font-lock-faces)
1c172af4 1896
55015061 1897(defface font-lock-keyword-face
6b61353c 1898 '((((class grayscale) (background light)) (:foreground "LightGray" :weight bold))
0cccb49d 1899 (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold))
6b61353c 1900 (((class color) (min-colors 88) (background light)) (:foreground "Purple"))
ea81d57e 1901 (((class color) (min-colors 88) (background dark)) (:foreground "Cyan1"))
6b61353c
KH
1902 (((class color) (min-colors 16) (background light)) (:foreground "Purple"))
1903 (((class color) (min-colors 16) (background dark)) (:foreground "Cyan"))
1904 (((class color) (min-colors 8)) (:foreground "cyan" :weight bold))
0cccb49d 1905 (t (:weight bold)))
55015061 1906 "Font Lock mode face used to highlight keywords."
a4deefed 1907 :group 'font-lock-faces)
55015061
SM
1908
1909(defface font-lock-builtin-face
6b61353c 1910 '((((class grayscale) (background light)) (:foreground "LightGray" :weight bold))
0cccb49d 1911 (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold))
e094097c 1912 (((class color) (min-colors 88) (background light)) (:foreground "MediumOrchid4"))
6b61353c
KH
1913 (((class color) (min-colors 88) (background dark)) (:foreground "LightSteelBlue"))
1914 (((class color) (min-colors 16) (background light)) (:foreground "Orchid"))
1915 (((class color) (min-colors 16) (background dark)) (:foreground "LightSteelBlue"))
1916 (((class color) (min-colors 8)) (:foreground "blue" :weight bold))
0cccb49d 1917 (t (:weight bold)))
55015061 1918 "Font Lock mode face used to highlight builtins."
a4deefed 1919 :group 'font-lock-faces)
55015061
SM
1920
1921(defface font-lock-function-name-face
ea81d57e 1922 '((((class color) (min-colors 88) (background light)) (:foreground "Blue1"))
6b61353c
KH
1923 (((class color) (min-colors 88) (background dark)) (:foreground "LightSkyBlue"))
1924 (((class color) (min-colors 16) (background light)) (:foreground "Blue"))
1925 (((class color) (min-colors 16) (background dark)) (:foreground "LightSkyBlue"))
1926 (((class color) (min-colors 8)) (:foreground "blue" :weight bold))
0cccb49d 1927 (t (:inverse-video t :weight bold)))
55015061 1928 "Font Lock mode face used to highlight function names."
a4deefed 1929 :group 'font-lock-faces)
55015061
SM
1930
1931(defface font-lock-variable-name-face
6b61353c 1932 '((((class grayscale) (background light))
0cccb49d 1933 (:foreground "Gray90" :weight bold :slant italic))
55015061 1934 (((class grayscale) (background dark))
0cccb49d 1935 (:foreground "DimGray" :weight bold :slant italic))
e094097c 1936 (((class color) (min-colors 88) (background light)) (:foreground "sienna"))
6b61353c
KH
1937 (((class color) (min-colors 88) (background dark)) (:foreground "LightGoldenrod"))
1938 (((class color) (min-colors 16) (background light)) (:foreground "DarkGoldenrod"))
1939 (((class color) (min-colors 16) (background dark)) (:foreground "LightGoldenrod"))
1940 (((class color) (min-colors 8)) (:foreground "yellow" :weight light))
0cccb49d 1941 (t (:weight bold :slant italic)))
55015061 1942 "Font Lock mode face used to highlight variable names."
a4deefed 1943 :group 'font-lock-faces)
55015061
SM
1944
1945(defface font-lock-type-face
6b61353c 1946 '((((class grayscale) (background light)) (:foreground "Gray90" :weight bold))
0cccb49d 1947 (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold))
6b61353c
KH
1948 (((class color) (min-colors 88) (background light)) (:foreground "ForestGreen"))
1949 (((class color) (min-colors 88) (background dark)) (:foreground "PaleGreen"))
1950 (((class color) (min-colors 16) (background light)) (:foreground "ForestGreen"))
1951 (((class color) (min-colors 16) (background dark)) (:foreground "PaleGreen"))
1952 (((class color) (min-colors 8)) (:foreground "green"))
0cccb49d 1953 (t (:weight bold :underline t)))
8acf2292 1954 "Font Lock mode face used to highlight type and classes."
a4deefed 1955 :group 'font-lock-faces)
55015061 1956
8acf2292 1957(defface font-lock-constant-face
6b61353c 1958 '((((class grayscale) (background light))
0cccb49d 1959 (:foreground "LightGray" :weight bold :underline t))
55015061 1960 (((class grayscale) (background dark))
0cccb49d 1961 (:foreground "Gray50" :weight bold :underline t))
e094097c 1962 (((class color) (min-colors 88) (background light)) (:foreground "dark cyan"))
6b61353c
KH
1963 (((class color) (min-colors 88) (background dark)) (:foreground "Aquamarine"))
1964 (((class color) (min-colors 16) (background light)) (:foreground "CadetBlue"))
1965 (((class color) (min-colors 16) (background dark)) (:foreground "Aquamarine"))
1966 (((class color) (min-colors 8)) (:foreground "magenta"))
0cccb49d 1967 (t (:weight bold :underline t)))
8acf2292 1968 "Font Lock mode face used to highlight constants and labels."
a4deefed 1969 :group 'font-lock-faces)
55015061
SM
1970
1971(defface font-lock-warning-face
ea81d57e 1972 '((((class color) (min-colors 88) (background light)) (:foreground "Red1" :weight bold))
6b61353c 1973 (((class color) (min-colors 88) (background dark)) (:foreground "Pink" :weight bold))
11ec76b7 1974 (((class color) (min-colors 16) (background light)) (:foreground "Red1" :weight bold))
c9341aa0
JB
1975 (((class color) (min-colors 16) (background dark)) (:foreground "Pink" :weight bold))
1976 (((class color) (min-colors 8)) (:foreground "red"))
0cccb49d 1977 (t (:inverse-video t :weight bold)))
55015061 1978 "Font Lock mode face used to highlight warnings."
a4deefed 1979 :group 'font-lock-faces)
2d63aa67 1980
5d27cf9f 1981(defface font-lock-negation-char-face
39eae073 1982 '((t nil))
5d27cf9f 1983 "Font Lock mode face used to highlight easy to overlook negation."
a4deefed 1984 :group 'font-lock-faces)
5d27cf9f 1985
d654cab8 1986(defface font-lock-preprocessor-face
c9341aa0 1987 '((t :inherit font-lock-builtin-face))
d654cab8 1988 "Font Lock mode face used to highlight preprocessor directives."
a4deefed 1989 :group 'font-lock-faces)
d654cab8 1990
9ad5e4d4 1991(defface font-lock-regexp-grouping-backslash
d8d5c28c 1992 '((t :inherit bold))
9ad5e4d4 1993 "Font Lock mode face for backslashes in Lisp regexp grouping constructs."
a4deefed 1994 :group 'font-lock-faces)
c711faac 1995
112abe24 1996(defface font-lock-regexp-grouping-construct
c711faac 1997 '((t :inherit bold))
9ad5e4d4 1998 "Font Lock mode face used to highlight grouping constructs in Lisp regexps."
a4deefed 1999 :group 'font-lock-faces)
c711faac 2000
6772c8e1 2001;;; End of Color etc. support.
9bfbb130 2002\f
56fcbd7e
SM
2003;;; Menu support.
2004
2005;; This section of code is commented out because Emacs does not have real menu
2006;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
2007;; the menu entry text, but with Xt it looks both ugly and embarrassingly
2008;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
2009;; the entry for "Text Properties" something like:
2010;;
2011;; (define-key menu-bar-edit-menu [font-lock]
9c8de95c 2012;; (cons "Syntax Highlighting" font-lock-menu))
56fcbd7e
SM
2013;;
2014;; and remove a single ";" from the beginning of each line in the rest of this
2015;; section. Probably the mechanism for telling the menu code what are menu
2016;; buttons and when they are on or off needs tweaking. I have assumed that the
2017;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
2018
d55c4199
SM
2019;;;;;###autoload
2020;;(progn
2021;; ;; Make the Font Lock menu.
2022;; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
2023;; ;; Add the menu items in reverse order.
2024;; (define-key font-lock-menu [fontify-less]
2025;; '("Less In Current Buffer" . font-lock-fontify-less))
2026;; (define-key font-lock-menu [fontify-more]
2027;; '("More In Current Buffer" . font-lock-fontify-more))
2028;; (define-key font-lock-menu [font-lock-sep]
2029;; '("--"))
2030;; (define-key font-lock-menu [font-lock-mode]
2031;; '("In Current Buffer" . font-lock-mode))
2032;; (define-key font-lock-menu [global-font-lock-mode]
2033;; '("In All Buffers" . global-font-lock-mode)))
2034;;
2035;;;;;###autoload
2036;;(progn
2037;; ;; We put the appropriate `menu-enable' etc. symbol property values on when
2038;; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
2039;; (put 'global-font-lock-mode 'menu-toggle t)
2040;; (put 'font-lock-mode 'menu-toggle t)
2041;; (put 'font-lock-fontify-more 'menu-enable '(identity))
2042;; (put 'font-lock-fontify-less 'menu-enable '(identity)))
2043;;
2044;; ;; Put the appropriate symbol property values on now. See above.
2045;;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
2046;;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
2047;;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
2048;;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
2049;;
2050;;(defvar font-lock-fontify-level nil) ; For less/more fontification.
2051;;
2052;;(defun font-lock-fontify-level (level)
2053;; (let ((font-lock-maximum-decoration level))
2054;; (when font-lock-mode
2055;; (font-lock-mode))
2056;; (font-lock-mode)
2057;; (when font-lock-verbose
2058;; (message "Fontifying %s... level %d" (buffer-name) level))))
2059;;
2060;;(defun font-lock-fontify-less ()
2061;; "Fontify the current buffer with less decoration.
2062;;See `font-lock-maximum-decoration'."
2063;; (interactive)
2064;; ;; Check in case we get called interactively.
2065;; (if (nth 1 font-lock-fontify-level)
2066;; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
2067;; (error "No less decoration")))
2068;;
2069;;(defun font-lock-fontify-more ()
2070;; "Fontify the current buffer with more decoration.
2071;;See `font-lock-maximum-decoration'."
2072;; (interactive)
2073;; ;; Check in case we get called interactively.
2074;; (if (nth 2 font-lock-fontify-level)
2075;; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
2076;; (error "No more decoration")))
2077;;
2078;; ;; This should be called by `font-lock-set-defaults'.
2079;;(defun font-lock-set-menu ()
2080;; ;; Activate less/more fontification entries if there are multiple levels for
2081;; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
2082;; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
2083;; (let ((keywords (or (nth 0 font-lock-defaults)
2084;; (nth 1 (assq major-mode font-lock-defaults-alist))))
2085;; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
2086;; (make-local-variable 'font-lock-fontify-level)
2087;; (if (or (symbolp keywords) (= (length keywords) 1))
2088;; (font-lock-unset-menu)
2089;; (cond ((eq level t)
2090;; (setq level (1- (length keywords))))
2091;; ((or (null level) (zerop level))
2092;; ;; The default level is usually, but not necessarily, level 1.
2093;; (setq level (- (length keywords)
2094;; (length (member (eval (car keywords))
2095;; (mapcar 'eval (cdr keywords))))))))
2096;; (setq font-lock-fontify-level (list level (> level 1)
2097;; (< level (1- (length keywords))))))))
2098;;
2099;; ;; This should be called by `font-lock-unset-defaults'.
2100;;(defun font-lock-unset-menu ()
2101;; ;; Deactivate less/more fontification entries.
2102;; (setq font-lock-fontify-level nil))
2d63aa67
SM
2103
2104;;; End of Menu support.
56fcbd7e 2105\f
9bfbb130 2106;;; Various regexp information shared by several modes.
d55c4199 2107;; ;; Information specific to a single mode should go in its load library.
030f4a35 2108
1fed50c4
SM
2109;; Font Lock support for C, C++, Objective-C and Java modes is now in
2110;; cc-fonts.el (and required by cc-mode.el). However, the below function
56fcbd7e 2111;; should stay in font-lock.el, since it is used by other libraries. sm.
2e6a15fc 2112
c1f2ffc8 2113(defun font-lock-match-c-style-declaration-item-and-skip-to-next (limit)
2e6a15fc 2114 "Match, and move over, any declaration/definition item after point.
c1f2ffc8
SM
2115Matches after point, but ignores leading whitespace and `*' characters.
2116Does not move further than LIMIT.
2117
ac6e572c
SM
2118The expected syntax of a declaration/definition item is `word' (preceded by
2119optional whitespace and `*' characters and proceeded by optional whitespace)
2120optionally followed by a `('. Everything following the item (but belonging to
4cac2fc3 2121it) is expected to be skip-able by `scan-sexps', and items are expected to be
ac6e572c 2122separated with a `,' and to be terminated with a `;'.
c1f2ffc8
SM
2123
2124Thus the regexp matches after point: word (
2125 ^^^^ ^
2126Where the match subexpressions are: 1 2
2127
2128The item is delimited by (match-beginning 1) and (match-end 1).
2129If (match-beginning 2) is non-nil, the item is followed by a `('.
2130
2131This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
c1966bb4 2132 (when (looking-at "[ \n\t*]*\\(\\sw+\\)[ \t\n]*\\(((?\\)?")
8259bf10
SM
2133 (when (and (match-end 2) (> (- (match-end 2) (match-beginning 2)) 1))
2134 ;; If `word' is followed by a double open-paren, it's probably
2135 ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one
2136 ;; word to try and match `myfun' rather than `P_'.
2137 (let ((pos (point)))
c1966bb4 2138 (skip-chars-backward " \t\n")
8259bf10 2139 (skip-syntax-backward "w")
4cac2fc3 2140 (unless (looking-at "\\(\\sw+\\)[ \t\n]*\\sw+[ \t\n]*\\(((?\\)?")
8259bf10
SM
2141 ;; Looks like it was something else, so go back to where we
2142 ;; were and reset the match data by rematching.
2143 (goto-char pos)
c1966bb4 2144 (looking-at "[ \n\t*]*\\(\\sw+\\)[ \t\n]*\\(((?\\)?"))))
2e6a15fc
SM
2145 (save-match-data
2146 (condition-case nil
2147 (save-restriction
c1966bb4 2148 ;; Restrict to the LIMIT.
2e6a15fc
SM
2149 (narrow-to-region (point-min) limit)
2150 (goto-char (match-end 1))
2151 ;; Move over any item value, etc., to the next item.
c1966bb4 2152 (while (not (looking-at "[ \t\n]*\\(\\(,\\)\\|;\\|\\'\\)"))
2e6a15fc 2153 (goto-char (or (scan-sexps (point) 1) (point-max))))
c1ebafd6
KH
2154 (if (match-end 2)
2155 (goto-char (match-end 2))))
2e6a15fc 2156 (error t)))))
4076cbf6
MY
2157
2158;; C preprocessor(cpp) is used outside of C, C++ and Objective-C source file.
2159;; e.g. assembler code and GNU linker script in Linux kernel.
2160;; `cpp-font-lock-keywords' is handy for modes for the files.
2161;;
2162;; Here we cannot use `regexp-opt' because because regex-opt is not preloaded
071e6277 2163;; while font-lock.el is preloaded to emacs. So values pre-calculated with
4076cbf6
MY
2164;; regexp-opt are used here.
2165
2166;; `cpp-font-lock-keywords-source-directives' is calculated from:
2167;;
2168;; (regexp-opt
2169;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
8c8b1164 2170;; "ifndef" "import" "include" "line" "pragma" "undef" "warning"))
4076cbf6
MY
2171;;
2172(defconst cpp-font-lock-keywords-source-directives
8c8b1164 2173 "define\\|e\\(?:l\\(?:if\\|se\\)\\|ndif\\|rror\\)\\|file\\|i\\(?:f\\(?:n?def\\)?\\|mport\\|nclude\\)\\|line\\|pragma\\|undef\\|warning"
2124318a 2174 "Regular expression used in `cpp-font-lock-keywords'.")
4076cbf6
MY
2175
2176;; `cpp-font-lock-keywords-source-depth' is calculated from:
2177;;
2178;; (regexp-opt-depth (regexp-opt
2179;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
8c8b1164 2180;; "ifndef" "import" "include" "line" "pragma" "undef" "warning")))
4076cbf6
MY
2181;;
2182(defconst cpp-font-lock-keywords-source-depth 0
2183 "An integer representing regular expression depth of `cpp-font-lock-keywords-source-directives'.
2184Used in `cpp-font-lock-keywords'.")
2185
2186(defconst cpp-font-lock-keywords
2187 (let* ((directives cpp-font-lock-keywords-source-directives)
2188 (directives-depth cpp-font-lock-keywords-source-depth))
2189 (list
2190 ;;
2191 ;; Fontify error directives.
8c8b1164 2192 '("^#[ \t]*\\(?:error\\|warning\\)[ \t]+\\(.+\\)" 1 font-lock-warning-face prepend)
4076cbf6
MY
2193 ;;
2194 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2195 '("^#[ \t]*\\(?:import\\|include\\)[ \t]*\\(<[^>\"\n]*>?\\)"
2196 1 font-lock-string-face prepend)
2197 ;;
2198 ;; Fontify function macro names.
071e6277 2199 '("^#[ \t]*define[ \t]+\\([[:alpha:]_][[:alnum:]_$]*\\)("
4076cbf6
MY
2200 (1 font-lock-function-name-face prepend)
2201 ;;
2202 ;; Macro arguments.
2203 ((lambda (limit)
2204 (re-search-forward
071e6277
GM
2205 "\\(?:\\([[:alpha:]_][[:alnum:]_]*\\)[,]?\\)"
2206 (or (save-excursion (re-search-forward ")" limit t))
4076cbf6 2207 limit)
071e6277 2208 t))
4076cbf6
MY
2209 nil nil (1 font-lock-variable-name-face prepend)))
2210 ;;
2211 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2212 '("^#[ \t]*\\(?:elif\\|if\\)\\>"
2213 ("\\<\\(defined\\)\\>[ \t]*(?\\([[:alpha:]_][[:alnum:]_]*\\)?" nil nil
2214 (1 font-lock-builtin-face prepend) (2 font-lock-variable-name-face prepend t)))
2215 ;;
2216 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2217 (list
2218 (concat "^\\(#[ \t]*\\(?:" directives
2219 "\\)\\)\\>[ \t!]*\\([[:alpha:]_][[:alnum:]_]*\\)?")
2220 '(1 font-lock-preprocessor-face prepend)
2221 (list (+ 2 directives-depth)
2222 'font-lock-variable-name-face nil t))))
2124318a
JPW
2223 "Font lock keywords for C preprocessor directives.
2224`c-mode', `c++-mode' and `objc-mode' have their own font lock keywords
2225for C preprocessor directives. This definition is for the other modes
2226in which C preprocessor directives are used. e.g. `asm-mode' and
4076cbf6
MY
2227`ld-script-mode'.")
2228
46f26fcf
SM
2229\f
2230;; Lisp.
2e6a15fc 2231
030f4a35 2232(defconst lisp-font-lock-keywords-1
2e6a15fc 2233 (eval-when-compile
71994ae7
DP
2234 `(;; Definitions.
2235 (,(concat "(\\(def\\("
2236 ;; Function declarations.
588fe8bc 2237 "\\(advice\\|alias\\|generic\\|macro\\*?\\|method\\|"
71994ae7 2238 "setf\\|subst\\*?\\|un\\*?\\|"
140adc83 2239 "ine-\\(condition\\|"
5da23a93 2240 "\\(?:derived\\|\\(?:global\\(?:ized\\)?-\\)?minor\\|generic\\)-mode\\|"
71994ae7
DP
2241 "method-combination\\|setf-expander\\|skeleton\\|widget\\|"
2242 "function\\|\\(compiler\\|modify\\|symbol\\)-macro\\)\\)\\|"
2243 ;; Variable declarations.
588fe8bc 2244 "\\(const\\(ant\\)?\\|custom\\|varalias\\|face\\|parameter\\|var\\)\\|"
71994ae7
DP
2245 ;; Structure declarations.
2246 "\\(class\\|group\\|theme\\|package\\|struct\\|type\\)"
2247 "\\)\\)\\>"
2248 ;; Any whitespace and defined object.
2249 "[ \t'\(]*"
5d4cf42a 2250 "\\(setf[ \t]+\\sw+)\\|\\sw+\\)?")
71994ae7
DP
2251 (1 font-lock-keyword-face)
2252 (9 (cond ((match-beginning 3) font-lock-function-name-face)
2253 ((match-beginning 6) font-lock-variable-name-face)
2254 (t font-lock-type-face))
2255 nil t))
071e6277
GM
2256 ;; Emacs Lisp autoload cookies. Supports the slightly different
2257 ;; forms used by mh-e, calendar, etc.
2258 ("^;;;###\\([-a-z]*autoload\\)" 1 font-lock-warning-face prepend)
71994ae7
DP
2259 ;; Regexp negated char group.
2260 ("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
56fcbd7e 2261 "Subdued level highlighting for Lisp modes.")
030f4a35
RS
2262
2263(defconst lisp-font-lock-keywords-2
799761f0 2264 (append lisp-font-lock-keywords-1
2e6a15fc 2265 (eval-when-compile
71994ae7
DP
2266 `(;; Control structures. Emacs Lisp forms.
2267 (,(concat
2268 "(" (regexp-opt
ef651d13 2269 '("cond" "if" "while" "while-no-input" "let" "let*"
71994ae7
DP
2270 "prog" "progn" "progv" "prog1" "prog2" "prog*"
2271 "inline" "lambda" "save-restriction" "save-excursion"
3e50a5e8
MR
2272 "save-selected-window" "save-window-excursion"
2273 "save-match-data" "save-current-buffer"
456f369a
ŠN
2274 "combine-after-change-calls" "unwind-protect"
2275 "condition-case" "condition-case-no-debug"
2276 "track-mouse" "eval-after-load" "eval-and-compile"
2277 "eval-when-compile" "eval-when" "eval-next-after-load"
d4f26f40 2278 "with-case-table" "with-category-table"
456f369a
ŠN
2279 "with-current-buffer" "with-demoted-errors"
2280 "with-electric-help"
71994ae7
DP
2281 "with-local-quit" "with-no-warnings"
2282 "with-output-to-string" "with-output-to-temp-buffer"
456f369a
ŠN
2283 "with-selected-window" "with-selected-frame"
2284 "with-silent-modifications" "with-syntax-table"
71994ae7
DP
2285 "with-temp-buffer" "with-temp-file" "with-temp-message"
2286 "with-timeout" "with-timeout-handler") t)
2287 "\\>")
2288 . 1)
2289 ;; Control structures. Common Lisp forms.
2290 (,(concat
2291 "(" (regexp-opt
2292 '("when" "unless" "case" "ecase" "typecase" "etypecase"
2293 "ccase" "ctypecase" "handler-case" "handler-bind"
2294 "restart-bind" "restart-case" "in-package"
2295 "break" "ignore-errors"
2296 "loop" "do" "do*" "dotimes" "dolist" "the" "locally"
cddaedb6 2297 "proclaim" "declaim" "declare" "symbol-macrolet" "letf"
71994ae7
DP
2298 "lexical-let" "lexical-let*" "flet" "labels" "compiler-let"
2299 "destructuring-bind" "macrolet" "tagbody" "block" "go"
2300 "multiple-value-bind" "multiple-value-prog1"
2301 "return" "return-from"
2302 "with-accessors" "with-compilation-unit"
2303 "with-condition-restarts" "with-hash-table-iterator"
2304 "with-input-from-string" "with-open-file"
2305 "with-open-stream" "with-output-to-string"
2306 "with-package-iterator" "with-simple-restart"
2307 "with-slots" "with-standard-io-syntax") t)
2308 "\\>")
2309 . 1)
2310 ;; Exit/Feature symbols as constants.
2311 (,(concat "(\\(catch\\|throw\\|featurep\\|provide\\|require\\)\\>"
2312 "[ \t']*\\(\\sw+\\)?")
2313 (1 font-lock-keyword-face)
2314 (2 font-lock-constant-face nil t))
2315 ;; Erroneous structures.
2316 ("(\\(abort\\|assert\\|warn\\|check-type\\|cerror\\|error\\|signal\\)\\>" 1 font-lock-warning-face)
2317 ;; Words inside \\[] tend to be for `substitute-command-keys'.
b50f58d5 2318 ("\\\\\\\\\\[\\(\\sw+\\)\\]" 1 font-lock-constant-face prepend)
71994ae7
DP
2319 ;; Words inside `' tend to be symbol names.
2320 ("`\\(\\sw\\sw+\\)'" 1 font-lock-constant-face prepend)
2321 ;; Constant values.
2322 ("\\<:\\sw+\\>" 0 font-lock-builtin-face)
2323 ;; ELisp and CLisp `&' keywords as types.
317921ec 2324 ("\\<\\&\\sw+\\>" . font-lock-type-face)
9ad5e4d4 2325 ;; ELisp regexp grouping constructs
ae0c6927 2326 ((lambda (bound)
9ad5e4d4
EZ
2327 (catch 'found
2328 ;; The following loop is needed to continue searching after matches
2329 ;; that do not occur in strings. The associated regexp matches one
2330 ;; of `\\\\' `\\(' `\\(?:' `\\|' `\\)'. `\\\\' has been included to
2331 ;; avoid highlighting, for example, `\\(' in `\\\\('.
0ffaebf0 2332 (while (re-search-forward "\\(\\\\\\\\\\)\\(?:\\(\\\\\\\\\\)\\|\\((\\(?:\\?[0-9]*:\\)?\\|[|)]\\)\\)" bound t)
9ad5e4d4
EZ
2333 (unless (match-beginning 2)
2334 (let ((face (get-text-property (1- (point)) 'face)))
2335 (when (or (and (listp face)
2336 (memq 'font-lock-string-face face))
2337 (eq 'font-lock-string-face face))
2338 (throw 'found t)))))))
2339 (1 'font-lock-regexp-grouping-backslash prepend)
2340 (3 'font-lock-regexp-grouping-construct prepend))
90cbc9cd
SM
2341;;; This is too general -- rms.
2342;;; A user complained that he has functions whose names start with `do'
2343;;; and that they get the wrong color.
6b61353c 2344;;; ;; CL `with-' and `do-' constructs
71994ae7 2345;;; ("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
2e6a15fc 2346 )))
fb512de9 2347 "Gaudy level highlighting for Lisp modes.")
030f4a35 2348
fb512de9
SM
2349(defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
2350 "Default expressions to highlight in Lisp modes.")
46f26fcf 2351\f
030f4a35 2352(provide 'font-lock)
54f73af3 2353
7ae3cc71 2354;; arch-tag: 682327e4-64d8-4057-b20b-1fbb9f1fc54c
030f4a35 2355;;; font-lock.el ends here