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