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