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