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