| blob | 96b290e34f4a7a8beb5f4d71db68c71798c631e5 |
1 ;;; font-lock.el --- Electric font lock mode
3 ;; Copyright (C) 1992-2015 Free Software Foundation, Inc.
5 ;; Author: Jamie Zawinski
6 ;; Richard Stallman
7 ;; Stefan Monnier
8 ;; Maintainer: emacs-devel@gnu.org
9 ;; Keywords: languages, faces
10 ;; Package: emacs
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
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 init 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's 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 the buffer local variable `font-lock-defaults'.
104 ;; (Font Lock mode is set up via (a) where a mode's patterns are
105 ;; distributed with the mode's package library, and (b) where a mode's
106 ;; patterns are distributed with font-lock.el itself. An example of (a)
107 ;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is
108 ;; (a); (b) is used where it is not clear which package library should contain
109 ;; the pattern definitions.) Font Lock mode chooses which variable to use for
110 ;; fontification based on `font-lock-maximum-decoration'.
111 ;;
112 ;; Font Lock mode fontification behavior can be modified in a number of ways.
113 ;; See the below comments and the comments distributed throughout this file.
115 ;;; Constructing patterns:
117 ;; See the documentation for the variable `font-lock-keywords'.
118 ;;
119 ;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and
120 ;; `font-lock-syntactic-keywords' can be generated via the function
121 ;; `regexp-opt'.
123 ;;; Adding patterns for modes that already support Font Lock:
125 ;; Though Font Lock highlighting patterns already exist for many modes, it's
126 ;; likely there's something that you want fontified that currently isn't, even
127 ;; at the maximum fontification level. You can add highlighting patterns via
128 ;; `font-lock-add-keywords'. For example, say in some C
129 ;; header file you #define the token `and' to expand to `&&', etc., to make
130 ;; your C code almost readable. In your ~/.emacs there could be:
131 ;;
132 ;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>"))
133 ;;
134 ;; Some modes provide specific ways to modify patterns based on the values of
135 ;; other variables. For example, additional C types can be specified via the
136 ;; variable `c-font-lock-extra-types'.
138 ;;; Adding patterns for modes that do not support Font Lock:
140 ;; Not all modes support Font Lock mode. If you (as a user of the mode) add
141 ;; patterns for a new mode, you must define in your ~/.emacs a variable or
142 ;; variables that specify regexp fontification. Then, you should indicate to
143 ;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what
144 ;; support is required. For example, say Foo mode should have the following
145 ;; regexps fontified case-sensitively, and comments and strings should not be
146 ;; fontified automagically. In your ~/.emacs there could be:
147 ;;
148 ;; (defvar foo-font-lock-keywords
149 ;; '(("\\<\\(one\\|two\\|three\\)\\>" . 'font-lock-keyword-face)
150 ;; ("\\<\\(four\\|five\\|six\\)\\>" . 'font-lock-type-face))
151 ;; "Default expressions to highlight in Foo mode.")
152 ;;
153 ;; (add-hook 'foo-mode-hook
154 ;; (lambda ()
155 ;; (set (make-local-variable 'font-lock-defaults)
156 ;; '(foo-font-lock-keywords t))))
158 ;;; Adding Font Lock support for modes:
160 ;; Of course, it would be better that the mode already supports Font Lock mode.
161 ;; The package author would do something similar to above. The mode must
162 ;; define at the top-level a variable or variables that specify regexp
163 ;; fontification. Then, the mode command should indicate to Font Lock mode,
164 ;; via `font-lock-defaults', exactly what support is required. For example,
165 ;; say Bar mode should have the following regexps fontified case-insensitively,
166 ;; and comments and strings should be fontified automagically. In bar.el there
167 ;; could be:
168 ;;
169 ;; (defvar bar-font-lock-keywords
170 ;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . 'font-lock-keyword-face)
171 ;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . 'font-lock-type-face))
172 ;; "Default expressions to highlight in Bar mode.")
173 ;;
174 ;; and within `bar-mode' there could be:
175 ;;
176 ;; (set (make-local-variable 'font-lock-defaults)
177 ;; '(bar-font-lock-keywords nil t))
178 \f
179 ;; What is fontification for? You might say, "It's to make my code look nice."
180 ;; I think it should be for adding information in the form of cues. These cues
181 ;; should provide you with enough information to both (a) distinguish between
182 ;; different items, and (b) identify the item meanings, without having to read
183 ;; the items and think about it. Therefore, fontification allows you to think
184 ;; less about, say, the structure of code, and more about, say, why the code
185 ;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
186 ;;
187 ;; So, here are my opinions/advice/guidelines:
188 ;;
189 ;; - Highlight conceptual objects, such as function and variable names, and
190 ;; different objects types differently, i.e., (a) and (b) above, highlight
191 ;; function names differently to variable names.
192 ;; - Keep the faces distinct from each other as far as possible.
193 ;; i.e., (a) above.
194 ;; - Use the same face for the same conceptual object, across all modes.
195 ;; i.e., (b) above, all modes that have items that can be thought of as, say,
196 ;; keywords, should be highlighted with the same face, etc.
197 ;; - Make the face attributes fit the concept as far as possible.
198 ;; i.e., function names might be a bold color such as blue, comments might
199 ;; be a bright color such as red, character strings might be brown, because,
200 ;; err, strings are brown (that was not the reason, please believe me).
201 ;; - Don't use a non-nil OVERRIDE unless you have a good reason.
202 ;; Only use OVERRIDE for special things that are easy to define, such as the
203 ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
204 ;; Don't use it to, say, highlight keywords in commented out code or strings.
205 ;; - Err, that's it.
206 \f
207 ;;; Code:
212 ;; Define core `font-lock' group.
214 "Font Lock mode text highlighting package."
220 "Faces for highlighting text."
225 "Extra mode-specific type names for highlighting declarations."
227 \f
228 ;; User variables.
231 "Maximum buffer size for unsupported buffer fontification.
232 When `font-lock-support-mode' is nil, only buffers smaller than
233 this are fontified. This variable has no effect if a Font Lock
234 support mode (usually `jit-lock-mode') is enabled.
236 If nil, means size is irrelevant.
237 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
238 where MAJOR-MODE is a symbol or t (meaning the default). For example:
239 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
240 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
241 for buffers in Rmail mode, and size is irrelevant otherwise."
257 "Maximum decoration level for fontification.
258 If nil, use the default decoration (typically the minimum available).
259 If t, use the maximum decoration available.
260 If a number, use that level of decoration (or if not available the maximum).
261 The higher the number, the more decoration is done.
262 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
263 where MAJOR-MODE is a symbol or t (meaning the default). For example:
264 ((c-mode . t) (c++-mode . 2) (t . 1))
265 means use the maximum decoration available for buffers in C mode, level 2
266 decoration for buffers in C++ mode, and level 1 decoration otherwise."
283 "If non-nil, means show status messages for buffer fontification.
284 If a number, only buffers greater than this size have fontification messages."
290 \f
292 ;; Originally these variable values were face names such as `bold' etc.
293 ;; Now we create our own faces, but we keep these variables for compatibility
294 ;; and they give users another mechanism for changing face appearance.
295 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
296 ;; returns a face. So the easiest thing is to continue using these variables,
297 ;; rather than sometimes evalling FACENAME and sometimes not. sm.
299 ;; Note that in new code, in the vast majority of cases there is no
300 ;; need to create variables that specify face names. Simply using
301 ;; faces directly is enough. Font-lock is not a template to be
302 ;; followed in this area.
337 "Face name to use for easy to overlook negation.
346 ;; Fontification variables:
349 "A list of the keywords to highlight.
350 There are two kinds of values: user-level, and compiled.
352 A user-level keywords list is what a major mode or the user would
353 set up. Normally the list would come from `font-lock-defaults'.
354 through selection of a fontification level and evaluation of any
355 contained expressions. You can also alter it by calling
356 `font-lock-add-keywords' or `font-lock-remove-keywords' with MODE = nil.
358 Each element in a user-level keywords list should have one of these forms:
360 MATCHER
361 (MATCHER . SUBEXP)
362 (MATCHER . FACENAME)
363 (MATCHER . HIGHLIGHT)
364 (MATCHER HIGHLIGHT ...)
365 (eval . FORM)
367 where MATCHER can be either the regexp to search for, or the function name to
368 call to make the search (called with one argument, the limit of the search;
369 it should return non-nil, move point, and set `match-data' appropriately if
370 it succeeds; like `re-search-forward' would).
371 MATCHER regexps can be generated via the function `regexp-opt'.
373 FORM is an expression, whose value should be a keyword element, evaluated when
374 the keyword is (first) used in a buffer. This feature can be used to provide a
375 keyword that can only be generated when Font Lock mode is actually turned on.
377 HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
380 typically only MATCH-HIGHLIGHT is required.
381 However, if an item or (typically) items are to be highlighted following the
382 instance of another item (the anchor), for example each instance of the
385 MATCH-HIGHLIGHT should be of the form:
387 (SUBEXP FACENAME [OVERRIDE [LAXMATCH]])
389 SUBEXP is the number of the subexpression of MATCHER to be highlighted.
391 FACENAME is an expression whose value is the face name to use.
392 Instead of a face, FACENAME can evaluate to a property list
393 of the form (face FACE PROP1 VAL1 PROP2 VAL2 ...)
394 in which case all the listed text-properties will be set rather than
395 just FACE. In such a case, you will most likely want to put those
396 properties in `font-lock-extra-managed-props' or to override
397 `font-lock-unfontify-region-function'.
399 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
400 be overwritten. If `keep', only parts not already fontified are highlighted.
401 If `prepend' or `append', existing fontification is merged with the new, in
402 which the new or existing fontification, respectively, takes precedence.
403 If LAXMATCH is non-nil, that means don't signal an error if there is
404 no match for SUBEXP in MATCHER.
406 For example, an element of the form highlights (if not already highlighted):
409 variable `font-lock-keyword-face'.
411 the value of `font-lock-keyword-face'.
415 of `foo-bar-face', even if already highlighted.
416 (fubar-match 1 fubar-face)
417 the first subexpression within all occurrences of
418 whatever the function `fubar-match' finds and matches
419 in the value of `fubar-face'.
421 MATCH-ANCHORED should be of the form:
423 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
425 where MATCHER is a regexp to search for or the function name to call to make
426 the search, as for MATCH-HIGHLIGHT above, but with one exception; see below.
427 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
428 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
429 used to initialize before, and cleanup after, MATCHER is used. Typically,
430 PRE-MATCH-FORM is used to move to some position relative to the original
431 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
432 be used to move back, before resuming with MATCH-ANCHORED's parent's MATCHER.
434 For example, an element of the form highlights (if not already highlighted):
445 The above-mentioned exception is as follows. The limit of the MATCHER search
446 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
447 However, if PRE-MATCH-FORM returns a position greater than the position after
448 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
449 It is generally a bad idea to return a position greater than the end of the
450 line, i.e., cause the MATCHER search to span lines.
452 These regular expressions can match text which spans lines, although
453 it is better to avoid it if possible since updating them while editing
454 text is slower, and it is not guaranteed to be always correct when using
455 support modes like jit-lock or lazy-lock.
457 This variable is set by major modes via the variable `font-lock-defaults'.
458 Be careful when composing regexps for this list; a poorly written pattern can
459 dramatically slow things down!
461 A compiled keywords list starts with t. It is produced internally
462 by `font-lock-compile-keywords' from a user-level keywords list.
463 Its second element is the user-level keywords list that was
464 compiled. The remaining elements have the same form as
465 user-level keywords, but normally their values have been
469 "Alist of additional `font-lock-keywords' elements for major modes.
471 Each element has the form (MODE KEYWORDS . HOW).
472 Function `font-lock-set-defaults' adds the elements in the list KEYWORDS to
473 `font-lock-keywords' when Font Lock is turned on in major mode MODE.
475 If HOW is nil, KEYWORDS are added at the beginning of
476 `font-lock-keywords'. If it is `set', they are used to replace the
477 value of `font-lock-keywords'. If HOW is any other non-nil value,
478 they are added at the end.
480 This is normally set via `font-lock-add-keywords' and
485 "Alist of `font-lock-keywords' elements to be removed for major modes.
487 Each element has the form (MODE . KEYWORDS). Function `font-lock-set-defaults'
488 removes the elements in the list KEYWORDS from `font-lock-keywords'
489 when Font Lock is turned on in major mode MODE.
491 This is normally set via `font-lock-add-keywords' and
495 "Non-nil means Font Lock should not fontify comments or strings.
499 "Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
500 This is set via the function `font-lock-set-defaults', based on
505 "Point up to which `font-lock-syntactic-keywords' has been applied.
506 If nil, this is ignored, in which case the syntactic fontification may
513 "Function to determine which face to use when fontifying syntactically.
514 The function is called with a single parameter (the state as returned by
515 `parse-partial-sexp' at the beginning of the region to highlight) and
519 "A list of the syntactic keywords to put syntax properties on.
520 The value can be the list itself, or the name of a function or variable
521 whose value is the list.
523 See `font-lock-keywords' for a description of the form of this list;
524 only the differences are stated here. MATCH-HIGHLIGHT should be of the form:
526 (SUBEXP SYNTAX OVERRIDE LAXMATCH)
528 where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax
529 table, a cons cell (as returned by `string-to-syntax') or an expression whose
530 value is such a form. OVERRIDE cannot be `prepend' or `append'.
532 Here are two examples of elements of `font-lock-syntactic-keywords'
533 and what they do:
538 dollar-sign character. Hash characters in other contexts will still
539 follow whatever the syntax table says about the hash character.
545 gives a pair single-quotes, which surround a single character, a SYNTAX of
547 contexts will not be affected.
554 "Non-nil means use this syntax table for fontifying.
555 If this is nil, the major mode's syntax table is used.
559 "Non-nil means use this function to move back outside all constructs.
560 When called with no args it should move point backward to a place which
561 is not in a string or comment and not within any bracket-pairs (or else,
562 a place such that any bracket-pairs outside it can be ignored for Emacs
563 syntax analysis and fontification).
565 If this is nil, Font Lock uses `syntax-begin-function' to move back
566 outside of any comment, string, or sexp. This variable is semi-obsolete;
567 we recommend setting `syntax-begin-function' instead.
574 "Non-nil means use this function to mark a block of text.
575 When called with no args it should leave point at the beginning of any
576 enclosing textual block and mark at the end.
580 "Function to use for fontifying the buffer.
584 "Function to use for unfontifying the buffer.
585 This is used when turning off Font Lock mode.
589 "Function to use for fontifying a region.
590 It should take two args, the beginning and end of the region, and an optional
591 third arg VERBOSE. If VERBOSE is non-nil, the function should print status
592 messages. This is normally set via `font-lock-defaults'.
593 If it fontifies a larger region, it should ideally return a list of the form
594 \(jit-lock-bounds BEG . END) indicating the bounds of the region actually
598 "Function to use for unfontifying a region.
599 It should take two args, the beginning and end of the region.
603 "List of Font Lock mode related modes that should not be turned on.
604 Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
609 "Whether font-lock should cater to multiline keywords.
610 If nil, don't try to handle multiline patterns.
611 If t, always handle multiline patterns.
612 If `undecided', don't try to handle multiline patterns until you see one.
616 \f
617 ;; Font Lock mode.
620 ;;
621 ;; Borrowed from lazy-lock.el.
622 ;; We use this to preserve or protect things when modifying text properties.
624 "Bind variables according to VARLIST and eval BODY restoring buffer state."
629 ;;
630 ;; Shut up the byte compiler.
636 "Return non-nil if the current buffer is ready for fontification.
637 The MODE argument, if non-nil, means Font Lock mode is about to
638 be enabled."
641 font-lock-keywords)
643 font-lock-set-defaults
644 font-lock-major-mode
648 ;; The first fontification after turning the mode on. This must
649 ;; only be called after the mode hooks have been run.
654 nil)
662 ;; Turn on Font Lock mode.
667 ;; Turn off Font Lock mode.
674 "Add highlighting KEYWORDS for MODE.
676 MODE should be a symbol, the major mode command name, such as `c-mode'
677 or nil. If nil, highlighting keywords are added for the current buffer.
678 KEYWORDS should be a list; see the variable `font-lock-keywords'.
679 By default they are added at the beginning of the current highlighting list.
680 If optional argument HOW is `set', they are used to replace the current
681 highlighting list. If HOW is any other non-nil value, they are added at the
682 end of the current highlighting list.
684 For example:
686 (font-lock-add-keywords 'c-mode
690 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
691 comments, and to fontify `and', `or' and `not' words as keywords.
693 The above procedure will only add the keywords for C mode, not
694 for modes derived from C mode. To add them for derived modes too,
695 pass nil for MODE and add the call to c-mode-hook.
697 For example:
699 (add-hook 'c-mode-hook
700 (lambda ()
701 (font-lock-add-keywords nil
704 'font-lock-keyword-face)))))
706 The above procedure may fail to add keywords to derived modes if
707 some involved major mode does not follow the standard conventions.
708 File a bug report if this happens, so the major mode can be corrected.
710 Note that some modes have specialized support for additional patterns, e.g.,
711 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
712 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
714 ;; If MODE is non-nil, add the KEYWORDS and HOW spec to
715 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
722 ;; Make sure that `font-lock-removed-keywords-alist' does not
723 ;; contain the new keywords.
728 ;; The major mode has not set any keywords, so when we enabled
729 ;; font-lock-mode it only enabled the font-core.el part, not the
730 ;; font-lock-mode-internal. Try again.
734 ;; Otherwise set or add the keywords now.
735 ;; This is a no-op if it has been done already in this buffer
736 ;; for the correct major mode.
739 ;; Bring back the user-level (uncompiled) keywords.
742 ;; Now modify or replace them.
748 font-lock-keywords)))
752 ;; If the keywords were compiled before, compile them again.
758 "Update `font-lock-removed-keywords-alist' when adding new KEYWORDS to MODE."
759 ;; When font-lock is enabled first all keywords in the list
760 ;; `font-lock-keywords-alist' are added, then all keywords in the
761 ;; list `font-lock-removed-keywords-alist' are removed. If a
762 ;; keyword was once added, removed, and then added again it must be
763 ;; removed from the removed-keywords list. Otherwise the second add
764 ;; will not take effect.
768 ;; A new set of keywords is defined. Forget all about
769 ;; our old keywords that should be removed.
772 ;; Delete all previously removed keywords.
775 ;; Delete the mode cell if empty.
780 ;; Written by Anders Lindgren <andersl@andersl.com>.
781 ;;
782 ;; Case study:
783 ;; (I) The keywords are removed from a major mode.
784 ;; In this case the keyword could be local (i.e. added earlier by
785 ;; `font-lock-add-keywords'), global, or both.
786 ;;
787 ;; (a) In the local case we remove the keywords from the variable
788 ;; `font-lock-keywords-alist'.
789 ;;
790 ;; (b) The actual global keywords are not known at this time.
791 ;; All keywords are added to `font-lock-removed-keywords-alist',
792 ;; when font-lock is enabled those keywords are removed.
793 ;;
794 ;; Note that added keywords are taken out of the list of removed
795 ;; keywords. This ensure correct operation when the same keyword
796 ;; is added and removed several times.
797 ;;
798 ;; (II) The keywords are removed from the current buffer.
800 "Remove highlighting KEYWORDS for MODE.
802 MODE should be a symbol, the major mode command name, such as `c-mode'
803 or nil. If nil, highlighting keywords are removed for the current buffer.
805 To make the removal apply to modes derived from MODE as well,
806 pass nil for MODE and add the call to MODE-hook. This may fail
807 for some derived modes if some involved major mode does not
808 follow the standard conventions. File a bug report if this
809 happens, so the major mode can be corrected."
811 ;; Remove one keyword at the time.
814 ;; If MODE is non-nil, remove the KEYWORD from
815 ;; `font-lock-keywords-alist'.
818 ;; `keywords-list-how-pair' is a cons with a list of
819 ;; keywords in the car top-cell and the original how
820 ;; argument in the cdr top-cell.
823 ;; Remove keyword list/how pair when the keyword list
824 ;; is empty and how doesn't specify `set'. (If it
825 ;; should be deleted then previously deleted keywords
826 ;; would appear again.)
833 ;; Final cleanup, remove major mode cell if last keyword
834 ;; was deleted.
838 ;; Remember the keyword in case it is not local.
844 font-lock-removed-keywords-alist))))))
846 ;; Otherwise remove it immediately.
849 ;; Bring back the user-level (uncompiled) keywords.
853 ;; Edit them.
859 ;; If the keywords were compiled before, compile them again.
863 \f
864 ;;; Font Lock Support mode.
866 ;; This is the code used to interface font-lock.el with any of its add-on
867 ;; packages, and provide the user interface. Packages that have their own
868 ;; local buffer fontification functions (see below) may have to call
869 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
870 ;; themselves.
873 "Support mode for Font Lock mode.
874 Support modes speed up Font Lock mode by being choosy about when fontification
875 occurs. The default support mode, Just-in-time Lock mode (symbol
876 `jit-lock-mode'), is recommended.
878 Other, older support modes are Fast Lock mode (symbol `fast-lock-mode') and
879 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
880 However, they are no longer recommended, as Just-in-time Lock mode is better.
882 If nil, means support for Font Lock mode is never performed.
883 If a symbol, use that support mode.
884 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
885 where MAJOR-MODE is a symbol or t (meaning the default). For example:
886 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
887 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
888 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
890 The value of this variable is used when Font Lock mode is turned on."
906 ))
925 (`jit-lock-mode
926 ;; Prepare for jit-lock
933 ;; Prevent font-lock-fontify-buffer from fontifying eagerly the whole
934 ;; buffer. This is important for things like CWarn mode which
935 ;; adds/removes a few keywords and does a refontify (which takes ages on
936 ;; large files).
939 ;; Don't fontify eagerly (and don't abort if the buffer is large).
941 ;; Use jit-lock.
944 ;; Tell jit-lock how we extend the region to refontify.
946 'font-lock-extend-jit-lock-region-after-change
947 nil t))))
954 ;; Reset local vars to the non-jit-lock case.
962 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
963 ;; (jit-lock-mode
964 ;; (jit-lock-after-fontify-buffer))
971 ;; Useless as well. It's only called when:
972 ;; - turning off font-lock: it does not matter if we leave spurious
973 ;; `fontified' text props around since jit-lock-mode is also off.
974 ;; - font-lock-default-fontify-buffer fails: this is not run
975 ;; any more anyway. -sm
976 ;;
977 ;; (jit-lock-mode
978 ;; (jit-lock-after-unfontify-buffer))
982 ;;; End of Font Lock Support mode.
983 \f
984 ;;; Fontification functions.
986 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
987 ;; code to fontify a region, the function runs the function whose name is the
988 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
989 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
990 ;; which does contain the code to fontify a region. However, the value of the
991 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
992 ;; do anything. The indirection of the fontification functions gives major
993 ;; modes the capability of modifying the way font-lock.el fontifies. Major
994 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
995 ;; via the variable `font-lock-defaults'.
996 ;;
997 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
998 ;; font-lock.el uses its own function for buffer fontification. This function
999 ;; makes fontification be on a message-by-message basis and so visiting an
1000 ;; RMAIL file is much faster. A clever implementation of the function might
1001 ;; fontify the headers differently than the message body. (It should, and
1002 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
1003 ;; you?) This hints at a more interesting use...
1004 ;;
1005 ;; Languages that contain text normally contained in different major modes
1006 ;; could define their own fontification functions that treat text differently
1007 ;; depending on its context. For example, Perl mode could arrange that here
1008 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
1009 ;; rules one way and C code another. Neat!
1010 ;;
1011 ;; A further reason to use the fontification indirection feature is when the
1012 ;; default syntactic fontification, or the default fontification in general,
1013 ;; is not flexible enough for a particular major mode. For example, perhaps
1014 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
1015 ;; cope with. You need to write your own version of that function, e.g.,
1016 ;; `hairy-fontify-syntactically-region', and make your own version of
1017 ;; `hairy-fontify-region' call that function before calling
1018 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
1019 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
1020 ;; would call your region fontification function instead of its own. For
1021 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
1022 ;; directives correctly and cleanly. (It is the same problem as fontifying
1023 ;; multi-line strings and comments; regexps are not appropriate for the job.)
1026 "A function that determines the region to refontify after a change.
1028 This variable is either nil, or is a function that determines the
1029 region to refontify after a change.
1030 It is usually set by the major mode via `font-lock-defaults'.
1031 Font-lock calls this function after each buffer change.
1033 The function is given three parameters, the standard BEG, END, and OLD-LEN
1034 from `after-change-functions'. It should return either a cons of the beginning
1035 and end buffer positions \(in that order) of the region to refontify, or nil
1036 \(which directs the caller to fontify a default region).
1037 This function should preserve the match-data.
1042 "Fontify the current buffer the way the function `font-lock-mode' would."
1044 ;; When called from Lisp, this function is a big mess. The caller usually
1045 ;; expects one of the following behaviors:
1046 ;; - refresh the highlighting (because the font-lock-keywords have been
1047 ;; changed).
1048 ;; - apply font-lock highlighting even if font-lock-mode is not enabled.
1049 ;; - reset the highlighting rules because font-lock-defaults
1050 ;; has been changed (and then rehighlight everything).
1051 ;; Of course, this function doesn't do all of the above in all situations
1052 ;; (e.g. depending on whether jit-lock is in use) and it can't guess what
1053 ;; the caller wants.
1064 "Fontify the text between BEG and END.
1065 If LOUDLY is non-nil, print status messages while fontifying.
1066 This works by calling `font-lock-fontify-region-function'."
1071 "Unfontify the text between BEG and END.
1072 This works by calling `font-lock-unfontify-region-function'."
1077 "Function to use to mark a region for refontification.
1081 "Declare the region BEG...END's fontification as out-of-date.
1082 If the region is not specified, it defaults to the whole buffer."
1084 font-lock-fontified
1091 "Function to make sure a region has been fontified.
1095 "Make sure the region BEG...END has been fontified.
1096 If the region is not specified, it defaults to the whole buffer."
1102 "Fontify the whole buffer using `font-lock-fontify-region-function'."
1105 font-lock-verbose)))
1109 ;; Make sure we fontify etc. in the whole buffer.
1118 ;; We don't restore the old fontification, so it's best to unfontify.
1122 "Unfontify the whole buffer using `font-lock-unfontify-region-function'."
1123 ;; Make sure we unfontify etc. in the whole buffer.
1131 "If non-nil, font-lock will work on the non-widened buffer.
1132 Useful for things like RMAIL and Info where the whole buffer is not
1139 ;; This use of font-lock-multiline property is unreliable but is just
1140 ;; a handy heuristic: in case you don't have a function that does
1141 ;; /identification/ of multiline elements, you may still occasionally
1142 ;; discover them by accident (or you may /identify/ them but not in all
1143 ;; cases), in which case the font-lock-multiline property can help make
1144 ;; sure you will properly *re*identify them during refontification.
1145 font-lock-extend-region-multiline)
1146 "Special hook run just before proceeding to fontify a region.
1147 This is used to allow major modes to help font-lock find safe buffer positions
1148 as beginning and end of the fontified region. Its most common use is to solve
1149 the problem of /identification/ of multiline elements by providing a function
1150 that tries to find such elements and move the boundaries such that they do
1151 not fall in the middle of one.
1152 Each function is called with no argument; it is expected to adjust the
1153 dynamically bound variables `font-lock-beg' and `font-lock-end'; and return
1154 non-nil if it did make such an adjustment.
1155 These functions are run in turn repeatedly until they all return nil.
1157 ;; Mark it as a special hook which doesn't use any global setting
1158 ;; (i.e. doesn't obey the element t in the buffer-local value).
1162 "Move fontification boundaries away from any `font-lock-multiline' property."
1170 ;;
1176 changed))
1179 "Move fontification boundaries to beginning of lines."
1189 changed))
1192 "Fontify the text between BEG and END.
1193 If LOUDLY is non-nil, print status messages while fontifying.
1194 This function is the default `font-lock-fontify-region-function'."
1196 ;; Use the fontification syntax table, if any.
1200 ;; Extend the region to fontify so that it starts and ends at
1201 ;; safe places.
1209 ;; If there's been a change, we should go through
1210 ;; the list again since this new position may
1211 ;; warrant a different answer from one of the fun
1212 ;; we've already seen.
1213 font-lock-extend-region-functions)))
1215 ;; Now do the fontification.
1219 ;; Ensure the beginning of the file is properly syntactic-fontified.
1230 ;; The following must be rethought, since keywords can override fontification.
1231 ;; ;; Now scan for keywords, but not if we are inside a comment now.
1232 ;; (or (and (not font-lock-keywords-only)
1233 ;; (let ((state (parse-partial-sexp beg end nil nil
1234 ;; font-lock-cache-state)))
1235 ;; (or (nth 4 state) (nth 7 state))))
1236 ;; (font-lock-fontify-keywords-region beg end))
1239 "Additional text properties managed by font-lock.
1240 This is used by `font-lock-default-unfontify-region' to decide
1244 "Unfontify the text between BEG and END.
1245 This function is the default `font-lock-unfontify-region-function'."
1248 font-lock-extra-managed-props
1253 ;; Called when any modification is made to buffer text.
1260 beg end old-len))))
1263 ;; Fontify the region the major mode has specified.
1265 ;; Fontify the whole lines which enclose the region.
1266 ;; Actually, this is not needed because
1267 ;; font-lock-default-fontify-region already rounds up to a whole
1268 ;; number of lines.
1269 ;; (setq beg (progn (goto-char beg) (line-beginning-position))
1270 ;; end (progn (goto-char end) (line-beginning-position 2)))
1272 ;; Rounding up to a whole number of lines should include the
1273 ;; line right after `end'. Typical case: the first char of
1274 ;; the line was deleted. Or a \n was inserted in the middle
1275 ;; of a line.
1281 "Function meant for `jit-lock-after-change-extend-region-functions'.
1282 This function does 2 things:
1283 - extend the region so that it not only includes the part that was modified
1284 but also the surrounding text whose highlighting may change as a consequence.
1285 - anticipate (part of) the region extension that will happen later in
1286 `font-lock-default-fontify-region', in order to avoid the need for
1287 double-redisplay in `jit-lock-fontify-now'."
1289 ;; First extend the region as font-lock-after-change-function would.
1292 beg end old-len))))
1296 ;; Then extend the region obeying font-lock-multiline properties,
1297 ;; indicating which part of the buffer needs to be refontified.
1298 ;; !!! This is the *main* user of font-lock-multiline property !!!
1299 ;; font-lock-after-change-function could/should also do that, but it
1300 ;; doesn't need to because font-lock-default-fontify-region does
1301 ;; it anyway. Here OTOH we have no guarantee that
1302 ;; font-lock-default-fontify-region will be executed on this region
1303 ;; any time soon.
1304 ;; Note: contrary to font-lock-default-fontify-region, we do not do
1305 ;; any loop here because we are not looking for a safe spot: we just
1306 ;; mark the text whose appearance may need to change as a result of
1307 ;; the buffer modification.
1319 ;; Rounding up to a whole number of lines should include the
1320 ;; line right after `end'. Typical case: the first char of
1321 ;; the line was deleted. Or a \n was inserted in the middle
1322 ;; of a line.
1324 ;; Finally, pre-enlarge the region to a whole number of lines, to try
1325 ;; and anticipate what font-lock-default-fontify-region will do, so as to
1326 ;; avoid double-redisplay.
1327 ;; We could just run `font-lock-extend-region-functions', but since
1328 ;; the only purpose is to avoid the double-redisplay, we prefer to
1329 ;; do here only the part that is cheap and most likely to be useful.
1331 font-lock-extend-region-functions)
1339 jit-lock-end end))))
1342 "Fontify some lines the way `font-lock-fontify-buffer' would.
1343 The lines could be a function or paragraph, or a specified number of lines.
1344 If ARG is given, fontify that many lines before and after point, or 16 lines if
1345 no ARG is given and `font-lock-mark-block-function' is nil.
1346 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1347 delimit the region to fontify."
1350 deactivate-mark)
1351 ;; Make sure we have the right `font-lock-keywords' etc.
1365 ;;; End of Fontification functions.
1366 \f
1367 ;;; Additional text property functions.
1369 ;; The following text property functions should be builtins. This means they
1370 ;; should be written in C and put with all the other text property functions.
1371 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1372 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1373 ;; in Lisp below and commented out. sm.
1376 "Prepend to one property of the text from START to END.
1377 Arguments PROP and VALUE specify the property and value to prepend to the value
1378 already in place. The resulting property values are always lists.
1379 Optional argument OBJECT is the string or buffer containing the text."
1384 ;; Canonicalize old forms of face property.
1392 object)
1396 "Append to one property of the text from START to END.
1397 Arguments PROP and VALUE specify the property and value to append to the value
1398 already in place. The resulting property values are always lists.
1399 Optional argument OBJECT is the string or buffer containing the text."
1404 ;; Canonicalize old forms of face property.
1412 object)
1416 "Fill in one property of the text from START to END.
1417 Arguments PROP and VALUE specify the property and value to put where none are
1418 already in place. Therefore existing property values are not overwritten.
1419 Optional argument OBJECT is the string or buffer containing the text."
1427 end
1429 "Remove a specific property value from text from START to END.
1430 Arguments PROP and VALUE specify the property and value to remove. The
1431 resulting property values are not `eq' to VALUE nor lists containing VALUE.
1432 Optional argument OBJECT is the string or buffer containing the text."
1447 object))
1454 ;;; End of Additional text property functions.
1455 \f
1456 ;;; Syntactic regexp fontification functions.
1458 ;; These syntactic keyword pass functions are identical to those keyword pass
1459 ;; functions below, with the following exceptions; (a) they operate on
1460 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1461 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1462 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1463 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1464 ;; LOUDLY as it is not likely to be intensive.
1467 "Apply HIGHLIGHT following a match.
1468 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1469 see `font-lock-syntactic-keywords'."
1475 ;; No match but we might not signal an error.
1481 ;; Flush the syntax-cache. I believe this is not necessary for
1482 ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can
1483 ;; still be necessary for other users of syntax-ppss anyway.
1487 ;; Cannot override existing fontification.
1491 ;; Override existing fontification.
1494 ;; Keep existing fontification.
1498 "Fontify according to KEYWORDS until LIMIT.
1499 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1500 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1502 ;; Evaluate PRE-MATCH-FORM.
1504 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1509 ;; Find an occurrence of `matcher' before `limit'.
1513 ;; Apply each highlight to this instance of `matcher'.
1518 ;; Evaluate POST-MATCH-FORM.
1522 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1523 START should be at the beginning of a line."
1525 ;; We wouldn't go through so much trouble if we didn't intend to use those
1526 ;; properties, would we?
1528 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1531 font-lock-syntactic-keywords)))
1532 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1535 font-lock-syntactic-keywords
1536 t)))
1537 ;; Get down to business.
1540 keyword matcher highlights)
1542 ;; Find an occurrence of `matcher' from `start' to `end'.
1549 ;; Apply each highlight to this instance of `matcher', which may be
1550 ;; specific highlights or more keywords anchored to `matcher'.
1556 end))
1560 ;;; End of Syntactic regexp fontification functions.
1561 \f
1562 ;;; Syntactic fontification functions.
1571 "Put proper face on each string and comment between START and END.
1572 START should be at the beginning of a line."
1578 ;; Find the `start' state.
1580 face beg)
1582 ;;
1583 ;; Find each interesting place between here and `end'.
1594 comment-start-skip))
1595 ;; Find the comment delimiters
1596 ;; and use font-lock-comment-delimiter-face for them.
1600 comment-start-skip))
1602 font-lock-comment-delimiter-face)))
1605 font-lock-comment-delimiter-face))))
1610 ;;; End of Syntactic fontification functions.
1611 \f
1612 ;;; Keyword regexp fontification functions.
1615 "Apply HIGHLIGHT following a match.
1616 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1621 ;; No match but we might not signal an error.
1630 ;; If `val' is nil, don't do anything. It is important to do it
1631 ;; explicitly, because when adding nil via things like
1632 ;; font-lock-append-text-property, the property is actually
1633 ;; changed from <face> to (<face>) which is undesirable. --Stef
1634 nil)
1636 ;; Cannot override existing fontification.
1640 ;; Override existing fontification.
1643 ;; Prepend to existing fontification.
1646 ;; Append to existing fontification.
1649 ;; Keep existing fontification.
1653 "Fontify according to KEYWORDS until LIMIT.
1654 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1655 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1658 ;; Evaluate PRE-MATCH-FORM.
1660 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1665 ;; this is a multiline anchored match
1666 ;; (setq font-lock-multiline t)
1670 limit
1673 ;; Find an occurrence of `matcher' before `limit'.
1678 ;; Apply each highlight to this instance of `matcher'.
1683 ;; Evaluate POST-MATCH-FORM.
1687 "Fontify according to `font-lock-keywords' between START and END.
1688 START should be at the beginning of a line.
1689 LOUDLY, if non-nil, allows progress-meter bar."
1697 keyword matcher highlights)
1698 ;;
1699 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1703 ;;
1704 ;; Find an occurrence of `matcher' from `start' to `end'.
1711 ;; Beware empty string matches since they will
1712 ;; loop indefinitely.
1719 ;; this is a multiline regexp match
1720 ;; (setq font-lock-multiline t)
1729 ;; Apply each highlight to this instance of `matcher', which may be
1730 ;; specific highlights or more keywords anchored to `matcher'.
1737 ;; Ensure forward progress. `pos' is a marker because anchored
1738 ;; keyword may add/delete text (this happens e.g. in grep.el).
1744 ;;; End of Keyword regexp fontification functions.
1745 \f
1746 ;; Various functions.
1749 "Compile KEYWORDS into the form (t KEYWORDS COMPILED...)
1750 Here each COMPILED is of the form (MATCHER HIGHLIGHT ...) as shown in the
1751 `font-lock-keywords' doc string.
1752 If SYNTACTIC-KEYWORDS is non-nil, it means these keywords are used for
1753 `font-lock-syntactic-keywords' rather than for `font-lock-keywords'."
1755 ;; This should never happen. But some external packages sometimes
1756 ;; call font-lock in unexpected and incorrect ways. It's important to
1757 ;; stop processing at this point, otherwise we may end up changing the
1758 ;; global value of font-lock-keywords and break highlighting in many
1759 ;; other buffers.
1762 keywords
1769 syntax-begin-function)))
1773 ;; Try to detect when a string or comment contains something that
1774 ;; looks like a defun and would thus confuse font-lock.
1782 font-lock-comment-face))
1785 prepend)))))
1786 keywords))
1794 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1805 keyword)))
1808 "Evaluate KEYWORDS if a function (funcall) or variable (eval) name."
1810 keywords
1816 "If VALUES is an list, use `major-mode' as a key and return the `assq' value.
1817 VALUES should then be an alist on the form ((MAJOR-MODE . VALUE) ...) where
1818 MAJOR-MODE may be t.
1819 If VALUES isn't a list, return VALUES."
1822 values))
1825 "Return LEVELth element of KEYWORDS.
1826 A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1827 \(1- (length KEYWORDS))."
1829 keywords)
1838 "Restart fontification in current buffer after recomputing from defaults.
1839 Recompute fontification variables using `font-lock-defaults' and
1840 `font-lock-maximum-decoration'. Then restart fontification.
1842 Use this function when you have changed any of the above
1843 variables directly.
1845 Note: This function will erase modifications done by
1846 `font-lock-add-keywords' or `font-lock-remove-keywords', but will
1847 preserve `hi-lock-mode' highlighting patterns."
1857 "Set fontification defaults appropriately for this mode.
1858 Sets various variables using `font-lock-defaults' and
1859 `font-lock-maximum-decoration'."
1860 ;; Set fontification defaults if not previously set for correct major mode.
1872 ;; Syntactic fontification?
1876 ;; Case fold during regexp fontification?
1880 ;; Syntax table for regexp and syntactic fontification?
1886 ;; The character to modify may be a single CHAR or a STRING.
1892 ;; Syntax function for syntactic fontification?
1897 ;; Variable alist?
1900 ;; Set up `font-lock-keywords' last because its value might depend
1901 ;; on other settings (e.g. font-lock-compile-keywords uses
1902 ;; font-lock-beginning-of-syntax-function).
1905 ;; Local fontification?
1911 ;; Now compile the keywords.
1916 \f
1917 ;;; Color etc. support.
1919 ;; Note that `defface' will not overwrite any faces declared above via
1920 ;; `custom-declare-face'.
1939 "Font Lock mode face used to highlight comments."
1944 "Font Lock mode face used to highlight comment delimiters."
1956 "Font Lock mode face used to highlight strings."
1961 "Font Lock mode face used to highlight documentation."
1973 "Font Lock mode face used to highlight keywords."
1985 "Font Lock mode face used to highlight builtins."
1995 "Font Lock mode face used to highlight function names."
2009 "Font Lock mode face used to highlight variable names."
2021 "Font Lock mode face used to highlight type and classes."
2035 "Font Lock mode face used to highlight constants and labels."
2040 "Font Lock mode face used to highlight warnings."
2045 "Font Lock mode face used to highlight easy to overlook negation."
2050 "Font Lock mode face used to highlight preprocessor directives."
2055 "Font Lock mode face for backslashes in Lisp regexp grouping constructs."
2060 "Font Lock mode face used to highlight grouping constructs in Lisp regexps."
2063 ;;; End of Color etc. support.
2064 \f
2065 ;;; Menu support.
2067 ;; This section of code is commented out because Emacs does not have real menu
2068 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
2069 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
2070 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
2071 ;; the entry for "Text Properties" something like:
2072 ;;
2073 ;; (define-key menu-bar-edit-menu [font-lock]
2074 ;; (cons "Syntax Highlighting" font-lock-menu))
2075 ;;
2076 ;; and remove a single ";" from the beginning of each line in the rest of this
2077 ;; section. Probably the mechanism for telling the menu code what are menu
2078 ;; buttons and when they are on or off needs tweaking. I have assumed that the
2079 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
2081 ;;;;;###autoload
2082 ;;(progn
2083 ;; ;; Make the Font Lock menu.
2084 ;; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
2085 ;; ;; Add the menu items in reverse order.
2086 ;; (define-key font-lock-menu [fontify-less]
2087 ;; '("Less In Current Buffer" . font-lock-fontify-less))
2088 ;; (define-key font-lock-menu [fontify-more]
2089 ;; '("More In Current Buffer" . font-lock-fontify-more))
2090 ;; (define-key font-lock-menu [font-lock-sep]
2091 ;; '("--"))
2092 ;; (define-key font-lock-menu [font-lock-mode]
2093 ;; '("In Current Buffer" . font-lock-mode))
2094 ;; (define-key font-lock-menu [global-font-lock-mode]
2095 ;; '("In All Buffers" . global-font-lock-mode)))
2096 ;;
2097 ;;;;;###autoload
2098 ;;(progn
2099 ;; ;; We put the appropriate `menu-enable' etc. symbol property values on when
2100 ;; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
2101 ;; (put 'global-font-lock-mode 'menu-toggle t)
2102 ;; (put 'font-lock-mode 'menu-toggle t)
2103 ;; (put 'font-lock-fontify-more 'menu-enable '(identity))
2104 ;; (put 'font-lock-fontify-less 'menu-enable '(identity)))
2105 ;;
2106 ;; ;; Put the appropriate symbol property values on now. See above.
2107 ;;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
2108 ;;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
2109 ;;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
2110 ;;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
2111 ;;
2112 ;;(defvar font-lock-fontify-level nil) ; For less/more fontification.
2113 ;;
2114 ;;(defun font-lock-fontify-level (level)
2115 ;; (let ((font-lock-maximum-decoration level))
2116 ;; (when font-lock-mode
2117 ;; (font-lock-mode))
2118 ;; (font-lock-mode)
2119 ;; (when font-lock-verbose
2120 ;; (message "Fontifying %s... level %d" (buffer-name) level))))
2121 ;;
2122 ;;(defun font-lock-fontify-less ()
2123 ;; "Fontify the current buffer with less decoration.
2124 ;;See `font-lock-maximum-decoration'."
2125 ;; (interactive)
2126 ;; ;; Check in case we get called interactively.
2127 ;; (if (nth 1 font-lock-fontify-level)
2128 ;; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
2129 ;; (error "No less decoration")))
2130 ;;
2131 ;;(defun font-lock-fontify-more ()
2132 ;; "Fontify the current buffer with more decoration.
2133 ;;See `font-lock-maximum-decoration'."
2134 ;; (interactive)
2135 ;; ;; Check in case we get called interactively.
2136 ;; (if (nth 2 font-lock-fontify-level)
2137 ;; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
2138 ;; (error "No more decoration")))
2139 ;;
2140 ;; ;; This should be called by `font-lock-set-defaults'.
2141 ;;(defun font-lock-set-menu ()
2142 ;; ;; Activate less/more fontification entries if there are multiple levels for
2143 ;; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
2144 ;; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
2145 ;; (let ((keywords (nth 0 font-lock-defaults))
2146 ;; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
2147 ;; (make-local-variable 'font-lock-fontify-level)
2148 ;; (if (or (symbolp keywords) (= (length keywords) 1))
2149 ;; (font-lock-unset-menu)
2150 ;; (cond ((eq level t)
2151 ;; (setq level (1- (length keywords))))
2152 ;; ((or (null level) (zerop level))
2153 ;; ;; The default level is usually, but not necessarily, level 1.
2154 ;; (setq level (- (length keywords)
2155 ;; (length (member (eval (car keywords))
2156 ;; (mapcar 'eval (cdr keywords))))))))
2157 ;; (setq font-lock-fontify-level (list level (> level 1)
2158 ;; (< level (1- (length keywords))))))))
2159 ;;
2160 ;; ;; This should be called by `font-lock-unset-defaults'.
2161 ;;(defun font-lock-unset-menu ()
2162 ;; ;; Deactivate less/more fontification entries.
2163 ;; (setq font-lock-fontify-level nil))
2165 ;;; End of Menu support.
2166 \f
2167 ;;; Various regexp information shared by several modes.
2168 ;; ;; Information specific to a single mode should go in its load library.
2170 ;; Font Lock support for C, C++, Objective-C and Java modes is now in
2171 ;; cc-fonts.el (and required by cc-mode.el). However, the below function
2172 ;; should stay in font-lock.el, since it is used by other libraries. sm.
2175 "Match, and move over, any declaration/definition item after point.
2176 Matches after point, but ignores leading whitespace and `*' characters.
2177 Does not move further than LIMIT.
2179 The expected syntax of a declaration/definition item is `word' (preceded by
2180 optional whitespace and `*' characters and proceeded by optional whitespace)
2181 optionally followed by a `('. Everything following the item (but belonging to
2182 it) is expected to be skip-able by `scan-sexps', and items are expected to be
2183 separated with a `,' and to be terminated with a `;'.
2185 Thus the regexp matches after point: word (
2186 ^^^^ ^
2187 Where the match subexpressions are: 1 2
2189 The item is delimited by (match-beginning 1) and (match-end 1).
2190 If (match-beginning 2) is non-nil, the item is followed by a `('.
2192 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
2195 ;; If `word' is followed by a double open-paren, it's probably
2196 ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one
2197 ;; word to try and match `myfun' rather than `P_'.
2202 ;; Looks like it was something else, so go back to where we
2203 ;; were and reset the match data by rematching.
2209 ;; Restrict to the LIMIT.
2212 ;; Move over any item value, etc., to the next item.
2219 ;; C preprocessor(cpp) is used outside of C, C++ and Objective-C source file.
2220 ;; e.g. assembler code and GNU linker script in Linux kernel.
2221 ;; `cpp-font-lock-keywords' is handy for modes for the files.
2222 ;;
2223 ;; Here we cannot use `regexp-opt' because because regex-opt is not preloaded
2224 ;; while font-lock.el is preloaded to emacs. So values pre-calculated with
2225 ;; regexp-opt are used here.
2227 ;; `cpp-font-lock-keywords-source-directives' is calculated from:
2228 ;;
2229 ;; (regexp-opt
2230 ;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
2231 ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning"))
2232 ;;
2234 "define\\|e\\(?:l\\(?:if\\|se\\)\\|ndif\\|rror\\)\\|file\\|i\\(?:f\\(?:n?def\\)?\\|mport\\|nclude\\)\\|line\\|pragma\\|undef\\|warning"
2237 ;; `cpp-font-lock-keywords-source-depth' is calculated from:
2238 ;;
2239 ;; (regexp-opt-depth (regexp-opt
2240 ;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
2241 ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning")))
2242 ;;
2244 "An integer representing regular expression depth of `cpp-font-lock-keywords-source-directives'.
2251 ;;
2252 ;; Fontify error directives.
2254 ;;
2255 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2258 ;;
2259 ;; Fontify function macro names.
2262 ;;
2263 ;; Macro arguments.
2268 limit)
2269 t))
2271 ;;
2272 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2276 ;;
2277 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2284 "Font lock keywords for C preprocessor directives.
2285 `c-mode', `c++-mode' and `objc-mode' have their own font lock keywords
2286 for C preprocessor directives. This definition is for the other modes
2287 in which C preprocessor directives are used. e.g. `asm-mode' and
2289 \f
2292 ;;; font-lock.el ends here