| blob | 32fbb0608a28ac38e74b786dc6e21212ae22f631 |
1 ;;; font-lock.el --- Electric font lock mode
3 ;; Copyright (C) 1992-2011 Free Software Foundation, Inc.
5 ;; Author: Jamie Zawinski
6 ;; Richard Stallman
7 ;; Stefan Monnier
8 ;; Maintainer: FSF
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 ~/.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 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 size of a buffer for buffer fontification.
232 Only buffers less than this can be fontified when Font Lock mode is turned on.
233 If nil, means size is irrelevant.
234 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
235 where MAJOR-MODE is a symbol or t (meaning the default). For example:
236 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
237 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
238 for buffers in Rmail mode, and size is irrelevant otherwise."
253 "Maximum decoration level for fontification.
254 If nil, use the default decoration (typically the minimum available).
255 If t, use the maximum decoration available.
256 If a number, use that level of decoration (or if not available the maximum).
257 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
258 where MAJOR-MODE is a symbol or t (meaning the default). For example:
259 ((c-mode . t) (c++-mode . 2) (t . 1))
260 means use the maximum decoration available for buffers in C mode, level 2
261 decoration for buffers in C++ mode, and level 1 decoration otherwise."
278 "If non-nil, means show status messages for buffer fontification.
279 If a number, only buffers greater than this size have fontification messages."
285 \f
287 ;; Originally these variable values were face names such as `bold' etc.
288 ;; Now we create our own faces, but we keep these variables for compatibility
289 ;; and they give users another mechanism for changing face appearance.
290 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
291 ;; returns a face. So the easiest thing is to continue using these variables,
292 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
294 ;; Note that in new code, in the vast majority of cases there is no
295 ;; need to create variables that specify face names. Simply using
296 ;; faces directly is enough. Font-lock is not a template to be
297 ;; followed in this area.
332 "Face name to use for easy to overlook negation.
341 ;; Fontification variables:
344 "A list of the keywords to highlight.
345 There are two kinds of values: user-level, and compiled.
347 A user-level keywords list is what a major mode or the user would
348 set up. Normally the list would come from `font-lock-defaults'.
349 through selection of a fontification level and evaluation of any
350 contained expressions. You can also alter it by calling
351 `font-lock-add-keywords' or `font-lock-remove-keywords' with MODE = nil.
353 Each element in a user-level keywords list should have one of these forms:
355 MATCHER
356 (MATCHER . SUBEXP)
357 (MATCHER . FACENAME)
358 (MATCHER . HIGHLIGHT)
359 (MATCHER HIGHLIGHT ...)
360 (eval . FORM)
362 where MATCHER can be either the regexp to search for, or the function name to
363 call to make the search (called with one argument, the limit of the search;
364 it should return non-nil, move point, and set `match-data' appropriately if
365 it succeeds; like `re-search-forward' would).
366 MATCHER regexps can be generated via the function `regexp-opt'.
368 FORM is an expression, whose value should be a keyword element, evaluated when
369 the keyword is (first) used in a buffer. This feature can be used to provide a
370 keyword that can only be generated when Font Lock mode is actually turned on.
372 HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
375 typically only MATCH-HIGHLIGHT is required.
376 However, if an item or (typically) items are to be highlighted following the
377 instance of another item (the anchor), for example each instance of the
380 MATCH-HIGHLIGHT should be of the form:
382 (SUBEXP FACENAME [OVERRIDE [LAXMATCH]])
384 SUBEXP is the number of the subexpression of MATCHER to be highlighted.
386 FACENAME is an expression whose value is the face name to use.
387 Instead of a face, FACENAME can evaluate to a property list
388 of the form (face FACE PROP1 VAL1 PROP2 VAL2 ...)
389 in which case all the listed text-properties will be set rather than
390 just FACE. In such a case, you will most likely want to put those
391 properties in `font-lock-extra-managed-props' or to override
392 `font-lock-unfontify-region-function'.
394 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
395 be overwritten. If `keep', only parts not already fontified are highlighted.
396 If `prepend' or `append', existing fontification is merged with the new, in
397 which the new or existing fontification, respectively, takes precedence.
398 If LAXMATCH is non-nil, that means don't signal an error if there is
399 no match for SUBEXP in MATCHER.
401 For example, an element of the form highlights (if not already highlighted):
404 variable `font-lock-keyword-face'.
406 the value of `font-lock-keyword-face'.
410 of `foo-bar-face', even if already highlighted.
411 (fubar-match 1 fubar-face)
412 the first subexpression within all occurrences of
413 whatever the function `fubar-match' finds and matches
414 in the value of `fubar-face'.
416 MATCH-ANCHORED should be of the form:
418 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
420 where MATCHER is a regexp to search for or the function name to call to make
421 the search, as for MATCH-HIGHLIGHT above, but with one exception; see below.
422 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
423 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
424 used to initialize before, and cleanup after, MATCHER is used. Typically,
425 PRE-MATCH-FORM is used to move to some position relative to the original
426 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
427 be used to move back, before resuming with MATCH-ANCHORED's parent's MATCHER.
429 For example, an element of the form highlights (if not already highlighted):
440 The above-mentioned exception is as follows. The limit of the MATCHER search
441 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
442 However, if PRE-MATCH-FORM returns a position greater than the position after
443 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
444 It is generally a bad idea to return a position greater than the end of the
445 line, i.e., cause the MATCHER search to span lines.
447 These regular expressions can match text which spans lines, although
448 it is better to avoid it if possible since updating them while editing
449 text is slower, and it is not guaranteed to be always correct when using
450 support modes like jit-lock or lazy-lock.
452 This variable is set by major modes via the variable `font-lock-defaults'.
453 Be careful when composing regexps for this list; a poorly written pattern can
454 dramatically slow things down!
456 A compiled keywords list starts with t. It is produced internal
457 by `font-lock-compile-keywords' from a user-level keywords list.
458 Its second element is the user-level keywords list that was
459 compiled. The remaining elements have the same form as
460 user-level keywords, but normally their values have been
464 "Alist of additional `font-lock-keywords' elements for major modes.
466 Each element has the form (MODE KEYWORDS . HOW).
467 `font-lock-set-defaults' adds the elements in the list KEYWORDS to
468 `font-lock-keywords' when Font Lock is turned on in major mode MODE.
470 If HOW is nil, KEYWORDS are added at the beginning of
471 `font-lock-keywords'. If it is `set', they are used to replace the
472 value of `font-lock-keywords'. If HOW is any other non-nil value,
473 they are added at the end.
475 This is normally set via `font-lock-add-keywords' and
480 "Alist of `font-lock-keywords' elements to be removed for major modes.
482 Each element has the form (MODE . KEYWORDS). `font-lock-set-defaults'
483 removes the elements in the list KEYWORDS from `font-lock-keywords'
484 when Font Lock is turned on in major mode MODE.
486 This is normally set via `font-lock-add-keywords' and
490 "*Non-nil means Font Lock should not fontify comments or strings.
494 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
495 This is set via the function `font-lock-set-defaults', based on
500 "Point up to which `font-lock-syntactic-keywords' has been applied.
501 If nil, this is ignored, in which case the syntactic fontification may
508 "Function to determine which face to use when fontifying syntactically.
509 The function is called with a single parameter (the state as returned by
510 `parse-partial-sexp' at the beginning of the region to highlight) and
514 "A list of the syntactic keywords to put syntax properties on.
515 The value can be the list itself, or the name of a function or variable
516 whose value is the list.
518 See `font-lock-keywords' for a description of the form of this list;
519 only the differences are stated here. MATCH-HIGHLIGHT should be of the form:
521 (SUBEXP SYNTAX OVERRIDE LAXMATCH)
523 where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax
524 table, a cons cell (as returned by `string-to-syntax') or an expression whose
525 value is such a form. OVERRIDE cannot be `prepend' or `append'.
527 Here are two examples of elements of `font-lock-syntactic-keywords'
528 and what they do:
533 dollar-sign character. Hash characters in other contexts will still
534 follow whatever the syntax table says about the hash character.
540 gives a pair single-quotes, which surround a single character, a SYNTAX of
542 contexts will not be affected.
549 "Non-nil means use this syntax table for fontifying.
550 If this is nil, the major mode's syntax table is used.
554 "*Non-nil means use this function to move back outside all constructs.
555 When called with no args it should move point backward to a place which
556 is not in a string or comment and not within any bracket-pairs (or else,
557 a place such that any bracket-pairs outside it can be ignored for Emacs
558 syntax analysis and fontification).
560 If this is nil, Font Lock uses `syntax-begin-function' to move back
561 outside of any comment, string, or sexp. This variable is semi-obsolete;
562 we recommend setting `syntax-begin-function' instead.
569 "*Non-nil means use this function to mark a block of text.
570 When called with no args it should leave point at the beginning of any
571 enclosing textual block and mark at the end.
575 "Function to use for fontifying the buffer.
579 "Function to use for unfontifying the buffer.
580 This is used when turning off Font Lock mode.
584 "Function to use for fontifying a region.
585 It should take two args, the beginning and end of the region, and an optional
586 third arg VERBOSE. If VERBOSE is non-nil, the function should print status
590 "Function to use for unfontifying a region.
591 It should take two args, the beginning and end of the region.
595 "List of Font Lock mode related modes that should not be turned on.
596 Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
600 "Whether font-lock should cater to multiline keywords.
601 If nil, don't try to handle multiline patterns.
602 If t, always handle multiline patterns.
603 If `undecided', don't try to handle multiline patterns until you see one.
607 \f
608 ;; Font Lock mode.
611 ;;
612 ;; We don't do this at the top-level as we only use non-autoloaded macros.
614 ;;
615 ;; Borrowed from lazy-lock.el.
616 ;; We use this to preserve or protect things when modifying text properties.
618 "Bind variables according to VARLIST and eval BODY restoring buffer state."
623 ;;
624 ;; Shut up the byte compiler.
628 ;; Turn on Font Lock mode.
633 ;; Fontify the buffer if we have to.
636 nil)
642 ;; Turn off Font Lock mode.
649 "Add highlighting KEYWORDS for MODE.
651 MODE should be a symbol, the major mode command name, such as `c-mode'
652 or nil. If nil, highlighting keywords are added for the current buffer.
653 KEYWORDS should be a list; see the variable `font-lock-keywords'.
654 By default they are added at the beginning of the current highlighting list.
655 If optional argument HOW is `set', they are used to replace the current
656 highlighting list. If HOW is any other non-nil value, they are added at the
657 end of the current highlighting list.
659 For example:
661 (font-lock-add-keywords 'c-mode
665 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
666 comments, and to fontify `and', `or' and `not' words as keywords.
668 The above procedure will only add the keywords for C mode, not
669 for modes derived from C mode. To add them for derived modes too,
670 pass nil for MODE and add the call to c-mode-hook.
672 For example:
674 (add-hook 'c-mode-hook
675 (lambda ()
676 (font-lock-add-keywords nil
679 font-lock-keyword-face)))))
681 The above procedure may fail to add keywords to derived modes if
682 some involved major mode does not follow the standard conventions.
683 File a bug report if this happens, so the major mode can be corrected.
685 Note that some modes have specialized support for additional patterns, e.g.,
686 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
687 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
689 ;; If MODE is non-nil, add the KEYWORDS and HOW spec to
690 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
697 ;; Make sure that `font-lock-removed-keywords-alist' does not
698 ;; contain the new keywords.
703 ;; The major mode has not set any keywords, so when we enabled
704 ;; font-lock-mode it only enabled the font-core.el part, not the
705 ;; font-lock-mode-internal. Try again.
709 ;; Otherwise set or add the keywords now.
710 ;; This is a no-op if it has been done already in this buffer
711 ;; for the correct major mode.
714 ;; Bring back the user-level (uncompiled) keywords.
717 ;; Now modify or replace them.
723 font-lock-keywords)))
727 ;; If the keywords were compiled before, compile them again.
733 "Update `font-lock-removed-keywords-alist' when adding new KEYWORDS to MODE."
734 ;; When font-lock is enabled first all keywords in the list
735 ;; `font-lock-keywords-alist' are added, then all keywords in the
736 ;; list `font-lock-removed-keywords-alist' are removed. If a
737 ;; keyword was once added, removed, and then added again it must be
738 ;; removed from the removed-keywords list. Otherwise the second add
739 ;; will not take effect.
743 ;; A new set of keywords is defined. Forget all about
744 ;; our old keywords that should be removed.
747 ;; Delete all previously removed keywords.
750 ;; Delete the mode cell if empty.
755 ;; Written by Anders Lindgren <andersl@andersl.com>.
756 ;;
757 ;; Case study:
758 ;; (I) The keywords are removed from a major mode.
759 ;; In this case the keyword could be local (i.e. added earlier by
760 ;; `font-lock-add-keywords'), global, or both.
761 ;;
762 ;; (a) In the local case we remove the keywords from the variable
763 ;; `font-lock-keywords-alist'.
764 ;;
765 ;; (b) The actual global keywords are not known at this time.
766 ;; All keywords are added to `font-lock-removed-keywords-alist',
767 ;; when font-lock is enabled those keywords are removed.
768 ;;
769 ;; Note that added keywords are taken out of the list of removed
770 ;; keywords. This ensure correct operation when the same keyword
771 ;; is added and removed several times.
772 ;;
773 ;; (II) The keywords are removed from the current buffer.
775 "Remove 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 removed for the current buffer.
780 To make the removal apply to modes derived from MODE as well,
781 pass nil for MODE and add the call to MODE-hook. This may fail
782 for some derived modes if some involved major mode does not
783 follow the standard conventions. File a bug report if this
784 happens, so the major mode can be corrected."
786 ;; Remove one keyword at the time.
789 ;; If MODE is non-nil, remove the KEYWORD from
790 ;; `font-lock-keywords-alist'.
793 ;; `keywords-list-how-pair' is a cons with a list of
794 ;; keywords in the car top-cell and the original how
795 ;; argument in the cdr top-cell.
798 ;; Remove keyword list/how pair when the keyword list
799 ;; is empty and how doesn't specify `set'. (If it
800 ;; should be deleted then previously deleted keywords
801 ;; would appear again.)
808 ;; Final cleanup, remove major mode cell if last keyword
809 ;; was deleted.
813 ;; Remember the keyword in case it is not local.
819 font-lock-removed-keywords-alist))))))
821 ;; Otherwise remove it immediately.
824 ;; Bring back the user-level (uncompiled) keywords.
828 ;; Edit them.
834 ;; If the keywords were compiled before, compile them again.
838 \f
839 ;;; Font Lock Support mode.
841 ;; This is the code used to interface font-lock.el with any of its add-on
842 ;; packages, and provide the user interface. Packages that have their own
843 ;; local buffer fontification functions (see below) may have to call
844 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
845 ;; themselves.
848 "Support mode for Font Lock mode.
849 Support modes speed up Font Lock mode by being choosy about when fontification
850 occurs. The default support mode, Just-in-time Lock mode (symbol
851 `jit-lock-mode'), is recommended.
853 Other, older support modes are Fast Lock mode (symbol `fast-lock-mode') and
854 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
855 However, they are no longer recommended, as Just-in-time Lock mode is better.
857 If nil, means support for Font Lock mode is never performed.
858 If a symbol, use that support mode.
859 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
860 where MAJOR-MODE is a symbol or t (meaning the default). For example:
861 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
862 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
863 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
865 The value of this variable is used when Font Lock mode is turned on."
881 ))
901 ;; Prepare for jit-lock
906 ;; Don't fontify eagerly (and don't abort if the buffer is large).
908 ;; Use jit-lock.
911 ;; Tell jit-lock how we extend the region to refontify.
913 'font-lock-extend-jit-lock-region-after-change
914 nil t))))
921 ;; Reset local vars to the non-jit-lock case.
929 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
930 ;; (jit-lock-mode
931 ;; (jit-lock-after-fontify-buffer))
938 ;; Useless as well. It's only called when:
939 ;; - turning off font-lock: it does not matter if we leave spurious
940 ;; `fontified' text props around since jit-lock-mode is also off.
941 ;; - font-lock-default-fontify-buffer fails: this is not run
942 ;; any more anyway. -sm
943 ;;
944 ;; (jit-lock-mode
945 ;; (jit-lock-after-unfontify-buffer))
949 ;;; End of Font Lock Support mode.
950 \f
951 ;;; Fontification functions.
953 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
954 ;; code to fontify a region, the function runs the function whose name is the
955 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
956 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
957 ;; which does contain the code to fontify a region. However, the value of the
958 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
959 ;; do anything. The indirection of the fontification functions gives major
960 ;; modes the capability of modifying the way font-lock.el fontifies. Major
961 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
962 ;; via the variable `font-lock-defaults'.
963 ;;
964 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
965 ;; font-lock.el uses its own function for buffer fontification. This function
966 ;; makes fontification be on a message-by-message basis and so visiting an
967 ;; RMAIL file is much faster. A clever implementation of the function might
968 ;; fontify the headers differently than the message body. (It should, and
969 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
970 ;; you?) This hints at a more interesting use...
971 ;;
972 ;; Languages that contain text normally contained in different major modes
973 ;; could define their own fontification functions that treat text differently
974 ;; depending on its context. For example, Perl mode could arrange that here
975 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
976 ;; rules one way and C code another. Neat!
977 ;;
978 ;; A further reason to use the fontification indirection feature is when the
979 ;; default syntactual fontification, or the default fontification in general,
980 ;; is not flexible enough for a particular major mode. For example, perhaps
981 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
982 ;; cope with. You need to write your own version of that function, e.g.,
983 ;; `hairy-fontify-syntactically-region', and make your own version of
984 ;; `hairy-fontify-region' call that function before calling
985 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
986 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
987 ;; would call your region fontification function instead of its own. For
988 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
989 ;; directives correctly and cleanly. (It is the same problem as fontifying
990 ;; multi-line strings and comments; regexps are not appropriate for the job.)
993 "A function that determines the region to refontify after a change.
995 This variable is either nil, or is a function that determines the
996 region to refontify after a change.
997 It is usually set by the major mode via `font-lock-defaults'.
998 Font-lock calls this function after each buffer change.
1000 The function is given three parameters, the standard BEG, END, and OLD-LEN
1001 from `after-change-functions'. It should return either a cons of the beginning
1002 and end buffer positions \(in that order) of the region to refontify, or nil
1003 \(which directs the caller to fontify a default region).
1004 This function should preserve the match-data.
1009 "Fontify the current buffer the way the function `font-lock-mode' would."
1030 font-lock-verbose)))
1034 ;; Make sure we fontify etc. in the whole buffer.
1043 ;; We don't restore the old fontification, so it's best to unfontify.
1047 ;; Make sure we unfontify etc. in the whole buffer.
1055 "If non-nil, font-lock will work on the non-widened buffer.
1056 Useful for things like RMAIL and Info where the whole buffer is not
1063 ;; This use of font-lock-multiline property is unreliable but is just
1064 ;; a handy heuristic: in case you don't have a function that does
1065 ;; /identification/ of multiline elements, you may still occasionally
1066 ;; discover them by accident (or you may /identify/ them but not in all
1067 ;; cases), in which case the font-lock-multiline property can help make
1068 ;; sure you will properly *re*identify them during refontification.
1069 font-lock-extend-region-multiline)
1070 "Special hook run just before proceeding to fontify a region.
1071 This is used to allow major modes to help font-lock find safe buffer positions
1072 as beginning and end of the fontified region. Its most common use is to solve
1073 the problem of /identification/ of multiline elements by providing a function
1074 that tries to find such elements and move the boundaries such that they do
1075 not fall in the middle of one.
1076 Each function is called with no argument; it is expected to adjust the
1077 dynamically bound variables `font-lock-beg' and `font-lock-end'; and return
1078 non-nil if it did make such an adjustment.
1079 These functions are run in turn repeatedly until they all return nil.
1081 ;; Mark it as a special hook which doesn't use any global setting
1082 ;; (i.e. doesn't obey the element t in the buffer-local value).
1086 "Move fontification boundaries away from any `font-lock-multiline' property."
1094 ;;
1100 changed))
1103 "Move fontification boundaries to beginning of lines."
1113 changed))
1117 ;; Use the fontification syntax table, if any.
1121 ;; Extend the region to fontify so that it starts and ends at
1122 ;; safe places.
1130 ;; If there's been a change, we should go through
1131 ;; the list again since this new position may
1132 ;; warrant a different answer from one of the fun
1133 ;; we've already seen.
1134 font-lock-extend-region-functions)))
1136 ;; Now do the fontification.
1140 ;; Ensure the beginning of the file is properly syntactic-fontified.
1150 ;; The following must be rethought, since keywords can override fontification.
1151 ;; ;; Now scan for keywords, but not if we are inside a comment now.
1152 ;; (or (and (not font-lock-keywords-only)
1153 ;; (let ((state (parse-partial-sexp beg end nil nil
1154 ;; font-lock-cache-state)))
1155 ;; (or (nth 4 state) (nth 7 state))))
1156 ;; (font-lock-fontify-keywords-region beg end))
1159 "Additional text properties managed by font-lock.
1160 This is used by `font-lock-default-unfontify-region' to decide
1166 font-lock-extra-managed-props
1171 ;; Called when any modification is made to buffer text.
1178 beg end old-len))))
1181 ;; Fontify the region the major mode has specified.
1183 ;; Fontify the whole lines which enclose the region.
1184 ;; Actually, this is not needed because
1185 ;; font-lock-default-fontify-region already rounds up to a whole
1186 ;; number of lines.
1187 ;; (setq beg (progn (goto-char beg) (line-beginning-position))
1188 ;; end (progn (goto-char end) (line-beginning-position 2)))
1190 ;; Rounding up to a whole number of lines should include the
1191 ;; line right after `end'. Typical case: the first char of
1192 ;; the line was deleted. Or a \n was inserted in the middle
1193 ;; of a line.
1199 "Function meant for `jit-lock-after-change-extend-region-functions'.
1200 This function does 2 things:
1201 - extend the region so that it not only includes the part that was modified
1202 but also the surrounding text whose highlighting may change as a consequence.
1203 - anticipate (part of) the region extension that will happen later in
1204 `font-lock-default-fontify-region', in order to avoid the need for
1205 double-redisplay in `jit-lock-fontify-now'."
1207 ;; First extend the region as font-lock-after-change-function would.
1210 beg end old-len))))
1214 ;; Then extend the region obeying font-lock-multiline properties,
1215 ;; indicating which part of the buffer needs to be refontified.
1216 ;; !!! This is the *main* user of font-lock-multiline property !!!
1217 ;; font-lock-after-change-function could/should also do that, but it
1218 ;; doesn't need to because font-lock-default-fontify-region does
1219 ;; it anyway. Here OTOH we have no guarantee that
1220 ;; font-lock-default-fontify-region will be executed on this region
1221 ;; any time soon.
1222 ;; Note: contrary to font-lock-default-fontify-region, we do not do
1223 ;; any loop here because we are not looking for a safe spot: we just
1224 ;; mark the text whose appearance may need to change as a result of
1225 ;; the buffer modification.
1237 ;; Rounding up to a whole number of lines should include the
1238 ;; line right after `end'. Typical case: the first char of
1239 ;; the line was deleted. Or a \n was inserted in the middle
1240 ;; of a line.
1242 ;; Finally, pre-enlarge the region to a whole number of lines, to try
1243 ;; and anticipate what font-lock-default-fontify-region will do, so as to
1244 ;; avoid double-redisplay.
1245 ;; We could just run `font-lock-extend-region-functions', but since
1246 ;; the only purpose is to avoid the double-redisplay, we prefer to
1247 ;; do here only the part that is cheap and most likely to be useful.
1249 font-lock-extend-region-functions)
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.
1281 ;;; End of Fontification functions.
1282 \f
1283 ;;; Additional text property functions.
1285 ;; The following text property functions should be builtins. This means they
1286 ;; should be written in C and put with all the other text property functions.
1287 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1288 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1289 ;; in Lisp below and commented out. sm.
1292 "Prepend to one property of the text from START to END.
1293 Arguments PROP and VALUE specify the property and value to prepend to the value
1294 already in place. The resulting property values are always lists.
1295 Optional argument OBJECT is the string or buffer containing the text."
1300 ;; Canonicalize old forms of face property.
1308 object)
1312 "Append to one property of the text from START to END.
1313 Arguments PROP and VALUE specify the property and value to append to the value
1314 already in place. The resulting property values are always lists.
1315 Optional argument OBJECT is the string or buffer containing the text."
1320 ;; Canonicalize old forms of face property.
1328 object)
1332 "Fill in one property of the text from START to END.
1333 Arguments PROP and VALUE specify the property and value to put where none are
1334 already in place. Therefore existing property values are not overwritten.
1335 Optional argument OBJECT is the string or buffer containing the text."
1342 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1343 ;; is to `add-text-properties', etc.
1344 ;;(defun remove-text-property (start end property &optional object)
1345 ;; "Remove a property from text from START to END.
1346 ;;Argument PROPERTY is the property to remove.
1347 ;;Optional argument OBJECT is the string or buffer containing the text.
1348 ;;Return t if the property was actually removed, nil otherwise."
1349 ;; (remove-text-properties start end (list property) object))
1351 ;; For consistency: maybe this should be called `remove-single-property' like
1352 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1353 ;;(defun remove-single-text-property (start end prop value &optional object)
1354 ;; "Remove a specific property value from text from START to END.
1355 ;;Arguments PROP and VALUE specify the property and value to remove. The
1356 ;;resulting property values are not equal to VALUE nor lists containing VALUE.
1357 ;;Optional argument OBJECT is the string or buffer containing the text."
1358 ;; (let ((start (text-property-not-all start end prop nil object)) next prev)
1359 ;; (while start
1360 ;; (setq next (next-single-property-change start prop object end)
1361 ;; prev (get-text-property start prop object))
1362 ;; (cond ((and (symbolp prev) (eq value prev))
1363 ;; (remove-text-property start next prop object))
1364 ;; ((and (listp prev) (memq value prev))
1365 ;; (let ((new (delq value prev)))
1366 ;; (cond ((null new)
1367 ;; (remove-text-property start next prop object))
1368 ;; ((= (length new) 1)
1369 ;; (put-text-property start next prop (car new) object))
1370 ;; (t
1371 ;; (put-text-property start next prop new object))))))
1372 ;; (setq start (text-property-not-all next end prop nil object)))))
1374 ;;; End of Additional text property functions.
1375 \f
1376 ;;; Syntactic regexp fontification functions.
1378 ;; These syntactic keyword pass functions are identical to those keyword pass
1379 ;; functions below, with the following exceptions; (a) they operate on
1380 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1381 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1382 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1383 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1384 ;; LOUDLY as it is not likely to be intensive.
1387 "Apply HIGHLIGHT following a match.
1388 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1389 see `font-lock-syntactic-keywords'."
1395 ;; No match but we might not signal an error.
1401 ;; Flush the syntax-cache. I believe this is not necessary for
1402 ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can
1403 ;; still be necessary for other users of syntax-ppss anyway.
1407 ;; Cannot override existing fontification.
1411 ;; Override existing fontification.
1414 ;; Keep existing fontification.
1418 "Fontify according to KEYWORDS until LIMIT.
1419 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1420 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1422 ;; Evaluate PRE-MATCH-FORM.
1424 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1429 ;; Find an occurrence of `matcher' before `limit'.
1433 ;; Apply each highlight to this instance of `matcher'.
1438 ;; Evaluate POST-MATCH-FORM.
1442 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1443 START should be at the beginning of a line."
1445 ;; We wouldn't go through so much trouble if we didn't intend to use those
1446 ;; properties, would we?
1448 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1451 font-lock-syntactic-keywords)))
1452 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1455 font-lock-syntactic-keywords
1456 t)))
1457 ;; Get down to business.
1460 keyword matcher highlights)
1462 ;; Find an occurrence of `matcher' from `start' to `end'.
1469 ;; Apply each highlight to this instance of `matcher', which may be
1470 ;; specific highlights or more keywords anchored to `matcher'.
1476 end))
1480 ;;; End of Syntactic regexp fontification functions.
1481 \f
1482 ;;; Syntactic fontification functions.
1491 "Put proper face on each string and comment between START and END.
1492 START should be at the beginning of a line."
1498 ;; Find the `start' state.
1500 face beg)
1502 ;;
1503 ;; Find each interesting place between here and `end'.
1514 comment-start-skip))
1515 ;; Find the comment delimiters
1516 ;; and use font-lock-comment-delimiter-face for them.
1520 comment-start-skip))
1522 font-lock-comment-delimiter-face)))
1525 font-lock-comment-delimiter-face))))
1530 ;;; End of Syntactic fontification functions.
1531 \f
1532 ;;; Keyword regexp fontification functions.
1535 "Apply HIGHLIGHT following a match.
1536 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1541 ;; No match but we might not signal an error.
1550 ;; If `val' is nil, don't do anything. It is important to do it
1551 ;; explicitly, because when adding nil via things like
1552 ;; font-lock-append-text-property, the property is actually
1553 ;; changed from <face> to (<face>) which is undesirable. --Stef
1554 nil)
1556 ;; Cannot override existing fontification.
1560 ;; Override existing fontification.
1563 ;; Prepend to existing fontification.
1566 ;; Append to existing fontification.
1569 ;; Keep existing fontification.
1573 "Fontify according to KEYWORDS until LIMIT.
1574 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1575 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1578 ;; Evaluate PRE-MATCH-FORM.
1580 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1585 ;; this is a multiline anchored match
1586 ;; (setq font-lock-multiline t)
1590 limit
1593 ;; Find an occurrence of `matcher' before `limit'.
1598 ;; Apply each highlight to this instance of `matcher'.
1603 ;; Evaluate POST-MATCH-FORM.
1607 "Fontify according to `font-lock-keywords' between START and END.
1608 START should be at the beginning of a line.
1609 LOUDLY, if non-nil, allows progress-meter bar."
1617 keyword matcher highlights)
1618 ;;
1619 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1623 ;;
1624 ;; Find an occurrence of `matcher' from `start' to `end'.
1631 ;; Beware empty string matches since they will
1632 ;; loop indefinitely.
1639 ;; this is a multiline regexp match
1640 ;; (setq font-lock-multiline t)
1649 ;; Apply each highlight to this instance of `matcher', which may be
1650 ;; specific highlights or more keywords anchored to `matcher'.
1657 ;; Ensure forward progress. `pos' is a marker because anchored
1658 ;; keyword may add/delete text (this happens e.g. in grep.el).
1664 ;;; End of Keyword regexp fontification functions.
1665 \f
1666 ;; Various functions.
1669 "Compile KEYWORDS into the form (t KEYWORDS COMPILED...)
1670 Here each COMPILED is of the form (MATCHER HIGHLIGHT ...) as shown in the
1671 `font-lock-keywords' doc string.
1672 If SYNTACTIC-KEYWORDS is non-nil, it means these keywords are used for
1673 `font-lock-syntactic-keywords' rather than for `font-lock-keywords'."
1675 ;; This should never happen. But some external packages sometimes
1676 ;; call font-lock in unexpected and incorrect ways. It's important to
1677 ;; stop processing at this point, otherwise we may end up changing the
1678 ;; global value of font-lock-keywords and break highlighting in many
1679 ;; other buffers.
1682 keywords
1689 syntax-begin-function)))
1693 ;; Try to detect when a string or comment contains something that
1694 ;; looks like a defun and would thus confuse font-lock.
1702 font-lock-comment-face))
1705 prepend)))))
1706 keywords))
1714 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1725 keyword)))
1728 "Evalulate KEYWORDS if a function (funcall) or variable (eval) name."
1730 keywords
1736 "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1737 Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
1740 alist))
1743 "Return LEVELth element of KEYWORDS.
1744 A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1745 \(1- (length KEYWORDS))."
1747 keywords)
1758 "Restart fontification in current buffer after recomputing from defaults.
1759 Recompute fontification variables using `font-lock-defaults' and
1760 `font-lock-maximum-decoration'. Then restart fontification.
1762 Use this function when you have changed any of the above
1763 variables directly.
1765 Note: This function will erase modifications done by
1766 `font-lock-add-keywords' or `font-lock-remove-keywords', but will
1767 preserve `hi-lock-mode' highlighting patterns."
1777 "Set fontification defaults appropriately for this mode.
1778 Sets various variables using `font-lock-defaults' and
1779 `font-lock-maximum-decoration'."
1780 ;; Set fontification defaults if not previously set for correct major mode.
1795 ;; Syntactic fontification?
1799 ;; Case fold during regexp fontification?
1803 ;; Syntax table for regexp and syntactic fontification?
1809 ;; The character to modify may be a single CHAR or a STRING.
1815 ;; Syntax function for syntactic fontification?
1820 ;; Variable alist?
1823 ;; Set up `font-lock-keywords' last because its value might depend
1824 ;; on other settings (e.g. font-lock-compile-keywords uses
1825 ;; font-lock-beginning-of-syntax-function).
1828 ;; Local fontification?
1834 ;; Now compile the keywords.
1838 \f
1839 ;;; Color etc. support.
1841 ;; Note that `defface' will not overwrite any faces declared above via
1842 ;; `custom-declare-face'.
1859 )
1861 "Font Lock mode face used to highlight comments."
1872 "Font Lock mode face used to highlight comment delimiters."
1884 "Font Lock mode face used to highlight strings."
1889 "Font Lock mode face used to highlight documentation."
1901 "Font Lock mode face used to highlight keywords."
1913 "Font Lock mode face used to highlight builtins."
1923 "Font Lock mode face used to highlight function names."
1937 "Font Lock mode face used to highlight variable names."
1949 "Font Lock mode face used to highlight type and classes."
1963 "Font Lock mode face used to highlight constants and labels."
1973 "Font Lock mode face used to highlight warnings."
1978 "Font Lock mode face used to highlight easy to overlook negation."
1983 "Font Lock mode face used to highlight preprocessor directives."
1988 "Font Lock mode face for backslashes in Lisp regexp grouping constructs."
1993 "Font Lock mode face used to highlight grouping constructs in Lisp regexps."
1996 ;;; End of Color etc. support.
1997 \f
1998 ;;; Menu support.
2000 ;; This section of code is commented out because Emacs does not have real menu
2001 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
2002 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
2003 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
2004 ;; the entry for "Text Properties" something like:
2005 ;;
2006 ;; (define-key menu-bar-edit-menu [font-lock]
2007 ;; (cons "Syntax Highlighting" font-lock-menu))
2008 ;;
2009 ;; and remove a single ";" from the beginning of each line in the rest of this
2010 ;; section. Probably the mechanism for telling the menu code what are menu
2011 ;; buttons and when they are on or off needs tweaking. I have assumed that the
2012 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
2014 ;;;;;###autoload
2015 ;;(progn
2016 ;; ;; Make the Font Lock menu.
2017 ;; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
2018 ;; ;; Add the menu items in reverse order.
2019 ;; (define-key font-lock-menu [fontify-less]
2020 ;; '("Less In Current Buffer" . font-lock-fontify-less))
2021 ;; (define-key font-lock-menu [fontify-more]
2022 ;; '("More In Current Buffer" . font-lock-fontify-more))
2023 ;; (define-key font-lock-menu [font-lock-sep]
2024 ;; '("--"))
2025 ;; (define-key font-lock-menu [font-lock-mode]
2026 ;; '("In Current Buffer" . font-lock-mode))
2027 ;; (define-key font-lock-menu [global-font-lock-mode]
2028 ;; '("In All Buffers" . global-font-lock-mode)))
2029 ;;
2030 ;;;;;###autoload
2031 ;;(progn
2032 ;; ;; We put the appropriate `menu-enable' etc. symbol property values on when
2033 ;; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
2034 ;; (put 'global-font-lock-mode 'menu-toggle t)
2035 ;; (put 'font-lock-mode 'menu-toggle t)
2036 ;; (put 'font-lock-fontify-more 'menu-enable '(identity))
2037 ;; (put 'font-lock-fontify-less 'menu-enable '(identity)))
2038 ;;
2039 ;; ;; Put the appropriate symbol property values on now. See above.
2040 ;;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
2041 ;;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
2042 ;;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
2043 ;;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
2044 ;;
2045 ;;(defvar font-lock-fontify-level nil) ; For less/more fontification.
2046 ;;
2047 ;;(defun font-lock-fontify-level (level)
2048 ;; (let ((font-lock-maximum-decoration level))
2049 ;; (when font-lock-mode
2050 ;; (font-lock-mode))
2051 ;; (font-lock-mode)
2052 ;; (when font-lock-verbose
2053 ;; (message "Fontifying %s... level %d" (buffer-name) level))))
2054 ;;
2055 ;;(defun font-lock-fontify-less ()
2056 ;; "Fontify the current buffer with less decoration.
2057 ;;See `font-lock-maximum-decoration'."
2058 ;; (interactive)
2059 ;; ;; Check in case we get called interactively.
2060 ;; (if (nth 1 font-lock-fontify-level)
2061 ;; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
2062 ;; (error "No less decoration")))
2063 ;;
2064 ;;(defun font-lock-fontify-more ()
2065 ;; "Fontify the current buffer with more decoration.
2066 ;;See `font-lock-maximum-decoration'."
2067 ;; (interactive)
2068 ;; ;; Check in case we get called interactively.
2069 ;; (if (nth 2 font-lock-fontify-level)
2070 ;; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
2071 ;; (error "No more decoration")))
2072 ;;
2073 ;; ;; This should be called by `font-lock-set-defaults'.
2074 ;;(defun font-lock-set-menu ()
2075 ;; ;; Activate less/more fontification entries if there are multiple levels for
2076 ;; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
2077 ;; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
2078 ;; (let ((keywords (nth 0 font-lock-defaults))
2079 ;; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
2080 ;; (make-local-variable 'font-lock-fontify-level)
2081 ;; (if (or (symbolp keywords) (= (length keywords) 1))
2082 ;; (font-lock-unset-menu)
2083 ;; (cond ((eq level t)
2084 ;; (setq level (1- (length keywords))))
2085 ;; ((or (null level) (zerop level))
2086 ;; ;; The default level is usually, but not necessarily, level 1.
2087 ;; (setq level (- (length keywords)
2088 ;; (length (member (eval (car keywords))
2089 ;; (mapcar 'eval (cdr keywords))))))))
2090 ;; (setq font-lock-fontify-level (list level (> level 1)
2091 ;; (< level (1- (length keywords))))))))
2092 ;;
2093 ;; ;; This should be called by `font-lock-unset-defaults'.
2094 ;;(defun font-lock-unset-menu ()
2095 ;; ;; Deactivate less/more fontification entries.
2096 ;; (setq font-lock-fontify-level nil))
2098 ;;; End of Menu support.
2099 \f
2100 ;;; Various regexp information shared by several modes.
2101 ;; ;; Information specific to a single mode should go in its load library.
2103 ;; Font Lock support for C, C++, Objective-C and Java modes is now in
2104 ;; cc-fonts.el (and required by cc-mode.el). However, the below function
2105 ;; should stay in font-lock.el, since it is used by other libraries. sm.
2108 "Match, and move over, any declaration/definition item after point.
2109 Matches after point, but ignores leading whitespace and `*' characters.
2110 Does not move further than LIMIT.
2112 The expected syntax of a declaration/definition item is `word' (preceded by
2113 optional whitespace and `*' characters and proceeded by optional whitespace)
2114 optionally followed by a `('. Everything following the item (but belonging to
2115 it) is expected to be skip-able by `scan-sexps', and items are expected to be
2116 separated with a `,' and to be terminated with a `;'.
2118 Thus the regexp matches after point: word (
2119 ^^^^ ^
2120 Where the match subexpressions are: 1 2
2122 The item is delimited by (match-beginning 1) and (match-end 1).
2123 If (match-beginning 2) is non-nil, the item is followed by a `('.
2125 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
2128 ;; If `word' is followed by a double open-paren, it's probably
2129 ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one
2130 ;; word to try and match `myfun' rather than `P_'.
2135 ;; Looks like it was something else, so go back to where we
2136 ;; were and reset the match data by rematching.
2142 ;; Restrict to the LIMIT.
2145 ;; Move over any item value, etc., to the next item.
2152 ;; C preprocessor(cpp) is used outside of C, C++ and Objective-C source file.
2153 ;; e.g. assembler code and GNU linker script in Linux kernel.
2154 ;; `cpp-font-lock-keywords' is handy for modes for the files.
2155 ;;
2156 ;; Here we cannot use `regexp-opt' because because regex-opt is not preloaded
2157 ;; while font-lock.el is preloaded to emacs. So values pre-calculated with
2158 ;; regexp-opt are used here.
2160 ;; `cpp-font-lock-keywords-source-directives' is calculated from:
2161 ;;
2162 ;; (regexp-opt
2163 ;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
2164 ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning"))
2165 ;;
2167 "define\\|e\\(?:l\\(?:if\\|se\\)\\|ndif\\|rror\\)\\|file\\|i\\(?:f\\(?:n?def\\)?\\|mport\\|nclude\\)\\|line\\|pragma\\|undef\\|warning"
2170 ;; `cpp-font-lock-keywords-source-depth' is calculated from:
2171 ;;
2172 ;; (regexp-opt-depth (regexp-opt
2173 ;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
2174 ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning")))
2175 ;;
2177 "An integer representing regular expression depth of `cpp-font-lock-keywords-source-directives'.
2184 ;;
2185 ;; Fontify error directives.
2187 ;;
2188 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2191 ;;
2192 ;; Fontify function macro names.
2195 ;;
2196 ;; Macro arguments.
2201 limit)
2202 t))
2204 ;;
2205 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2209 ;;
2210 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2217 "Font lock keywords for C preprocessor directives.
2218 `c-mode', `c++-mode' and `objc-mode' have their own font lock keywords
2219 for C preprocessor directives. This definition is for the other modes
2220 in which C preprocessor directives are used. e.g. `asm-mode' and
2223 \f
2224 ;; Lisp.
2230 ;; Function declarations.
2237 ;; Variable declarations.
2239 ;; Structure declarations.
2242 ;; Any whitespace and defined object.
2249 nil t))
2250 ;; Emacs Lisp autoload cookies. Supports the slightly different
2251 ;; forms used by mh-e, calendar, etc.
2253 ;; Regexp negated char group.
2274 "with-electric-help"
2283 ;; Control structures. Common Lisp forms.
2304 ;; Exit/Feature symbols as constants.
2309 ;; Erroneous structures.
2310 ("(\\(abort\\|assert\\|warn\\|check-type\\|cerror\\|error\\|signal\\)\\>" 1 font-lock-warning-face)
2311 ;; Words inside \\[] tend to be for `substitute-command-keys'.
2313 ;; Words inside `' tend to be symbol names.
2315 ;; Constant values.
2317 ;; ELisp and CLisp `&' keywords as types.
2319 ;; ELisp regexp grouping constructs
2322 ;; The following loop is needed to continue searching after matches
2323 ;; that do not occur in strings. The associated regexp matches one
2324 ;; of `\\\\' `\\(' `\\(?:' `\\|' `\\)'. `\\\\' has been included to
2325 ;; avoid highlighting, for example, `\\(' in `\\\\('.
2326 (while (re-search-forward "\\(\\\\\\\\\\)\\(?:\\(\\\\\\\\\\)\\|\\((\\(?:\\?[0-9]*:\\)?\\|[|)]\\)\\)" bound t)
2335 ;;; This is too general -- rms.
2336 ;;; A user complained that he has functions whose names start with `do'
2337 ;;; and that they get the wrong color.
2338 ;;; ;; CL `with-' and `do-' constructs
2339 ;;; ("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
2340 )))
2345 \f
2348 ;;; font-lock.el ends here