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