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