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