(font-lock-extend-after-change-region-function,
[bpt/emacs.git] / lisp / font-lock.el
1 ;;; font-lock.el --- Electric font lock mode
2
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
5
6 ;; Author: jwz, then rms, then sm
7 ;; Maintainer: FSF
8 ;; Keywords: languages, faces
9
10 ;; This file is part of GNU Emacs.
11
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26
27 ;;; Commentary:
28
29 ;; Font Lock mode is a minor mode that causes your comments to be displayed in
30 ;; one face, strings in another, reserved words in another, and so on.
31 ;;
32 ;; Comments will be displayed in `font-lock-comment-face'.
33 ;; Strings will be displayed in `font-lock-string-face'.
34 ;; Regexps are used to display selected patterns in other faces.
35 ;;
36 ;; To make the text you type be fontified, use M-x font-lock-mode RET.
37 ;; When this minor mode is on, the faces of the current line are updated with
38 ;; every insertion or deletion.
39 ;;
40 ;; To turn Font Lock mode on automatically, add this to your ~/.emacs file:
41 ;;
42 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock)
43 ;;
44 ;; Or if you want to turn Font Lock mode on in many modes:
45 ;;
46 ;; (global-font-lock-mode t)
47 ;;
48 ;; Fontification for a particular mode may be available in a number of levels
49 ;; of decoration. The higher the level, the more decoration, but the more time
50 ;; it takes to fontify. See the variable `font-lock-maximum-decoration', and
51 ;; also the variable `font-lock-maximum-size'. Support modes for Font Lock
52 ;; mode can be used to speed up Font Lock mode. See `font-lock-support-mode'.
53 \f
54 ;;; How Font Lock mode fontifies:
55
56 ;; When Font Lock mode is turned on in a buffer, it (a) fontifies the entire
57 ;; buffer and (b) installs one of its fontification functions on one of the
58 ;; hook variables that are run by Emacs after every buffer change (i.e., an
59 ;; insertion or deletion). Fontification means the replacement of `face' text
60 ;; properties in a given region; Emacs displays text with these `face' text
61 ;; properties appropriately.
62 ;;
63 ;; Fontification normally involves syntactic (i.e., strings and comments) and
64 ;; regexp (i.e., keywords and everything else) passes. There are actually
65 ;; three passes; (a) the syntactic keyword pass, (b) the syntactic pass and (c)
66 ;; the keyword pass. Confused?
67 ;;
68 ;; The syntactic keyword pass places `syntax-table' text properties in the
69 ;; buffer according to the variable `font-lock-syntactic-keywords'. It is
70 ;; necessary because Emacs' syntax table is not powerful enough to describe all
71 ;; the different syntactic constructs required by the sort of people who decide
72 ;; that a single quote can be syntactic or not depending on the time of day.
73 ;; (What sort of person could decide to overload the meaning of a quote?)
74 ;; Obviously the syntactic keyword pass must occur before the syntactic pass.
75 ;;
76 ;; The syntactic pass places `face' text properties in the buffer according to
77 ;; syntactic context, i.e., according to the buffer's syntax table and buffer
78 ;; text's `syntax-table' text properties. It involves using a syntax parsing
79 ;; function to determine the context of different parts of a region of text. A
80 ;; syntax parsing function is necessary because generally strings and/or
81 ;; comments can span lines, and so the context of a given region is not
82 ;; necessarily apparent from the content of that region. Because the keyword
83 ;; pass only works within a given region, it is not generally appropriate for
84 ;; syntactic fontification. This is the first fontification pass that makes
85 ;; changes visible to the user; it fontifies strings and comments.
86 ;;
87 ;; The keyword pass places `face' text properties in the buffer according to
88 ;; the variable `font-lock-keywords'. It involves searching for given regexps
89 ;; (or calling given search functions) within the given region. This is the
90 ;; second fontification pass that makes changes visible to the user; it
91 ;; fontifies language reserved words, etc.
92 ;;
93 ;; Oh, and the answer is, "Yes, obviously just about everything should be done
94 ;; in a single syntactic pass, but the only syntactic parser available
95 ;; understands only strings and comments." Perhaps one day someone will write
96 ;; some syntactic parsers for common languages and a son-of-font-lock.el could
97 ;; use them rather then relying so heavily on the keyword (regexp) pass.
98
99 ;;; How Font Lock mode supports modes or is supported by modes:
100
101 ;; Modes that support Font Lock mode do so by defining one or more variables
102 ;; whose values specify the fontification. Font Lock mode knows of these
103 ;; variable names from (a) the buffer local variable `font-lock-defaults', if
104 ;; non-nil, or (b) the global variable `font-lock-defaults-alist', if the major
105 ;; mode has an entry. (Font Lock mode is set up via (a) where a mode's
106 ;; patterns are distributed with the mode's package library, and (b) where a
107 ;; mode's patterns are distributed with font-lock.el itself. An example of (a)
108 ;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is
109 ;; (a); (b) is used where it is not clear which package library should contain
110 ;; the pattern definitions.) Font Lock mode chooses which variable to use for
111 ;; fontification based on `font-lock-maximum-decoration'.
112 ;;
113 ;; Font Lock mode fontification behaviour can be modified in a number of ways.
114 ;; See the below comments and the comments distributed throughout this file.
115
116 ;;; Constructing patterns:
117
118 ;; See the documentation for the variable `font-lock-keywords'.
119 ;;
120 ;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and
121 ;; `font-lock-syntactic-keywords' can be generated via the function
122 ;; `regexp-opt'.
123
124 ;;; Adding patterns for modes that already support Font Lock:
125
126 ;; Though Font Lock highlighting patterns already exist for many modes, it's
127 ;; likely there's something that you want fontified that currently isn't, even
128 ;; at the maximum fontification level. You can add highlighting patterns via
129 ;; `font-lock-add-keywords'. For example, say in some C
130 ;; header file you #define the token `and' to expand to `&&', etc., to make
131 ;; your C code almost readable. In your ~/.emacs there could be:
132 ;;
133 ;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>"))
134 ;;
135 ;; Some modes provide specific ways to modify patterns based on the values of
136 ;; other variables. For example, additional C types can be specified via the
137 ;; variable `c-font-lock-extra-types'.
138
139 ;;; Adding patterns for modes that do not support Font Lock:
140
141 ;; Not all modes support Font Lock mode. If you (as a user of the mode) add
142 ;; patterns for a new mode, you must define in your ~/.emacs a variable or
143 ;; variables that specify regexp fontification. Then, you should indicate to
144 ;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what
145 ;; support is required. For example, say Foo mode should have the following
146 ;; regexps fontified case-sensitively, and comments and strings should not be
147 ;; fontified automagically. In your ~/.emacs there could be:
148 ;;
149 ;; (defvar foo-font-lock-keywords
150 ;; '(("\\<\\(one\\|two\\|three\\)\\>" . font-lock-keyword-face)
151 ;; ("\\<\\(four\\|five\\|six\\)\\>" . font-lock-type-face))
152 ;; "Default expressions to highlight in Foo mode.")
153 ;;
154 ;; (add-hook 'foo-mode-hook
155 ;; (lambda ()
156 ;; (set (make-local-variable 'font-lock-defaults)
157 ;; '(foo-font-lock-keywords t))))
158
159 ;;; Adding Font Lock support for modes:
160
161 ;; Of course, it would be better that the mode already supports Font Lock mode.
162 ;; The package author would do something similar to above. The mode must
163 ;; define at the top-level a variable or variables that specify regexp
164 ;; fontification. Then, the mode command should indicate to Font Lock mode,
165 ;; via `font-lock-defaults', exactly what support is required. For example,
166 ;; say Bar mode should have the following regexps fontified case-insensitively,
167 ;; and comments and strings should be fontified automagically. In bar.el there
168 ;; could be:
169 ;;
170 ;; (defvar bar-font-lock-keywords
171 ;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . font-lock-keyword-face)
172 ;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . font-lock-type-face))
173 ;; "Default expressions to highlight in Bar mode.")
174 ;;
175 ;; and within `bar-mode' there could be:
176 ;;
177 ;; (set (make-local-variable 'font-lock-defaults)
178 ;; '(bar-font-lock-keywords nil t))
179 \f
180 ;; What is fontification for? You might say, "It's to make my code look nice."
181 ;; I think it should be for adding information in the form of cues. These cues
182 ;; should provide you with enough information to both (a) distinguish between
183 ;; different items, and (b) identify the item meanings, without having to read
184 ;; the items and think about it. Therefore, fontification allows you to think
185 ;; less about, say, the structure of code, and more about, say, why the code
186 ;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
187 ;;
188 ;; So, here are my opinions/advice/guidelines:
189 ;;
190 ;; - Highlight conceptual objects, such as function and variable names, and
191 ;; different objects types differently, i.e., (a) and (b) above, highlight
192 ;; function names differently to variable names.
193 ;; - Keep the faces distinct from each other as far as possible.
194 ;; i.e., (a) above.
195 ;; - Use the same face for the same conceptual object, across all modes.
196 ;; i.e., (b) above, all modes that have items that can be thought of as, say,
197 ;; keywords, should be highlighted with the same face, etc.
198 ;; - Make the face attributes fit the concept as far as possible.
199 ;; i.e., function names might be a bold colour such as blue, comments might
200 ;; be a bright colour such as red, character strings might be brown, because,
201 ;; err, strings are brown (that was not the reason, please believe me).
202 ;; - Don't use a non-nil OVERRIDE unless you have a good reason.
203 ;; Only use OVERRIDE for special things that are easy to define, such as the
204 ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
205 ;; Don't use it to, say, highlight keywords in commented out code or strings.
206 ;; - Err, that's it.
207 \f
208 ;;; Code:
209
210 (require 'syntax)
211
212 ;; Define core `font-lock' group.
213 (defgroup font-lock '((jit-lock custom-group))
214 "Font Lock mode text highlighting package."
215 :link '(custom-manual :tag "Emacs Manual" "(emacs)Font Lock")
216 :link '(custom-manual :tag "Elisp Manual" "(elisp)Font Lock Mode")
217 :group 'faces)
218
219 (defgroup font-lock-faces nil
220 "Faces for highlighting text."
221 :prefix "font-lock-"
222 :group 'font-lock)
223
224 (defgroup font-lock-extra-types nil
225 "Extra mode-specific type names for highlighting declarations."
226 :group 'font-lock)
227 \f
228 ;; User variables.
229
230 (defcustom font-lock-maximum-size 256000
231 "*Maximum size of a buffer for buffer fontification.
232 Only buffers less than this can be fontified when Font Lock mode is turned on.
233 If nil, means size is irrelevant.
234 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
235 where MAJOR-MODE is a symbol or t (meaning the default). For example:
236 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
237 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
238 for buffers in Rmail mode, and size is irrelevant otherwise."
239 :type '(choice (const :tag "none" nil)
240 (integer :tag "size")
241 (repeat :menu-tag "mode specific" :tag "mode specific"
242 :value ((t . nil))
243 (cons :tag "Instance"
244 (radio :tag "Mode"
245 (const :tag "all" t)
246 (symbol :tag "name"))
247 (radio :tag "Size"
248 (const :tag "none" nil)
249 (integer :tag "size")))))
250 :group 'font-lock)
251
252 (defcustom font-lock-maximum-decoration t
253 "*Maximum decoration level for fontification.
254 If nil, use the default decoration (typically the minimum available).
255 If t, use the maximum decoration available.
256 If a number, use that level of decoration (or if not available the maximum).
257 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
258 where MAJOR-MODE is a symbol or t (meaning the default). For example:
259 ((c-mode . t) (c++-mode . 2) (t . 1))
260 means use the maximum decoration available for buffers in C mode, level 2
261 decoration for buffers in C++ mode, and level 1 decoration otherwise."
262 :type '(choice (const :tag "default" nil)
263 (const :tag "maximum" t)
264 (integer :tag "level" 1)
265 (repeat :menu-tag "mode specific" :tag "mode specific"
266 :value ((t . t))
267 (cons :tag "Instance"
268 (radio :tag "Mode"
269 (const :tag "all" t)
270 (symbol :tag "name"))
271 (radio :tag "Decoration"
272 (const :tag "default" nil)
273 (const :tag "maximum" t)
274 (integer :tag "level" 1)))))
275 :group 'font-lock)
276
277 (defcustom font-lock-verbose 0
278 "*If non-nil, means show status messages for buffer fontification.
279 If a number, only buffers greater than this size have fontification messages."
280 :type '(choice (const :tag "never" nil)
281 (other :tag "always" t)
282 (integer :tag "size"))
283 :group 'font-lock)
284 \f
285
286 ;; Originally these variable values were face names such as `bold' etc.
287 ;; Now we create our own faces, but we keep these variables for compatibility
288 ;; and they give users another mechanism for changing face appearance.
289 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
290 ;; returns a face. So the easiest thing is to continue using these variables,
291 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
292 (defvar font-lock-comment-face 'font-lock-comment-face
293 "Face name to use for comments.")
294
295 (defvar font-lock-comment-delimiter-face 'font-lock-comment-delimiter-face
296 "Face name to use for comment delimiters.")
297
298 (defvar font-lock-string-face 'font-lock-string-face
299 "Face name to use for strings.")
300
301 (defvar font-lock-doc-face 'font-lock-doc-face
302 "Face name to use for documentation.")
303
304 (defvar font-lock-keyword-face 'font-lock-keyword-face
305 "Face name to use for keywords.")
306
307 (defvar font-lock-builtin-face 'font-lock-builtin-face
308 "Face name to use for builtins.")
309
310 (defvar font-lock-function-name-face 'font-lock-function-name-face
311 "Face name to use for function names.")
312
313 (defvar font-lock-variable-name-face 'font-lock-variable-name-face
314 "Face name to use for variable names.")
315
316 (defvar font-lock-type-face 'font-lock-type-face
317 "Face name to use for type and class names.")
318
319 (defvar font-lock-constant-face 'font-lock-constant-face
320 "Face name to use for constant and label names.")
321
322 (defvar font-lock-warning-face 'font-lock-warning-face
323 "Face name to use for things that should stand out.")
324
325 (defvar font-lock-negation-char-face 'font-lock-negation-char-face
326 "Face name to use for easy to overlook negation.
327 This can be an \"!\" or the \"n\" in \"ifndef\".")
328
329 (defvar font-lock-preprocessor-face 'font-lock-preprocessor-face
330 "Face name to use for preprocessor directives.")
331
332 (defvar font-lock-reference-face 'font-lock-constant-face)
333 (make-obsolete-variable 'font-lock-reference-face 'font-lock-constant-face)
334
335 ;; Fontification variables:
336
337 (defvar font-lock-keywords nil
338 "A list of the keywords to highlight.
339 There are two kinds of values: user-level, and compiled.
340
341 A user-level keywords list is what a major mode or the user would
342 set up. Normally the list would come from `font-lock-defaults'.
343 through selection of a fontification level and evaluation of any
344 contained expressions. You can also alter it by calling
345 `font-lock-add-keywords' or `font-lock-remove-keywords' with MODE = nil.
346
347 Each element in a user-level keywords list should have one of these forms:
348
349 MATCHER
350 (MATCHER . SUBEXP)
351 (MATCHER . FACENAME)
352 (MATCHER . HIGHLIGHT)
353 (MATCHER HIGHLIGHT ...)
354 (eval . FORM)
355
356 where MATCHER can be either the regexp to search for, or the function name to
357 call to make the search (called with one argument, the limit of the search;
358 it should return non-nil, move point, and set `match-data' appropriately iff
359 it succeeds; like `re-search-forward' would).
360 MATCHER regexps can be generated via the function `regexp-opt'.
361
362 FORM is an expression, whose value should be a keyword element, evaluated when
363 the keyword is (first) used in a buffer. This feature can be used to provide a
364 keyword that can only be generated when Font Lock mode is actually turned on.
365
366 HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
367
368 For highlighting single items, for example each instance of the word \"foo\",
369 typically only MATCH-HIGHLIGHT is required.
370 However, if an item or (typically) items are to be highlighted following the
371 instance of another item (the anchor), for example each instance of the
372 word \"bar\" following the word \"anchor\" then MATCH-ANCHORED may be required.
373
374 MATCH-HIGHLIGHT should be of the form:
375
376 (SUBEXP FACENAME [OVERRIDE [LAXMATCH]])
377
378 SUBEXP is the number of the subexpression of MATCHER to be highlighted.
379
380 FACENAME is an expression whose value is the face name to use.
381 Instead of a face, FACENAME can evaluate to a property list
382 of the form (face FACE PROP1 VAL1 PROP2 VAL2 ...)
383 in which case all the listed text-properties will be set rather than
384 just FACE. In such a case, you will most likely want to put those
385 properties in `font-lock-extra-managed-props' or to override
386 `font-lock-unfontify-region-function'.
387
388 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
389 be overwritten. If `keep', only parts not already fontified are highlighted.
390 If `prepend' or `append', existing fontification is merged with the new, in
391 which the new or existing fontification, respectively, takes precedence.
392 If LAXMATCH is non-nil, that means don't signal an error if there is
393 no match for SUBEXP in MATCHER.
394
395 For example, an element of the form highlights (if not already highlighted):
396
397 \"\\\\\\=<foo\\\\\\=>\" discrete occurrences of \"foo\" in the value of the
398 variable `font-lock-keyword-face'.
399 (\"fu\\\\(bar\\\\)\" . 1) substring \"bar\" within all occurrences of \"fubar\" in
400 the value of `font-lock-keyword-face'.
401 (\"fubar\" . fubar-face) Occurrences of \"fubar\" in the value of `fubar-face'.
402 (\"foo\\\\|bar\" 0 foo-bar-face t)
403 occurrences of either \"foo\" or \"bar\" in the value
404 of `foo-bar-face', even if already highlighted.
405 (fubar-match 1 fubar-face)
406 the first subexpression within all occurrences of
407 whatever the function `fubar-match' finds and matches
408 in the value of `fubar-face'.
409
410 MATCH-ANCHORED should be of the form:
411
412 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
413
414 where MATCHER is a regexp to search for or the function name to call to make
415 the search, as for MATCH-HIGHLIGHT above, but with one exception; see below.
416 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
417 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
418 used to initialize before, and cleanup after, MATCHER is used. Typically,
419 PRE-MATCH-FORM is used to move to some position relative to the original
420 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
421 be used to move back, before resuming with MATCH-ANCHORED's parent's MATCHER.
422
423 For example, an element of the form highlights (if not already highlighted):
424
425 (\"\\\\\\=<anchor\\\\\\=>\" (0 anchor-face) (\"\\\\\\=<item\\\\\\=>\" nil nil (0 item-face)))
426
427 discrete occurrences of \"anchor\" in the value of `anchor-face', and subsequent
428 discrete occurrences of \"item\" (on the same line) in the value of `item-face'.
429 (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil. Therefore \"item\" is
430 initially searched for starting from the end of the match of \"anchor\", and
431 searching for subsequent instances of \"anchor\" resumes from where searching
432 for \"item\" concluded.)
433
434 The above-mentioned exception is as follows. The limit of the MATCHER search
435 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
436 However, if PRE-MATCH-FORM returns a position greater than the position after
437 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
438 It is generally a bad idea to return a position greater than the end of the
439 line, i.e., cause the MATCHER search to span lines.
440
441 These regular expressions can match text which spans lines, although
442 it is better to avoid it if possible since updating them while editing
443 text is slower, and it is not guaranteed to be always correct when using
444 support modes like jit-lock or lazy-lock.
445
446 This variable is set by major modes via the variable `font-lock-defaults'.
447 Be careful when composing regexps for this list; a poorly written pattern can
448 dramatically slow things down!
449
450 A compiled keywords list starts with t. It is produced internal
451 by `font-lock-compile-keywords' from a user-level keywords list.
452 Its second element is the user-level keywords list that was
453 compiled. The remaining elements have the same form as
454 user-level keywords, but normally their values have been
455 optimized.")
456
457 (defvar font-lock-keywords-alist nil
458 "Alist of additional `font-lock-keywords' elements for major modes.
459
460 Each element has the form (MODE KEYWORDS . HOW).
461 `font-lock-set-defaults' adds the elements in the list KEYWORDS to
462 `font-lock-keywords' when Font Lock is turned on in major mode MODE.
463
464 If HOW is nil, KEYWORDS are added at the beginning of
465 `font-lock-keywords'. If it is `set', they are used to replace the
466 value of `font-lock-keywords'. If HOW is any other non-nil value,
467 they are added at the end.
468
469 This is normally set via `font-lock-add-keywords' and
470 `font-lock-remove-keywords'.")
471
472 (defvar font-lock-removed-keywords-alist nil
473 "Alist of `font-lock-keywords' elements to be removed for major modes.
474
475 Each element has the form (MODE . KEYWORDS). `font-lock-set-defaults'
476 removes the elements in the list KEYWORDS from `font-lock-keywords'
477 when Font Lock is turned on in major mode MODE.
478
479 This is normally set via `font-lock-add-keywords' and
480 `font-lock-remove-keywords'.")
481
482 (defvar font-lock-keywords-only nil
483 "*Non-nil means Font Lock should not fontify comments or strings.
484 This is normally set via `font-lock-defaults'.")
485
486 (defvar font-lock-keywords-case-fold-search nil
487 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
488 This is normally set via `font-lock-defaults'.")
489 (make-variable-buffer-local 'font-lock-keywords-case-fold-search)
490
491 (defvar font-lock-syntactically-fontified 0
492 "Point up to which `font-lock-syntactic-keywords' has been applied.
493 If nil, this is ignored, in which case the syntactic fontification may
494 sometimes be slightly incorrect.")
495 (make-variable-buffer-local 'font-lock-syntactically-fontified)
496
497 (defvar font-lock-syntactic-face-function
498 (lambda (state)
499 (if (nth 3 state) font-lock-string-face font-lock-comment-face))
500 "Function to determine which face to use when fontifying syntactically.
501 The function is called with a single parameter (the state as returned by
502 `parse-partial-sexp' at the beginning of the region to highlight) and
503 should return a face. This is normally set via `font-lock-defaults'.")
504
505 (defvar font-lock-syntactic-keywords nil
506 "A list of the syntactic keywords to put syntax properties on.
507 The value can be the list itself, or the name of a function or variable
508 whose value is the list.
509
510 See `font-lock-keywords' for a description of the form of this list;
511 only the differences are stated here. MATCH-HIGHLIGHT should be of the form:
512
513 (SUBEXP SYNTAX OVERRIDE LAXMATCH)
514
515 where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax
516 table, a cons cell (as returned by `string-to-syntax') or an expression whose
517 value is such a form. OVERRIDE cannot be `prepend' or `append'.
518
519 Here are two examples of elements of `font-lock-syntactic-keywords'
520 and what they do:
521
522 (\"\\\\$\\\\(#\\\\)\" 1 \".\")
523
524 gives a hash character punctuation syntax (\".\") when following a
525 dollar-sign character. Hash characters in other contexts will still
526 follow whatever the syntax table says about the hash character.
527
528 (\"\\\\('\\\\).\\\\('\\\\)\"
529 (1 \"\\\"\")
530 (2 \"\\\"\"))
531
532 gives a pair single-quotes, which surround a single character, a SYNTAX of
533 \"\\\"\" (meaning string quote syntax). Single-quote characters in other
534 contexts will not be affected.
535
536 This is normally set via `font-lock-defaults'.")
537
538 (defvar font-lock-syntax-table nil
539 "Non-nil means use this syntax table for fontifying.
540 If this is nil, the major mode's syntax table is used.
541 This is normally set via `font-lock-defaults'.")
542
543 (defvar font-lock-beginning-of-syntax-function nil
544 "*Non-nil means use this function to move back outside all constructs.
545 When called with no args it should move point backward to a place which
546 is not in a string or comment and not within any bracket-pairs (or else,
547 a place such that any bracket-pairs outside it can be ignored for Emacs
548 syntax analysis and fontification).
549
550 If this is nil, Font Lock uses `syntax-begin-function' to move back
551 outside of any comment, string, or sexp. This variable is semi-obsolete;
552 we recommend setting `syntax-begin-function' instead.
553
554 This is normally set via `font-lock-defaults'.")
555
556 (defvar font-lock-mark-block-function nil
557 "*Non-nil means use this function to mark a block of text.
558 When called with no args it should leave point at the beginning of any
559 enclosing textual block and mark at the end.
560 This is normally set via `font-lock-defaults'.")
561
562 (defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer
563 "Function to use for fontifying the buffer.
564 This is normally set via `font-lock-defaults'.")
565
566 (defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer
567 "Function to use for unfontifying the buffer.
568 This is used when turning off Font Lock mode.
569 This is normally set via `font-lock-defaults'.")
570
571 (defvar font-lock-fontify-region-function 'font-lock-default-fontify-region
572 "Function to use for fontifying a region.
573 It should take two args, the beginning and end of the region, and an optional
574 third arg VERBOSE. If VERBOSE is non-nil, the function should print status
575 messages. This is normally set via `font-lock-defaults'.")
576
577 (defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region
578 "Function to use for unfontifying a region.
579 It should take two args, the beginning and end of the region.
580 This is normally set via `font-lock-defaults'.")
581
582 (defvar font-lock-inhibit-thing-lock nil
583 "List of Font Lock mode related modes that should not be turned on.
584 Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
585 `lazy-lock-mode'. This is normally set via `font-lock-defaults'.")
586
587 (defvar font-lock-multiline nil
588 "Whether font-lock should cater to multiline keywords.
589 If nil, don't try to handle multiline patterns.
590 If t, always handle multiline patterns.
591 If `undecided', don't try to handle multiline patterns until you see one.
592 Major/minor modes can set this variable if they know which option applies.")
593
594 (defvar font-lock-fontified nil) ; Whether we have fontified the buffer.
595 \f
596 ;; Font Lock mode.
597
598 (eval-when-compile
599 ;;
600 ;; We don't do this at the top-level as we only use non-autoloaded macros.
601 (require 'cl)
602 ;;
603 ;; Borrowed from lazy-lock.el.
604 ;; We use this to preserve or protect things when modifying text properties.
605 (defmacro save-buffer-state (varlist &rest body)
606 "Bind variables according to VARLIST and eval BODY restoring buffer state."
607 (declare (indent 1) (debug let))
608 (let ((modified (make-symbol "modified")))
609 `(let* ,(append varlist
610 `((,modified (buffer-modified-p))
611 (buffer-undo-list t)
612 (inhibit-read-only t)
613 (inhibit-point-motion-hooks t)
614 (inhibit-modification-hooks t)
615 deactivate-mark
616 buffer-file-name
617 buffer-file-truename))
618 (progn
619 ,@body)
620 (unless ,modified
621 (restore-buffer-modified-p nil)))))
622 ;;
623 ;; Shut up the byte compiler.
624 (defvar font-lock-face-attributes)) ; Obsolete but respected if set.
625
626 (defun font-lock-mode-internal (arg)
627 ;; Turn on Font Lock mode.
628 (when arg
629 (add-hook 'after-change-functions 'font-lock-after-change-function t t)
630 (font-lock-set-defaults)
631 (font-lock-turn-on-thing-lock)
632 ;; Fontify the buffer if we have to.
633 (let ((max-size (font-lock-value-in-major-mode font-lock-maximum-size)))
634 (cond (font-lock-fontified
635 nil)
636 ((or (null max-size) (> max-size (buffer-size)))
637 (font-lock-fontify-buffer))
638 (font-lock-verbose
639 (message "Fontifying %s...buffer size greater than font-lock-maximum-size"
640 (buffer-name))))))
641 ;; Turn off Font Lock mode.
642 (unless font-lock-mode
643 (remove-hook 'after-change-functions 'font-lock-after-change-function t)
644 (font-lock-unfontify-buffer)
645 (font-lock-turn-off-thing-lock)))
646
647 (defun font-lock-add-keywords (mode keywords &optional how)
648 "Add highlighting KEYWORDS for MODE.
649
650 MODE should be a symbol, the major mode command name, such as `c-mode'
651 or nil. If nil, highlighting keywords are added for the current buffer.
652 KEYWORDS should be a list; see the variable `font-lock-keywords'.
653 By default they are added at the beginning of the current highlighting list.
654 If optional argument HOW is `set', they are used to replace the current
655 highlighting list. If HOW is any other non-nil value, they are added at the
656 end of the current highlighting list.
657
658 For example:
659
660 (font-lock-add-keywords 'c-mode
661 '((\"\\\\\\=<\\\\(FIXME\\\\):\" 1 font-lock-warning-face prepend)
662 (\"\\\\\\=<\\\\(and\\\\|or\\\\|not\\\\)\\\\\\=>\" . font-lock-keyword-face)))
663
664 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
665 comments, and to fontify `and', `or' and `not' words as keywords.
666
667 The above procedure will only add the keywords for C mode, not
668 for modes derived from C mode. To add them for derived modes too,
669 pass nil for MODE and add the call to c-mode-hook.
670
671 For example:
672
673 (add-hook 'c-mode-hook
674 (lambda ()
675 (font-lock-add-keywords nil
676 '((\"\\\\\\=<\\\\(FIXME\\\\):\" 1 font-lock-warning-face prepend)
677 (\"\\\\\\=<\\\\(and\\\\|or\\\\|not\\\\)\\\\\\=>\" .
678 font-lock-keyword-face)))))
679
680 The above procedure may fail to add keywords to derived modes if
681 some involved major mode does not follow the standard conventions.
682 File a bug report if this happens, so the major mode can be corrected.
683
684 Note that some modes have specialized support for additional patterns, e.g.,
685 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
686 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
687 (cond (mode
688 ;; If MODE is non-nil, add the KEYWORDS and HOW spec to
689 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
690 (let ((spec (cons keywords how)) cell)
691 (if (setq cell (assq mode font-lock-keywords-alist))
692 (if (eq how 'set)
693 (setcdr cell (list spec))
694 (setcdr cell (append (cdr cell) (list spec))))
695 (push (list mode spec) font-lock-keywords-alist)))
696 ;; Make sure that `font-lock-removed-keywords-alist' does not
697 ;; contain the new keywords.
698 (font-lock-update-removed-keyword-alist mode keywords how))
699 (t
700 ;; Otherwise set or add the keywords now.
701 ;; This is a no-op if it has been done already in this buffer
702 ;; for the correct major mode.
703 (font-lock-set-defaults)
704 (let ((was-compiled (eq (car font-lock-keywords) t)))
705 ;; Bring back the user-level (uncompiled) keywords.
706 (if was-compiled
707 (setq font-lock-keywords (cadr font-lock-keywords)))
708 ;; Now modify or replace them.
709 (if (eq how 'set)
710 (setq font-lock-keywords keywords)
711 (font-lock-remove-keywords nil keywords) ;to avoid duplicates
712 (let ((old (if (eq (car-safe font-lock-keywords) t)
713 (cdr font-lock-keywords)
714 font-lock-keywords)))
715 (setq font-lock-keywords (if how
716 (append old keywords)
717 (append keywords old)))))
718 ;; If the keywords were compiled before, compile them again.
719 (if was-compiled
720 (setq font-lock-keywords
721 (font-lock-compile-keywords font-lock-keywords t)))))))
722
723 (defun font-lock-update-removed-keyword-alist (mode keywords how)
724 "Update `font-lock-removed-keywords-alist' when adding new KEYWORDS to MODE."
725 ;; When font-lock is enabled first all keywords in the list
726 ;; `font-lock-keywords-alist' are added, then all keywords in the
727 ;; list `font-lock-removed-keywords-alist' are removed. If a
728 ;; keyword was once added, removed, and then added again it must be
729 ;; removed from the removed-keywords list. Otherwise the second add
730 ;; will not take effect.
731 (let ((cell (assq mode font-lock-removed-keywords-alist)))
732 (if cell
733 (if (eq how 'set)
734 ;; A new set of keywords is defined. Forget all about
735 ;; our old keywords that should be removed.
736 (setq font-lock-removed-keywords-alist
737 (delq cell font-lock-removed-keywords-alist))
738 ;; Delete all previously removed keywords.
739 (dolist (kword keywords)
740 (setcdr cell (delete kword (cdr cell))))
741 ;; Delete the mode cell if empty.
742 (if (null (cdr cell))
743 (setq font-lock-removed-keywords-alist
744 (delq cell font-lock-removed-keywords-alist)))))))
745
746 ;; Written by Anders Lindgren <andersl@andersl.com>.
747 ;;
748 ;; Case study:
749 ;; (I) The keywords are removed from a major mode.
750 ;; In this case the keyword could be local (i.e. added earlier by
751 ;; `font-lock-add-keywords'), global, or both.
752 ;;
753 ;; (a) In the local case we remove the keywords from the variable
754 ;; `font-lock-keywords-alist'.
755 ;;
756 ;; (b) The actual global keywords are not known at this time.
757 ;; All keywords are added to `font-lock-removed-keywords-alist',
758 ;; when font-lock is enabled those keywords are removed.
759 ;;
760 ;; Note that added keywords are taken out of the list of removed
761 ;; keywords. This ensure correct operation when the same keyword
762 ;; is added and removed several times.
763 ;;
764 ;; (II) The keywords are removed from the current buffer.
765 (defun font-lock-remove-keywords (mode keywords)
766 "Remove highlighting KEYWORDS for MODE.
767
768 MODE should be a symbol, the major mode command name, such as `c-mode'
769 or nil. If nil, highlighting keywords are removed for the current buffer.
770
771 To make the removal apply to modes derived from MODE as well,
772 pass nil for MODE and add the call to MODE-hook. This may fail
773 for some derived modes if some involved major mode does not
774 follow the standard conventions. File a bug report if this
775 happens, so the major mode can be corrected."
776 (cond (mode
777 ;; Remove one keyword at the time.
778 (dolist (keyword keywords)
779 (let ((top-cell (assq mode font-lock-keywords-alist)))
780 ;; If MODE is non-nil, remove the KEYWORD from
781 ;; `font-lock-keywords-alist'.
782 (when top-cell
783 (dolist (keyword-list-how-pair (cdr top-cell))
784 ;; `keywords-list-how-pair' is a cons with a list of
785 ;; keywords in the car top-cell and the original how
786 ;; argument in the cdr top-cell.
787 (setcar keyword-list-how-pair
788 (delete keyword (car keyword-list-how-pair))))
789 ;; Remove keyword list/how pair when the keyword list
790 ;; is empty and how doesn't specify `set'. (If it
791 ;; should be deleted then previously deleted keywords
792 ;; would appear again.)
793 (let ((cell top-cell))
794 (while (cdr cell)
795 (if (and (null (car (car (cdr cell))))
796 (not (eq (cdr (car (cdr cell))) 'set)))
797 (setcdr cell (cdr (cdr cell)))
798 (setq cell (cdr cell)))))
799 ;; Final cleanup, remove major mode cell if last keyword
800 ;; was deleted.
801 (if (null (cdr top-cell))
802 (setq font-lock-keywords-alist
803 (delq top-cell font-lock-keywords-alist))))
804 ;; Remember the keyword in case it is not local.
805 (let ((cell (assq mode font-lock-removed-keywords-alist)))
806 (if cell
807 (unless (member keyword (cdr cell))
808 (nconc cell (list keyword)))
809 (push (cons mode (list keyword))
810 font-lock-removed-keywords-alist))))))
811 (t
812 ;; Otherwise remove it immediately.
813 (font-lock-set-defaults)
814 (let ((was-compiled (eq (car font-lock-keywords) t)))
815 ;; Bring back the user-level (uncompiled) keywords.
816 (if was-compiled
817 (setq font-lock-keywords (cadr font-lock-keywords)))
818
819 ;; Edit them.
820 (setq font-lock-keywords (copy-sequence font-lock-keywords))
821 (dolist (keyword keywords)
822 (setq font-lock-keywords
823 (delete keyword font-lock-keywords)))
824
825 ;; If the keywords were compiled before, compile them again.
826 (if was-compiled
827 (setq font-lock-keywords
828 (font-lock-compile-keywords font-lock-keywords t)))))))
829 \f
830 ;;; Font Lock Support mode.
831
832 ;; This is the code used to interface font-lock.el with any of its add-on
833 ;; packages, and provide the user interface. Packages that have their own
834 ;; local buffer fontification functions (see below) may have to call
835 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
836 ;; themselves.
837
838 (defcustom font-lock-support-mode 'jit-lock-mode
839 "*Support mode for Font Lock mode.
840 Support modes speed up Font Lock mode by being choosy about when fontification
841 occurs. The default support mode, Just-in-time Lock mode (symbol
842 `jit-lock-mode'), is recommended.
843
844 Other, older support modes are Fast Lock mode (symbol `fast-lock-mode') and
845 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
846 However, they are no longer recommended, as Just-in-time Lock mode is better.
847
848 If nil, means support for Font Lock mode is never performed.
849 If a symbol, use that support mode.
850 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
851 where MAJOR-MODE is a symbol or t (meaning the default). For example:
852 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
853 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
854 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
855
856 The value of this variable is used when Font Lock mode is turned on."
857 :type '(choice (const :tag "none" nil)
858 (const :tag "fast lock" fast-lock-mode)
859 (const :tag "lazy lock" lazy-lock-mode)
860 (const :tag "jit lock" jit-lock-mode)
861 (repeat :menu-tag "mode specific" :tag "mode specific"
862 :value ((t . jit-lock-mode))
863 (cons :tag "Instance"
864 (radio :tag "Mode"
865 (const :tag "all" t)
866 (symbol :tag "name"))
867 (radio :tag "Support"
868 (const :tag "none" nil)
869 (const :tag "fast lock" fast-lock-mode)
870 (const :tag "lazy lock" lazy-lock-mode)
871 (const :tag "JIT lock" jit-lock-mode)))
872 ))
873 :version "21.1"
874 :group 'font-lock)
875
876 (defvar fast-lock-mode)
877 (defvar lazy-lock-mode)
878 (defvar jit-lock-mode)
879
880 (defun font-lock-turn-on-thing-lock ()
881 (let ((thing-mode (font-lock-value-in-major-mode font-lock-support-mode)))
882 (cond ((eq thing-mode 'fast-lock-mode)
883 (fast-lock-mode t))
884 ((eq thing-mode 'lazy-lock-mode)
885 (lazy-lock-mode t))
886 ((eq thing-mode 'jit-lock-mode)
887 ;; Prepare for jit-lock
888 (remove-hook 'after-change-functions
889 'font-lock-after-change-function t)
890 (set (make-local-variable 'font-lock-fontify-buffer-function)
891 'jit-lock-refontify)
892 ;; Don't fontify eagerly (and don't abort if the buffer is large).
893 (set (make-local-variable 'font-lock-fontified) t)
894 ;; Use jit-lock.
895 (jit-lock-register 'font-lock-fontify-region
896 (not font-lock-keywords-only))
897 ;; Tell jit-lock how we extend the region to refontify.
898 (add-hook 'jit-lock-after-change-extend-region-functions
899 'font-lock-extend-jit-lock-region-after-change
900 nil t)))))
901
902 (defun font-lock-turn-off-thing-lock ()
903 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
904 (fast-lock-mode -1))
905 ((and (boundp 'jit-lock-mode) jit-lock-mode)
906 (jit-lock-unregister 'font-lock-fontify-region)
907 ;; Reset local vars to the non-jit-lock case.
908 (kill-local-variable 'font-lock-fontify-buffer-function))
909 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
910 (lazy-lock-mode -1))))
911
912 (defun font-lock-after-fontify-buffer ()
913 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
914 (fast-lock-after-fontify-buffer))
915 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
916 ;; (jit-lock-mode
917 ;; (jit-lock-after-fontify-buffer))
918 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
919 (lazy-lock-after-fontify-buffer))))
920
921 (defun font-lock-after-unfontify-buffer ()
922 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
923 (fast-lock-after-unfontify-buffer))
924 ;; Useless as well. It's only called when:
925 ;; - turning off font-lock: it does not matter if we leave spurious
926 ;; `fontified' text props around since jit-lock-mode is also off.
927 ;; - font-lock-default-fontify-buffer fails: this is not run
928 ;; any more anyway. -sm
929 ;;
930 ;; (jit-lock-mode
931 ;; (jit-lock-after-unfontify-buffer))
932 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
933 (lazy-lock-after-unfontify-buffer))))
934
935 ;;; End of Font Lock Support mode.
936 \f
937 ;;; Fontification functions.
938
939 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
940 ;; code to fontify a region, the function runs the function whose name is the
941 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
942 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
943 ;; which does contain the code to fontify a region. However, the value of the
944 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
945 ;; do anything. The indirection of the fontification functions gives major
946 ;; modes the capability of modifying the way font-lock.el fontifies. Major
947 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
948 ;; via the variable `font-lock-defaults'.
949 ;;
950 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
951 ;; font-lock.el uses its own function for buffer fontification. This function
952 ;; makes fontification be on a message-by-message basis and so visiting an
953 ;; RMAIL file is much faster. A clever implementation of the function might
954 ;; fontify the headers differently than the message body. (It should, and
955 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
956 ;; you?) This hints at a more interesting use...
957 ;;
958 ;; Languages that contain text normally contained in different major modes
959 ;; could define their own fontification functions that treat text differently
960 ;; depending on its context. For example, Perl mode could arrange that here
961 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
962 ;; rules one way and C code another. Neat!
963 ;;
964 ;; A further reason to use the fontification indirection feature is when the
965 ;; default syntactual fontification, or the default fontification in general,
966 ;; is not flexible enough for a particular major mode. For example, perhaps
967 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
968 ;; cope with. You need to write your own version of that function, e.g.,
969 ;; `hairy-fontify-syntactically-region', and make your own version of
970 ;; `hairy-fontify-region' call that function before calling
971 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
972 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
973 ;; would call your region fontification function instead of its own. For
974 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
975 ;; directives correctly and cleanly. (It is the same problem as fontifying
976 ;; multi-line strings and comments; regexps are not appropriate for the job.)
977
978 (defvar font-lock-extend-after-change-region-function nil
979 "A function that determines the region to refontify after a change.
980
981 This variable is either nil, or is a function that determines the
982 region to refontify after a change.
983 It is usually set by the major mode via `font-lock-defaults'.
984 Font-lock calls this function after each buffer change.
985
986 The function is given three parameters, the standard BEG, END, and OLD-LEN
987 from `after-change-functions'. It should return either a cons of the beginning
988 and end buffer positions \(in that order) of the region to refontify, or nil
989 \(which directs the caller to fontify a default region).
990 This function should preserve the match-data.
991 The region it returns may start or end in the middle of a line.")
992
993 (defun font-lock-fontify-buffer ()
994 "Fontify the current buffer the way the function `font-lock-mode' would."
995 (interactive)
996 (font-lock-set-defaults)
997 (let ((font-lock-verbose (or font-lock-verbose (interactive-p))))
998 (funcall font-lock-fontify-buffer-function)))
999
1000 (defun font-lock-unfontify-buffer ()
1001 (funcall font-lock-unfontify-buffer-function))
1002
1003 (defun font-lock-fontify-region (beg end &optional loudly)
1004 (font-lock-set-defaults)
1005 (funcall font-lock-fontify-region-function beg end loudly))
1006
1007 (defun font-lock-unfontify-region (beg end)
1008 (save-buffer-state nil
1009 (funcall font-lock-unfontify-region-function beg end)))
1010
1011 (defun font-lock-default-fontify-buffer ()
1012 (let ((verbose (if (numberp font-lock-verbose)
1013 (> (buffer-size) font-lock-verbose)
1014 font-lock-verbose)))
1015 (with-temp-message
1016 (when verbose
1017 (format "Fontifying %s..." (buffer-name)))
1018 ;; Make sure we fontify etc. in the whole buffer.
1019 (save-restriction
1020 (widen)
1021 (condition-case nil
1022 (save-excursion
1023 (save-match-data
1024 (font-lock-fontify-region (point-min) (point-max) verbose)
1025 (font-lock-after-fontify-buffer)
1026 (setq font-lock-fontified t)))
1027 ;; We don't restore the old fontification, so it's best to unfontify.
1028 (quit (font-lock-unfontify-buffer)))))))
1029
1030 (defun font-lock-default-unfontify-buffer ()
1031 ;; Make sure we unfontify etc. in the whole buffer.
1032 (save-restriction
1033 (widen)
1034 (font-lock-unfontify-region (point-min) (point-max))
1035 (font-lock-after-unfontify-buffer)
1036 (setq font-lock-fontified nil)))
1037
1038 (defvar font-lock-dont-widen nil
1039 "If non-nil, font-lock will work on the non-widened buffer.
1040 Useful for things like RMAIL and Info where the whole buffer is not
1041 a very meaningful entity to highlight.")
1042
1043
1044 (defvar font-lock-beg) (defvar font-lock-end)
1045 (defvar font-lock-extend-region-functions
1046 '(font-lock-extend-region-wholelines
1047 ;; This use of font-lock-multiline property is unreliable but is just
1048 ;; a handy heuristic: in case you don't have a function that does
1049 ;; /identification/ of multiline elements, you may still occasionally
1050 ;; discover them by accident (or you may /identify/ them but not in all
1051 ;; cases), in which case the font-lock-multiline property can help make
1052 ;; sure you will properly *re*identify them during refontification.
1053 font-lock-extend-region-multiline)
1054 "Special hook run just before proceeding to fontify a region.
1055 This is used to allow major modes to help font-lock find safe buffer positions
1056 as beginning and end of the fontified region. Its most common use is to solve
1057 the problem of /identification/ of multiline elements by providing a function
1058 that tries to find such elements and move the boundaries such that they do
1059 not fall in the middle of one.
1060 Each function is called with no argument; it is expected to adjust the
1061 dynamically bound variables `font-lock-beg' and `font-lock-end'; and return
1062 non-nil iff it did make such an adjustment.
1063 These functions are run in turn repeatedly until they all return nil.
1064 Put first the functions more likely to cause a change and cheaper to compute.")
1065 ;; Mark it as a special hook which doesn't use any global setting
1066 ;; (i.e. doesn't obey the element t in the buffer-local value).
1067 (make-variable-buffer-local 'font-lock-extend-region-functions)
1068
1069 (defun font-lock-extend-region-multiline ()
1070 "Move fontification boundaries away from any `font-lock-multiline' property."
1071 (let ((changed nil))
1072 (when (and (> font-lock-beg (point-min))
1073 (get-text-property (1- font-lock-beg) 'font-lock-multiline))
1074 (setq changed t)
1075 (setq font-lock-beg (or (previous-single-property-change
1076 font-lock-beg 'font-lock-multiline)
1077 (point-min))))
1078 ;;
1079 (when (get-text-property font-lock-end 'font-lock-multiline)
1080 (setq changed t)
1081 (setq font-lock-end (or (text-property-any font-lock-end (point-max)
1082 'font-lock-multiline nil)
1083 (point-max))))
1084 changed))
1085
1086
1087 (defun font-lock-extend-region-wholelines ()
1088 "Move fontification boundaries to beginning of lines."
1089 (let ((changed nil))
1090 (goto-char font-lock-beg)
1091 (unless (bobp) (setq changed t font-lock-beg (line-beginning-position)))
1092 (goto-char font-lock-end)
1093 (unless (bobp) (setq changed t font-lock-end (line-beginning-position 2)))
1094 changed))
1095
1096 (defun font-lock-default-fontify-region (beg end loudly)
1097 (save-buffer-state
1098 ((parse-sexp-lookup-properties
1099 (or parse-sexp-lookup-properties font-lock-syntactic-keywords))
1100 (old-syntax-table (syntax-table)))
1101 (unwind-protect
1102 (save-restriction
1103 (unless font-lock-dont-widen (widen))
1104 ;; Use the fontification syntax table, if any.
1105 (when font-lock-syntax-table
1106 (set-syntax-table font-lock-syntax-table))
1107 ;; Extend the region to fontify so that it starts and ends at
1108 ;; safe places.
1109 (let ((funs font-lock-extend-region-functions)
1110 (font-lock-beg beg)
1111 (font-lock-end end))
1112 (while funs
1113 (setq funs (if (or (not (funcall (car funs)))
1114 (eq funs font-lock-extend-region-functions))
1115 (cdr funs)
1116 ;; If there's been a change, we should go through
1117 ;; the list again since this new position may
1118 ;; warrant a different answer from one of the fun
1119 ;; we've already seen.
1120 font-lock-extend-region-functions)))
1121 (setq beg font-lock-beg end font-lock-end))
1122 ;; Now do the fontification.
1123 (font-lock-unfontify-region beg end)
1124 (when font-lock-syntactic-keywords
1125 (font-lock-fontify-syntactic-keywords-region beg end))
1126 (unless font-lock-keywords-only
1127 (font-lock-fontify-syntactically-region beg end loudly))
1128 (font-lock-fontify-keywords-region beg end loudly))
1129 ;; Clean up.
1130 (set-syntax-table old-syntax-table))))
1131
1132 ;; The following must be rethought, since keywords can override fontification.
1133 ;; ;; Now scan for keywords, but not if we are inside a comment now.
1134 ;; (or (and (not font-lock-keywords-only)
1135 ;; (let ((state (parse-partial-sexp beg end nil nil
1136 ;; font-lock-cache-state)))
1137 ;; (or (nth 4 state) (nth 7 state))))
1138 ;; (font-lock-fontify-keywords-region beg end))
1139
1140 (defvar font-lock-extra-managed-props nil
1141 "Additional text properties managed by font-lock.
1142 This is used by `font-lock-default-unfontify-region' to decide
1143 what properties to clear before refontifying a region.")
1144
1145 (defun font-lock-default-unfontify-region (beg end)
1146 (remove-list-of-text-properties
1147 beg end (append
1148 font-lock-extra-managed-props
1149 (if font-lock-syntactic-keywords
1150 '(syntax-table face font-lock-multiline)
1151 '(face font-lock-multiline)))))
1152
1153 ;; Called when any modification is made to buffer text.
1154 (defun font-lock-after-change-function (beg end old-len)
1155 (save-excursion
1156 (let ((inhibit-point-motion-hooks t)
1157 (inhibit-quit t)
1158 (region (if font-lock-extend-after-change-region-function
1159 (funcall font-lock-extend-after-change-region-function
1160 beg end old-len))))
1161 (save-match-data
1162 (if region
1163 ;; Fontify the region the major mode has specified.
1164 (setq beg (car region) end (cdr region))
1165 ;; Fontify the whole lines which enclose the region.
1166 ;; Actually, this is not needed because
1167 ;; font-lock-default-fontify-region already rounds up to a whole
1168 ;; number of lines.
1169 ;; (setq beg (progn (goto-char beg) (line-beginning-position))
1170 ;; end (progn (goto-char end) (line-beginning-position 2)))
1171 )
1172 (font-lock-fontify-region beg end)))))
1173
1174 (defvar jit-lock-start) (defvar jit-lock-end)
1175 (defun font-lock-extend-jit-lock-region-after-change (beg end old-len)
1176 (save-excursion
1177 ;; First extend the region as font-lock-after-change-function would.
1178 (let ((region (if font-lock-extend-after-change-region-function
1179 (funcall font-lock-extend-after-change-region-function
1180 beg end old-len))))
1181 (if region
1182 (setq beg (min jit-lock-start (car region))
1183 end (max jit-lock-end (cdr region))))
1184 ;; Then extend the region obeying font-lock-multiline properties,
1185 ;; indicating which part of the buffer needs to be refontified.
1186 ;; !!! This is the *main* user of font-lock-multiline property !!!
1187 ;; font-lock-after-change-function could/should also do that, but it
1188 ;; doesn't need to because font-lock-default-fontify-region does
1189 ;; it anyway. Here OTOH we have no guarantee that
1190 ;; font-lock-default-fontify-region will be executed on this region
1191 ;; any time soon.
1192 (when (and (> beg (point-min))
1193 (get-text-property (1- beg) 'font-lock-multiline))
1194 (setq beg (or (previous-single-property-change
1195 beg 'font-lock-multiline)
1196 (point-min))))
1197 (setq end (or (text-property-any end (point-max)
1198 'font-lock-multiline nil)
1199 (point-max)))
1200 ;; Finally, pre-enlarge the region to a whole number of lines, to try
1201 ;; and predict what font-lock-default-fontify-region will do, so as to
1202 ;; avoid double-redisplay.
1203 (when (memq 'font-lock-extend-region-wholelines
1204 font-lock-extend-region-functions)
1205 (goto-char beg)
1206 (forward-line 0)
1207 (setq jit-lock-start (min jit-lock-start (point)))
1208 (goto-char end)
1209 (forward-line 1)
1210 (setq jit-lock-end (max jit-lock-end (point)))))))
1211
1212 (defun font-lock-fontify-block (&optional arg)
1213 "Fontify some lines the way `font-lock-fontify-buffer' would.
1214 The lines could be a function or paragraph, or a specified number of lines.
1215 If ARG is given, fontify that many lines before and after point, or 16 lines if
1216 no ARG is given and `font-lock-mark-block-function' is nil.
1217 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1218 delimit the region to fontify."
1219 (interactive "P")
1220 (let ((inhibit-point-motion-hooks t) font-lock-beginning-of-syntax-function
1221 deactivate-mark)
1222 ;; Make sure we have the right `font-lock-keywords' etc.
1223 (if (not font-lock-mode) (font-lock-set-defaults))
1224 (save-excursion
1225 (save-match-data
1226 (condition-case error-data
1227 (if (or arg (not font-lock-mark-block-function))
1228 (let ((lines (if arg (prefix-numeric-value arg) 16)))
1229 (font-lock-fontify-region
1230 (save-excursion (forward-line (- lines)) (point))
1231 (save-excursion (forward-line lines) (point))))
1232 (funcall font-lock-mark-block-function)
1233 (font-lock-fontify-region (point) (mark)))
1234 ((error quit) (message "Fontifying block...%s" error-data)))))))
1235
1236 (unless (featurep 'facemenu)
1237 (error "facemenu must be loaded before font-lock"))
1238 (define-key facemenu-keymap "\M-o" 'font-lock-fontify-block)
1239
1240 ;;; End of Fontification functions.
1241 \f
1242 ;;; Additional text property functions.
1243
1244 ;; The following text property functions should be builtins. This means they
1245 ;; should be written in C and put with all the other text property functions.
1246 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1247 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1248 ;; in Lisp below and commented out. sm.
1249
1250 (defun font-lock-prepend-text-property (start end prop value &optional object)
1251 "Prepend to one property of the text from START to END.
1252 Arguments PROP and VALUE specify the property and value to prepend to the value
1253 already in place. The resulting property values are always lists.
1254 Optional argument OBJECT is the string or buffer containing the text."
1255 (let ((val (if (listp value) value (list value))) next prev)
1256 (while (/= start end)
1257 (setq next (next-single-property-change start prop object end)
1258 prev (get-text-property start prop object))
1259 (put-text-property start next prop
1260 (append val (if (listp prev) prev (list prev)))
1261 object)
1262 (setq start next))))
1263
1264 (defun font-lock-append-text-property (start end prop value &optional object)
1265 "Append to one property of the text from START to END.
1266 Arguments PROP and VALUE specify the property and value to append to the value
1267 already in place. The resulting property values are always lists.
1268 Optional argument OBJECT is the string or buffer containing the text."
1269 (let ((val (if (listp value) value (list value))) next prev)
1270 (while (/= start end)
1271 (setq next (next-single-property-change start prop object end)
1272 prev (get-text-property start prop object))
1273 (put-text-property start next prop
1274 (append (if (listp prev) prev (list prev)) val)
1275 object)
1276 (setq start next))))
1277
1278 (defun font-lock-fillin-text-property (start end prop value &optional object)
1279 "Fill in one property of the text from START to END.
1280 Arguments PROP and VALUE specify the property and value to put where none are
1281 already in place. Therefore existing property values are not overwritten.
1282 Optional argument OBJECT is the string or buffer containing the text."
1283 (let ((start (text-property-any start end prop nil object)) next)
1284 (while start
1285 (setq next (next-single-property-change start prop object end))
1286 (put-text-property start next prop value object)
1287 (setq start (text-property-any next end prop nil object)))))
1288
1289 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1290 ;; is to `add-text-properties', etc.
1291 ;;(defun remove-text-property (start end property &optional object)
1292 ;; "Remove a property from text from START to END.
1293 ;;Argument PROPERTY is the property to remove.
1294 ;;Optional argument OBJECT is the string or buffer containing the text.
1295 ;;Return t if the property was actually removed, nil otherwise."
1296 ;; (remove-text-properties start end (list property) object))
1297
1298 ;; For consistency: maybe this should be called `remove-single-property' like
1299 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1300 ;;(defun remove-single-text-property (start end prop value &optional object)
1301 ;; "Remove a specific property value from text from START to END.
1302 ;;Arguments PROP and VALUE specify the property and value to remove. The
1303 ;;resulting property values are not equal to VALUE nor lists containing VALUE.
1304 ;;Optional argument OBJECT is the string or buffer containing the text."
1305 ;; (let ((start (text-property-not-all start end prop nil object)) next prev)
1306 ;; (while start
1307 ;; (setq next (next-single-property-change start prop object end)
1308 ;; prev (get-text-property start prop object))
1309 ;; (cond ((and (symbolp prev) (eq value prev))
1310 ;; (remove-text-property start next prop object))
1311 ;; ((and (listp prev) (memq value prev))
1312 ;; (let ((new (delq value prev)))
1313 ;; (cond ((null new)
1314 ;; (remove-text-property start next prop object))
1315 ;; ((= (length new) 1)
1316 ;; (put-text-property start next prop (car new) object))
1317 ;; (t
1318 ;; (put-text-property start next prop new object))))))
1319 ;; (setq start (text-property-not-all next end prop nil object)))))
1320
1321 ;;; End of Additional text property functions.
1322 \f
1323 ;;; Syntactic regexp fontification functions.
1324
1325 ;; These syntactic keyword pass functions are identical to those keyword pass
1326 ;; functions below, with the following exceptions; (a) they operate on
1327 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1328 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1329 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1330 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1331 ;; LOUDLY as it is not likely to be intensive.
1332
1333 (defun font-lock-apply-syntactic-highlight (highlight)
1334 "Apply HIGHLIGHT following a match.
1335 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1336 see `font-lock-syntactic-keywords'."
1337 (let* ((match (nth 0 highlight))
1338 (start (match-beginning match)) (end (match-end match))
1339 (value (nth 1 highlight))
1340 (override (nth 2 highlight)))
1341 (if (not start)
1342 ;; No match but we might not signal an error.
1343 (or (nth 3 highlight)
1344 (error "No match %d in highlight %S" match highlight))
1345 (when (and (consp value) (not (numberp (car value))))
1346 (setq value (eval value)))
1347 (when (stringp value) (setq value (string-to-syntax value)))
1348 ;; Flush the syntax-cache. I believe this is not necessary for
1349 ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can
1350 ;; still be necessary for other users of syntax-ppss anyway.
1351 (syntax-ppss-after-change-function start)
1352 (cond
1353 ((not override)
1354 ;; Cannot override existing fontification.
1355 (or (text-property-not-all start end 'syntax-table nil)
1356 (put-text-property start end 'syntax-table value)))
1357 ((eq override t)
1358 ;; Override existing fontification.
1359 (put-text-property start end 'syntax-table value))
1360 ((eq override 'keep)
1361 ;; Keep existing fontification.
1362 (font-lock-fillin-text-property start end 'syntax-table value))))))
1363
1364 (defun font-lock-fontify-syntactic-anchored-keywords (keywords limit)
1365 "Fontify according to KEYWORDS until LIMIT.
1366 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1367 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1368 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
1369 ;; Evaluate PRE-MATCH-FORM.
1370 (pre-match-value (eval (nth 1 keywords))))
1371 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1372 (if (and (numberp pre-match-value) (> pre-match-value (point)))
1373 (setq limit pre-match-value)
1374 (setq limit (line-end-position)))
1375 (save-match-data
1376 ;; Find an occurrence of `matcher' before `limit'.
1377 (while (if (stringp matcher)
1378 (re-search-forward matcher limit t)
1379 (funcall matcher limit))
1380 ;; Apply each highlight to this instance of `matcher'.
1381 (setq highlights lowdarks)
1382 (while highlights
1383 (font-lock-apply-syntactic-highlight (car highlights))
1384 (setq highlights (cdr highlights)))))
1385 ;; Evaluate POST-MATCH-FORM.
1386 (eval (nth 2 keywords))))
1387
1388 (defun font-lock-fontify-syntactic-keywords-region (start end)
1389 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1390 START should be at the beginning of a line."
1391 ;; Ensure the beginning of the file is properly syntactic-fontified.
1392 (when (and font-lock-syntactically-fontified
1393 (< font-lock-syntactically-fontified start))
1394 (setq start (max font-lock-syntactically-fontified (point-min)))
1395 (setq font-lock-syntactically-fontified end))
1396 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1397 (when (symbolp font-lock-syntactic-keywords)
1398 (setq font-lock-syntactic-keywords (font-lock-eval-keywords
1399 font-lock-syntactic-keywords)))
1400 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1401 (unless (eq (car font-lock-syntactic-keywords) t)
1402 (setq font-lock-syntactic-keywords (font-lock-compile-keywords
1403 font-lock-syntactic-keywords)))
1404 ;; Get down to business.
1405 (let ((case-fold-search font-lock-keywords-case-fold-search)
1406 (keywords (cddr font-lock-syntactic-keywords))
1407 keyword matcher highlights)
1408 (while keywords
1409 ;; Find an occurrence of `matcher' from `start' to `end'.
1410 (setq keyword (car keywords) matcher (car keyword))
1411 (goto-char start)
1412 (while (if (stringp matcher)
1413 (re-search-forward matcher end t)
1414 (funcall matcher end))
1415 ;; Apply each highlight to this instance of `matcher', which may be
1416 ;; specific highlights or more keywords anchored to `matcher'.
1417 (setq highlights (cdr keyword))
1418 (while highlights
1419 (if (numberp (car (car highlights)))
1420 (font-lock-apply-syntactic-highlight (car highlights))
1421 (font-lock-fontify-syntactic-anchored-keywords (car highlights)
1422 end))
1423 (setq highlights (cdr highlights))))
1424 (setq keywords (cdr keywords)))))
1425
1426 ;;; End of Syntactic regexp fontification functions.
1427 \f
1428 ;;; Syntactic fontification functions.
1429
1430 (defvar font-lock-comment-start-skip nil
1431 "If non-nil, Font Lock mode uses this instead of `comment-start-skip'.")
1432
1433 (defvar font-lock-comment-end-skip nil
1434 "If non-nil, Font Lock mode uses this instead of `comment-end'.")
1435
1436 (defun font-lock-fontify-syntactically-region (start end &optional loudly ppss)
1437 "Put proper face on each string and comment between START and END.
1438 START should be at the beginning of a line."
1439 (let ((comment-end-regexp
1440 (or font-lock-comment-end-skip
1441 (regexp-quote
1442 (replace-regexp-in-string "^ *" "" comment-end))))
1443 state face beg)
1444 (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
1445 (goto-char start)
1446 ;;
1447 ;; Find the `start' state.
1448 (setq state (or ppss (syntax-ppss start)))
1449 ;;
1450 ;; Find each interesting place between here and `end'.
1451 (while
1452 (progn
1453 (when (or (nth 3 state) (nth 4 state))
1454 (setq face (funcall font-lock-syntactic-face-function state))
1455 (setq beg (max (nth 8 state) start))
1456 (setq state (parse-partial-sexp (point) end nil nil state
1457 'syntax-table))
1458 (when face (put-text-property beg (point) 'face face))
1459 (when (and (eq face 'font-lock-comment-face)
1460 (or font-lock-comment-start-skip
1461 comment-start-skip))
1462 ;; Find the comment delimiters
1463 ;; and use font-lock-comment-delimiter-face for them.
1464 (save-excursion
1465 (goto-char beg)
1466 (if (looking-at (or font-lock-comment-start-skip
1467 comment-start-skip))
1468 (put-text-property beg (match-end 0) 'face
1469 font-lock-comment-delimiter-face)))
1470 (if (looking-back comment-end-regexp (point-at-bol) t)
1471 (put-text-property (match-beginning 0) (point) 'face
1472 font-lock-comment-delimiter-face))))
1473 (< (point) end))
1474 (setq state (parse-partial-sexp (point) end nil nil state
1475 'syntax-table)))))
1476
1477 ;;; End of Syntactic fontification functions.
1478 \f
1479 ;;; Keyword regexp fontification functions.
1480
1481 (defsubst font-lock-apply-highlight (highlight)
1482 "Apply HIGHLIGHT following a match.
1483 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1484 (let* ((match (nth 0 highlight))
1485 (start (match-beginning match)) (end (match-end match))
1486 (override (nth 2 highlight)))
1487 (if (not start)
1488 ;; No match but we might not signal an error.
1489 (or (nth 3 highlight)
1490 (error "No match %d in highlight %S" match highlight))
1491 (let ((val (eval (nth 1 highlight))))
1492 (when (eq (car-safe val) 'face)
1493 (add-text-properties start end (cddr val))
1494 (setq val (cadr val)))
1495 (cond
1496 ((not (or val (eq override t)))
1497 ;; If `val' is nil, don't do anything. It is important to do it
1498 ;; explicitly, because when adding nil via things like
1499 ;; font-lock-append-text-property, the property is actually
1500 ;; changed from <face> to (<face>) which is undesirable. --Stef
1501 nil)
1502 ((not override)
1503 ;; Cannot override existing fontification.
1504 (or (text-property-not-all start end 'face nil)
1505 (put-text-property start end 'face val)))
1506 ((eq override t)
1507 ;; Override existing fontification.
1508 (put-text-property start end 'face val))
1509 ((eq override 'prepend)
1510 ;; Prepend to existing fontification.
1511 (font-lock-prepend-text-property start end 'face val))
1512 ((eq override 'append)
1513 ;; Append to existing fontification.
1514 (font-lock-append-text-property start end 'face val))
1515 ((eq override 'keep)
1516 ;; Keep existing fontification.
1517 (font-lock-fillin-text-property start end 'face val)))))))
1518
1519 (defsubst font-lock-fontify-anchored-keywords (keywords limit)
1520 "Fontify according to KEYWORDS until LIMIT.
1521 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1522 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1523 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
1524 (lead-start (match-beginning 0))
1525 ;; Evaluate PRE-MATCH-FORM.
1526 (pre-match-value (eval (nth 1 keywords))))
1527 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1528 (if (not (and (numberp pre-match-value) (> pre-match-value (point))))
1529 (setq limit (line-end-position))
1530 (setq limit pre-match-value)
1531 (when (and font-lock-multiline (>= limit (line-beginning-position 2)))
1532 ;; this is a multiline anchored match
1533 ;; (setq font-lock-multiline t)
1534 (put-text-property (if (= limit (line-beginning-position 2))
1535 (1- limit)
1536 (min lead-start (point)))
1537 limit
1538 'font-lock-multiline t)))
1539 (save-match-data
1540 ;; Find an occurrence of `matcher' before `limit'.
1541 (while (and (< (point) limit)
1542 (if (stringp matcher)
1543 (re-search-forward matcher limit t)
1544 (funcall matcher limit)))
1545 ;; Apply each highlight to this instance of `matcher'.
1546 (setq highlights lowdarks)
1547 (while highlights
1548 (font-lock-apply-highlight (car highlights))
1549 (setq highlights (cdr highlights)))))
1550 ;; Evaluate POST-MATCH-FORM.
1551 (eval (nth 2 keywords))))
1552
1553 (defun font-lock-fontify-keywords-region (start end &optional loudly)
1554 "Fontify according to `font-lock-keywords' between START and END.
1555 START should be at the beginning of a line.
1556 LOUDLY, if non-nil, allows progress-meter bar."
1557 (unless (eq (car font-lock-keywords) t)
1558 (setq font-lock-keywords
1559 (font-lock-compile-keywords font-lock-keywords t)))
1560 (let ((case-fold-search font-lock-keywords-case-fold-search)
1561 (keywords (cddr font-lock-keywords))
1562 (bufname (buffer-name)) (count 0)
1563 (pos (make-marker))
1564 keyword matcher highlights)
1565 ;;
1566 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1567 (while keywords
1568 (if loudly (message "Fontifying %s... (regexps..%s)" bufname
1569 (make-string (incf count) ?.)))
1570 ;;
1571 ;; Find an occurrence of `matcher' from `start' to `end'.
1572 (setq keyword (car keywords) matcher (car keyword))
1573 (goto-char start)
1574 (while (and (< (point) end)
1575 (if (stringp matcher)
1576 (re-search-forward matcher end t)
1577 (funcall matcher end))
1578 ;; Beware empty string matches since they will
1579 ;; loop indefinitely.
1580 (or (> (point) (match-beginning 0))
1581 (progn (forward-char 1) t)))
1582 (when (and font-lock-multiline
1583 (>= (point)
1584 (save-excursion (goto-char (match-beginning 0))
1585 (forward-line 1) (point))))
1586 ;; this is a multiline regexp match
1587 ;; (setq font-lock-multiline t)
1588 (put-text-property (if (= (point)
1589 (save-excursion
1590 (goto-char (match-beginning 0))
1591 (forward-line 1) (point)))
1592 (1- (point))
1593 (match-beginning 0))
1594 (point)
1595 'font-lock-multiline t))
1596 ;; Apply each highlight to this instance of `matcher', which may be
1597 ;; specific highlights or more keywords anchored to `matcher'.
1598 (setq highlights (cdr keyword))
1599 (while highlights
1600 (if (numberp (car (car highlights)))
1601 (font-lock-apply-highlight (car highlights))
1602 (set-marker pos (point))
1603 (font-lock-fontify-anchored-keywords (car highlights) end)
1604 ;; Ensure forward progress. `pos' is a marker because anchored
1605 ;; keyword may add/delete text (this happens e.g. in grep.el).
1606 (if (< (point) pos) (goto-char pos)))
1607 (setq highlights (cdr highlights))))
1608 (setq keywords (cdr keywords)))
1609 (set-marker pos nil)))
1610
1611 ;;; End of Keyword regexp fontification functions.
1612 \f
1613 ;; Various functions.
1614
1615 (defun font-lock-compile-keywords (keywords &optional regexp)
1616 "Compile KEYWORDS into the form (t KEYWORDS COMPILED...)
1617 Here each COMPILED is of the form (MATCHER HIGHLIGHT ...) as shown in the
1618 `font-lock-keywords' doc string.
1619 If REGEXP is non-nil, it means these keywords are used for
1620 `font-lock-keywords' rather than for `font-lock-syntactic-keywords'."
1621 (if (not font-lock-set-defaults)
1622 ;; This should never happen. But some external packages sometimes
1623 ;; call font-lock in unexpected and incorrect ways. It's important to
1624 ;; stop processing at this point, otherwise we may end up changing the
1625 ;; global value of font-lock-keywords and break highlighting in many
1626 ;; other buffers.
1627 (error "Font-lock trying to use keywords before setting them up"))
1628 (if (eq (car-safe keywords) t)
1629 keywords
1630 (setq keywords
1631 (cons t (cons keywords
1632 (mapcar 'font-lock-compile-keyword keywords))))
1633 (if (and regexp
1634 (eq (or syntax-begin-function
1635 font-lock-beginning-of-syntax-function)
1636 'beginning-of-defun)
1637 (not beginning-of-defun-function))
1638 ;; Try to detect when a string or comment contains something that
1639 ;; looks like a defun and would thus confuse font-lock.
1640 (nconc keywords
1641 `((,(if defun-prompt-regexp
1642 (concat "^\\(?:" defun-prompt-regexp "\\)?\\s(")
1643 "^\\s(")
1644 (0
1645 (if (memq (get-text-property (match-beginning 0) 'face)
1646 '(font-lock-string-face font-lock-doc-face
1647 font-lock-comment-face))
1648 (list 'face font-lock-warning-face
1649 'help-echo "Looks like a toplevel defun: escape the parenthesis"))
1650 prepend)))))
1651 keywords))
1652
1653 (defun font-lock-compile-keyword (keyword)
1654 (cond ((nlistp keyword) ; MATCHER
1655 (list keyword '(0 font-lock-keyword-face)))
1656 ((eq (car keyword) 'eval) ; (eval . FORM)
1657 (font-lock-compile-keyword (eval (cdr keyword))))
1658 ((eq (car-safe (cdr keyword)) 'quote) ; (MATCHER . 'FORM)
1659 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1660 (if (symbolp (nth 2 keyword))
1661 (list (car keyword) (list 0 (cdr keyword)))
1662 (font-lock-compile-keyword (cons (car keyword) (nth 2 keyword)))))
1663 ((numberp (cdr keyword)) ; (MATCHER . MATCH)
1664 (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
1665 ((symbolp (cdr keyword)) ; (MATCHER . FACENAME)
1666 (list (car keyword) (list 0 (cdr keyword))))
1667 ((nlistp (nth 1 keyword)) ; (MATCHER . HIGHLIGHT)
1668 (list (car keyword) (cdr keyword)))
1669 (t ; (MATCHER HIGHLIGHT ...)
1670 keyword)))
1671
1672 (defun font-lock-eval-keywords (keywords)
1673 "Evalulate KEYWORDS if a function (funcall) or variable (eval) name."
1674 (if (listp keywords)
1675 keywords
1676 (font-lock-eval-keywords (if (fboundp keywords)
1677 (funcall keywords)
1678 (eval keywords)))))
1679
1680 (defun font-lock-value-in-major-mode (alist)
1681 "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1682 Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
1683 (if (consp alist)
1684 (cdr (or (assq major-mode alist) (assq t alist)))
1685 alist))
1686
1687 (defun font-lock-choose-keywords (keywords level)
1688 "Return LEVELth element of KEYWORDS.
1689 A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1690 \(1- (length KEYWORDS))."
1691 (cond ((not (and (listp keywords) (symbolp (car keywords))))
1692 keywords)
1693 ((numberp level)
1694 (or (nth level keywords) (car (last keywords))))
1695 ((eq level t)
1696 (car (last keywords)))
1697 (t
1698 (car keywords))))
1699
1700 (defvar font-lock-set-defaults nil) ; Whether we have set up defaults.
1701
1702 (defvar font-lock-mode-major-mode)
1703 (defun font-lock-set-defaults ()
1704 "Set fontification defaults appropriately for this mode.
1705 Sets various variables using `font-lock-defaults' (or, if nil, using
1706 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1707 ;; Set fontification defaults iff not previously set for correct major mode.
1708 (unless (and font-lock-set-defaults
1709 (eq font-lock-mode-major-mode major-mode))
1710 (setq font-lock-mode-major-mode major-mode)
1711 (set (make-local-variable 'font-lock-set-defaults) t)
1712 (make-local-variable 'font-lock-fontified)
1713 (make-local-variable 'font-lock-multiline)
1714 (let* ((defaults (or font-lock-defaults
1715 (cdr (assq major-mode
1716 (with-no-warnings
1717 font-lock-defaults-alist)))))
1718 (keywords
1719 (font-lock-choose-keywords (nth 0 defaults)
1720 (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1721 (local (cdr (assq major-mode font-lock-keywords-alist)))
1722 (removed-keywords
1723 (cdr-safe (assq major-mode font-lock-removed-keywords-alist))))
1724 (set (make-local-variable 'font-lock-defaults) defaults)
1725 ;; Syntactic fontification?
1726 (when (nth 1 defaults)
1727 (set (make-local-variable 'font-lock-keywords-only) t))
1728 ;; Case fold during regexp fontification?
1729 (when (nth 2 defaults)
1730 (set (make-local-variable 'font-lock-keywords-case-fold-search) t))
1731 ;; Syntax table for regexp and syntactic fontification?
1732 (when (nth 3 defaults)
1733 (set (make-local-variable 'font-lock-syntax-table)
1734 (copy-syntax-table (syntax-table)))
1735 (dolist (selem (nth 3 defaults))
1736 ;; The character to modify may be a single CHAR or a STRING.
1737 (let ((syntax (cdr selem)))
1738 (dolist (char (if (numberp (car selem))
1739 (list (car selem))
1740 (mapcar 'identity (car selem))))
1741 (modify-syntax-entry char syntax font-lock-syntax-table)))))
1742 ;; Syntax function for syntactic fontification?
1743 (when (nth 4 defaults)
1744 (set (make-local-variable 'font-lock-beginning-of-syntax-function)
1745 (nth 4 defaults)))
1746 ;; Variable alist?
1747 (dolist (x (nthcdr 5 defaults))
1748 (set (make-local-variable (car x)) (cdr x)))
1749 ;; Set up `font-lock-keywords' last because its value might depend
1750 ;; on other settings (e.g. font-lock-compile-keywords uses
1751 ;; font-lock-beginning-of-syntax-function).
1752 (set (make-local-variable 'font-lock-keywords)
1753 (font-lock-eval-keywords keywords))
1754 ;; Local fontification?
1755 (while local
1756 (font-lock-add-keywords nil (car (car local)) (cdr (car local)))
1757 (setq local (cdr local)))
1758 (when removed-keywords
1759 (font-lock-remove-keywords nil removed-keywords))
1760 ;; Now compile the keywords.
1761 (unless (eq (car font-lock-keywords) t)
1762 (setq font-lock-keywords
1763 (font-lock-compile-keywords font-lock-keywords t))))))
1764 \f
1765 ;;; Colour etc. support.
1766
1767 ;; Note that `defface' will not overwrite any faces declared above via
1768 ;; `custom-declare-face'.
1769 (defface font-lock-comment-face
1770 '((((class grayscale) (background light))
1771 (:foreground "DimGray" :weight bold :slant italic))
1772 (((class grayscale) (background dark))
1773 (:foreground "LightGray" :weight bold :slant italic))
1774 (((class color) (min-colors 88) (background light))
1775 (:foreground "Firebrick"))
1776 (((class color) (min-colors 88) (background dark))
1777 (:foreground "chocolate1"))
1778 (((class color) (min-colors 16) (background light))
1779 (:foreground "red"))
1780 (((class color) (min-colors 16) (background dark))
1781 (:foreground "red1"))
1782 (((class color) (min-colors 8) (background light))
1783 )
1784 (((class color) (min-colors 8) (background dark))
1785 )
1786 (t (:weight bold :slant italic)))
1787 "Font Lock mode face used to highlight comments."
1788 :group 'font-lock-faces)
1789
1790 (defface font-lock-comment-delimiter-face
1791 '((default :inherit font-lock-comment-face)
1792 (((class grayscale)))
1793 (((class color) (min-colors 16)))
1794 (((class color) (min-colors 8) (background light))
1795 :foreground "red")
1796 (((class color) (min-colors 8) (background dark))
1797 :foreground "red1"))
1798 "Font Lock mode face used to highlight comment delimiters."
1799 :group 'font-lock-faces)
1800
1801 (defface font-lock-string-face
1802 '((((class grayscale) (background light)) (:foreground "DimGray" :slant italic))
1803 (((class grayscale) (background dark)) (:foreground "LightGray" :slant italic))
1804 (((class color) (min-colors 88) (background light)) (:foreground "RosyBrown"))
1805 (((class color) (min-colors 88) (background dark)) (:foreground "LightSalmon"))
1806 (((class color) (min-colors 16) (background light)) (:foreground "RosyBrown"))
1807 (((class color) (min-colors 16) (background dark)) (:foreground "LightSalmon"))
1808 (((class color) (min-colors 8)) (:foreground "green"))
1809 (t (:slant italic)))
1810 "Font Lock mode face used to highlight strings."
1811 :group 'font-lock-faces)
1812
1813 (defface font-lock-doc-face
1814 '((t :inherit font-lock-string-face))
1815 "Font Lock mode face used to highlight documentation."
1816 :group 'font-lock-faces)
1817
1818 (defface font-lock-keyword-face
1819 '((((class grayscale) (background light)) (:foreground "LightGray" :weight bold))
1820 (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold))
1821 (((class color) (min-colors 88) (background light)) (:foreground "Purple"))
1822 (((class color) (min-colors 88) (background dark)) (:foreground "Cyan1"))
1823 (((class color) (min-colors 16) (background light)) (:foreground "Purple"))
1824 (((class color) (min-colors 16) (background dark)) (:foreground "Cyan"))
1825 (((class color) (min-colors 8)) (:foreground "cyan" :weight bold))
1826 (t (:weight bold)))
1827 "Font Lock mode face used to highlight keywords."
1828 :group 'font-lock-faces)
1829
1830 (defface font-lock-builtin-face
1831 '((((class grayscale) (background light)) (:foreground "LightGray" :weight bold))
1832 (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold))
1833 (((class color) (min-colors 88) (background light)) (:foreground "Orchid"))
1834 (((class color) (min-colors 88) (background dark)) (:foreground "LightSteelBlue"))
1835 (((class color) (min-colors 16) (background light)) (:foreground "Orchid"))
1836 (((class color) (min-colors 16) (background dark)) (:foreground "LightSteelBlue"))
1837 (((class color) (min-colors 8)) (:foreground "blue" :weight bold))
1838 (t (:weight bold)))
1839 "Font Lock mode face used to highlight builtins."
1840 :group 'font-lock-faces)
1841
1842 (defface font-lock-function-name-face
1843 '((((class color) (min-colors 88) (background light)) (:foreground "Blue1"))
1844 (((class color) (min-colors 88) (background dark)) (:foreground "LightSkyBlue"))
1845 (((class color) (min-colors 16) (background light)) (:foreground "Blue"))
1846 (((class color) (min-colors 16) (background dark)) (:foreground "LightSkyBlue"))
1847 (((class color) (min-colors 8)) (:foreground "blue" :weight bold))
1848 (t (:inverse-video t :weight bold)))
1849 "Font Lock mode face used to highlight function names."
1850 :group 'font-lock-faces)
1851
1852 (defface font-lock-variable-name-face
1853 '((((class grayscale) (background light))
1854 (:foreground "Gray90" :weight bold :slant italic))
1855 (((class grayscale) (background dark))
1856 (:foreground "DimGray" :weight bold :slant italic))
1857 (((class color) (min-colors 88) (background light)) (:foreground "DarkGoldenrod"))
1858 (((class color) (min-colors 88) (background dark)) (:foreground "LightGoldenrod"))
1859 (((class color) (min-colors 16) (background light)) (:foreground "DarkGoldenrod"))
1860 (((class color) (min-colors 16) (background dark)) (:foreground "LightGoldenrod"))
1861 (((class color) (min-colors 8)) (:foreground "yellow" :weight light))
1862 (t (:weight bold :slant italic)))
1863 "Font Lock mode face used to highlight variable names."
1864 :group 'font-lock-faces)
1865
1866 (defface font-lock-type-face
1867 '((((class grayscale) (background light)) (:foreground "Gray90" :weight bold))
1868 (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold))
1869 (((class color) (min-colors 88) (background light)) (:foreground "ForestGreen"))
1870 (((class color) (min-colors 88) (background dark)) (:foreground "PaleGreen"))
1871 (((class color) (min-colors 16) (background light)) (:foreground "ForestGreen"))
1872 (((class color) (min-colors 16) (background dark)) (:foreground "PaleGreen"))
1873 (((class color) (min-colors 8)) (:foreground "green"))
1874 (t (:weight bold :underline t)))
1875 "Font Lock mode face used to highlight type and classes."
1876 :group 'font-lock-faces)
1877
1878 (defface font-lock-constant-face
1879 '((((class grayscale) (background light))
1880 (:foreground "LightGray" :weight bold :underline t))
1881 (((class grayscale) (background dark))
1882 (:foreground "Gray50" :weight bold :underline t))
1883 (((class color) (min-colors 88) (background light)) (:foreground "CadetBlue"))
1884 (((class color) (min-colors 88) (background dark)) (:foreground "Aquamarine"))
1885 (((class color) (min-colors 16) (background light)) (:foreground "CadetBlue"))
1886 (((class color) (min-colors 16) (background dark)) (:foreground "Aquamarine"))
1887 (((class color) (min-colors 8)) (:foreground "magenta"))
1888 (t (:weight bold :underline t)))
1889 "Font Lock mode face used to highlight constants and labels."
1890 :group 'font-lock-faces)
1891
1892 (defface font-lock-warning-face
1893 '((((class color) (min-colors 88) (background light)) (:foreground "Red1" :weight bold))
1894 (((class color) (min-colors 88) (background dark)) (:foreground "Pink" :weight bold))
1895 (((class color) (min-colors 16) (background light)) (:foreground "Red1" :weight bold))
1896 (((class color) (min-colors 16) (background dark)) (:foreground "Pink" :weight bold))
1897 (((class color) (min-colors 8)) (:foreground "red"))
1898 (t (:inverse-video t :weight bold)))
1899 "Font Lock mode face used to highlight warnings."
1900 :group 'font-lock-faces)
1901
1902 (defface font-lock-negation-char-face
1903 '((t nil))
1904 "Font Lock mode face used to highlight easy to overlook negation."
1905 :group 'font-lock-faces)
1906
1907 (defface font-lock-preprocessor-face
1908 '((t :inherit font-lock-builtin-face))
1909 "Font Lock mode face used to highlight preprocessor directives."
1910 :group 'font-lock-faces)
1911
1912 (defface font-lock-regexp-grouping-backslash
1913 '((t :inherit bold))
1914 "Font Lock mode face for backslashes in Lisp regexp grouping constructs."
1915 :group 'font-lock-faces)
1916
1917 (defface font-lock-regexp-grouping-construct
1918 '((t :inherit bold))
1919 "Font Lock mode face used to highlight grouping constructs in Lisp regexps."
1920 :group 'font-lock-faces)
1921
1922 ;;; End of Colour etc. support.
1923 \f
1924 ;;; Menu support.
1925
1926 ;; This section of code is commented out because Emacs does not have real menu
1927 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1928 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1929 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1930 ;; the entry for "Text Properties" something like:
1931 ;;
1932 ;; (define-key menu-bar-edit-menu [font-lock]
1933 ;; (cons "Syntax Highlighting" font-lock-menu))
1934 ;;
1935 ;; and remove a single ";" from the beginning of each line in the rest of this
1936 ;; section. Probably the mechanism for telling the menu code what are menu
1937 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1938 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1939
1940 ;;;;;###autoload
1941 ;;(progn
1942 ;; ;; Make the Font Lock menu.
1943 ;; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1944 ;; ;; Add the menu items in reverse order.
1945 ;; (define-key font-lock-menu [fontify-less]
1946 ;; '("Less In Current Buffer" . font-lock-fontify-less))
1947 ;; (define-key font-lock-menu [fontify-more]
1948 ;; '("More In Current Buffer" . font-lock-fontify-more))
1949 ;; (define-key font-lock-menu [font-lock-sep]
1950 ;; '("--"))
1951 ;; (define-key font-lock-menu [font-lock-mode]
1952 ;; '("In Current Buffer" . font-lock-mode))
1953 ;; (define-key font-lock-menu [global-font-lock-mode]
1954 ;; '("In All Buffers" . global-font-lock-mode)))
1955 ;;
1956 ;;;;;###autoload
1957 ;;(progn
1958 ;; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1959 ;; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1960 ;; (put 'global-font-lock-mode 'menu-toggle t)
1961 ;; (put 'font-lock-mode 'menu-toggle t)
1962 ;; (put 'font-lock-fontify-more 'menu-enable '(identity))
1963 ;; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1964 ;;
1965 ;; ;; Put the appropriate symbol property values on now. See above.
1966 ;;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
1967 ;;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1968 ;;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1969 ;;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1970 ;;
1971 ;;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1972 ;;
1973 ;;(defun font-lock-fontify-level (level)
1974 ;; (let ((font-lock-maximum-decoration level))
1975 ;; (when font-lock-mode
1976 ;; (font-lock-mode))
1977 ;; (font-lock-mode)
1978 ;; (when font-lock-verbose
1979 ;; (message "Fontifying %s... level %d" (buffer-name) level))))
1980 ;;
1981 ;;(defun font-lock-fontify-less ()
1982 ;; "Fontify the current buffer with less decoration.
1983 ;;See `font-lock-maximum-decoration'."
1984 ;; (interactive)
1985 ;; ;; Check in case we get called interactively.
1986 ;; (if (nth 1 font-lock-fontify-level)
1987 ;; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1988 ;; (error "No less decoration")))
1989 ;;
1990 ;;(defun font-lock-fontify-more ()
1991 ;; "Fontify the current buffer with more decoration.
1992 ;;See `font-lock-maximum-decoration'."
1993 ;; (interactive)
1994 ;; ;; Check in case we get called interactively.
1995 ;; (if (nth 2 font-lock-fontify-level)
1996 ;; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1997 ;; (error "No more decoration")))
1998 ;;
1999 ;; ;; This should be called by `font-lock-set-defaults'.
2000 ;;(defun font-lock-set-menu ()
2001 ;; ;; Activate less/more fontification entries if there are multiple levels for
2002 ;; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
2003 ;; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
2004 ;; (let ((keywords (or (nth 0 font-lock-defaults)
2005 ;; (nth 1 (assq major-mode font-lock-defaults-alist))))
2006 ;; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
2007 ;; (make-local-variable 'font-lock-fontify-level)
2008 ;; (if (or (symbolp keywords) (= (length keywords) 1))
2009 ;; (font-lock-unset-menu)
2010 ;; (cond ((eq level t)
2011 ;; (setq level (1- (length keywords))))
2012 ;; ((or (null level) (zerop level))
2013 ;; ;; The default level is usually, but not necessarily, level 1.
2014 ;; (setq level (- (length keywords)
2015 ;; (length (member (eval (car keywords))
2016 ;; (mapcar 'eval (cdr keywords))))))))
2017 ;; (setq font-lock-fontify-level (list level (> level 1)
2018 ;; (< level (1- (length keywords))))))))
2019 ;;
2020 ;; ;; This should be called by `font-lock-unset-defaults'.
2021 ;;(defun font-lock-unset-menu ()
2022 ;; ;; Deactivate less/more fontification entries.
2023 ;; (setq font-lock-fontify-level nil))
2024
2025 ;;; End of Menu support.
2026 \f
2027 ;;; Various regexp information shared by several modes.
2028 ;; ;; Information specific to a single mode should go in its load library.
2029
2030 ;; Font Lock support for C, C++, Objective-C and Java modes is now in
2031 ;; cc-fonts.el (and required by cc-mode.el). However, the below function
2032 ;; should stay in font-lock.el, since it is used by other libraries. sm.
2033
2034 (defun font-lock-match-c-style-declaration-item-and-skip-to-next (limit)
2035 "Match, and move over, any declaration/definition item after point.
2036 Matches after point, but ignores leading whitespace and `*' characters.
2037 Does not move further than LIMIT.
2038
2039 The expected syntax of a declaration/definition item is `word' (preceded by
2040 optional whitespace and `*' characters and proceeded by optional whitespace)
2041 optionally followed by a `('. Everything following the item (but belonging to
2042 it) is expected to be skip-able by `scan-sexps', and items are expected to be
2043 separated with a `,' and to be terminated with a `;'.
2044
2045 Thus the regexp matches after point: word (
2046 ^^^^ ^
2047 Where the match subexpressions are: 1 2
2048
2049 The item is delimited by (match-beginning 1) and (match-end 1).
2050 If (match-beginning 2) is non-nil, the item is followed by a `('.
2051
2052 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
2053 (when (looking-at "[ \n\t*]*\\(\\sw+\\)[ \t\n]*\\(((?\\)?")
2054 (when (and (match-end 2) (> (- (match-end 2) (match-beginning 2)) 1))
2055 ;; If `word' is followed by a double open-paren, it's probably
2056 ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one
2057 ;; word to try and match `myfun' rather than `P_'.
2058 (let ((pos (point)))
2059 (skip-chars-backward " \t\n")
2060 (skip-syntax-backward "w")
2061 (unless (looking-at "\\(\\sw+\\)[ \t\n]*\\sw+[ \t\n]*\\(((?\\)?")
2062 ;; Looks like it was something else, so go back to where we
2063 ;; were and reset the match data by rematching.
2064 (goto-char pos)
2065 (looking-at "[ \n\t*]*\\(\\sw+\\)[ \t\n]*\\(((?\\)?"))))
2066 (save-match-data
2067 (condition-case nil
2068 (save-restriction
2069 ;; Restrict to the LIMIT.
2070 (narrow-to-region (point-min) limit)
2071 (goto-char (match-end 1))
2072 ;; Move over any item value, etc., to the next item.
2073 (while (not (looking-at "[ \t\n]*\\(\\(,\\)\\|;\\|\\'\\)"))
2074 (goto-char (or (scan-sexps (point) 1) (point-max))))
2075 (goto-char (match-end 2)))
2076 (error t)))))
2077
2078 ;; C preprocessor(cpp) is used outside of C, C++ and Objective-C source file.
2079 ;; e.g. assembler code and GNU linker script in Linux kernel.
2080 ;; `cpp-font-lock-keywords' is handy for modes for the files.
2081 ;;
2082 ;; Here we cannot use `regexp-opt' because because regex-opt is not preloaded
2083 ;; while font-lock.el is preloaded to emacs. So values pre-calculated with
2084 ;; regexp-opt are used here.
2085
2086 ;; `cpp-font-lock-keywords-source-directives' is calculated from:
2087 ;;
2088 ;; (regexp-opt
2089 ;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
2090 ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning"))
2091 ;;
2092 (defconst cpp-font-lock-keywords-source-directives
2093 "define\\|e\\(?:l\\(?:if\\|se\\)\\|ndif\\|rror\\)\\|file\\|i\\(?:f\\(?:n?def\\)?\\|mport\\|nclude\\)\\|line\\|pragma\\|undef\\|warning"
2094 "Regular expressoin used in `cpp-font-lock-keywords'.")
2095
2096 ;; `cpp-font-lock-keywords-source-depth' is calculated from:
2097 ;;
2098 ;; (regexp-opt-depth (regexp-opt
2099 ;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
2100 ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning")))
2101 ;;
2102 (defconst cpp-font-lock-keywords-source-depth 0
2103 "An integer representing regular expression depth of `cpp-font-lock-keywords-source-directives'.
2104 Used in `cpp-font-lock-keywords'.")
2105
2106 (defconst cpp-font-lock-keywords
2107 (let* ((directives cpp-font-lock-keywords-source-directives)
2108 (directives-depth cpp-font-lock-keywords-source-depth))
2109 (list
2110 ;;
2111 ;; Fontify error directives.
2112 '("^#[ \t]*\\(?:error\\|warning\\)[ \t]+\\(.+\\)" 1 font-lock-warning-face prepend)
2113 ;;
2114 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2115 '("^#[ \t]*\\(?:import\\|include\\)[ \t]*\\(<[^>\"\n]*>?\\)"
2116 1 font-lock-string-face prepend)
2117 ;;
2118 ;; Fontify function macro names.
2119 '("^#[ \t]*define[ \t]+\\([[:alpha:]_][[:alnum:]_$]*\\)("
2120 (1 font-lock-function-name-face prepend)
2121 ;;
2122 ;; Macro arguments.
2123 ((lambda (limit)
2124 (re-search-forward
2125 "\\(?:\\([[:alpha:]_][[:alnum:]_]*\\)[,]?\\)"
2126 (or (save-excursion (re-search-forward ")" limit t))
2127 limit)
2128 t))
2129 nil nil (1 font-lock-variable-name-face prepend)))
2130 ;;
2131 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2132 '("^#[ \t]*\\(?:elif\\|if\\)\\>"
2133 ("\\<\\(defined\\)\\>[ \t]*(?\\([[:alpha:]_][[:alnum:]_]*\\)?" nil nil
2134 (1 font-lock-builtin-face prepend) (2 font-lock-variable-name-face prepend t)))
2135 ;;
2136 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2137 (list
2138 (concat "^\\(#[ \t]*\\(?:" directives
2139 "\\)\\)\\>[ \t!]*\\([[:alpha:]_][[:alnum:]_]*\\)?")
2140 '(1 font-lock-preprocessor-face prepend)
2141 (list (+ 2 directives-depth)
2142 'font-lock-variable-name-face nil t))))
2143 "Font lock keyords for C preprocessor directives.
2144 `c-mode', `c++-mode' and `objc-mode' have their own
2145 font lock keyords for C preprocessor directives. This definition is for the
2146 other modes in which C preprocessor directives are used. e.g. `asm-mode' and
2147 `ld-script-mode'.")
2148
2149 \f
2150 ;; Lisp.
2151
2152 (defconst lisp-font-lock-keywords-1
2153 (eval-when-compile
2154 `(;; Definitions.
2155 (,(concat "(\\(def\\("
2156 ;; Function declarations.
2157 "\\(advice\\|alias\\|generic\\|macro\\*?\\|method\\|"
2158 "setf\\|subst\\*?\\|un\\*?\\|"
2159 "ine-\\(condition\\|"
2160 "\\(?:derived\\|\\(?:global-\\)?minor\\|generic\\)-mode\\|"
2161 "method-combination\\|setf-expander\\|skeleton\\|widget\\|"
2162 "function\\|\\(compiler\\|modify\\|symbol\\)-macro\\)\\)\\|"
2163 ;; Variable declarations.
2164 "\\(const\\(ant\\)?\\|custom\\|varalias\\|face\\|parameter\\|var\\)\\|"
2165 ;; Structure declarations.
2166 "\\(class\\|group\\|theme\\|package\\|struct\\|type\\)"
2167 "\\)\\)\\>"
2168 ;; Any whitespace and defined object.
2169 "[ \t'\(]*"
2170 "\\(setf[ \t]+\\sw+)\\|\\sw+\\)?")
2171 (1 font-lock-keyword-face)
2172 (9 (cond ((match-beginning 3) font-lock-function-name-face)
2173 ((match-beginning 6) font-lock-variable-name-face)
2174 (t font-lock-type-face))
2175 nil t))
2176 ;; Emacs Lisp autoload cookies.
2177 ("^;;;###\\(autoload\\)" 1 font-lock-warning-face prepend)
2178 ;; Regexp negated char group.
2179 ("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
2180 "Subdued level highlighting for Lisp modes.")
2181
2182 (defconst lisp-font-lock-keywords-2
2183 (append lisp-font-lock-keywords-1
2184 (eval-when-compile
2185 `(;; Control structures. Emacs Lisp forms.
2186 (,(concat
2187 "(" (regexp-opt
2188 '("cond" "if" "while" "while-no-input" "let" "let*"
2189 "prog" "progn" "progv" "prog1" "prog2" "prog*"
2190 "inline" "lambda" "save-restriction" "save-excursion"
2191 "save-window-excursion" "save-selected-window"
2192 "save-match-data" "save-current-buffer" "unwind-protect"
2193 "condition-case" "track-mouse"
2194 "eval-after-load" "eval-and-compile" "eval-when-compile"
2195 "eval-when" "eval-at-startup" "eval-next-after-load"
2196 "with-category-table"
2197 "with-current-buffer" "with-electric-help"
2198 "with-local-quit" "with-no-warnings"
2199 "with-output-to-string" "with-output-to-temp-buffer"
2200 "with-selected-window" "with-syntax-table"
2201 "with-temp-buffer" "with-temp-file" "with-temp-message"
2202 "with-timeout" "with-timeout-handler") t)
2203 "\\>")
2204 . 1)
2205 ;; Control structures. Common Lisp forms.
2206 (,(concat
2207 "(" (regexp-opt
2208 '("when" "unless" "case" "ecase" "typecase" "etypecase"
2209 "ccase" "ctypecase" "handler-case" "handler-bind"
2210 "restart-bind" "restart-case" "in-package"
2211 "break" "ignore-errors"
2212 "loop" "do" "do*" "dotimes" "dolist" "the" "locally"
2213 "proclaim" "declaim" "declare" "symbol-macrolet"
2214 "lexical-let" "lexical-let*" "flet" "labels" "compiler-let"
2215 "destructuring-bind" "macrolet" "tagbody" "block" "go"
2216 "multiple-value-bind" "multiple-value-prog1"
2217 "return" "return-from"
2218 "with-accessors" "with-compilation-unit"
2219 "with-condition-restarts" "with-hash-table-iterator"
2220 "with-input-from-string" "with-open-file"
2221 "with-open-stream" "with-output-to-string"
2222 "with-package-iterator" "with-simple-restart"
2223 "with-slots" "with-standard-io-syntax") t)
2224 "\\>")
2225 . 1)
2226 ;; Exit/Feature symbols as constants.
2227 (,(concat "(\\(catch\\|throw\\|featurep\\|provide\\|require\\)\\>"
2228 "[ \t']*\\(\\sw+\\)?")
2229 (1 font-lock-keyword-face)
2230 (2 font-lock-constant-face nil t))
2231 ;; Erroneous structures.
2232 ("(\\(abort\\|assert\\|warn\\|check-type\\|cerror\\|error\\|signal\\)\\>" 1 font-lock-warning-face)
2233 ;; Words inside \\[] tend to be for `substitute-command-keys'.
2234 ("\\\\\\\\\\[\\(\\sw+\\)\\]" 1 font-lock-constant-face prepend)
2235 ;; Words inside `' tend to be symbol names.
2236 ("`\\(\\sw\\sw+\\)'" 1 font-lock-constant-face prepend)
2237 ;; Constant values.
2238 ("\\<:\\sw+\\>" 0 font-lock-builtin-face)
2239 ;; ELisp and CLisp `&' keywords as types.
2240 ("\\<\\&\\sw+\\>" . font-lock-type-face)
2241 ;; ELisp regexp grouping constructs
2242 ((lambda (bound)
2243 (catch 'found
2244 ;; The following loop is needed to continue searching after matches
2245 ;; that do not occur in strings. The associated regexp matches one
2246 ;; of `\\\\' `\\(' `\\(?:' `\\|' `\\)'. `\\\\' has been included to
2247 ;; avoid highlighting, for example, `\\(' in `\\\\('.
2248 (while (re-search-forward "\\(\\\\\\\\\\)\\(?:\\(\\\\\\\\\\)\\|\\((\\(?:\\?:\\)?\\|[|)]\\)\\)" bound t)
2249 (unless (match-beginning 2)
2250 (let ((face (get-text-property (1- (point)) 'face)))
2251 (when (or (and (listp face)
2252 (memq 'font-lock-string-face face))
2253 (eq 'font-lock-string-face face))
2254 (throw 'found t)))))))
2255 (1 'font-lock-regexp-grouping-backslash prepend)
2256 (3 'font-lock-regexp-grouping-construct prepend))
2257 ;;; This is too general -- rms.
2258 ;;; A user complained that he has functions whose names start with `do'
2259 ;;; and that they get the wrong color.
2260 ;;; ;; CL `with-' and `do-' constructs
2261 ;;; ("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
2262 )))
2263 "Gaudy level highlighting for Lisp modes.")
2264
2265 (defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
2266 "Default expressions to highlight in Lisp modes.")
2267 \f
2268 (provide 'font-lock)
2269
2270 ;; arch-tag: 682327e4-64d8-4057-b20b-1fbb9f1fc54c
2271 ;;; font-lock.el ends here