| blob | 30605b576361603052056f8c43c23998e55a3ebe |
1 ;;; font-lock.el --- Electric font lock mode
3 ;; Copyright (C) 1992, 93, 94, 95, 96, 97, 98, 1999, 2000, 2001
4 ;; Free Software Foundation, Inc.
6 ;; Author: jwz, then rms, then sm
7 ;; Maintainer: FSF
8 ;; Keywords: languages, faces
10 ;; This file is part of GNU Emacs.
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.
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.
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., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
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:
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.
99 ;;; How Font Lock mode supports modes or is supported by modes:
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.
116 ;;; Constructing patterns:
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'.
124 ;;; Adding patterns for modes that already support Font Lock:
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'.
139 ;;; Adding patterns for modes that do not support Font Lock:
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 ;; (function (lambda ()
156 ;; (make-local-variable 'font-lock-defaults)
157 ;; (setq font-lock-defaults '(foo-font-lock-keywords t)))))
159 ;;; Adding Font Lock support for modes:
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 ;; (make-local-variable 'font-lock-defaults)
178 ;; (setq font-lock-defaults '(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:
210 ;; Define core `font-lock' group.
212 "Font Lock mode text highlighting package."
218 "Faces for highlighting text."
223 "Extra mode-specific type names for highlighting declarations."
226 ;; Define support mode groups here to impose `font-lock' group order.
228 "Font Lock support mode to cache fontification."
234 "Font Lock support mode to fontify lazily."
240 "Font Lock support mode to fontify just-in-time."
245 \f
246 ;; User variables.
249 "*Maximum size of a buffer for buffer fontification.
250 Only buffers less than this can be fontified when Font Lock mode is turned on.
251 If nil, means size is irrelevant.
252 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
253 where MAJOR-MODE is a symbol or t (meaning the default). For example:
254 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
255 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
256 for buffers in Rmail mode, and size is irrelevant otherwise."
271 "*Maximum decoration level for fontification.
272 If nil, use the default decoration (typically the minimum available).
273 If t, use the maximum decoration available.
274 If a number, use that level of decoration (or if not available the maximum).
275 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
276 where MAJOR-MODE is a symbol or t (meaning the default). For example:
277 ((c-mode . t) (c++-mode . 2) (t . 1))
278 means use the maximum decoration available for buffers in C mode, level 2
279 decoration for buffers in C++ mode, and level 1 decoration otherwise."
296 "*If non-nil, means show status messages for buffer fontification.
297 If a number, only buffers greater than this size have fontification messages."
302 \f
304 ;; Originally these variable values were face names such as `bold' etc.
305 ;; Now we create our own faces, but we keep these variables for compatibility
306 ;; and they give users another mechanism for changing face appearance.
307 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
308 ;; returns a face. So the easiest thing is to continue using these variables,
309 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
343 ;; Fontification variables:
346 "A list of the keywords to highlight.
347 Each element should have one of these forms:
349 MATCHER
350 (MATCHER . MATCH)
351 (MATCHER . FACENAME)
352 (MATCHER . HIGHLIGHT)
353 (MATCHER HIGHLIGHT ...)
354 (eval . FORM)
356 where HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
358 FORM is an expression, whose value should be a keyword element, evaluated when
359 the keyword is (first) used in a buffer. This feature can be used to provide a
360 keyword that can only be generated when Font Lock mode is actually turned on.
363 typically only MATCH-HIGHLIGHT is required.
364 However, if an item or (typically) items are to be highlighted following the
365 instance of another item (the anchor), for example each instance of the
368 MATCH-HIGHLIGHT should be of the form:
370 (MATCH FACENAME OVERRIDE LAXMATCH)
372 where MATCHER can be either the regexp to search for, or the function name to
373 call to make the search (called with one argument, the limit of the search) and
374 return non-nil if it succeeds (and set `match-data' appropriately).
375 MATCHER regexps can be generated via the function `regexp-opt'. MATCH is
376 the subexpression of MATCHER to be highlighted. FACENAME is an expression
377 whose value is the face name to use. Face default attributes can be
380 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
381 be overwritten. If `keep', only parts not already fontified are highlighted.
382 If `prepend' or `append', existing fontification is merged with the new, in
383 which the new or existing fontification, respectively, takes precedence.
384 If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER.
386 For example, an element of the form highlights (if not already highlighted):
389 variable `font-lock-keyword-face'.
391 the value of `font-lock-keyword-face'.
395 of `foo-bar-face', even if already highlighted.
396 (fubar-match 1 fubar-face)
397 the first subexpression within all occurrences of
398 whatever the function `fubar-match' finds and matches
399 in the value of `fubar-face'.
401 MATCH-ANCHORED should be of the form:
403 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
405 where MATCHER is a regexp to search for or the function name to call to make
406 the search, as for MATCH-HIGHLIGHT above, but with one exception; see below.
407 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
408 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
409 used to initialise before, and cleanup after, MATCHER is used. Typically,
410 PRE-MATCH-FORM is used to move to some position relative to the original
411 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
412 be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
414 For example, an element of the form highlights (if not already highlighted):
425 The above-mentioned exception is as follows. The limit of the MATCHER search
426 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
427 However, if PRE-MATCH-FORM returns a position greater than the position after
428 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
429 It is generally a bad idea to return a position greater than the end of the
430 line, i.e., cause the MATCHER search to span lines.
432 These regular expressions can match text which spans lines, although
433 it is better to avoid it if possible since updating them while editing
434 text is slower, and it is not guaranteed to be always correct when using
435 support modes like jit-lock or lazy-lock.
437 This variable is set by major modes via the variable `font-lock-defaults'.
438 Be careful when composing regexps for this list; a poorly written pattern can
441 ;; This variable is used by mode packages that support Font Lock mode by
442 ;; defining their own keywords to use for `font-lock-keywords'. (The mode
443 ;; command should make it buffer-local and set it to provide the set up.)
445 "Defaults for Font Lock mode specified by the major mode.
446 Defaults should be of the form:
448 (KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN ...)
450 KEYWORDS may be a symbol (a variable or function whose value is the keywords to
451 use for fontification) or a list of symbols. If KEYWORDS-ONLY is non-nil,
452 syntactic fontification (strings and comments) is not performed.
453 If CASE-FOLD is non-nil, the case of the keywords is ignored when fontifying.
454 If SYNTAX-ALIST is non-nil, it should be a list of cons pairs of the form
455 \(CHAR-OR-STRING . STRING) used to set the local Font Lock syntax table, for
456 keyword and syntactic fontification (see `modify-syntax-entry').
458 If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
459 backwards outside any enclosing syntactic block, for syntactic fontification.
460 Typical values are `beginning-of-line' (i.e., the start of the line is known to
461 be outside a syntactic block), or `beginning-of-defun' for programming modes or
462 `backward-paragraph' for textual modes (i.e., the mode-dependent function is
463 known to move outside a syntactic block). If nil, the beginning of the buffer
464 is used as a position outside of a syntactic block, in the worst case.
466 These item elements are used by Font Lock mode to set the variables
467 `font-lock-keywords', `font-lock-keywords-only',
468 `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
469 `font-lock-beginning-of-syntax-function', respectively.
471 Further item elements are alists of the form (VARIABLE . VALUE) and are in no
472 particular order. Each VARIABLE is made buffer-local before set to VALUE.
474 Currently, appropriate variables include `font-lock-mark-block-function'.
475 If this is non-nil, it should be a function with no args used to mark any
477 Typical values are `mark-defun' for programming modes or `mark-paragraph' for
478 textual modes (i.e., the mode-dependent function is known to put point and mark
479 around a text block relevant to that mode).
481 Other variables include that for syntactic keyword fontification,
482 `font-lock-syntactic-keywords'
483 and those for buffer-specialised fontification functions,
484 `font-lock-fontify-buffer-function', `font-lock-unfontify-buffer-function',
485 `font-lock-fontify-region-function', `font-lock-unfontify-region-function',
487 ;;;###autoload
490 ;; This variable is used where font-lock.el itself supplies the keywords.
493 ;; Thus the calculation of the cache is usually faster but not
494 ;; infallible, so we risk mis-fontification. sm.
497 c-font-lock-keywords-2 c-font-lock-keywords-3)
507 objc-font-lock-keywords-2 objc-font-lock-keywords-3)
512 java-font-lock-keywords-2 java-font-lock-keywords-3)
517 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
528 "Alist of fall-back Font Lock defaults for major modes.
530 This variable should not be used any more.
531 Set the buffer-local `font-lock-keywords' in the major mode instead.
533 Each item should be a list of the form:
535 (MAJOR-MODE . FONT-LOCK-DEFAULTS)
537 where MAJOR-MODE is a symbol and FONT-LOCK-DEFAULTS is a list of default
542 "*Alist of `font-lock-keywords' local to a `major-mode'.
543 This is normally set via `font-lock-add-keywords' and
547 "*Alist of `font-lock-keywords' removed from `major-mode'.
548 This is normally set via `font-lock-add-keywords' and
552 "*Non-nil means Font Lock should not fontify comments or strings.
556 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
560 "Point up to which `font-lock-syntactic-keywords' has been applied.
561 If nil, this is ignored, in which case the syntactic fontification may
568 "Function to determine which face to use when fontifying syntactically.
569 The function is called with a single parameter (the state as returned by
570 `parse-partial-sexp' at the beginning of the region to highlight) and
574 "A list of the syntactic keywords to highlight.
575 Can be the list or the name of a function or variable whose value is the list.
576 See `font-lock-keywords' for a description of the form of this list;
577 the differences are listed below. MATCH-HIGHLIGHT should be of the form:
579 (MATCH SYNTAX OVERRIDE LAXMATCH)
581 where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax
582 table, a cons cell (as returned by `string-to-syntax') or an expression whose
583 value is such a form. OVERRIDE cannot be `prepend' or `append'.
585 For example, an element of the form highlights syntactically:
589 a hash character when following a dollar character, with a SYNTAX of
591 specify hash characters to have comment start syntax, the element will only
592 highlight hash characters that do not follow dollar characters as comments
593 syntactically.
599 both single quotes which surround a single character, with a SYNTAX of
601 does not specify single quotes to have quote syntax, the element will only
602 highlight single quotes of the form 'c' as strings syntactically.
603 Other forms, such as foo'bar or 'fubar', will not be highlighted as strings.
608 "Non-nil means use this syntax table for fontifying.
609 If this is nil, the major mode's syntax table is used.
612 ;; If this is nil, we only use the beginning of the buffer if we can't use
613 ;; `font-lock-cache-position' and `font-lock-cache-state'.
615 "*Non-nil means use this function to move back outside of a syntactic block.
616 When called with no args it should leave point at the beginning of any
617 enclosing syntactic block.
618 If this is nil, the beginning of the buffer is used (in the worst case).
622 "*Non-nil means use this function to mark a block of text.
623 When called with no args it should leave point at the beginning of any
624 enclosing textual block and mark at the end.
628 "Function to use for fontifying the buffer.
632 "Function to use for unfontifying the buffer.
633 This is used when turning off Font Lock mode.
637 "Function to use for fontifying a region.
638 It should take two args, the beginning and end of the region, and an optional
639 third arg VERBOSE. If non-nil, the function should print status messages.
643 "Function to use for unfontifying a region.
644 It should take two args, the beginning and end of the region.
648 "List of Font Lock mode related modes that should not be turned on.
649 Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
653 "Whether font-lock should cater to multiline keywords.
654 If nil, don't try to handle multiline patterns.
655 If t, always handle multiline patterns.
656 If `undecided', don't try to handle multiline patterns until you see one.
660 \f
661 ;; Font Lock mode.
664 ;;
665 ;; We don't do this at the top-level as we only use non-autoloaded macros.
667 ;;
668 ;; Borrowed from lazy-lock.el.
669 ;; We use this to preserve or protect things when modifying text properties.
671 "Bind variables according to VARLIST and eval BODY restoring buffer state."
675 before-change-functions after-change-functions
676 deactivate-mark buffer-file-name buffer-file-truename))
677 ,@body
682 ;;
683 ;; Shut up the byte compiler.
686 ;;;###autoload
688 "Toggle Font Lock mode.
689 With arg, turn Font Lock mode on if and only if arg is positive,
690 otherwise turn it off.
693 When Font Lock mode is enabled, text is fontified as you type it:
695 - Comments are displayed in `font-lock-comment-face';
696 - Strings are displayed in `font-lock-string-face';
697 - Certain other expressions are displayed in other faces according to the
698 value of the variable `font-lock-keywords'.
700 To customize the faces (colors, fonts, etc.) used by Font Lock for
703 You can enable Font Lock mode in any major mode automatically by turning on in
704 the major mode's hook. For example, put in your ~/.emacs:
706 (add-hook 'c-mode-hook 'turn-on-font-lock)
708 Alternatively, you can use Global Font Lock mode to automagically turn on Font
709 Lock mode in buffers whose major mode supports it and whose major mode is one
710 of `font-lock-global-modes'. For example, put in your ~/.emacs:
712 (global-font-lock-mode t)
714 There are a number of support modes that may be used to speed up Font Lock mode
715 in various ways, specified via the variable `font-lock-support-mode'. Where
716 major modes support different levels of fontification, you can use the variable
717 `font-lock-maximum-decoration' to specify which level you generally prefer.
718 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
719 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
721 For example, to specify that Font Lock mode use use Lazy Lock mode as a support
722 mode and use maximum levels of fontification, put in your ~/.emacs:
724 (setq font-lock-support-mode 'lazy-lock-mode)
725 (setq font-lock-maximum-decoration t)
727 To add your own highlighting for some major mode, and modify the highlighting
728 selected automatically via the variable `font-lock-maximum-decoration', you can
729 use `font-lock-add-keywords'.
731 To fontify a buffer, without turning on Font Lock mode and regardless of buffer
734 To fontify a block (the function or paragraph containing point, or a number of
735 lines around point), perhaps because modification on the current line caused
738 See the variable `font-lock-defaults-alist' for the Font Lock mode default
739 settings. You can set your own default settings for some mode, by setting a
740 buffer local value for `font-lock-defaults', via its mode hook."
741 nil nil nil
742 ;; Don't turn on Font Lock mode if we don't have a display (we're running a
743 ;; batch job) or if the buffer is invisible (the name starts with a space).
747 ;; Turn on Font Lock mode.
752 ;; Fontify the buffer if we have to.
755 nil)
761 ;; Turn off Font Lock mode.
768 ;;;###autoload
770 "Turn on Font Lock mode (only if the terminal can display it)."
774 ;;;###autoload
776 "Add highlighting KEYWORDS for MODE.
777 MODE should be a symbol, the major mode command name, such as `c-mode'
778 or nil. If nil, highlighting keywords are added for the current buffer.
779 KEYWORDS should be a list; see the variable `font-lock-keywords'.
780 By default they are added at the beginning of the current highlighting list.
781 If optional argument APPEND is `set', they are used to replace the current
782 highlighting list. If APPEND is any other non-nil value, they are added at the
783 end of the current highlighting list.
785 For example:
787 (font-lock-add-keywords 'c-mode
791 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
792 comments, and to fontify `and', `or' and `not' words as keywords.
794 Note that some modes have specialised support for additional patterns, e.g.,
795 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
796 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
798 ;; If MODE is non-nil, add the KEYWORDS and APPEND spec to
799 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
806 ;; Make sure that `font-lock-removed-keywords-alist' does not
807 ;; contain the new keywords.
810 ;; Otherwise set or add the keywords now.
817 font-lock-keywords)))
823 ;; Update `font-lock-removed-keywords-alist' when adding new
824 ;; KEYWORDS to MODE.
825 ;;
826 ;; When font-lock is enabled first all keywords in the list
827 ;; `font-lock-keywords-alist' are added, then all keywords in the
828 ;; list `font-lock-removed-keywords-alist' are removed. If a
829 ;; keyword was once added, removed, and then added again it must be
830 ;; removed from the removed-keywords list. Otherwise the second add
831 ;; will not take effect.
835 ;; A new set of keywords is defined. Forget all about
836 ;; our old keywords that should be removed.
839 ;; Delete all previously removed keywords.
842 ;; Delete the mode cell if empty.
847 ;; Written by Anders Lindgren <andersl@andersl.com>.
848 ;;
849 ;; Case study:
850 ;; (I) The keywords are removed from a major mode.
851 ;; In this case the keyword could be local (i.e. added earlier by
852 ;; `font-lock-add-keywords'), global, or both.
853 ;;
854 ;; (a) In the local case we remove the keywords from the variable
855 ;; `font-lock-keywords-alist'.
856 ;;
857 ;; (b) The actual global keywords are not known at this time.
858 ;; All keywords are added to `font-lock-removed-keywords-alist',
859 ;; when font-lock is enabled those keywords are removed.
860 ;;
861 ;; Note that added keywords are taken out of the list of removed
862 ;; keywords. This ensure correct operation when the same keyword
863 ;; is added and removed several times.
864 ;;
865 ;; (II) The keywords are removed from the current buffer.
866 ;;;###autoload
868 "Remove highlighting KEYWORDS for MODE.
870 MODE should be a symbol, the major mode command name, such as `c-mode'
871 or nil. If nil, highlighting keywords are removed for the current buffer."
873 ;; Remove one keyword at the time.
876 ;; If MODE is non-nil, remove the KEYWORD from
877 ;; `font-lock-keywords-alist'.
880 ;; `keywords-list-append-pair' is a cons with a list of
881 ;; keywords in the car top-cell and the original append
882 ;; argument in the cdr top-cell.
885 ;; Remove keyword list/append pair when the keyword list
886 ;; is empty and append doesn't specify `set'. (If it
887 ;; should be deleted then previously deleted keywords
888 ;; would appear again.)
895 ;; Final cleanup, remove major mode cell if last keyword
896 ;; was deleted.
900 ;; Remember the keyword in case it is not local.
906 font-lock-removed-keywords-alist))))))
908 ;; Otherwise remove it immediately.
914 ;; The keywords might be compiled.
916 font-lock-keywords)))))))
917 \f
918 ;;; Global Font Lock mode.
920 ;; A few people have hassled in the past for a way to make it easier to turn on
921 ;; Font Lock mode, without the user needing to know for which modes s/he has to
922 ;; turn it on, perhaps the same way hilit19.el/hl319.el does. I've always
923 ;; balked at that way, as I see it as just re-moulding the same problem in
924 ;; another form. That is; some person would still have to keep track of which
925 ;; modes (which may not even be distributed with Emacs) support Font Lock mode.
926 ;; The list would always be out of date. And that person might have to be me.
928 ;; Implementation.
929 ;;
930 ;; In a previous discussion the following hack came to mind. It is a gross
931 ;; hack, but it generally works. We use the convention that major modes start
932 ;; by calling the function `kill-all-local-variables', which in turn runs
933 ;; functions on the hook variable `change-major-mode-hook'. We attach our
934 ;; function `font-lock-change-major-mode' to that hook. Of course, when this
935 ;; hook is run, the major mode is in the process of being changed and we do not
936 ;; know what the final major mode will be. So, `font-lock-change-major-mode'
937 ;; only (a) notes the name of the current buffer, and (b) adds our function
938 ;; `turn-on-font-lock-if-enabled' to the hook variables `find-file-hooks' and
939 ;; `post-command-hook' (for buffers that are not visiting files). By the time
940 ;; the functions on the first of these hooks to be run are run, the new major
941 ;; mode is assumed to be in place. This way we get a Font Lock function run
942 ;; when a major mode is turned on, without knowing major modes or their hooks.
943 ;;
944 ;; Naturally this requires that (a) major modes run `kill-all-local-variables',
945 ;; as they are supposed to do, and (b) the major mode is in place after the
946 ;; file is visited or the command that ran `kill-all-local-variables' has
947 ;; finished, whichever the sooner. Arguably, any major mode that does not
948 ;; follow the convension (a) is broken, and I can't think of any reason why (b)
949 ;; would not be met (except `gnudoit' on non-files). However, it is not clean.
950 ;;
951 ;; Probably the cleanest solution is to have each major mode function run some
952 ;; hook, e.g., `major-mode-hook', but maybe implementing that change is
953 ;; impractical. I am personally against making `setq' a macro or be advised,
954 ;; or have a special function such as `set-major-mode', but maybe someone can
955 ;; come up with another solution?
957 ;; User interface.
958 ;;
959 ;; Although Global Font Lock mode is a pseudo-mode, I think that the user
960 ;; interface should conform to the usual Emacs convention for modes, i.e., a
961 ;; command to toggle the feature (`global-font-lock-mode') with a variable for
962 ;; finer control of the mode's behaviour (`font-lock-global-modes').
963 ;;
964 ;; The feature should not be enabled by loading font-lock.el, since other
965 ;; mechanisms for turning on Font Lock mode, such as M-x font-lock-mode RET or
966 ;; (add-hook 'c-mode-hook 'turn-on-font-lock), would cause Font Lock mode to be
967 ;; turned on everywhere. That would not be intuitive or informative because
968 ;; loading a file tells you nothing about the feature or how to control it. It
969 ;; would also be contrary to the Principle of Least Surprise. sm.
972 "*Modes for which Font Lock mode is automagically turned on.
973 Global Font Lock mode is controlled by the command `global-font-lock-mode'.
974 If nil, means no modes have Font Lock mode automatically turned on.
975 If t, all modes that support Font Lock mode have it automatically turned on.
976 If a list, it should be a list of `major-mode' symbol names for which Font Lock
977 mode should be automatically turned on. The sense of the list is negated if it
978 begins with `not'. For example:
979 (c-mode c++-mode)
980 means that Font Lock mode is turned on for buffers in C and C++ modes only."
999 ;;;###autoload
1001 global-font-lock-mode font-lock-mode turn-on-font-lock-if-enabled
1004 ;;; End of Global Font Lock mode.
1005 \f
1006 ;;; Font Lock Support mode.
1008 ;; This is the code used to interface font-lock.el with any of its add-on
1009 ;; packages, and provide the user interface. Packages that have their own
1010 ;; local buffer fontification functions (see below) may have to call
1011 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
1012 ;; themselves.
1015 "*Support mode for Font Lock mode.
1016 Support modes speed up Font Lock mode by being choosy about when fontification
1017 occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode'),
1018 Lazy Lock mode (symbol `lazy-lock-mode'), and Just-in-time Lock mode (symbol
1019 `jit-lock-mode'. See those modes for more info.
1020 If nil, means support for Font Lock mode is never performed.
1021 If a symbol, use that support mode.
1022 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
1023 where MAJOR-MODE is a symbol or t (meaning the default). For example:
1024 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
1025 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
1026 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
1028 The value of this variable is used when Font Lock mode is turned on."
1044 ))
1059 ;; Prepare for jit-lock
1064 ;; Don't fontify eagerly (and don't abort is the buffer is large).
1066 ;; Use jit-lock.
1075 ;; Reset local vars to the non-jit-lock case.
1083 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
1084 ;; (jit-lock-mode
1085 ;; (jit-lock-after-fontify-buffer))
1092 ;; Useless as well. It's only called when:
1093 ;; - turning off font-lock: it does not matter if we leave spurious
1094 ;; `fontified' text props around since jit-lock-mode is also off.
1095 ;; - font-lock-default-fontify-buffer fails: this is not run
1096 ;; any more anyway. -sm
1097 ;;
1098 ;; (jit-lock-mode
1099 ;; (jit-lock-after-unfontify-buffer))
1103 ;;; End of Font Lock Support mode.
1104 \f
1105 ;;; Fontification functions.
1107 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
1108 ;; code to fontify a region, the function runs the function whose name is the
1109 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
1110 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
1111 ;; which does contain the code to fontify a region. However, the value of the
1112 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
1113 ;; do anything. The indirection of the fontification functions gives major
1114 ;; modes the capability of modifying the way font-lock.el fontifies. Major
1115 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
1116 ;; via the variable `font-lock-defaults'.
1117 ;;
1118 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
1119 ;; font-lock.el uses its own function for buffer fontification. This function
1120 ;; makes fontification be on a message-by-message basis and so visiting an
1121 ;; RMAIL file is much faster. A clever implementation of the function might
1122 ;; fontify the headers differently than the message body. (It should, and
1123 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
1124 ;; you?) This hints at a more interesting use...
1125 ;;
1126 ;; Languages that contain text normally contained in different major modes
1127 ;; could define their own fontification functions that treat text differently
1128 ;; depending on its context. For example, Perl mode could arrange that here
1129 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
1130 ;; rules one way and C code another. Neat!
1131 ;;
1132 ;; A further reason to use the fontification indirection feature is when the
1133 ;; default syntactual fontification, or the default fontification in general,
1134 ;; is not flexible enough for a particular major mode. For example, perhaps
1135 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
1136 ;; cope with. You need to write your own version of that function, e.g.,
1137 ;; `hairy-fontify-syntactically-region', and make your own version of
1138 ;; `hairy-fontify-region' call that function before calling
1139 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
1140 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
1141 ;; would call your region fontification function instead of its own. For
1142 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
1143 ;; directives correctly and cleanly. (It is the same problem as fontifying
1144 ;; multi-line strings and comments; regexps are not appropriate for the job.)
1146 ;;;###autoload
1148 "Fontify the current buffer the way the function `font-lock-mode' would."
1165 font-lock-verbose)))
1169 ;; Make sure we have the right `font-lock-keywords' etc.
1172 ;; Make sure we fontify etc. in the whole buffer.
1181 ;; We don't restore the old fontification, so it's best to unfontify.
1183 ;; Make sure we undo `font-lock-keywords' etc.
1188 ;; Make sure we unfontify etc. in the whole buffer.
1202 ;; Use the fontification syntax table, if any.
1205 ;; check to see if we should expand the beg/end area for
1206 ;; proper multiline matches
1210 ;; We are just after or in a multiline match.
1222 ;; Now do the fontification.
1229 ;; Clean up.
1232 ;; The following must be rethought, since keywords can override fontification.
1233 ; ;; Now scan for keywords, but not if we are inside a comment now.
1234 ; (or (and (not font-lock-keywords-only)
1235 ; (let ((state (parse-partial-sexp beg end nil nil
1236 ; font-lock-cache-state)))
1237 ; (or (nth 4 state) (nth 7 state))))
1238 ; (font-lock-fontify-keywords-region beg end))
1247 ;; Called when any modification is made to buffer text.
1252 ;; Rescan between start of lines enclosing the region.
1258 "Fontify some lines the way `font-lock-fontify-buffer' would.
1259 The lines could be a function or paragraph, or a specified number of lines.
1260 If ARG is given, fontify that many lines before and after point, or 16 lines if
1261 no ARG is given and `font-lock-mark-block-function' is nil.
1262 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1263 delimit the region to fontify."
1266 deactivate-mark)
1267 ;; Make sure we have the right `font-lock-keywords' etc.
1283 ;;; End of Fontification functions.
1284 \f
1285 ;;; Additional text property functions.
1287 ;; The following text property functions should be builtins. This means they
1288 ;; should be written in C and put with all the other text property functions.
1289 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1290 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1291 ;; in Lisp below and commented out. sm.
1294 "Prepend to one property of the text from START to END.
1295 Arguments PROP and VALUE specify the property and value to prepend to the value
1296 already in place. The resulting property values are always lists.
1297 Optional argument OBJECT is the string or buffer containing the text."
1304 object)
1308 "Append to one property of the text from START to END.
1309 Arguments PROP and VALUE specify the property and value to append to the value
1310 already in place. The resulting property values are always lists.
1311 Optional argument OBJECT is the string or buffer containing the text."
1318 object)
1322 "Fill in one property of the text from START to END.
1323 Arguments PROP and VALUE specify the property and value to put where none are
1324 already in place. Therefore existing property values are not overwritten.
1325 Optional argument OBJECT is the string or buffer containing the text."
1332 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1333 ;; is to `add-text-properties', etc.
1334 ;(defun remove-text-property (start end property &optional object)
1335 ; "Remove a property from text from START to END.
1336 ;Argument PROPERTY is the property to remove.
1337 ;Optional argument OBJECT is the string or buffer containing the text.
1338 ;Return t if the property was actually removed, nil otherwise."
1339 ; (remove-text-properties start end (list property) object))
1341 ;; For consistency: maybe this should be called `remove-single-property' like
1342 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1343 ;(defun remove-single-text-property (start end prop value &optional object)
1344 ; "Remove a specific property value from text from START to END.
1345 ;Arguments PROP and VALUE specify the property and value to remove. The
1346 ;resulting property values are not equal to VALUE nor lists containing VALUE.
1347 ;Optional argument OBJECT is the string or buffer containing the text."
1348 ; (let ((start (text-property-not-all start end prop nil object)) next prev)
1349 ; (while start
1350 ; (setq next (next-single-property-change start prop object end)
1351 ; prev (get-text-property start prop object))
1352 ; (cond ((and (symbolp prev) (eq value prev))
1353 ; (remove-text-property start next prop object))
1354 ; ((and (listp prev) (memq value prev))
1355 ; (let ((new (delq value prev)))
1356 ; (cond ((null new)
1357 ; (remove-text-property start next prop object))
1358 ; ((= (length new) 1)
1359 ; (put-text-property start next prop (car new) object))
1360 ; (t
1361 ; (put-text-property start next prop new object))))))
1362 ; (setq start (text-property-not-all next end prop nil object)))))
1364 ;;; End of Additional text property functions.
1365 \f
1366 ;;; Syntactic regexp fontification functions.
1368 ;; These syntactic keyword pass functions are identical to those keyword pass
1369 ;; functions below, with the following exceptions; (a) they operate on
1370 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1371 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1372 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1373 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1374 ;; LOUDLY as it is not likely to be intensive.
1377 "Apply HIGHLIGHT following a match.
1378 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1379 see `font-lock-syntactic-keywords'."
1388 ;; No match but we might not signal an error.
1392 ;; Cannot override existing fontification.
1396 ;; Override existing fontification.
1399 ;; Keep existing fontification.
1403 "Fontify according to KEYWORDS until LIMIT.
1404 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1405 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1407 ;; Evaluate PRE-MATCH-FORM.
1409 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1414 ;; Find an occurrence of `matcher' before `limit'.
1418 ;; Apply each highlight to this instance of `matcher'.
1423 ;; Evaluate POST-MATCH-FORM.
1427 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1428 START should be at the beginning of a line."
1429 ;; Ensure the beginning of the file is properly syntactic-fontified.
1434 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1437 font-lock-syntactic-keywords)))
1438 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1441 font-lock-syntactic-keywords)))
1442 ;; Get down to business.
1445 keyword matcher highlights)
1447 ;; Find an occurrence of `matcher' from `start' to `end'.
1453 ;; Apply each highlight to this instance of `matcher', which may be
1454 ;; specific highlights or more keywords anchored to `matcher'.
1460 end))
1464 ;;; End of Syntactic regexp fontification functions.
1465 \f
1466 ;;; Syntactic fontification functions.
1468 ;; These record the parse state at a particular position, always the start of a
1469 ;; line. Used to make `font-lock-fontify-syntactically-region' faster.
1470 ;; Previously, `font-lock-cache-position' was just a buffer position. However,
1471 ;; under certain situations, this occasionally resulted in mis-fontification.
1472 ;; I think the "situations" were deletion with Lazy Lock mode's deferral. sm.
1477 "Put proper face on each string and comment between START and END.
1478 START should be at the beginning of a line."
1480 state face beg)
1483 ;;
1484 ;; Find the state at the `beginning-of-line' before `start'.
1486 ;; Use the cache for the state of `start'.
1488 ;; Find the state of `start'.
1490 ;; Use the state at the previous cache position, if any, or
1491 ;; otherwise calculate from `point-min'.
1495 font-lock-cache-state)))
1496 ;; Call the function to move outside any syntactic block.
1499 ;; Cache the state and position of `start'.
1502 ;;
1503 ;; If the region starts inside a string or comment, show the extent of it.
1508 ;;
1509 ;; Find each interesting place between here and `end'.
1520 ;;; End of Syntactic fontification functions.
1521 \f
1522 ;;; Keyword regexp fontification functions.
1525 "Apply HIGHLIGHT following a match.
1526 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1531 ;; No match but we might not signal an error.
1535 ;; Cannot override existing fontification.
1539 ;; Override existing fontification.
1542 ;; Prepend to existing fontification.
1545 ;; Append to existing fontification.
1548 ;; Keep existing fontification.
1552 "Fontify according to KEYWORDS until LIMIT.
1553 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1554 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1557 ;; Evaluate PRE-MATCH-FORM.
1559 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1564 ;; this is a multiline anchored match
1565 ;; (setq font-lock-multiline t)
1569 limit
1572 ;; Find an occurrence of `matcher' before `limit'.
1577 ;; Apply each highlight to this instance of `matcher'.
1582 ;; Evaluate POST-MATCH-FORM.
1586 "Fontify according to `font-lock-keywords' between START and END.
1587 START should be at the beginning of a line."
1593 keyword matcher highlights)
1594 ;;
1595 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1599 ;;
1600 ;; Find an occurrence of `matcher' from `start' to `end'.
1612 ;; this is a multiline regexp match
1613 ;; (setq font-lock-multiline t)
1622 ;; Apply each highlight to this instance of `matcher', which may be
1623 ;; specific highlights or more keywords anchored to `matcher'.
1632 ;;; End of Keyword regexp fontification functions.
1633 \f
1634 ;; Various functions.
1637 "Compile KEYWORDS into the form (t KEYWORD ...).
1638 Here KEYWORD is of the form (MATCHER HIGHLIGHT ...) as shown in the
1639 `font-lock-keywords' doc string."
1641 keywords
1650 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1661 keyword)))
1664 "Evalulate KEYWORDS if a function (funcall) or variable (eval) name."
1666 keywords
1672 "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1673 Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
1676 alist))
1679 "Return LEVELth element of KEYWORDS.
1680 A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1681 \(1- (length KEYWORDS))."
1683 keywords)
1694 "Set fontification defaults appropriately for this mode.
1695 Sets various variables using `font-lock-defaults' (or, if nil, using
1696 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1697 ;; Set fontification defaults iff not previously set.
1712 ;; Regexp fontification?
1715 ;; Local fontification?
1721 ;; Syntactic fontification?
1724 ;; Case fold during regexp fontification?
1727 ;; Syntax table for regexp and syntactic fontification?
1733 ;; The character to modify may be a single CHAR or a STRING.
1742 ;; Syntax function for syntactic fontification?
1746 ;; Variable alist?
1754 "Unset fontification defaults. See function `font-lock-set-defaults'."
1756 font-lock-keywords nil
1757 font-lock-keywords-only nil
1758 font-lock-keywords-case-fold-search nil
1759 font-lock-syntax-table nil
1760 font-lock-beginning-of-syntax-function nil)
1767 \f
1768 ;;; Colour etc. support.
1770 ;; Originally face attributes were specified via `font-lock-face-attributes'.
1771 ;; Users then changed the default face attributes by setting that variable.
1772 ;; However, we try and be back-compatible and respect its value if set except
1773 ;; for faces where M-x customize has been used to save changes for the face.
1779 ;; Rustle up a `defface' SPEC from a `font-lock-face-attributes' entry.
1786 face-spec)
1799 ;; But now we do it the custom way. Note that `defface' will not overwrite any
1800 ;; faces declared above via `custom-declare-face'.
1811 "Font Lock mode face used to highlight comments."
1821 "Font Lock mode face used to highlight strings."
1826 "Font Lock mode face used to highlight documentation."
1836 "Font Lock mode face used to highlight keywords."
1846 "Font Lock mode face used to highlight builtins."
1854 "Font Lock mode face used to highlight function names."
1866 "Font Lock mode face used to highlight variable names."
1876 "Font Lock mode face used to highlight type and classes."
1888 "Font Lock mode face used to highlight constants and labels."
1896 "Font Lock mode face used to highlight warnings."
1899 ;;; End of Colour etc. support.
1900 \f
1901 ;;; Menu support.
1903 ;; This section of code is commented out because Emacs does not have real menu
1904 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1905 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1906 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1907 ;; the entry for "Text Properties" something like:
1908 ;;
1909 ;; (define-key menu-bar-edit-menu [font-lock]
1910 ;; (cons "Syntax Highlighting" font-lock-menu))
1911 ;;
1912 ;; and remove a single ";" from the beginning of each line in the rest of this
1913 ;; section. Probably the mechanism for telling the menu code what are menu
1914 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1915 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1917 ;;;;###autoload
1918 ;(progn
1919 ; ;; Make the Font Lock menu.
1920 ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1921 ; ;; Add the menu items in reverse order.
1922 ; (define-key font-lock-menu [fontify-less]
1923 ; '("Less In Current Buffer" . font-lock-fontify-less))
1924 ; (define-key font-lock-menu [fontify-more]
1925 ; '("More In Current Buffer" . font-lock-fontify-more))
1926 ; (define-key font-lock-menu [font-lock-sep]
1927 ; '("--"))
1928 ; (define-key font-lock-menu [font-lock-mode]
1929 ; '("In Current Buffer" . font-lock-mode))
1930 ; (define-key font-lock-menu [global-font-lock-mode]
1931 ; '("In All Buffers" . global-font-lock-mode)))
1932 ;
1933 ;;;;###autoload
1934 ;(progn
1935 ; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1936 ; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1937 ; (put 'global-font-lock-mode 'menu-toggle t)
1938 ; (put 'font-lock-mode 'menu-toggle t)
1939 ; (put 'font-lock-fontify-more 'menu-enable '(identity))
1940 ; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1941 ;
1942 ;;; Put the appropriate symbol property values on now. See above.
1943 ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
1944 ;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1945 ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1946 ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1947 ;
1948 ;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1949 ;
1950 ;(defun font-lock-fontify-level (level)
1951 ; (let ((font-lock-maximum-decoration level))
1952 ; (when font-lock-mode
1953 ; (font-lock-mode))
1954 ; (font-lock-mode)
1955 ; (when font-lock-verbose
1956 ; (message "Fontifying %s... level %d" (buffer-name) level))))
1957 ;
1958 ;(defun font-lock-fontify-less ()
1959 ; "Fontify the current buffer with less decoration.
1960 ;See `font-lock-maximum-decoration'."
1961 ; (interactive)
1962 ; ;; Check in case we get called interactively.
1963 ; (if (nth 1 font-lock-fontify-level)
1964 ; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1965 ; (error "No less decoration")))
1966 ;
1967 ;(defun font-lock-fontify-more ()
1968 ; "Fontify the current buffer with more decoration.
1969 ;See `font-lock-maximum-decoration'."
1970 ; (interactive)
1971 ; ;; Check in case we get called interactively.
1972 ; (if (nth 2 font-lock-fontify-level)
1973 ; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1974 ; (error "No more decoration")))
1975 ;
1976 ;;; This should be called by `font-lock-set-defaults'.
1977 ;(defun font-lock-set-menu ()
1978 ; ;; Activate less/more fontification entries if there are multiple levels for
1979 ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
1980 ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
1981 ; (let ((keywords (or (nth 0 font-lock-defaults)
1982 ; (nth 1 (assq major-mode font-lock-defaults-alist))))
1983 ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1984 ; (make-local-variable 'font-lock-fontify-level)
1985 ; (if (or (symbolp keywords) (= (length keywords) 1))
1986 ; (font-lock-unset-menu)
1987 ; (cond ((eq level t)
1988 ; (setq level (1- (length keywords))))
1989 ; ((or (null level) (zerop level))
1990 ; ;; The default level is usually, but not necessarily, level 1.
1991 ; (setq level (- (length keywords)
1992 ; (length (member (eval (car keywords))
1993 ; (mapcar 'eval (cdr keywords))))))))
1994 ; (setq font-lock-fontify-level (list level (> level 1)
1995 ; (< level (1- (length keywords))))))))
1996 ;
1997 ;;; This should be called by `font-lock-unset-defaults'.
1998 ;(defun font-lock-unset-menu ()
1999 ; ;; Deactivate less/more fontification entries.
2000 ; (setq font-lock-fontify-level nil))
2002 ;;; End of Menu support.
2003 \f
2004 ;;; Various regexp information shared by several modes.
2005 ;;; Information specific to a single mode should go in its load library.
2007 ;; Font Lock support for C, C++, Objective-C and Java modes will one day be in
2008 ;; some cc-font.el (and required by cc-mode.el). However, the below function
2009 ;; should stay in font-lock.el, since it is used by other libraries. sm.
2012 "Match, and move over, any declaration/definition item after point.
2013 Matches after point, but ignores leading whitespace and `*' characters.
2014 Does not move further than LIMIT.
2016 The expected syntax of a declaration/definition item is `word' (preceded by
2017 optional whitespace and `*' characters and proceeded by optional whitespace)
2018 optionally followed by a `('. Everything following the item (but belonging to
2019 it) is expected to by skip-able by `scan-sexps', and items are expected to be
2020 separated with a `,' and to be terminated with a `;'.
2022 Thus the regexp matches after point: word (
2023 ^^^^ ^
2024 Where the match subexpressions are: 1 2
2026 The item is delimited by (match-beginning 1) and (match-end 1).
2027 If (match-beginning 2) is non-nil, the item is followed by a `('.
2029 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
2034 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2037 ;; Move over any item value, etc., to the next item.
2042 \f
2043 ;; Lisp.
2048 ;;
2049 ;; Definitions.
2051 ;; Function declarations.
2057 ;; Variable declarations.
2059 ;; Structure declarations.
2062 ;; Any whitespace and defined object.
2069 nil t))
2070 ;;
2071 ;; Emacs Lisp autoload cookies.
2073 ))
2080 ;;
2081 ;; Control structures. Emacs Lisp forms.
2091 "eval-when"
2098 ;;
2099 ;; Control structures. Common Lisp forms.
2113 ;;
2114 ;; Exit/Feature symbols as constants.
2119 ;;
2120 ;; Erroneous structures.
2122 ;;
2123 ;; Words inside \\[] tend to be for `substitute-command-keys'.
2125 ;;
2126 ;; Words inside `' tend to be symbol names.
2128 ;;
2129 ;; Constant values.
2131 ;;
2132 ;; ELisp and CLisp `&' keywords as types.
2134 ;;
2135 ;; CL `with-' and `do-' constructs
2137 )))
2142 \f
2143 ;;; User choices.
2145 ;; These provide a means to fontify types not defined by the language. Those
2146 ;; types might be the user's own or they might be generally accepted and used.
2147 ;; Generally accepted types are used to provide default variable values.
2150 "Widget `:type' for members of the custom group `font-lock-extra-types'.
2151 Members should `:load' the package `font-lock' to use this widget."
2156 "*List of extra types to fontify in C mode.
2157 Each list item should be a regexp not containing word-delimiters.
2159 ending in _t are treated as type names.
2161 The value of this variable is used when Font Lock mode is turned on."
2175 "type_info"
2178 "*List of extra types to fontify in C++ mode.
2179 Each list item should be a regexp not containing word-delimiters.
2181 name.
2183 The value of this variable is used when Font Lock mode is turned on."
2188 "*List of extra types to fontify in Objective-C mode.
2189 Each list item should be a regexp not containing word-delimiters.
2191 Class, BOOL, IMP and SEL are treated as type names.
2193 The value of this variable is used when Font Lock mode is turned on."
2199 "*List of extra types to fontify in Java mode.
2200 Each list item should be a regexp not containing word-delimiters.
2202 words (and words conforming to the Java id spec) are treated as type names.
2204 The value of this variable is used when Font Lock mode is turned on."
2207 \f
2208 ;;; C.
2210 ;; [Murmur murmur murmur] Maestro, drum-roll please... [Murmur murmur murmur.]
2211 ;; Ahem. [Murmur murmur murmur] Lay-dees an Gennel-men. [Murmur murmur shhh!]
2212 ;; I am most proud and humbly honoured today [murmur murmur cough] to present
2213 ;; to you good people, the winner of the Second Millennium Award for The Most
2214 ;; Hairy Language Syntax. [Ahhh!] All rise please. [Shuffle shuffle
2215 ;; shuffle.] And a round of applause please. For... The C Language! [Roar.]
2216 ;;
2217 ;; Thank you... You are too kind... It is with a feeling of great privilege
2218 ;; and indeed emotion [sob] that I accept this award. It has been a long hard
2219 ;; road. But we know our destiny. And our future. For we must not rest.
2220 ;; There are more tokens to overload, more shoehorn, more methodologies. But
2221 ;; more is a plus! [Ha ha ha.] And more means plus! [Ho ho ho.] The future
2222 ;; is C++! [Ohhh!] The Third Millennium Award... Will be ours! [Roar.]
2228 "Medium level highlighting for C mode.
2232 "Gaudy level highlighting for C mode.
2239 ;; Type related, but we don't do anything special.
2242 ;; Dan Nicolaescu <done@gnu.org> says this is new.
2256 c-font-lock-extra-types)
2269 ;;
2270 ;; These are all anchored at the beginning of line for speed.
2271 ;; Note that `c++-font-lock-keywords-1' depends on `c-font-lock-keywords-1'.
2272 ;;
2273 ;; Fontify function name definitions (GNU style; without type on line).
2275 ;;
2276 ;; Fontify error directives.
2278 ;;
2279 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2282 ;;
2283 ;; Fontify function macro names.
2285 ;;
2286 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2290 ;;
2291 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2302 ;;
2303 ;; Simple regexps for speed.
2304 ;;
2305 ;; Fontify all type names.
2308 ;;
2309 ;; Fontify all builtin keywords (except case, default and goto; see below).
2311 ;;
2312 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2316 ;; Return limit of search.
2318 nil
2320 ;; Anders Lindgren <andersl@andersl.com> points out that it is quicker to
2321 ;; use MATCH-ANCHORED to effectively anchor the regexp on the left.
2322 ;; This must come after the one for keywords and targets.
2326 )))
2330 ;;
2331 ;; More complicated regexps for more complete highlighting for types.
2332 ;; We still have to fontify type specifiers individually, as C is so hairy.
2334 ;;
2335 ;; Fontify all storage types, plus their items.
2339 ;; Fontify each declaration item.
2341 ;; Start with point after all type specifiers.
2346 ;; Finish with point after first type specifier.
2348 ;; Fontify as a variable or function name.
2350 font-lock-function-name-face
2351 font-lock-variable-name-face)))))
2352 ;;
2353 ;; Fontify all storage specs and types, plus their items.
2360 nil nil
2361 ;; Fontify as a variable or function name.
2363 font-lock-function-name-face
2365 ;;
2366 ;; Fontify structures, or typedef names, plus their items.
2371 ;;
2372 ;; Fontify anything at beginning of line as a declaration or definition.
2378 font-lock-function-name-face
2379 font-lock-variable-name-face))))
2380 )))
2381 )
2384 "Default expressions to highlight in C mode.
2386 \f
2387 ;;; C++.
2393 "Medium level highlighting for C++ mode.
2397 "Gaudy level highlighting for C++ mode.
2401 ;; Regexp matches after point: word<word>::word (
2402 ;; ^^^^ ^^^^ ^^^^ ^
2403 ;; Where the match subexpressions are: 1 3 5 6
2404 ;;
2405 ;; Item is delimited by (match-beginning 1) and (match-end 1).
2406 ;; If (match-beginning 3) is non-nil, that part of the item incloses a `<>'.
2407 ;; If (match-beginning 5) is non-nil, that part of the item follows a `::'.
2408 ;; If (match-beginning 6) is non-nil, the item is followed by a `('.
2411 ;; Skip any leading whitespace.
2413 ;; This is `c++-type-spec' from below. (Hint hint!)
2417 ;; Match any trailing parenthesis.
2422 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2425 ;; Move over any item value, etc., to the next item.
2432 ;; Match C++ constructors and destructors inside class declarations.
2438 ;; Don't match function pointer declarations, e.g.:
2439 ;; Foo (*fptr)();
2447 res))
2454 "typeid"
2455 ;; Branko Cibej <branko.cibej@hermes.si> says this is new.
2456 "export"
2457 ;; Mark Mitchell <mmitchell@usa.net> says these are new.
2459 ;; Alain Picard <ap@abelard.apana.org.au> suggests treating these
2460 ;; as keywords not types.
2467 ;; Taken from Stroustrup, minus keywords otherwise fontified.
2476 ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new.
2491 ;;
2492 ;; A brave attempt to match templates following a type and/or match
2493 ;; class membership. See and sync the above function
2494 ;; `font-lock-match-c++-style-declaration-item-and-skip-to-next'.
2498 ;; If the string is a type, it may be followed by the cruft above.
2501 ;;
2502 ;; Parenthesis depth of user-defined types not forgetting their cruft.
2505 )
2508 ;;
2509 ;; The list `c-font-lock-keywords-1' less that for function names.
2512 ;;
2513 ;; Fontify function name definitions, possibly incorporating class names.
2516 font-lock-type-face
2517 font-lock-function-name-face))
2520 )))
2525 ;;
2526 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2530 ;;
2531 ;; Fontify operator overloading.
2535 ;;
2536 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2540 ;; Return limit of search.
2547 nil
2549 font-lock-type-face
2551 ;; This must come after the one for keywords and targets.
2555 ;;
2556 ;; Fontify other builtin keywords.
2558 ;;
2559 ;; Eric Hopper <hopper@omnifarious.mn.org> says `true' and `false' are new.
2561 )))
2565 ;;
2566 ;; More complicated regexps for more complete highlighting for types.
2568 ;;
2569 ;; Fontify all storage classes and type specifiers, plus their items.
2573 ;; The name of any template type.
2575 ;; Fontify each declaration item.
2577 ;; Start with point after all type specifiers.
2581 ;; Finish with point after first type specifier.
2583 ;; Fontify as a variable or function name.
2585 font-lock-type-face)
2587 font-lock-function-name-face)
2589 font-lock-variable-name-face)))
2592 font-lock-function-name-face
2594 ;;
2595 ;; Fontify all storage specs and types, plus their items.
2599 ;; The name of any template type.
2601 ;; The name of any type.
2604 ;; Fontify each declaration item.
2606 ;; Start with point after all type specifiers.
2607 nil
2608 ;; Finish with point after first type specifier.
2609 nil
2610 ;; Fontify as a variable or function name.
2612 font-lock-type-face)
2614 font-lock-function-name-face)
2616 font-lock-variable-name-face)))
2619 font-lock-function-name-face
2621 ))
2622 ;;
2623 ;; Fontify structures, or typedef names, plus their items.
2628 ;;
2629 ;; Fontify anything at beginning of line as a declaration or definition.
2635 font-lock-type-face)
2640 font-lock-function-name-face
2642 ;;
2643 ;; Fontify constructors and destructors inside class declarations.
2646 )))
2647 )
2650 "Default expressions to highlight in C++ mode.
2652 \f
2653 ;;; Objective-C.
2659 "Medium level highlighting for Objective-C mode.
2663 "Gaudy level highlighting for Objective-C mode.
2666 ;; Regexps written with help from Stephen Peters <speters@us.oracle.com> and
2667 ;; Jacques Duthen Prestataire <duthen@cegelec-red.fr>.
2689 objc-font-lock-extra-types)
2693 )
2696 ;;
2697 ;; The list `c-font-lock-keywords-1' less that for function names.
2700 ;;
2701 ;; Fontify compiler directives.
2706 ;;
2707 ;; Fontify method names and arguments. Oh Lordy!
2708 ;; First, on the same line as the function declaration.
2713 nil nil
2716 ;; Second, on lines following the function declaration.
2721 )))
2726 ;;
2727 ;; Simple regexps for speed.
2728 ;;
2729 ;; Fontify all type specifiers.
2733 ;;
2734 ;; Fontify all builtin keywords (except case, default and goto; see below).
2736 ;;
2737 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2740 ;; Fontify tags iff sole statement on line, otherwise we detect selectors.
2741 ;; This must come after the one for keywords and targets.
2745 ;;
2746 ;; Fontify null object pointers.
2748 )))
2752 ;;
2753 ;; More complicated regexps for more complete highlighting for types.
2754 ;; We still have to fontify type specifiers individually, as C is so hairy.
2756 ;;
2757 ;; Fontify all storage classes and type specifiers, plus their items.
2761 ;; Fontify each declaration item.
2763 ;; Start with point after all type specifiers.
2768 ;; Finish with point after first type specifier.
2770 ;; Fontify as a variable or function name.
2772 font-lock-function-name-face
2773 font-lock-variable-name-face)))))
2774 ;;
2775 ;; Fontify all storage specs and types, plus their items.
2779 ;; The name of any type.
2781 ;; Fontify each declaration item.
2783 nil nil
2784 ;; Fontify as a variable or function name.
2786 font-lock-function-name-face
2787 font-lock-variable-name-face)))
2788 ))
2789 ;;
2790 ;; Fontify structures, or typedef names, plus their items.
2795 ;;
2796 ;; Fontify anything at beginning of line as a declaration or definition.
2802 font-lock-function-name-face
2803 font-lock-variable-name-face))))
2804 )))
2805 )
2808 "Default expressions to highlight in Objective-C mode.
2810 \f
2811 ;;; Java.
2817 "Medium level highlighting for Java mode.
2821 "Gaudy level highlighting for Java mode.
2824 ;; Regexps written with help from Fred White <fwhite@bbn.com>,
2825 ;; Anders Lindgren <andersl@andersl.com> and Carl Manning <caroma@ai.mit.edu>.
2830 ;; Anders Lindgren <andersl@andersl.com> says these have gone.
2831 ;; "cast" "byvalue" "future" "generic" "operator" "var"
2832 ;; "inner" "outer" "rest"
2835 ;;
2836 ;; Classes immediately followed by an object name.
2843 java-font-lock-extra-types)
2846 ;;
2847 ;; These are eventually followed by an object name.
2852 ;; Anders Lindgren <andersl@andersl.com> says this has gone.
2853 ;; "threadsafe"
2855 ;; Carl Manning <caroma@ai.mit.edu> says this is new.
2857 )
2860 ;;
2861 ;; Fontify class names.
2864 ;;
2865 ;; Fontify package names in import directives.
2871 ))
2876 ;;
2877 ;; Fontify class names.
2881 ;;
2882 ;; Fontify all builtin keywords (except below).
2884 ;;
2885 ;; Fontify keywords and targets, and case default/goto tags.
2888 ;; This must come after the one for keywords and targets.
2892 ;;
2893 ;; Fontify all constants.
2895 ;;
2896 ;; Javadoc tags within comments.
2911 )))
2915 ;;
2916 ;; More complicated regexps for more complete highlighting for types.
2917 ;; We still have to fontify type specifiers individually, as Java is hairy.
2919 ;;
2920 ;; Fontify random types immediately followed by an item or items.
2925 ;; Fontify each declaration item.
2927 ;; Start and finish with point after the type specifier.
2932 ;; Fontify as a variable or function name.
2934 font-lock-function-name-face
2935 font-lock-variable-name-face)))))
2936 ;;
2937 ;; Fontify those that are eventually followed by an item or items.
2942 ;; Fontify each declaration item.
2944 ;; Start with point after all type specifiers.
2946 ;; Finish with point after first type specifier.
2948 ;; Fontify as a variable or function name.
2950 font-lock-function-name-face
2951 font-lock-variable-name-face))))
2952 )))
2953 )
2956 "Default expressions to highlight in Java mode.
2958 \f
2959 ;; Provide ourselves:
2964 ;;; font-lock.el ends here