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