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