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