Merge from erc--emacs--21
[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,
1c360af3 4;; 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
030f4a35 5
0279f991 6;; Author: jwz, then rms, then sm
030f4a35
RS
7;; Maintainer: FSF
8;; Keywords: languages, faces
9
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
b578f267 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
SM
357call to make the search (called with one argument, the limit of the search;
358it should return non-nil, move point, and set `match-data' appropriately iff
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'.")
471
472(defvar font-lock-removed-keywords-alist nil
0003d2e3
LK
473 "Alist of `font-lock-keywords' elements to be removed for major modes.
474
475Each element has the form (MODE . KEYWORDS). `font-lock-set-defaults'
476removes the elements in the list KEYWORDS from `font-lock-keywords'
477when Font Lock is turned on in major mode MODE.
478
76f5e2af
GM
479This is normally set via `font-lock-add-keywords' and
480`font-lock-remove-keywords'.")
c1f2ffc8 481
9bfbb130 482(defvar font-lock-keywords-only nil
d46c21ec
SM
483 "*Non-nil means Font Lock should not fontify comments or strings.
484This is normally set via `font-lock-defaults'.")
b89e1134 485
030f4a35 486(defvar font-lock-keywords-case-fold-search nil
d46c21ec
SM
487 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
488This is normally set via `font-lock-defaults'.")
1087f198 489(make-variable-buffer-local 'font-lock-keywords-case-fold-search)
030f4a35 490
c0a6a9fe
SM
491(defvar font-lock-syntactically-fontified 0
492 "Point up to which `font-lock-syntactic-keywords' has been applied.
493If nil, this is ignored, in which case the syntactic fontification may
494sometimes be slightly incorrect.")
495(make-variable-buffer-local 'font-lock-syntactically-fontified)
496
1c172af4
SM
497(defvar font-lock-syntactic-face-function
498 (lambda (state)
499 (if (nth 3 state) font-lock-string-face font-lock-comment-face))
500 "Function to determine which face to use when fontifying syntactically.
501The function is called with a single parameter (the state as returned by
502`parse-partial-sexp' at the beginning of the region to highlight) and
8ba81e93 503should return a face. This is normally set via `font-lock-defaults'.")
1c172af4 504
ac6e572c 505(defvar font-lock-syntactic-keywords nil
9bab4985
RS
506 "A list of the syntactic keywords to put syntax properties on.
507The value can be the list itself, or the name of a function or variable
508whose value is the list.
509
ac6e572c 510See `font-lock-keywords' for a description of the form of this list;
9bab4985 511only the differences are stated here. MATCH-HIGHLIGHT should be of the form:
ac6e572c 512
9bab4985 513 (SUBEXP SYNTAX OVERRIDE LAXMATCH)
ac6e572c 514
5299cb8e
SM
515where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax
516table, a cons cell (as returned by `string-to-syntax') or an expression whose
517value is such a form. OVERRIDE cannot be `prepend' or `append'.
ac6e572c 518
9bab4985
RS
519Here are two examples of elements of `font-lock-syntactic-keywords'
520and what they do:
9c8de95c 521
5299cb8e 522 (\"\\\\$\\\\(#\\\\)\" 1 \".\")
9c8de95c 523
9bab4985
RS
524 gives a hash character punctuation syntax (\".\") when following a
525 dollar-sign character. Hash characters in other contexts will still
526 follow whatever the syntax table says about the hash character.
9c8de95c
SM
527
528 (\"\\\\('\\\\).\\\\('\\\\)\"
5299cb8e
SM
529 (1 \"\\\"\")
530 (2 \"\\\"\"))
9c8de95c 531
9bab4985
RS
532 gives a pair single-quotes, which surround a single character, a SYNTAX of
533 \"\\\"\" (meaning string quote syntax). Single-quote characters in other
534 contexts will not be affected.
9c8de95c 535
ac6e572c
SM
536This is normally set via `font-lock-defaults'.")
537
b056da51 538(defvar font-lock-syntax-table nil
799761f0 539 "Non-nil means use this syntax table for fontifying.
d46c21ec
SM
540If this is nil, the major mode's syntax table is used.
541This is normally set via `font-lock-defaults'.")
542
543(defvar font-lock-beginning-of-syntax-function nil
fc896a92
RS
544 "*Non-nil means use this function to move back outside all constructs.
545When called with no args it should move point backward to a place which
546is not in a string or comment and not within any bracket-pairs (or else,
547a place such that any bracket-pairs outside it can be ignored for Emacs
548syntax analysis and fontification).
549
822b23b0
LK
550If this is nil, Font Lock uses `syntax-begin-function' to move back
551outside of any comment, string, or sexp. This variable is semi-obsolete;
552we recommend setting `syntax-begin-function' instead.
553
554This is normally set via `font-lock-defaults'.")
b056da51 555
a078558d
SM
556(defvar font-lock-mark-block-function nil
557 "*Non-nil means use this function to mark a block of text.
558When called with no args it should leave point at the beginning of any
559enclosing textual block and mark at the end.
560This is normally set via `font-lock-defaults'.")
561
a2b8e66b
SM
562(defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer
563 "Function to use for fontifying the buffer.
564This is normally set via `font-lock-defaults'.")
565
566(defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer
567 "Function to use for unfontifying the buffer.
568This is used when turning off Font Lock mode.
569This is normally set via `font-lock-defaults'.")
570
571(defvar font-lock-fontify-region-function 'font-lock-default-fontify-region
572 "Function to use for fontifying a region.
573It should take two args, the beginning and end of the region, and an optional
0edd2744
LK
574third arg VERBOSE. If VERBOSE is non-nil, the function should print status
575messages. This is normally set via `font-lock-defaults'.")
a2b8e66b
SM
576
577(defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region
578 "Function to use for unfontifying a region.
579It should take two args, the beginning and end of the region.
580This is normally set via `font-lock-defaults'.")
581
582(defvar font-lock-inhibit-thing-lock nil
583 "List of Font Lock mode related modes that should not be turned on.
019f00d8 584Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
e7f07c2c 585`lazy-lock-mode'. This is normally set via `font-lock-defaults'.")
a2b8e66b 586
f8115798
SM
587(defvar font-lock-multiline nil
588 "Whether font-lock should cater to multiline keywords.
589If nil, don't try to handle multiline patterns.
590If t, always handle multiline patterns.
591If `undecided', don't try to handle multiline patterns until you see one.
592Major/minor modes can set this variable if they know which option applies.")
593
594(defvar font-lock-fontified nil) ; Whether we have fontified the buffer.
030f4a35 595\f
5aa29679
RS
596;; Font Lock mode.
597
598(eval-when-compile
2e6a15fc 599 ;;
5aa29679 600 ;; We don't do this at the top-level as we only use non-autoloaded macros.
2e6a15fc
SM
601 (require 'cl)
602 ;;
603 ;; Borrowed from lazy-lock.el.
604 ;; We use this to preserve or protect things when modifying text properties.
605 (defmacro save-buffer-state (varlist &rest body)
606 "Bind variables according to VARLIST and eval BODY restoring buffer state."
56d8206b 607 (declare (indent 1) (debug let))
7b7a23f4
EZ
608 (let ((modified (make-symbol "modified")))
609 `(let* ,(append varlist
886c13f1 610 `((,modified (buffer-modified-p))
7b7a23f4
EZ
611 (buffer-undo-list t)
612 (inhibit-read-only t)
613 (inhibit-point-motion-hooks t)
614 (inhibit-modification-hooks t)
615 deactivate-mark
616 buffer-file-name
617 buffer-file-truename))
618 (progn
619 ,@body)
620 (unless ,modified
621 (restore-buffer-modified-p nil)))))
e0e277ff
SM
622 ;;
623 ;; Shut up the byte compiler.
1c172af4 624 (defvar font-lock-face-attributes)) ; Obsolete but respected if set.
030f4a35 625
f8115798
SM
626(defun font-lock-mode-internal (arg)
627 ;; Turn on Font Lock mode.
628 (when arg
629 (add-hook 'after-change-functions 'font-lock-after-change-function t t)
630 (font-lock-set-defaults)
631 (font-lock-turn-on-thing-lock)
632 ;; Fontify the buffer if we have to.
633 (let ((max-size (font-lock-value-in-major-mode font-lock-maximum-size)))
634 (cond (font-lock-fontified
635 nil)
636 ((or (null max-size) (> max-size (buffer-size)))
637 (font-lock-fontify-buffer))
638 (font-lock-verbose
639 (message "Fontifying %s...buffer size greater than font-lock-maximum-size"
640 (buffer-name))))))
641 ;; Turn off Font Lock mode.
642 (unless font-lock-mode
643 (remove-hook 'after-change-functions 'font-lock-after-change-function t)
644 (font-lock-unfontify-buffer)
645 (font-lock-turn-off-thing-lock)))
646
28aa8148 647(defun font-lock-add-keywords (mode keywords &optional how)
041470d2 648 "Add highlighting KEYWORDS for MODE.
8ba81e93 649
041470d2 650MODE should be a symbol, the major mode command name, such as `c-mode'
1c626aaf 651or nil. If nil, highlighting keywords are added for the current buffer.
c1f2ffc8
SM
652KEYWORDS should be a list; see the variable `font-lock-keywords'.
653By default they are added at the beginning of the current highlighting list.
28aa8148
RF
654If optional argument HOW is `set', they are used to replace the current
655highlighting list. If HOW is any other non-nil value, they are added at the
2d63aa67 656end of the current highlighting list.
c1f2ffc8
SM
657
658For example:
659
660 (font-lock-add-keywords 'c-mode
661 '((\"\\\\\\=<\\\\(FIXME\\\\):\" 1 font-lock-warning-face prepend)
662 (\"\\\\\\=<\\\\(and\\\\|or\\\\|not\\\\)\\\\\\=>\" . font-lock-keyword-face)))
663
664adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
2d63aa67
SM
665comments, and to fontify `and', `or' and `not' words as keywords.
666
bed88438
LT
667The above procedure will only add the keywords for C mode, not
668for modes derived from C mode. To add them for derived modes too,
669pass nil for MODE and add the call to c-mode-hook.
670
671For example:
672
673 (add-hook 'c-mode-hook
674 (lambda ()
dd314c0f 675 (font-lock-add-keywords nil
bed88438
LT
676 '((\"\\\\\\=<\\\\(FIXME\\\\):\" 1 font-lock-warning-face prepend)
677 (\"\\\\\\=<\\\\(and\\\\|or\\\\|not\\\\)\\\\\\=>\" .
678 font-lock-keyword-face)))))
679
680The above procedure may fail to add keywords to derived modes if
681some involved major mode does not follow the standard conventions.
682File a bug report if this happens, so the major mode can be corrected.
558371ba 683
8c2d6a44 684Note that some modes have specialized support for additional patterns, e.g.,
2d63aa67
SM
685see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
686`objc-font-lock-extra-types' and `java-font-lock-extra-types'."
041470d2 687 (cond (mode
28aa8148 688 ;; If MODE is non-nil, add the KEYWORDS and HOW spec to
c1f2ffc8 689 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
28aa8148 690 (let ((spec (cons keywords how)) cell)
041470d2 691 (if (setq cell (assq mode font-lock-keywords-alist))
28aa8148 692 (if (eq how 'set)
76f5e2af
GM
693 (setcdr cell (list spec))
694 (setcdr cell (append (cdr cell) (list spec))))
695 (push (list mode spec) font-lock-keywords-alist)))
696 ;; Make sure that `font-lock-removed-keywords-alist' does not
697 ;; contain the new keywords.
28aa8148 698 (font-lock-update-removed-keyword-alist mode keywords how))
6e1d0d15
SM
699 (t
700 ;; Otherwise set or add the keywords now.
bed88438
LT
701 ;; This is a no-op if it has been done already in this buffer
702 ;; for the correct major mode.
6e1d0d15 703 (font-lock-set-defaults)
69968400
RS
704 (let ((was-compiled (eq (car font-lock-keywords) t)))
705 ;; Bring back the user-level (uncompiled) keywords.
706 (if was-compiled
707 (setq font-lock-keywords (cadr font-lock-keywords)))
708 ;; Now modify or replace them.
28aa8148 709 (if (eq how 'set)
69968400
RS
710 (setq font-lock-keywords keywords)
711 (font-lock-remove-keywords nil keywords) ;to avoid duplicates
712 (let ((old (if (eq (car-safe font-lock-keywords) t)
713 (cdr font-lock-keywords)
714 font-lock-keywords)))
28aa8148 715 (setq font-lock-keywords (if how
69968400
RS
716 (append old keywords)
717 (append keywords old)))))
718 ;; If the keywords were compiled before, compile them again.
719 (if was-compiled
e0be77f6
SM
720 (setq font-lock-keywords
721 (font-lock-compile-keywords font-lock-keywords t)))))))
3708dfe9 722
28aa8148 723(defun font-lock-update-removed-keyword-alist (mode keywords how)
95965740 724 "Update `font-lock-removed-keywords-alist' when adding new KEYWORDS to MODE."
76f5e2af
GM
725 ;; When font-lock is enabled first all keywords in the list
726 ;; `font-lock-keywords-alist' are added, then all keywords in the
727 ;; list `font-lock-removed-keywords-alist' are removed. If a
728 ;; keyword was once added, removed, and then added again it must be
729 ;; removed from the removed-keywords list. Otherwise the second add
730 ;; will not take effect.
6e1d0d15 731 (let ((cell (assq mode font-lock-removed-keywords-alist)))
76f5e2af 732 (if cell
28aa8148 733 (if (eq how 'set)
76f5e2af
GM
734 ;; A new set of keywords is defined. Forget all about
735 ;; our old keywords that should be removed.
736 (setq font-lock-removed-keywords-alist
737 (delq cell font-lock-removed-keywords-alist))
738 ;; Delete all previously removed keywords.
739 (dolist (kword keywords)
740 (setcdr cell (delete kword (cdr cell))))
6e1d0d15 741 ;; Delete the mode cell if empty.
76f5e2af
GM
742 (if (null (cdr cell))
743 (setq font-lock-removed-keywords-alist
744 (delq cell font-lock-removed-keywords-alist)))))))
745
746;; Written by Anders Lindgren <andersl@andersl.com>.
747;;
748;; Case study:
749;; (I) The keywords are removed from a major mode.
750;; In this case the keyword could be local (i.e. added earlier by
751;; `font-lock-add-keywords'), global, or both.
752;;
753;; (a) In the local case we remove the keywords from the variable
754;; `font-lock-keywords-alist'.
755;;
756;; (b) The actual global keywords are not known at this time.
757;; All keywords are added to `font-lock-removed-keywords-alist',
758;; when font-lock is enabled those keywords are removed.
759;;
760;; Note that added keywords are taken out of the list of removed
761;; keywords. This ensure correct operation when the same keyword
762;; is added and removed several times.
763;;
764;; (II) The keywords are removed from the current buffer.
6e1d0d15
SM
765(defun font-lock-remove-keywords (mode keywords)
766 "Remove highlighting KEYWORDS for MODE.
3708dfe9 767
6e1d0d15 768MODE should be a symbol, the major mode command name, such as `c-mode'
558371ba
SM
769or nil. If nil, highlighting keywords are removed for the current buffer.
770
bed88438
LT
771To make the removal apply to modes derived from MODE as well,
772pass nil for MODE and add the call to MODE-hook. This may fail
773for some derived modes if some involved major mode does not
774follow the standard conventions. File a bug report if this
775happens, so the major mode can be corrected."
6e1d0d15
SM
776 (cond (mode
777 ;; Remove one keyword at the time.
778 (dolist (keyword keywords)
779 (let ((top-cell (assq mode font-lock-keywords-alist)))
780 ;; If MODE is non-nil, remove the KEYWORD from
76f5e2af
GM
781 ;; `font-lock-keywords-alist'.
782 (when top-cell
28aa8148
RF
783 (dolist (keyword-list-how-pair (cdr top-cell))
784 ;; `keywords-list-how-pair' is a cons with a list of
785 ;; keywords in the car top-cell and the original how
76f5e2af 786 ;; argument in the cdr top-cell.
28aa8148
RF
787 (setcar keyword-list-how-pair
788 (delete keyword (car keyword-list-how-pair))))
789 ;; Remove keyword list/how pair when the keyword list
790 ;; is empty and how doesn't specify `set'. (If it
76f5e2af
GM
791 ;; should be deleted then previously deleted keywords
792 ;; would appear again.)
793 (let ((cell top-cell))
794 (while (cdr cell)
795 (if (and (null (car (car (cdr cell))))
796 (not (eq (cdr (car (cdr cell))) 'set)))
797 (setcdr cell (cdr (cdr cell)))
798 (setq cell (cdr cell)))))
799 ;; Final cleanup, remove major mode cell if last keyword
800 ;; was deleted.
801 (if (null (cdr top-cell))
802 (setq font-lock-keywords-alist
803 (delq top-cell font-lock-keywords-alist))))
804 ;; Remember the keyword in case it is not local.
6e1d0d15 805 (let ((cell (assq mode font-lock-removed-keywords-alist)))
76f5e2af
GM
806 (if cell
807 (unless (member keyword (cdr cell))
808 (nconc cell (list keyword)))
6e1d0d15
SM
809 (push (cons mode (list keyword))
810 font-lock-removed-keywords-alist))))))
811 (t
812 ;; Otherwise remove it immediately.
813 (font-lock-set-defaults)
69968400
RS
814 (let ((was-compiled (eq (car font-lock-keywords) t)))
815 ;; Bring back the user-level (uncompiled) keywords.
816 (if was-compiled
817 (setq font-lock-keywords (cadr font-lock-keywords)))
818
819 ;; Edit them.
820 (setq font-lock-keywords (copy-sequence font-lock-keywords))
821 (dolist (keyword keywords)
822 (setq font-lock-keywords
823 (delete keyword font-lock-keywords)))
824
825 ;; If the keywords were compiled before, compile them again.
826 (if was-compiled
e0be77f6
SM
827 (setq font-lock-keywords
828 (font-lock-compile-keywords font-lock-keywords t)))))))
a2b8e66b 829\f
2d63aa67
SM
830;;; Font Lock Support mode.
831
5aa29679
RS
832;; This is the code used to interface font-lock.el with any of its add-on
833;; packages, and provide the user interface. Packages that have their own
834;; local buffer fontification functions (see below) may have to call
835;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
836;; themselves.
837
5f999b0b 838(defcustom font-lock-support-mode 'jit-lock-mode
5aa29679
RS
839 "*Support mode for Font Lock mode.
840Support modes speed up Font Lock mode by being choosy about when fontification
59442c80
RS
841occurs. The default support mode, Just-in-time Lock mode (symbol
842`jit-lock-mode'), is recommended.
843
844Other, older support modes are Fast Lock mode (symbol `fast-lock-mode') and
845Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
846However, they are no longer recommended, as Just-in-time Lock mode is better.
847
5aa29679
RS
848If nil, means support for Font Lock mode is never performed.
849If a symbol, use that support mode.
850If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
851where MAJOR-MODE is a symbol or t (meaning the default). For example:
852 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
853means that Fast Lock mode is used to support Font Lock mode for buffers in C or
854C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
855
55015061 856The value of this variable is used when Font Lock mode is turned on."
b34aa0a3
SM
857 :type '(choice (const :tag "none" nil)
858 (const :tag "fast lock" fast-lock-mode)
859 (const :tag "lazy lock" lazy-lock-mode)
e7f07c2c 860 (const :tag "jit lock" jit-lock-mode)
b34aa0a3 861 (repeat :menu-tag "mode specific" :tag "mode specific"
1c172af4 862 :value ((t . jit-lock-mode))
b34aa0a3
SM
863 (cons :tag "Instance"
864 (radio :tag "Mode"
865 (const :tag "all" t)
866 (symbol :tag "name"))
39df451b
SM
867 (radio :tag "Support"
868 (const :tag "none" nil)
b34aa0a3 869 (const :tag "fast lock" fast-lock-mode)
e7f07c2c
GM
870 (const :tag "lazy lock" lazy-lock-mode)
871 (const :tag "JIT lock" jit-lock-mode)))
b34aa0a3 872 ))
c69e5fcd 873 :version "21.1"
55015061 874 :group 'font-lock)
5aa29679 875
7f0d55f2
SM
876(defvar fast-lock-mode)
877(defvar lazy-lock-mode)
878(defvar jit-lock-mode)
2e6a15fc 879
5aa29679
RS
880(defun font-lock-turn-on-thing-lock ()
881 (let ((thing-mode (font-lock-value-in-major-mode font-lock-support-mode)))
882 (cond ((eq thing-mode 'fast-lock-mode)
883 (fast-lock-mode t))
884 ((eq thing-mode 'lazy-lock-mode)
e7f07c2c
GM
885 (lazy-lock-mode t))
886 ((eq thing-mode 'jit-lock-mode)
28a53bc1
SM
887 ;; Prepare for jit-lock
888 (remove-hook 'after-change-functions
889 'font-lock-after-change-function t)
890 (set (make-local-variable 'font-lock-fontify-buffer-function)
fd612dd9 891 'jit-lock-refontify)
c711faac 892 ;; Don't fontify eagerly (and don't abort if the buffer is large).
28a53bc1
SM
893 (set (make-local-variable 'font-lock-fontified) t)
894 ;; Use jit-lock.
895 (jit-lock-register 'font-lock-fontify-region
4cffd221
SM
896 (not font-lock-keywords-only))
897 ;; Tell jit-lock how we extend the region to refontify.
898 (add-hook 'jit-lock-after-change-extend-region-functions
899 'font-lock-extend-jit-lock-region-after-change
900 nil t)))))
5aa29679 901
5aa29679 902(defun font-lock-turn-off-thing-lock ()
7f0d55f2 903 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
1c172af4 904 (fast-lock-mode -1))
7f0d55f2 905 ((and (boundp 'jit-lock-mode) jit-lock-mode)
28a53bc1
SM
906 (jit-lock-unregister 'font-lock-fontify-region)
907 ;; Reset local vars to the non-jit-lock case.
908 (kill-local-variable 'font-lock-fontify-buffer-function))
7f0d55f2 909 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
1c172af4 910 (lazy-lock-mode -1))))
5aa29679
RS
911
912(defun font-lock-after-fontify-buffer ()
7f0d55f2 913 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
5aa29679 914 (fast-lock-after-fontify-buffer))
13f0d185
SM
915 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
916 ;; (jit-lock-mode
917 ;; (jit-lock-after-fontify-buffer))
7f0d55f2 918 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
5aa29679
RS
919 (lazy-lock-after-fontify-buffer))))
920
921(defun font-lock-after-unfontify-buffer ()
7f0d55f2 922 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
5aa29679 923 (fast-lock-after-unfontify-buffer))
13f0d185
SM
924 ;; Useless as well. It's only called when:
925 ;; - turning off font-lock: it does not matter if we leave spurious
926 ;; `fontified' text props around since jit-lock-mode is also off.
927 ;; - font-lock-default-fontify-buffer fails: this is not run
928 ;; any more anyway. -sm
5e9e032a 929 ;;
13f0d185
SM
930 ;; (jit-lock-mode
931 ;; (jit-lock-after-unfontify-buffer))
7f0d55f2 932 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
5aa29679
RS
933 (lazy-lock-after-unfontify-buffer))))
934
2d63aa67 935;;; End of Font Lock Support mode.
5aa29679 936\f
2d63aa67 937;;; Fontification functions.
a1eb1cf1 938
56fcbd7e
SM
939;; Rather than the function, e.g., `font-lock-fontify-region' containing the
940;; code to fontify a region, the function runs the function whose name is the
941;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
942;; the value of this variable is, e.g., `font-lock-default-fontify-region'
943;; which does contain the code to fontify a region. However, the value of the
944;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
945;; do anything. The indirection of the fontification functions gives major
946;; modes the capability of modifying the way font-lock.el fontifies. Major
947;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
948;; via the variable `font-lock-defaults'.
949;;
950;; For example, Rmail mode sets the variable `font-lock-defaults' so that
951;; font-lock.el uses its own function for buffer fontification. This function
952;; makes fontification be on a message-by-message basis and so visiting an
953;; RMAIL file is much faster. A clever implementation of the function might
954;; fontify the headers differently than the message body. (It should, and
955;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
956;; you?) This hints at a more interesting use...
957;;
958;; Languages that contain text normally contained in different major modes
959;; could define their own fontification functions that treat text differently
960;; depending on its context. For example, Perl mode could arrange that here
961;; docs are fontified differently than Perl code. Or Yacc mode could fontify
962;; rules one way and C code another. Neat!
963;;
964;; A further reason to use the fontification indirection feature is when the
965;; default syntactual fontification, or the default fontification in general,
966;; is not flexible enough for a particular major mode. For example, perhaps
55015061
SM
967;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
968;; cope with. You need to write your own version of that function, e.g.,
969;; `hairy-fontify-syntactically-region', and make your own version of
970;; `hairy-fontify-region' call that function before calling
56fcbd7e
SM
971;; `font-lock-fontify-keywords-region' for the normal regexp fontification
972;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
973;; would call your region fontification function instead of its own. For
55015061 974;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
56fcbd7e
SM
975;; directives correctly and cleanly. (It is the same problem as fontifying
976;; multi-line strings and comments; regexps are not appropriate for the job.)
977
2821e1b6
SM
978(defvar font-lock-extend-region-function nil
979 "A function that determines the region to fontify after a change.
980
981This variable is either nil, or is a function that determines the
982region to refontify after a change.
983It is usually set by the major mode via `font-lock-defaults'.
984Font-lock calls this function after each buffer change.
985
986The function is given three parameters, the standard BEG, END, and OLD-LEN
987from `after-change-functions'. It should return either a cons of the beginning
988and end buffer positions \(in that order) of the region to fontify, or nil
989\(which directs the caller to fontify a default region). This function
990should preserve point and the match-data.
991The region it returns may start or end in the middle of a line.")
992
993(defun font-lock-extend-region (beg end old-len)
994 "Determine the region to fontify after a buffer change.
995
996BEG END and OLD-LEN are the standard parameters from `after-change-functions'.
997The return value is either nil \(which directs the caller to chose the region
998itself), or a cons of the beginning and end \(in that order) of the region.
999The region returned may start or end in the middle of a line."
1000 (if font-lock-extend-region-function
1001 (funcall font-lock-extend-region-function beg end old-len)))
1002
030f4a35 1003(defun font-lock-fontify-buffer ()
019f00d8 1004 "Fontify the current buffer the way the function `font-lock-mode' would."
030f4a35 1005 (interactive)
1c360af3 1006 (font-lock-set-defaults)
a2b8e66b
SM
1007 (let ((font-lock-verbose (or font-lock-verbose (interactive-p))))
1008 (funcall font-lock-fontify-buffer-function)))
1009
1010(defun font-lock-unfontify-buffer ()
1011 (funcall font-lock-unfontify-buffer-function))
1012
1013(defun font-lock-fontify-region (beg end &optional loudly)
1c360af3 1014 (font-lock-set-defaults)
a2b8e66b
SM
1015 (funcall font-lock-fontify-region-function beg end loudly))
1016
1017(defun font-lock-unfontify-region (beg end)
516eb29c
SM
1018 (save-buffer-state nil
1019 (funcall font-lock-unfontify-region-function beg end)))
a2b8e66b
SM
1020
1021(defun font-lock-default-fontify-buffer ()
5aa29679
RS
1022 (let ((verbose (if (numberp font-lock-verbose)
1023 (> (buffer-size) font-lock-verbose)
1024 font-lock-verbose)))
79f238c9 1025 (with-temp-message
1787769b
SM
1026 (when verbose
1027 (format "Fontifying %s..." (buffer-name)))
79f238c9
SM
1028 ;; Make sure we fontify etc. in the whole buffer.
1029 (save-restriction
1030 (widen)
1031 (condition-case nil
1032 (save-excursion
1033 (save-match-data
1034 (font-lock-fontify-region (point-min) (point-max) verbose)
1035 (font-lock-after-fontify-buffer)
1036 (setq font-lock-fontified t)))
1037 ;; We don't restore the old fontification, so it's best to unfontify.
8259bf10 1038 (quit (font-lock-unfontify-buffer)))))))
7d7d915a 1039
a2b8e66b 1040(defun font-lock-default-unfontify-buffer ()
56fcbd7e 1041 ;; Make sure we unfontify etc. in the whole buffer.
a2b8e66b
SM
1042 (save-restriction
1043 (widen)
1044 (font-lock-unfontify-region (point-min) (point-max))
271c888a 1045 (font-lock-after-unfontify-buffer)
a2b8e66b 1046 (setq font-lock-fontified nil)))
9bfbb130 1047
7f0d55f2
SM
1048(defvar font-lock-dont-widen nil
1049 "If non-nil, font-lock will work on the non-widened buffer.
1050Useful for things like RMAIL and Info where the whole buffer is not
1051a very meaningful entity to highlight.")
1052
a2b8e66b 1053(defun font-lock-default-fontify-region (beg end loudly)
ac6e572c 1054 (save-buffer-state
8a2a6535
SM
1055 ((parse-sexp-lookup-properties
1056 (or parse-sexp-lookup-properties font-lock-syntactic-keywords))
ac6e572c 1057 (old-syntax-table (syntax-table)))
876f2438 1058 (unwind-protect
a078558d 1059 (save-restriction
7f0d55f2 1060 (unless font-lock-dont-widen (widen))
876f2438 1061 ;; Use the fontification syntax table, if any.
2e6a15fc
SM
1062 (when font-lock-syntax-table
1063 (set-syntax-table font-lock-syntax-table))
a9efeb1d 1064 (goto-char beg)
ef008321 1065 (setq beg (line-beginning-position))
fb0e4f8a
RS
1066 ;; check to see if we should expand the beg/end area for
1067 ;; proper multiline matches
5ae158bf 1068 (when (and (> beg (point-min))
28a53bc1
SM
1069 (get-text-property (1- beg) 'font-lock-multiline))
1070 ;; We are just after or in a multiline match.
1071 (setq beg (or (previous-single-property-change
1072 beg 'font-lock-multiline)
ba22aeff
SM
1073 (point-min)))
1074 (goto-char beg)
1075 (setq beg (line-beginning-position)))
5ae158bf
SM
1076 (setq end (or (text-property-any end (point-max)
1077 'font-lock-multiline nil)
1078 (point-max)))
ba22aeff 1079 (goto-char end)
5d4247d3
SM
1080 ;; Round up to a whole line.
1081 (unless (bolp) (setq end (line-beginning-position 2)))
876f2438 1082 ;; Now do the fontification.
2e6a15fc 1083 (font-lock-unfontify-region beg end)
ac6e572c
SM
1084 (when font-lock-syntactic-keywords
1085 (font-lock-fontify-syntactic-keywords-region beg end))
2e6a15fc 1086 (unless font-lock-keywords-only
876f2438
SM
1087 (font-lock-fontify-syntactically-region beg end loudly))
1088 (font-lock-fontify-keywords-region beg end loudly))
1089 ;; Clean up.
2e6a15fc 1090 (set-syntax-table old-syntax-table))))
9bfbb130
SM
1091
1092;; The following must be rethought, since keywords can override fontification.
5d4247d3
SM
1093;; ;; Now scan for keywords, but not if we are inside a comment now.
1094;; (or (and (not font-lock-keywords-only)
1095;; (let ((state (parse-partial-sexp beg end nil nil
1096;; font-lock-cache-state)))
1097;; (or (nth 4 state) (nth 7 state))))
1098;; (font-lock-fontify-keywords-region beg end))
9bfbb130 1099
8259bf10
SM
1100(defvar font-lock-extra-managed-props nil
1101 "Additional text properties managed by font-lock.
1102This is used by `font-lock-default-unfontify-region' to decide
4c02ca46 1103what properties to clear before refontifying a region.")
8259bf10 1104
a2b8e66b 1105(defun font-lock-default-unfontify-region (beg end)
516eb29c
SM
1106 (remove-list-of-text-properties
1107 beg end (append
1108 font-lock-extra-managed-props
1109 (if font-lock-syntactic-keywords
1110 '(syntax-table face font-lock-multiline)
1111 '(face font-lock-multiline)))))
9bfbb130
SM
1112
1113;; Called when any modification is made to buffer text.
1114(defun font-lock-after-change-function (beg end old-len)
14e2791a 1115 (let ((inhibit-point-motion-hooks t)
ef008321
AM
1116 (inhibit-quit t)
1117 (region (font-lock-extend-region beg end old-len)))
46f26fcf
SM
1118 (save-excursion
1119 (save-match-data
ef008321
AM
1120 (if region
1121 ;; Fontify the region the major mode has specified.
1122 (setq beg (car region) end (cdr region))
1123 ;; Fontify the whole lines which enclose the region.
4ffc92c2
SM
1124 (setq beg (progn (goto-char beg) (line-beginning-position))
1125 end (progn (goto-char end) (line-beginning-position 2))))
ef008321 1126 (font-lock-fontify-region beg end)))))
a2b8e66b 1127
4cffd221
SM
1128(defvar jit-lock-start) (defvar jit-lock-end)
1129(defun font-lock-extend-jit-lock-region-after-change (beg end old-len)
1130 (let ((region (font-lock-extend-region beg end old-len)))
1131 (if region
1132 (setq jit-lock-start (min jit-lock-start (car region))
1133 jit-lock-end (max jit-lock-end (cdr region)))
1134 (save-excursion
1135 (goto-char beg)
1136 (forward-line 0)
1137 (setq jit-lock-start
1138 (min jit-lock-start
1139 (if (and (not (eobp))
1140 (get-text-property (point) 'font-lock-multiline))
1141 (or (previous-single-property-change
1142 (point) 'font-lock-multiline)
1143 (point-min))
1144 (point))))
1145 (goto-char end)
1146 (forward-line 1)
1147 (setq jit-lock-end
1148 (max jit-lock-end
1149 (if (and (not (bobp))
1150 (get-text-property (1- (point))
1151 'font-lock-multiline))
1152 (or (next-single-property-change
1153 (1- (point)) 'font-lock-multiline)
1154 (point-max))
1155 (point))))))))
1156
a078558d
SM
1157(defun font-lock-fontify-block (&optional arg)
1158 "Fontify some lines the way `font-lock-fontify-buffer' would.
1159The lines could be a function or paragraph, or a specified number of lines.
a078558d 1160If ARG is given, fontify that many lines before and after point, or 16 lines if
a465832f
SM
1161no ARG is given and `font-lock-mark-block-function' is nil.
1162If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1163delimit the region to fontify."
a078558d 1164 (interactive "P")
46f26fcf
SM
1165 (let ((inhibit-point-motion-hooks t) font-lock-beginning-of-syntax-function
1166 deactivate-mark)
a078558d
SM
1167 ;; Make sure we have the right `font-lock-keywords' etc.
1168 (if (not font-lock-mode) (font-lock-set-defaults))
a2b8e66b
SM
1169 (save-excursion
1170 (save-match-data
1171 (condition-case error-data
a078558d
SM
1172 (if (or arg (not font-lock-mark-block-function))
1173 (let ((lines (if arg (prefix-numeric-value arg) 16)))
1174 (font-lock-fontify-region
1175 (save-excursion (forward-line (- lines)) (point))
1176 (save-excursion (forward-line lines) (point))))
1177 (funcall font-lock-mark-block-function)
1178 (font-lock-fontify-region (point) (mark)))
6c0fc428 1179 ((error quit) (message "Fontifying block...%s" error-data)))))))
a078558d 1180
407f5edd
LT
1181(unless (featurep 'facemenu)
1182 (error "facemenu must be loaded before font-lock"))
1183(define-key facemenu-keymap "\M-o" 'font-lock-fontify-block)
2d63aa67
SM
1184
1185;;; End of Fontification functions.
9bfbb130 1186\f
9bfbb130
SM
1187;;; Additional text property functions.
1188
1c626aaf
SM
1189;; The following text property functions should be builtins. This means they
1190;; should be written in C and put with all the other text property functions.
1191;; In the meantime, those that are used by font-lock.el are defined in Lisp
1192;; below and given a `font-lock-' prefix. Those that are not used are defined
1193;; in Lisp below and commented out. sm.
9bfbb130 1194
1c626aaf 1195(defun font-lock-prepend-text-property (start end prop value &optional object)
9bfbb130
SM
1196 "Prepend to one property of the text from START to END.
1197Arguments PROP and VALUE specify the property and value to prepend to the value
1c626aaf 1198already in place. The resulting property values are always lists.
9bfbb130
SM
1199Optional argument OBJECT is the string or buffer containing the text."
1200 (let ((val (if (listp value) value (list value))) next prev)
1201 (while (/= start end)
1202 (setq next (next-single-property-change start prop object end)
1203 prev (get-text-property start prop object))
1c626aaf
SM
1204 (put-text-property start next prop
1205 (append val (if (listp prev) prev (list prev)))
1206 object)
9bfbb130
SM
1207 (setq start next))))
1208
1c626aaf 1209(defun font-lock-append-text-property (start end prop value &optional object)
9bfbb130
SM
1210 "Append to one property of the text from START to END.
1211Arguments PROP and VALUE specify the property and value to append to the value
1c626aaf 1212already in place. The resulting property values are always lists.
9bfbb130
SM
1213Optional argument OBJECT is the string or buffer containing the text."
1214 (let ((val (if (listp value) value (list value))) next prev)
1215 (while (/= start end)
1216 (setq next (next-single-property-change start prop object end)
1217 prev (get-text-property start prop object))
1c626aaf
SM
1218 (put-text-property start next prop
1219 (append (if (listp prev) prev (list prev)) val)
1220 object)
9bfbb130 1221 (setq start next))))
1c626aaf
SM
1222
1223(defun font-lock-fillin-text-property (start end prop value &optional object)
1224 "Fill in one property of the text from START to END.
1225Arguments PROP and VALUE specify the property and value to put where none are
1226already in place. Therefore existing property values are not overwritten.
1227Optional argument OBJECT is the string or buffer containing the text."
1228 (let ((start (text-property-any start end prop nil object)) next)
1229 (while start
1230 (setq next (next-single-property-change start prop object end))
1231 (put-text-property start next prop value object)
1232 (setq start (text-property-any next end prop nil object)))))
1233
1234;; For completeness: this is to `remove-text-properties' as `put-text-property'
1235;; is to `add-text-properties', etc.
d55c4199
SM
1236;;(defun remove-text-property (start end property &optional object)
1237;; "Remove a property from text from START to END.
1238;;Argument PROPERTY is the property to remove.
1239;;Optional argument OBJECT is the string or buffer containing the text.
1240;;Return t if the property was actually removed, nil otherwise."
1241;; (remove-text-properties start end (list property) object))
1c626aaf
SM
1242
1243;; For consistency: maybe this should be called `remove-single-property' like
1244;; `next-single-property-change' (not `next-single-text-property-change'), etc.
d55c4199
SM
1245;;(defun remove-single-text-property (start end prop value &optional object)
1246;; "Remove a specific property value from text from START to END.
1247;;Arguments PROP and VALUE specify the property and value to remove. The
1248;;resulting property values are not equal to VALUE nor lists containing VALUE.
1249;;Optional argument OBJECT is the string or buffer containing the text."
1250;; (let ((start (text-property-not-all start end prop nil object)) next prev)
1251;; (while start
1252;; (setq next (next-single-property-change start prop object end)
1253;; prev (get-text-property start prop object))
1254;; (cond ((and (symbolp prev) (eq value prev))
1255;; (remove-text-property start next prop object))
1256;; ((and (listp prev) (memq value prev))
1257;; (let ((new (delq value prev)))
1258;; (cond ((null new)
1259;; (remove-text-property start next prop object))
1260;; ((= (length new) 1)
1261;; (put-text-property start next prop (car new) object))
1262;; (t
1263;; (put-text-property start next prop new object))))))
1264;; (setq start (text-property-not-all next end prop nil object)))))
2d63aa67
SM
1265
1266;;; End of Additional text property functions.
9bfbb130 1267\f
ac6e572c
SM
1268;;; Syntactic regexp fontification functions.
1269
1270;; These syntactic keyword pass functions are identical to those keyword pass
1271;; functions below, with the following exceptions; (a) they operate on
1272;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1273;; is less of an issue, (c) eval of property value does not occur JIT as speed
1274;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1275;; makes no sense for `syntax-table' property values, (e) they do not do it
1276;; LOUDLY as it is not likely to be intensive.
1277
1278(defun font-lock-apply-syntactic-highlight (highlight)
1279 "Apply HIGHLIGHT following a match.
1280HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1281see `font-lock-syntactic-keywords'."
1282 (let* ((match (nth 0 highlight))
1283 (start (match-beginning match)) (end (match-end match))
1284 (value (nth 1 highlight))
1285 (override (nth 2 highlight)))
8259bf10
SM
1286 (if (not start)
1287 ;; No match but we might not signal an error.
1288 (or (nth 3 highlight)
1289 (error "No match %d in highlight %S" match highlight))
1290 (when (and (consp value) (not (numberp (car value))))
1291 (setq value (eval value)))
1292 (when (stringp value) (setq value (string-to-syntax value)))
1293 ;; Flush the syntax-cache. I believe this is not necessary for
1294 ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can
1295 ;; still be necessary for other users of syntax-ppss anyway.
1296 (syntax-ppss-after-change-function start)
1297 (cond
1298 ((not override)
1299 ;; Cannot override existing fontification.
1300 (or (text-property-not-all start end 'syntax-table nil)
1301 (put-text-property start end 'syntax-table value)))
1302 ((eq override t)
1303 ;; Override existing fontification.
1304 (put-text-property start end 'syntax-table value))
1305 ((eq override 'keep)
1306 ;; Keep existing fontification.
1307 (font-lock-fillin-text-property start end 'syntax-table value))))))
ac6e572c
SM
1308
1309(defun font-lock-fontify-syntactic-anchored-keywords (keywords limit)
1310 "Fontify according to KEYWORDS until LIMIT.
1311KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1312LIMIT can be modified by the value of its PRE-MATCH-FORM."
1313 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
1314 ;; Evaluate PRE-MATCH-FORM.
1315 (pre-match-value (eval (nth 1 keywords))))
1316 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1317 (if (and (numberp pre-match-value) (> pre-match-value (point)))
1318 (setq limit pre-match-value)
6e1d0d15 1319 (setq limit (line-end-position)))
ac6e572c
SM
1320 (save-match-data
1321 ;; Find an occurrence of `matcher' before `limit'.
1322 (while (if (stringp matcher)
1323 (re-search-forward matcher limit t)
1324 (funcall matcher limit))
1325 ;; Apply each highlight to this instance of `matcher'.
1326 (setq highlights lowdarks)
1327 (while highlights
1328 (font-lock-apply-syntactic-highlight (car highlights))
1329 (setq highlights (cdr highlights)))))
1330 ;; Evaluate POST-MATCH-FORM.
1331 (eval (nth 2 keywords))))
1332
1333(defun font-lock-fontify-syntactic-keywords-region (start end)
1334 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1335START should be at the beginning of a line."
c0a6a9fe
SM
1336 ;; Ensure the beginning of the file is properly syntactic-fontified.
1337 (when (and font-lock-syntactically-fontified
1338 (< font-lock-syntactically-fontified start))
1339 (setq start (max font-lock-syntactically-fontified (point-min)))
1340 (setq font-lock-syntactically-fontified end))
ac6e572c
SM
1341 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1342 (when (symbolp font-lock-syntactic-keywords)
1343 (setq font-lock-syntactic-keywords (font-lock-eval-keywords
1344 font-lock-syntactic-keywords)))
1345 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1346 (unless (eq (car font-lock-syntactic-keywords) t)
1347 (setq font-lock-syntactic-keywords (font-lock-compile-keywords
1348 font-lock-syntactic-keywords)))
1349 ;; Get down to business.
1350 (let ((case-fold-search font-lock-keywords-case-fold-search)
0715d1a4 1351 (keywords (cddr font-lock-syntactic-keywords))
ac6e572c
SM
1352 keyword matcher highlights)
1353 (while keywords
1354 ;; Find an occurrence of `matcher' from `start' to `end'.
1355 (setq keyword (car keywords) matcher (car keyword))
1356 (goto-char start)
1357 (while (if (stringp matcher)
1358 (re-search-forward matcher end t)
1359 (funcall matcher end))
1360 ;; Apply each highlight to this instance of `matcher', which may be
1361 ;; specific highlights or more keywords anchored to `matcher'.
1362 (setq highlights (cdr keyword))
1363 (while highlights
1364 (if (numberp (car (car highlights)))
1365 (font-lock-apply-syntactic-highlight (car highlights))
1366 (font-lock-fontify-syntactic-anchored-keywords (car highlights)
1367 end))
1368 (setq highlights (cdr highlights))))
1369 (setq keywords (cdr keywords)))))
1370
1371;;; End of Syntactic regexp fontification functions.
1372\f
1373;;; Syntactic fontification functions.
1374
7435a76b
RS
1375(defvar font-lock-comment-start-skip nil
1376 "If non-nil, Font Lock mode uses this instead of `comment-start-skip'.")
1377
1378(defvar font-lock-comment-end-skip nil
1379 "If non-nil, Font Lock mode uses this instead of `comment-end'.")
1380
8259bf10 1381(defun font-lock-fontify-syntactically-region (start end &optional loudly ppss)
ac6e572c
SM
1382 "Put proper face on each string and comment between START and END.
1383START should be at the beginning of a line."
90cbc9cd 1384 (let ((comment-end-regexp
7435a76b
RS
1385 (or font-lock-comment-end-skip
1386 (regexp-quote
1387 (replace-regexp-in-string "^ *" "" comment-end))))
90cbc9cd 1388 state face beg)
ac6e572c
SM
1389 (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
1390 (goto-char start)
1391 ;;
7ae3cc71 1392 ;; Find the `start' state.
47fc2db3 1393 (setq state (or ppss (syntax-ppss start)))
ac6e572c
SM
1394 ;;
1395 ;; Find each interesting place between here and `end'.
8259bf10
SM
1396 (while
1397 (progn
1398 (when (or (nth 3 state) (nth 4 state))
1399 (setq face (funcall font-lock-syntactic-face-function state))
1400 (setq beg (max (nth 8 state) start))
1401 (setq state (parse-partial-sexp (point) end nil nil state
1402 'syntax-table))
a4479657 1403 (when face (put-text-property beg (point) 'face face))
90cbc9cd 1404 (when (and (eq face 'font-lock-comment-face)
7435a76b
RS
1405 (or font-lock-comment-start-skip
1406 comment-start-skip))
a4479657
RS
1407 ;; Find the comment delimiters
1408 ;; and use font-lock-comment-delimiter-face for them.
1409 (save-excursion
1410 (goto-char beg)
7435a76b
RS
1411 (if (looking-at (or font-lock-comment-start-skip
1412 comment-start-skip))
a4479657 1413 (put-text-property beg (match-end 0) 'face
90cbc9cd 1414 font-lock-comment-delimiter-face)))
a1594703 1415 (if (looking-back comment-end-regexp (point-at-bol) t)
a4479657 1416 (put-text-property (match-beginning 0) (point) 'face
90cbc9cd 1417 font-lock-comment-delimiter-face))))
6ce66ffe
SM
1418 (< (point) end))
1419 (setq state (parse-partial-sexp (point) end nil nil state
1420 'syntax-table)))))
ac6e572c
SM
1421
1422;;; End of Syntactic fontification functions.
1423\f
1424;;; Keyword regexp fontification functions.
9bfbb130
SM
1425
1426(defsubst font-lock-apply-highlight (highlight)
1427 "Apply HIGHLIGHT following a match.
1428HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1429 (let* ((match (nth 0 highlight))
1430 (start (match-beginning match)) (end (match-end match))
1431 (override (nth 2 highlight)))
8259bf10
SM
1432 (if (not start)
1433 ;; No match but we might not signal an error.
1434 (or (nth 3 highlight)
1435 (error "No match %d in highlight %S" match highlight))
1436 (let ((val (eval (nth 1 highlight))))
1437 (when (eq (car-safe val) 'face)
1438 (add-text-properties start end (cddr val))
1439 (setq val (cadr val)))
1440 (cond
a5f48305 1441 ((not (or val (eq override t)))
6b7f3491
SM
1442 ;; If `val' is nil, don't do anything. It is important to do it
1443 ;; explicitly, because when adding nil via things like
1444 ;; font-lock-append-text-property, the property is actually
1445 ;; changed from <face> to (<face>) which is undesirable. --Stef
1446 nil)
8259bf10
SM
1447 ((not override)
1448 ;; Cannot override existing fontification.
1449 (or (text-property-not-all start end 'face nil)
1450 (put-text-property start end 'face val)))
1451 ((eq override t)
1452 ;; Override existing fontification.
1453 (put-text-property start end 'face val))
1454 ((eq override 'prepend)
1455 ;; Prepend to existing fontification.
1456 (font-lock-prepend-text-property start end 'face val))
1457 ((eq override 'append)
1458 ;; Append to existing fontification.
1459 (font-lock-append-text-property start end 'face val))
1460 ((eq override 'keep)
1461 ;; Keep existing fontification.
1462 (font-lock-fillin-text-property start end 'face val)))))))
9bfbb130
SM
1463
1464(defsubst font-lock-fontify-anchored-keywords (keywords limit)
1465 "Fontify according to KEYWORDS until LIMIT.
56fcbd7e
SM
1466KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1467LIMIT can be modified by the value of its PRE-MATCH-FORM."
1468 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
fb0e4f8a 1469 (lead-start (match-beginning 0))
56fcbd7e
SM
1470 ;; Evaluate PRE-MATCH-FORM.
1471 (pre-match-value (eval (nth 1 keywords))))
1472 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
fb0e4f8a 1473 (if (not (and (numberp pre-match-value) (> pre-match-value (point))))
6e1d0d15 1474 (setq limit (line-end-position))
fb0e4f8a 1475 (setq limit pre-match-value)
ba22aeff 1476 (when (and font-lock-multiline (>= limit (line-beginning-position 2)))
fb0e4f8a 1477 ;; this is a multiline anchored match
ba22aeff
SM
1478 ;; (setq font-lock-multiline t)
1479 (put-text-property (if (= limit (line-beginning-position 2))
1480 (1- limit)
1481 (min lead-start (point)))
1482 limit
28a53bc1 1483 'font-lock-multiline t)))
9bfbb130 1484 (save-match-data
876f2438 1485 ;; Find an occurrence of `matcher' before `limit'.
afa18a4e
SM
1486 (while (and (< (point) limit)
1487 (if (stringp matcher)
1488 (re-search-forward matcher limit t)
1489 (funcall matcher limit)))
876f2438 1490 ;; Apply each highlight to this instance of `matcher'.
9bfbb130
SM
1491 (setq highlights lowdarks)
1492 (while highlights
1493 (font-lock-apply-highlight (car highlights))
1494 (setq highlights (cdr highlights)))))
876f2438 1495 ;; Evaluate POST-MATCH-FORM.
9bfbb130
SM
1496 (eval (nth 2 keywords))))
1497
1498(defun font-lock-fontify-keywords-region (start end &optional loudly)
1499 "Fontify according to `font-lock-keywords' between START and END.
7f0d55f2
SM
1500START should be at the beginning of a line.
1501LOUDLY, if non-nil, allows progress-meter bar."
ac6e572c 1502 (unless (eq (car font-lock-keywords) t)
2d5eba0e
SM
1503 (setq font-lock-keywords
1504 (font-lock-compile-keywords font-lock-keywords t)))
9bfbb130 1505 (let ((case-fold-search font-lock-keywords-case-fold-search)
69968400 1506 (keywords (cddr font-lock-keywords))
9bfbb130 1507 (bufname (buffer-name)) (count 0)
b71813cb 1508 (pos (make-marker))
876f2438
SM
1509 keyword matcher highlights)
1510 ;;
1511 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1512 (while keywords
1513 (if loudly (message "Fontifying %s... (regexps..%s)" bufname
2e6a15fc 1514 (make-string (incf count) ?.)))
9bfbb130 1515 ;;
876f2438
SM
1516 ;; Find an occurrence of `matcher' from `start' to `end'.
1517 (setq keyword (car keywords) matcher (car keyword))
1518 (goto-char start)
e7f07c2c
GM
1519 (while (and (< (point) end)
1520 (if (stringp matcher)
1521 (re-search-forward matcher end t)
8a08764f
SM
1522 (funcall matcher end))
1523 ;; Beware empty string matches since they will
1524 ;; loop indefinitely.
1525 (or (> (point) (match-beginning 0))
1526 (progn (forward-char 1) t)))
041470d2 1527 (when (and font-lock-multiline
ba22aeff
SM
1528 (>= (point)
1529 (save-excursion (goto-char (match-beginning 0))
1530 (forward-line 1) (point))))
fb0e4f8a 1531 ;; this is a multiline regexp match
ba22aeff
SM
1532 ;; (setq font-lock-multiline t)
1533 (put-text-property (if (= (point)
1534 (save-excursion
1535 (goto-char (match-beginning 0))
1536 (forward-line 1) (point)))
1537 (1- (point))
1538 (match-beginning 0))
1539 (point)
fb0e4f8a 1540 'font-lock-multiline t))
876f2438
SM
1541 ;; Apply each highlight to this instance of `matcher', which may be
1542 ;; specific highlights or more keywords anchored to `matcher'.
1543 (setq highlights (cdr keyword))
1544 (while highlights
1545 (if (numberp (car (car highlights)))
1546 (font-lock-apply-highlight (car highlights))
b71813cb
SM
1547 (set-marker pos (point))
1548 (font-lock-fontify-anchored-keywords (car highlights) end)
1549 ;; Ensure forward progress. `pos' is a marker because anchored
1550 ;; keyword may add/delete text (this happens e.g. in grep.el).
1551 (if (< (point) pos) (goto-char pos)))
876f2438 1552 (setq highlights (cdr highlights))))
b71813cb
SM
1553 (setq keywords (cdr keywords)))
1554 (set-marker pos nil)))
2d63aa67 1555
ac6e572c 1556;;; End of Keyword regexp fontification functions.
9bfbb130
SM
1557\f
1558;; Various functions.
1559
2d5eba0e 1560(defun font-lock-compile-keywords (keywords &optional regexp)
69968400
RS
1561 "Compile KEYWORDS into the form (t KEYWORDS COMPILED...)
1562Here each COMPILED is of the form (MATCHER HIGHLIGHT ...) as shown in the
2d5eba0e
SM
1563`font-lock-keywords' doc string.
1564If REGEXP is non-nil, it means these keywords are used for
1565`font-lock-keywords' rather than for `font-lock-syntactic-keywords'."
af3d4246
SM
1566 (if (not font-lock-set-defaults)
1567 ;; This should never happen. But some external packages sometimes
1568 ;; call font-lock in unexpected and incorrect ways. It's important to
1569 ;; stop processing at this point, otherwise we may end up changing the
1570 ;; global value of font-lock-keywords and break highlighting in many
1571 ;; other buffers.
1572 (error "Font-lock trying to use keywords before setting them up"))
55015061
SM
1573 (if (eq (car-safe keywords) t)
1574 keywords
69968400
RS
1575 (setq keywords
1576 (cons t (cons keywords
1577 (mapcar 'font-lock-compile-keyword keywords))))
2d5eba0e
SM
1578 (if (and regexp
1579 (eq (or syntax-begin-function
1580 font-lock-beginning-of-syntax-function)
1581 'beginning-of-defun)
1582 (not beginning-of-defun-function))
1583 ;; Try to detect when a string or comment contains something that
1584 ;; looks like a defun and would thus confuse font-lock.
1585 (nconc keywords
1586 `((,(if defun-prompt-regexp
1587 (concat "^\\(?:" defun-prompt-regexp "\\)?\\s(")
1588 "^\\s(")
1589 (0
048aac39 1590 (if (memq (get-text-property (match-beginning 0) 'face)
2d5eba0e
SM
1591 '(font-lock-string-face font-lock-doc-face
1592 font-lock-comment-face))
d55c4199
SM
1593 (list 'face font-lock-warning-face
1594 'help-echo "Looks like a toplevel defun: escape the parenthesis"))
2d5eba0e
SM
1595 prepend)))))
1596 keywords))
a2b8e66b
SM
1597
1598(defun font-lock-compile-keyword (keyword)
c1f2ffc8 1599 (cond ((nlistp keyword) ; MATCHER
a2b8e66b 1600 (list keyword '(0 font-lock-keyword-face)))
c1f2ffc8 1601 ((eq (car keyword) 'eval) ; (eval . FORM)
a2b8e66b 1602 (font-lock-compile-keyword (eval (cdr keyword))))
c1f2ffc8
SM
1603 ((eq (car-safe (cdr keyword)) 'quote) ; (MATCHER . 'FORM)
1604 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1605 (if (symbolp (nth 2 keyword))
1606 (list (car keyword) (list 0 (cdr keyword)))
1607 (font-lock-compile-keyword (cons (car keyword) (nth 2 keyword)))))
1608 ((numberp (cdr keyword)) ; (MATCHER . MATCH)
a2b8e66b 1609 (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
c1f2ffc8 1610 ((symbolp (cdr keyword)) ; (MATCHER . FACENAME)
a2b8e66b 1611 (list (car keyword) (list 0 (cdr keyword))))
c1f2ffc8 1612 ((nlistp (nth 1 keyword)) ; (MATCHER . HIGHLIGHT)
a2b8e66b 1613 (list (car keyword) (cdr keyword)))
c1f2ffc8 1614 (t ; (MATCHER HIGHLIGHT ...)
a2b8e66b 1615 keyword)))
d46c21ec 1616
ac6e572c 1617(defun font-lock-eval-keywords (keywords)
019f00d8 1618 "Evalulate KEYWORDS if a function (funcall) or variable (eval) name."
46f26fcf
SM
1619 (if (listp keywords)
1620 keywords
1621 (font-lock-eval-keywords (if (fboundp keywords)
1622 (funcall keywords)
1623 (eval keywords)))))
ac6e572c 1624
343204bd 1625(defun font-lock-value-in-major-mode (alist)
019f00d8
DL
1626 "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1627Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
343204bd
SM
1628 (if (consp alist)
1629 (cdr (or (assq major-mode alist) (assq t alist)))
1630 alist))
1631
d46c21ec 1632(defun font-lock-choose-keywords (keywords level)
019f00d8
DL
1633 "Return LEVELth element of KEYWORDS.
1634A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1635\(1- (length KEYWORDS))."
fd612dd9 1636 (cond ((not (and (listp keywords) (symbolp (car keywords))))
343204bd
SM
1637 keywords)
1638 ((numberp level)
e0be77f6 1639 (or (nth level keywords) (car (last keywords))))
343204bd 1640 ((eq level t)
e0be77f6 1641 (car (last keywords)))
343204bd
SM
1642 (t
1643 (car keywords))))
d46c21ec 1644
f8115798
SM
1645(defvar font-lock-set-defaults nil) ; Whether we have set up defaults.
1646
bed88438 1647(defvar font-lock-mode-major-mode)
f8115798
SM
1648(defun font-lock-set-defaults ()
1649 "Set fontification defaults appropriately for this mode.
1650Sets various variables using `font-lock-defaults' (or, if nil, using
1651`font-lock-defaults-alist') and `font-lock-maximum-decoration'."
bed88438
LT
1652 ;; Set fontification defaults iff not previously set for correct major mode.
1653 (unless (and font-lock-set-defaults
1654 (eq font-lock-mode-major-mode major-mode))
12245009 1655 (setq font-lock-mode-major-mode major-mode)
f8115798
SM
1656 (set (make-local-variable 'font-lock-set-defaults) t)
1657 (make-local-variable 'font-lock-fontified)
1658 (make-local-variable 'font-lock-multiline)
1659 (let* ((defaults (or font-lock-defaults
7ea820e9
RS
1660 (cdr (assq major-mode
1661 (with-no-warnings
d55c4199 1662 font-lock-defaults-alist)))))
f8115798
SM
1663 (keywords
1664 (font-lock-choose-keywords (nth 0 defaults)
1665 (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1666 (local (cdr (assq major-mode font-lock-keywords-alist)))
1667 (removed-keywords
1668 (cdr-safe (assq major-mode font-lock-removed-keywords-alist))))
1669 (set (make-local-variable 'font-lock-defaults) defaults)
1670 ;; Syntactic fontification?
1671 (when (nth 1 defaults)
1672 (set (make-local-variable 'font-lock-keywords-only) t))
1673 ;; Case fold during regexp fontification?
1674 (when (nth 2 defaults)
1675 (set (make-local-variable 'font-lock-keywords-case-fold-search) t))
1676 ;; Syntax table for regexp and syntactic fontification?
1677 (when (nth 3 defaults)
1678 (set (make-local-variable 'font-lock-syntax-table)
1679 (copy-syntax-table (syntax-table)))
1680 (dolist (selem (nth 3 defaults))
1681 ;; The character to modify may be a single CHAR or a STRING.
1682 (let ((syntax (cdr selem)))
1683 (dolist (char (if (numberp (car selem))
1684 (list (car selem))
1685 (mapcar 'identity (car selem))))
1686 (modify-syntax-entry char syntax font-lock-syntax-table)))))
1687 ;; Syntax function for syntactic fontification?
1688 (when (nth 4 defaults)
1689 (set (make-local-variable 'font-lock-beginning-of-syntax-function)
1690 (nth 4 defaults)))
1691 ;; Variable alist?
1692 (dolist (x (nthcdr 5 defaults))
1693 (set (make-local-variable (car x)) (cdr x)))
69968400 1694 ;; Set up `font-lock-keywords' last because its value might depend
f8115798
SM
1695 ;; on other settings (e.g. font-lock-compile-keywords uses
1696 ;; font-lock-beginning-of-syntax-function).
1697 (set (make-local-variable 'font-lock-keywords)
69968400 1698 (font-lock-eval-keywords keywords))
f8115798
SM
1699 ;; Local fontification?
1700 (while local
1701 (font-lock-add-keywords nil (car (car local)) (cdr (car local)))
1702 (setq local (cdr local)))
1703 (when removed-keywords
69968400
RS
1704 (font-lock-remove-keywords nil removed-keywords))
1705 ;; Now compile the keywords.
1706 (unless (eq (car font-lock-keywords) t)
e0be77f6
SM
1707 (setq font-lock-keywords
1708 (font-lock-compile-keywords font-lock-keywords t))))))
030f4a35 1709\f
2d63aa67 1710;;; Colour etc. support.
9bfbb130 1711
d60b49ac
DN
1712;; Note that `defface' will not overwrite any faces declared above via
1713;; `custom-declare-face'.
9177dd93
RS
1714(defface font-lock-comment-face
1715 '((((class grayscale) (background light))
1716 (:foreground "DimGray" :weight bold :slant italic))
1717 (((class grayscale) (background dark))
1718 (:foreground "LightGray" :weight bold :slant italic))
1719 (((class color) (min-colors 88) (background light))
1720 (:foreground "Firebrick"))
1721 (((class color) (min-colors 88) (background dark))
1722 (:foreground "chocolate1"))
1723 (((class color) (min-colors 16) (background light))
1724 (:foreground "red"))
1725 (((class color) (min-colors 16) (background dark))
1726 (:foreground "red1"))
1727 (((class color) (min-colors 8) (background light))
1728 )
1729 (((class color) (min-colors 8) (background dark))
1730 )
1731 (t (:weight bold :slant italic)))
1732 "Font Lock mode face used to highlight comments."
a4deefed 1733 :group 'font-lock-faces)
bf2cea1d
SM
1734
1735(defface font-lock-comment-delimiter-face
3187cffc 1736 '((default :inherit font-lock-comment-face)
3989c3e7
SM
1737 (((class grayscale)))
1738 (((class color) (min-colors 16)))
3187cffc
SM
1739 (((class color) (min-colors 8) (background light))
1740 :foreground "red")
1741 (((class color) (min-colors 8) (background dark))
1742 :foreground "red1"))
bf2cea1d 1743 "Font Lock mode face used to highlight comment delimiters."
a4deefed 1744 :group 'font-lock-faces)
9177dd93 1745
55015061 1746(defface font-lock-string-face
a12d182a 1747 '((((class grayscale) (background light)) (:foreground "DimGray" :slant italic))
0cccb49d 1748 (((class grayscale) (background dark)) (:foreground "LightGray" :slant italic))
a12d182a
EZ
1749 (((class color) (min-colors 88) (background light)) (:foreground "RosyBrown"))
1750 (((class color) (min-colors 88) (background dark)) (:foreground "LightSalmon"))
1751 (((class color) (min-colors 16) (background light)) (:foreground "RosyBrown"))
1752 (((class color) (min-colors 16) (background dark)) (:foreground "LightSalmon"))
1753 (((class color) (min-colors 8)) (:foreground "green"))
0cccb49d 1754 (t (:slant italic)))
55015061 1755 "Font Lock mode face used to highlight strings."
a4deefed 1756 :group 'font-lock-faces)
55015061 1757
1c172af4
SM
1758(defface font-lock-doc-face
1759 '((t :inherit font-lock-string-face))
1760 "Font Lock mode face used to highlight documentation."
a4deefed 1761 :group 'font-lock-faces)
1c172af4 1762
55015061 1763(defface font-lock-keyword-face
a12d182a 1764 '((((class grayscale) (background light)) (:foreground "LightGray" :weight bold))
0cccb49d 1765 (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold))
a12d182a 1766 (((class color) (min-colors 88) (background light)) (:foreground "Purple"))
ea81d57e 1767 (((class color) (min-colors 88) (background dark)) (:foreground "Cyan1"))
a12d182a
EZ
1768 (((class color) (min-colors 16) (background light)) (:foreground "Purple"))
1769 (((class color) (min-colors 16) (background dark)) (:foreground "Cyan"))
1770 (((class color) (min-colors 8)) (:foreground "cyan" :weight bold))
0cccb49d 1771 (t (:weight bold)))
55015061 1772 "Font Lock mode face used to highlight keywords."
a4deefed 1773 :group 'font-lock-faces)
55015061
SM
1774
1775(defface font-lock-builtin-face
a12d182a 1776 '((((class grayscale) (background light)) (:foreground "LightGray" :weight bold))
0cccb49d 1777 (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold))
a12d182a
EZ
1778 (((class color) (min-colors 88) (background light)) (:foreground "Orchid"))
1779 (((class color) (min-colors 88) (background dark)) (:foreground "LightSteelBlue"))
1780 (((class color) (min-colors 16) (background light)) (:foreground "Orchid"))
1781 (((class color) (min-colors 16) (background dark)) (:foreground "LightSteelBlue"))
1782 (((class color) (min-colors 8)) (:foreground "blue" :weight bold))
0cccb49d 1783 (t (:weight bold)))
55015061 1784 "Font Lock mode face used to highlight builtins."
a4deefed 1785 :group 'font-lock-faces)
55015061
SM
1786
1787(defface font-lock-function-name-face
ea81d57e 1788 '((((class color) (min-colors 88) (background light)) (:foreground "Blue1"))
a12d182a
EZ
1789 (((class color) (min-colors 88) (background dark)) (:foreground "LightSkyBlue"))
1790 (((class color) (min-colors 16) (background light)) (:foreground "Blue"))
1791 (((class color) (min-colors 16) (background dark)) (:foreground "LightSkyBlue"))
1792 (((class color) (min-colors 8)) (:foreground "blue" :weight bold))
0cccb49d 1793 (t (:inverse-video t :weight bold)))
55015061 1794 "Font Lock mode face used to highlight function names."
a4deefed 1795 :group 'font-lock-faces)
55015061
SM
1796
1797(defface font-lock-variable-name-face
a12d182a 1798 '((((class grayscale) (background light))
0cccb49d 1799 (:foreground "Gray90" :weight bold :slant italic))
55015061 1800 (((class grayscale) (background dark))
0cccb49d 1801 (:foreground "DimGray" :weight bold :slant italic))
a12d182a
EZ
1802 (((class color) (min-colors 88) (background light)) (:foreground "DarkGoldenrod"))
1803 (((class color) (min-colors 88) (background dark)) (:foreground "LightGoldenrod"))
1804 (((class color) (min-colors 16) (background light)) (:foreground "DarkGoldenrod"))
1805 (((class color) (min-colors 16) (background dark)) (:foreground "LightGoldenrod"))
1806 (((class color) (min-colors 8)) (:foreground "yellow" :weight light))
0cccb49d 1807 (t (:weight bold :slant italic)))
55015061 1808 "Font Lock mode face used to highlight variable names."
a4deefed 1809 :group 'font-lock-faces)
55015061
SM
1810
1811(defface font-lock-type-face
a12d182a 1812 '((((class grayscale) (background light)) (:foreground "Gray90" :weight bold))
0cccb49d 1813 (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold))
a12d182a
EZ
1814 (((class color) (min-colors 88) (background light)) (:foreground "ForestGreen"))
1815 (((class color) (min-colors 88) (background dark)) (:foreground "PaleGreen"))
1816 (((class color) (min-colors 16) (background light)) (:foreground "ForestGreen"))
1817 (((class color) (min-colors 16) (background dark)) (:foreground "PaleGreen"))
1818 (((class color) (min-colors 8)) (:foreground "green"))
0cccb49d 1819 (t (:weight bold :underline t)))
8acf2292 1820 "Font Lock mode face used to highlight type and classes."
a4deefed 1821 :group 'font-lock-faces)
55015061 1822
8acf2292 1823(defface font-lock-constant-face
a12d182a 1824 '((((class grayscale) (background light))
0cccb49d 1825 (:foreground "LightGray" :weight bold :underline t))
55015061 1826 (((class grayscale) (background dark))
0cccb49d 1827 (:foreground "Gray50" :weight bold :underline t))
a12d182a
EZ
1828 (((class color) (min-colors 88) (background light)) (:foreground "CadetBlue"))
1829 (((class color) (min-colors 88) (background dark)) (:foreground "Aquamarine"))
1830 (((class color) (min-colors 16) (background light)) (:foreground "CadetBlue"))
1831 (((class color) (min-colors 16) (background dark)) (:foreground "Aquamarine"))
1832 (((class color) (min-colors 8)) (:foreground "magenta"))
0cccb49d 1833 (t (:weight bold :underline t)))
8acf2292 1834 "Font Lock mode face used to highlight constants and labels."
a4deefed 1835 :group 'font-lock-faces)
55015061
SM
1836
1837(defface font-lock-warning-face
ea81d57e 1838 '((((class color) (min-colors 88) (background light)) (:foreground "Red1" :weight bold))
a12d182a 1839 (((class color) (min-colors 88) (background dark)) (:foreground "Pink" :weight bold))
11ec76b7 1840 (((class color) (min-colors 16) (background light)) (:foreground "Red1" :weight bold))
c9341aa0
JB
1841 (((class color) (min-colors 16) (background dark)) (:foreground "Pink" :weight bold))
1842 (((class color) (min-colors 8)) (:foreground "red"))
0cccb49d 1843 (t (:inverse-video t :weight bold)))
55015061 1844 "Font Lock mode face used to highlight warnings."
a4deefed 1845 :group 'font-lock-faces)
2d63aa67 1846
5d27cf9f 1847(defface font-lock-negation-char-face
39eae073 1848 '((t nil))
5d27cf9f 1849 "Font Lock mode face used to highlight easy to overlook negation."
a4deefed 1850 :group 'font-lock-faces)
5d27cf9f 1851
d654cab8 1852(defface font-lock-preprocessor-face
c9341aa0 1853 '((t :inherit font-lock-builtin-face))
d654cab8 1854 "Font Lock mode face used to highlight preprocessor directives."
a4deefed 1855 :group 'font-lock-faces)
d654cab8 1856
9ad5e4d4 1857(defface font-lock-regexp-grouping-backslash
d8d5c28c 1858 '((t :inherit bold))
9ad5e4d4 1859 "Font Lock mode face for backslashes in Lisp regexp grouping constructs."
a4deefed 1860 :group 'font-lock-faces)
c711faac 1861
112abe24 1862(defface font-lock-regexp-grouping-construct
c711faac 1863 '((t :inherit bold))
9ad5e4d4 1864 "Font Lock mode face used to highlight grouping constructs in Lisp regexps."
a4deefed 1865 :group 'font-lock-faces)
c711faac 1866
2d63aa67 1867;;; End of Colour etc. support.
9bfbb130 1868\f
56fcbd7e
SM
1869;;; Menu support.
1870
1871;; This section of code is commented out because Emacs does not have real menu
1872;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1873;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1874;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1875;; the entry for "Text Properties" something like:
1876;;
1877;; (define-key menu-bar-edit-menu [font-lock]
9c8de95c 1878;; (cons "Syntax Highlighting" font-lock-menu))
56fcbd7e
SM
1879;;
1880;; and remove a single ";" from the beginning of each line in the rest of this
1881;; section. Probably the mechanism for telling the menu code what are menu
1882;; buttons and when they are on or off needs tweaking. I have assumed that the
1883;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1884
d55c4199
SM
1885;;;;;###autoload
1886;;(progn
1887;; ;; Make the Font Lock menu.
1888;; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1889;; ;; Add the menu items in reverse order.
1890;; (define-key font-lock-menu [fontify-less]
1891;; '("Less In Current Buffer" . font-lock-fontify-less))
1892;; (define-key font-lock-menu [fontify-more]
1893;; '("More In Current Buffer" . font-lock-fontify-more))
1894;; (define-key font-lock-menu [font-lock-sep]
1895;; '("--"))
1896;; (define-key font-lock-menu [font-lock-mode]
1897;; '("In Current Buffer" . font-lock-mode))
1898;; (define-key font-lock-menu [global-font-lock-mode]
1899;; '("In All Buffers" . global-font-lock-mode)))
1900;;
1901;;;;;###autoload
1902;;(progn
1903;; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1904;; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1905;; (put 'global-font-lock-mode 'menu-toggle t)
1906;; (put 'font-lock-mode 'menu-toggle t)
1907;; (put 'font-lock-fontify-more 'menu-enable '(identity))
1908;; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1909;;
1910;; ;; Put the appropriate symbol property values on now. See above.
1911;;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
1912;;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1913;;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1914;;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1915;;
1916;;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1917;;
1918;;(defun font-lock-fontify-level (level)
1919;; (let ((font-lock-maximum-decoration level))
1920;; (when font-lock-mode
1921;; (font-lock-mode))
1922;; (font-lock-mode)
1923;; (when font-lock-verbose
1924;; (message "Fontifying %s... level %d" (buffer-name) level))))
1925;;
1926;;(defun font-lock-fontify-less ()
1927;; "Fontify the current buffer with less decoration.
1928;;See `font-lock-maximum-decoration'."
1929;; (interactive)
1930;; ;; Check in case we get called interactively.
1931;; (if (nth 1 font-lock-fontify-level)
1932;; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1933;; (error "No less decoration")))
1934;;
1935;;(defun font-lock-fontify-more ()
1936;; "Fontify the current buffer with more decoration.
1937;;See `font-lock-maximum-decoration'."
1938;; (interactive)
1939;; ;; Check in case we get called interactively.
1940;; (if (nth 2 font-lock-fontify-level)
1941;; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1942;; (error "No more decoration")))
1943;;
1944;; ;; This should be called by `font-lock-set-defaults'.
1945;;(defun font-lock-set-menu ()
1946;; ;; Activate less/more fontification entries if there are multiple levels for
1947;; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
1948;; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
1949;; (let ((keywords (or (nth 0 font-lock-defaults)
1950;; (nth 1 (assq major-mode font-lock-defaults-alist))))
1951;; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1952;; (make-local-variable 'font-lock-fontify-level)
1953;; (if (or (symbolp keywords) (= (length keywords) 1))
1954;; (font-lock-unset-menu)
1955;; (cond ((eq level t)
1956;; (setq level (1- (length keywords))))
1957;; ((or (null level) (zerop level))
1958;; ;; The default level is usually, but not necessarily, level 1.
1959;; (setq level (- (length keywords)
1960;; (length (member (eval (car keywords))
1961;; (mapcar 'eval (cdr keywords))))))))
1962;; (setq font-lock-fontify-level (list level (> level 1)
1963;; (< level (1- (length keywords))))))))
1964;;
1965;; ;; This should be called by `font-lock-unset-defaults'.
1966;;(defun font-lock-unset-menu ()
1967;; ;; Deactivate less/more fontification entries.
1968;; (setq font-lock-fontify-level nil))
2d63aa67
SM
1969
1970;;; End of Menu support.
56fcbd7e 1971\f
9bfbb130 1972;;; Various regexp information shared by several modes.
d55c4199 1973;; ;; Information specific to a single mode should go in its load library.
030f4a35 1974
1fed50c4
SM
1975;; Font Lock support for C, C++, Objective-C and Java modes is now in
1976;; cc-fonts.el (and required by cc-mode.el). However, the below function
56fcbd7e 1977;; should stay in font-lock.el, since it is used by other libraries. sm.
2e6a15fc 1978
c1f2ffc8 1979(defun font-lock-match-c-style-declaration-item-and-skip-to-next (limit)
2e6a15fc 1980 "Match, and move over, any declaration/definition item after point.
c1f2ffc8
SM
1981Matches after point, but ignores leading whitespace and `*' characters.
1982Does not move further than LIMIT.
1983
ac6e572c
SM
1984The expected syntax of a declaration/definition item is `word' (preceded by
1985optional whitespace and `*' characters and proceeded by optional whitespace)
1986optionally followed by a `('. Everything following the item (but belonging to
4cac2fc3 1987it) is expected to be skip-able by `scan-sexps', and items are expected to be
ac6e572c 1988separated with a `,' and to be terminated with a `;'.
c1f2ffc8
SM
1989
1990Thus the regexp matches after point: word (
1991 ^^^^ ^
1992Where the match subexpressions are: 1 2
1993
1994The item is delimited by (match-beginning 1) and (match-end 1).
1995If (match-beginning 2) is non-nil, the item is followed by a `('.
1996
1997This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
c1966bb4 1998 (when (looking-at "[ \n\t*]*\\(\\sw+\\)[ \t\n]*\\(((?\\)?")
8259bf10
SM
1999 (when (and (match-end 2) (> (- (match-end 2) (match-beginning 2)) 1))
2000 ;; If `word' is followed by a double open-paren, it's probably
2001 ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one
2002 ;; word to try and match `myfun' rather than `P_'.
2003 (let ((pos (point)))
c1966bb4 2004 (skip-chars-backward " \t\n")
8259bf10 2005 (skip-syntax-backward "w")
4cac2fc3 2006 (unless (looking-at "\\(\\sw+\\)[ \t\n]*\\sw+[ \t\n]*\\(((?\\)?")
8259bf10
SM
2007 ;; Looks like it was something else, so go back to where we
2008 ;; were and reset the match data by rematching.
2009 (goto-char pos)
c1966bb4 2010 (looking-at "[ \n\t*]*\\(\\sw+\\)[ \t\n]*\\(((?\\)?"))))
2e6a15fc
SM
2011 (save-match-data
2012 (condition-case nil
2013 (save-restriction
c1966bb4 2014 ;; Restrict to the LIMIT.
2e6a15fc
SM
2015 (narrow-to-region (point-min) limit)
2016 (goto-char (match-end 1))
2017 ;; Move over any item value, etc., to the next item.
c1966bb4 2018 (while (not (looking-at "[ \t\n]*\\(\\(,\\)\\|;\\|\\'\\)"))
2e6a15fc
SM
2019 (goto-char (or (scan-sexps (point) 1) (point-max))))
2020 (goto-char (match-end 2)))
2021 (error t)))))
4076cbf6
MY
2022
2023;; C preprocessor(cpp) is used outside of C, C++ and Objective-C source file.
2024;; e.g. assembler code and GNU linker script in Linux kernel.
2025;; `cpp-font-lock-keywords' is handy for modes for the files.
2026;;
2027;; Here we cannot use `regexp-opt' because because regex-opt is not preloaded
2028;; while font-lock.el is preloaded to emacs. So values pre-calculated with
2029;; regexp-opt are used here.
2030
2031;; `cpp-font-lock-keywords-source-directives' is calculated from:
2032;;
2033;; (regexp-opt
2034;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
8c8b1164 2035;; "ifndef" "import" "include" "line" "pragma" "undef" "warning"))
4076cbf6
MY
2036;;
2037(defconst cpp-font-lock-keywords-source-directives
8c8b1164 2038 "define\\|e\\(?:l\\(?:if\\|se\\)\\|ndif\\|rror\\)\\|file\\|i\\(?:f\\(?:n?def\\)?\\|mport\\|nclude\\)\\|line\\|pragma\\|undef\\|warning"
4076cbf6
MY
2039 "Regular expressoin used in `cpp-font-lock-keywords'.")
2040
2041;; `cpp-font-lock-keywords-source-depth' is calculated from:
2042;;
2043;; (regexp-opt-depth (regexp-opt
2044;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
8c8b1164 2045;; "ifndef" "import" "include" "line" "pragma" "undef" "warning")))
4076cbf6
MY
2046;;
2047(defconst cpp-font-lock-keywords-source-depth 0
2048 "An integer representing regular expression depth of `cpp-font-lock-keywords-source-directives'.
2049Used in `cpp-font-lock-keywords'.")
2050
2051(defconst cpp-font-lock-keywords
2052 (let* ((directives cpp-font-lock-keywords-source-directives)
2053 (directives-depth cpp-font-lock-keywords-source-depth))
2054 (list
2055 ;;
2056 ;; Fontify error directives.
8c8b1164 2057 '("^#[ \t]*\\(?:error\\|warning\\)[ \t]+\\(.+\\)" 1 font-lock-warning-face prepend)
4076cbf6
MY
2058 ;;
2059 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2060 '("^#[ \t]*\\(?:import\\|include\\)[ \t]*\\(<[^>\"\n]*>?\\)"
2061 1 font-lock-string-face prepend)
2062 ;;
2063 ;; Fontify function macro names.
2064 '("^#[ \t]*define[ \t]+\\([[:alpha:]_][[:alnum:]_$]*\\)("
2065 (1 font-lock-function-name-face prepend)
2066 ;;
2067 ;; Macro arguments.
2068 ((lambda (limit)
2069 (re-search-forward
2070 "\\(?:\\([[:alpha:]_][[:alnum:]_]*\\)[,]?\\)"
2071 (or (save-excursion (re-search-forward ")" limit t))
2072 limit)
2073 t))
2074 nil nil (1 font-lock-variable-name-face prepend)))
2075 ;;
2076 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2077 '("^#[ \t]*\\(?:elif\\|if\\)\\>"
2078 ("\\<\\(defined\\)\\>[ \t]*(?\\([[:alpha:]_][[:alnum:]_]*\\)?" nil nil
2079 (1 font-lock-builtin-face prepend) (2 font-lock-variable-name-face prepend t)))
2080 ;;
2081 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2082 (list
2083 (concat "^\\(#[ \t]*\\(?:" directives
2084 "\\)\\)\\>[ \t!]*\\([[:alpha:]_][[:alnum:]_]*\\)?")
2085 '(1 font-lock-preprocessor-face prepend)
2086 (list (+ 2 directives-depth)
2087 'font-lock-variable-name-face nil t))))
2088 "Font lock keyords for C preprocessor directives.
2089`c-mode', `c++-mode' and `objc-mode' have their own
2090font lock keyords for C preprocessor directives. This definition is for the
2091other modes in which C preprocessor directives are used. e.g. `asm-mode' and
2092`ld-script-mode'.")
2093
46f26fcf
SM
2094\f
2095;; Lisp.
2e6a15fc 2096
030f4a35 2097(defconst lisp-font-lock-keywords-1
2e6a15fc 2098 (eval-when-compile
71994ae7
DP
2099 `(;; Definitions.
2100 (,(concat "(\\(def\\("
2101 ;; Function declarations.
588fe8bc 2102 "\\(advice\\|alias\\|generic\\|macro\\*?\\|method\\|"
71994ae7 2103 "setf\\|subst\\*?\\|un\\*?\\|"
140adc83
JL
2104 "ine-\\(condition\\|"
2105 "\\(?:derived\\|\\(?:global-\\)?minor\\|generic\\)-mode\\|"
71994ae7
DP
2106 "method-combination\\|setf-expander\\|skeleton\\|widget\\|"
2107 "function\\|\\(compiler\\|modify\\|symbol\\)-macro\\)\\)\\|"
2108 ;; Variable declarations.
588fe8bc 2109 "\\(const\\(ant\\)?\\|custom\\|varalias\\|face\\|parameter\\|var\\)\\|"
71994ae7
DP
2110 ;; Structure declarations.
2111 "\\(class\\|group\\|theme\\|package\\|struct\\|type\\)"
2112 "\\)\\)\\>"
2113 ;; Any whitespace and defined object.
2114 "[ \t'\(]*"
2115 "\\(setf[ \t]+\\sw+)\\|\\sw+\\)?")
2116 (1 font-lock-keyword-face)
2117 (9 (cond ((match-beginning 3) font-lock-function-name-face)
2118 ((match-beginning 6) font-lock-variable-name-face)
2119 (t font-lock-type-face))
2120 nil t))
2121 ;; Emacs Lisp autoload cookies.
2122 ("^;;;###\\(autoload\\)" 1 font-lock-warning-face prepend)
2123 ;; Regexp negated char group.
2124 ("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
56fcbd7e 2125 "Subdued level highlighting for Lisp modes.")
030f4a35
RS
2126
2127(defconst lisp-font-lock-keywords-2
799761f0 2128 (append lisp-font-lock-keywords-1
2e6a15fc 2129 (eval-when-compile
71994ae7
DP
2130 `(;; Control structures. Emacs Lisp forms.
2131 (,(concat
2132 "(" (regexp-opt
c711faac 2133 '("cond" "if" "while" "while-no-input" "let" "let*"
71994ae7
DP
2134 "prog" "progn" "progv" "prog1" "prog2" "prog*"
2135 "inline" "lambda" "save-restriction" "save-excursion"
2136 "save-window-excursion" "save-selected-window"
2137 "save-match-data" "save-current-buffer" "unwind-protect"
2138 "condition-case" "track-mouse"
2139 "eval-after-load" "eval-and-compile" "eval-when-compile"
9f40e1d5 2140 "eval-when" "eval-at-startup" "eval-next-after-load"
71994ae7
DP
2141 "with-category-table"
2142 "with-current-buffer" "with-electric-help"
2143 "with-local-quit" "with-no-warnings"
2144 "with-output-to-string" "with-output-to-temp-buffer"
2145 "with-selected-window" "with-syntax-table"
2146 "with-temp-buffer" "with-temp-file" "with-temp-message"
2147 "with-timeout" "with-timeout-handler") t)
2148 "\\>")
2149 . 1)
2150 ;; Control structures. Common Lisp forms.
2151 (,(concat
2152 "(" (regexp-opt
2153 '("when" "unless" "case" "ecase" "typecase" "etypecase"
2154 "ccase" "ctypecase" "handler-case" "handler-bind"
2155 "restart-bind" "restart-case" "in-package"
2156 "break" "ignore-errors"
2157 "loop" "do" "do*" "dotimes" "dolist" "the" "locally"
2158 "proclaim" "declaim" "declare" "symbol-macrolet"
2159 "lexical-let" "lexical-let*" "flet" "labels" "compiler-let"
2160 "destructuring-bind" "macrolet" "tagbody" "block" "go"
2161 "multiple-value-bind" "multiple-value-prog1"
2162 "return" "return-from"
2163 "with-accessors" "with-compilation-unit"
2164 "with-condition-restarts" "with-hash-table-iterator"
2165 "with-input-from-string" "with-open-file"
2166 "with-open-stream" "with-output-to-string"
2167 "with-package-iterator" "with-simple-restart"
2168 "with-slots" "with-standard-io-syntax") t)
2169 "\\>")
2170 . 1)
2171 ;; Exit/Feature symbols as constants.
2172 (,(concat "(\\(catch\\|throw\\|featurep\\|provide\\|require\\)\\>"
2173 "[ \t']*\\(\\sw+\\)?")
2174 (1 font-lock-keyword-face)
2175 (2 font-lock-constant-face nil t))
2176 ;; Erroneous structures.
2177 ("(\\(abort\\|assert\\|warn\\|check-type\\|cerror\\|error\\|signal\\)\\>" 1 font-lock-warning-face)
2178 ;; Words inside \\[] tend to be for `substitute-command-keys'.
b50f58d5 2179 ("\\\\\\\\\\[\\(\\sw+\\)\\]" 1 font-lock-constant-face prepend)
71994ae7
DP
2180 ;; Words inside `' tend to be symbol names.
2181 ("`\\(\\sw\\sw+\\)'" 1 font-lock-constant-face prepend)
2182 ;; Constant values.
2183 ("\\<:\\sw+\\>" 0 font-lock-builtin-face)
2184 ;; ELisp and CLisp `&' keywords as types.
317921ec 2185 ("\\<\\&\\sw+\\>" . font-lock-type-face)
9ad5e4d4 2186 ;; ELisp regexp grouping constructs
ae0c6927 2187 ((lambda (bound)
9ad5e4d4
EZ
2188 (catch 'found
2189 ;; The following loop is needed to continue searching after matches
2190 ;; that do not occur in strings. The associated regexp matches one
2191 ;; of `\\\\' `\\(' `\\(?:' `\\|' `\\)'. `\\\\' has been included to
2192 ;; avoid highlighting, for example, `\\(' in `\\\\('.
2193 (while (re-search-forward "\\(\\\\\\\\\\)\\(?:\\(\\\\\\\\\\)\\|\\((\\(?:\\?:\\)?\\|[|)]\\)\\)" bound t)
2194 (unless (match-beginning 2)
2195 (let ((face (get-text-property (1- (point)) 'face)))
2196 (when (or (and (listp face)
2197 (memq 'font-lock-string-face face))
2198 (eq 'font-lock-string-face face))
2199 (throw 'found t)))))))
2200 (1 'font-lock-regexp-grouping-backslash prepend)
2201 (3 'font-lock-regexp-grouping-construct prepend))
90cbc9cd
SM
2202;;; This is too general -- rms.
2203;;; A user complained that he has functions whose names start with `do'
2204;;; and that they get the wrong color.
e6bdd6ab 2205;;; ;; CL `with-' and `do-' constructs
71994ae7 2206;;; ("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
2e6a15fc 2207 )))
fb512de9 2208 "Gaudy level highlighting for Lisp modes.")
030f4a35 2209
fb512de9
SM
2210(defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
2211 "Default expressions to highlight in Lisp modes.")
46f26fcf 2212\f
030f4a35 2213(provide 'font-lock)
54f73af3 2214
7ae3cc71 2215;; arch-tag: 682327e4-64d8-4057-b20b-1fbb9f1fc54c
030f4a35 2216;;; font-lock.el ends here