| blob | 51a4ee727225b15d8c2326ba18befe27c6ce293a |
1 ;;; font-lock.el --- Electric font lock mode
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004 2005 Free Software Foundation, Inc.
6 ;; Author: jwz, then rms, then sm
7 ;; Maintainer: FSF
8 ;; Keywords: languages, faces
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;; Font Lock mode is a minor mode that causes your comments to be displayed in
30 ;; one face, strings in another, reserved words in another, and so on.
31 ;;
32 ;; Comments will be displayed in `font-lock-comment-face'.
33 ;; Strings will be displayed in `font-lock-string-face'.
34 ;; Regexps are used to display selected patterns in other faces.
35 ;;
36 ;; To make the text you type be fontified, use M-x font-lock-mode RET.
37 ;; When this minor mode is on, the faces of the current line are updated with
38 ;; every insertion or deletion.
39 ;;
40 ;; To turn Font Lock mode on automatically, add this to your ~/.emacs file:
41 ;;
42 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock)
43 ;;
44 ;; Or if you want to turn Font Lock mode on in many modes:
45 ;;
46 ;; (global-font-lock-mode t)
47 ;;
48 ;; Fontification for a particular mode may be available in a number of levels
49 ;; of decoration. The higher the level, the more decoration, but the more time
50 ;; it takes to fontify. See the variable `font-lock-maximum-decoration', and
51 ;; also the variable `font-lock-maximum-size'. Support modes for Font Lock
52 ;; mode can be used to speed up Font Lock mode. See `font-lock-support-mode'.
53 \f
54 ;;; How Font Lock mode fontifies:
56 ;; When Font Lock mode is turned on in a buffer, it (a) fontifies the entire
57 ;; buffer and (b) installs one of its fontification functions on one of the
58 ;; hook variables that are run by Emacs after every buffer change (i.e., an
59 ;; insertion or deletion). Fontification means the replacement of `face' text
60 ;; properties in a given region; Emacs displays text with these `face' text
61 ;; properties appropriately.
62 ;;
63 ;; Fontification normally involves syntactic (i.e., strings and comments) and
64 ;; regexp (i.e., keywords and everything else) passes. There are actually
65 ;; three passes; (a) the syntactic keyword pass, (b) the syntactic pass and (c)
66 ;; the keyword pass. Confused?
67 ;;
68 ;; The syntactic keyword pass places `syntax-table' text properties in the
69 ;; buffer according to the variable `font-lock-syntactic-keywords'. It is
70 ;; necessary because Emacs' syntax table is not powerful enough to describe all
71 ;; the different syntactic constructs required by the sort of people who decide
72 ;; that a single quote can be syntactic or not depending on the time of day.
73 ;; (What sort of person could decide to overload the meaning of a quote?)
74 ;; Obviously the syntactic keyword pass must occur before the syntactic pass.
75 ;;
76 ;; The syntactic pass places `face' text properties in the buffer according to
77 ;; syntactic context, i.e., according to the buffer's syntax table and buffer
78 ;; text's `syntax-table' text properties. It involves using a syntax parsing
79 ;; function to determine the context of different parts of a region of text. A
80 ;; syntax parsing function is necessary because generally strings and/or
81 ;; comments can span lines, and so the context of a given region is not
82 ;; necessarily apparent from the content of that region. Because the keyword
83 ;; pass only works within a given region, it is not generally appropriate for
84 ;; syntactic fontification. This is the first fontification pass that makes
85 ;; changes visible to the user; it fontifies strings and comments.
86 ;;
87 ;; The keyword pass places `face' text properties in the buffer according to
88 ;; the variable `font-lock-keywords'. It involves searching for given regexps
89 ;; (or calling given search functions) within the given region. This is the
90 ;; second fontification pass that makes changes visible to the user; it
91 ;; fontifies language reserved words, etc.
92 ;;
93 ;; Oh, and the answer is, "Yes, obviously just about everything should be done
94 ;; in a single syntactic pass, but the only syntactic parser available
95 ;; understands only strings and comments." Perhaps one day someone will write
96 ;; some syntactic parsers for common languages and a son-of-font-lock.el could
97 ;; use them rather then relying so heavily on the keyword (regexp) pass.
99 ;;; How Font Lock mode supports modes or is supported by modes:
101 ;; Modes that support Font Lock mode do so by defining one or more variables
102 ;; whose values specify the fontification. Font Lock mode knows of these
103 ;; variable names from (a) the buffer local variable `font-lock-defaults', if
104 ;; non-nil, or (b) the global variable `font-lock-defaults-alist', if the major
105 ;; mode has an entry. (Font Lock mode is set up via (a) where a mode's
106 ;; patterns are distributed with the mode's package library, and (b) where a
107 ;; mode's patterns are distributed with font-lock.el itself. An example of (a)
108 ;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is
109 ;; (a); (b) is used where it is not clear which package library should contain
110 ;; the pattern definitions.) Font Lock mode chooses which variable to use for
111 ;; fontification based on `font-lock-maximum-decoration'.
112 ;;
113 ;; Font Lock mode fontification behaviour can be modified in a number of ways.
114 ;; See the below comments and the comments distributed throughout this file.
116 ;;; Constructing patterns:
118 ;; See the documentation for the variable `font-lock-keywords'.
119 ;;
120 ;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and
121 ;; `font-lock-syntactic-keywords' can be generated via the function
122 ;; `regexp-opt'.
124 ;;; Adding patterns for modes that already support Font Lock:
126 ;; Though Font Lock highlighting patterns already exist for many modes, it's
127 ;; likely there's something that you want fontified that currently isn't, even
128 ;; at the maximum fontification level. You can add highlighting patterns via
129 ;; `font-lock-add-keywords'. For example, say in some C
130 ;; header file you #define the token `and' to expand to `&&', etc., to make
131 ;; your C code almost readable. In your ~/.emacs there could be:
132 ;;
133 ;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>"))
134 ;;
135 ;; Some modes provide specific ways to modify patterns based on the values of
136 ;; other variables. For example, additional C types can be specified via the
137 ;; variable `c-font-lock-extra-types'.
139 ;;; Adding patterns for modes that do not support Font Lock:
141 ;; Not all modes support Font Lock mode. If you (as a user of the mode) add
142 ;; patterns for a new mode, you must define in your ~/.emacs a variable or
143 ;; variables that specify regexp fontification. Then, you should indicate to
144 ;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what
145 ;; support is required. For example, say Foo mode should have the following
146 ;; regexps fontified case-sensitively, and comments and strings should not be
147 ;; fontified automagically. In your ~/.emacs there could be:
148 ;;
149 ;; (defvar foo-font-lock-keywords
150 ;; '(("\\<\\(one\\|two\\|three\\)\\>" . font-lock-keyword-face)
151 ;; ("\\<\\(four\\|five\\|six\\)\\>" . font-lock-type-face))
152 ;; "Default expressions to highlight in Foo mode.")
153 ;;
154 ;; (add-hook 'foo-mode-hook
155 ;; (lambda ()
156 ;; (make-local-variable 'font-lock-defaults)
157 ;; (setq font-lock-defaults '(foo-font-lock-keywords t))))
159 ;;; Adding Font Lock support for modes:
161 ;; Of course, it would be better that the mode already supports Font Lock mode.
162 ;; The package author would do something similar to above. The mode must
163 ;; define at the top-level a variable or variables that specify regexp
164 ;; fontification. Then, the mode command should indicate to Font Lock mode,
165 ;; via `font-lock-defaults', exactly what support is required. For example,
166 ;; say Bar mode should have the following regexps fontified case-insensitively,
167 ;; and comments and strings should be fontified automagically. In bar.el there
168 ;; could be:
169 ;;
170 ;; (defvar bar-font-lock-keywords
171 ;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . font-lock-keyword-face)
172 ;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . font-lock-type-face))
173 ;; "Default expressions to highlight in Bar mode.")
174 ;;
175 ;; and within `bar-mode' there could be:
176 ;;
177 ;; (make-local-variable 'font-lock-defaults)
178 ;; (setq font-lock-defaults '(bar-font-lock-keywords nil t))
179 \f
180 ;; What is fontification for? You might say, "It's to make my code look nice."
181 ;; I think it should be for adding information in the form of cues. These cues
182 ;; should provide you with enough information to both (a) distinguish between
183 ;; different items, and (b) identify the item meanings, without having to read
184 ;; the items and think about it. Therefore, fontification allows you to think
185 ;; less about, say, the structure of code, and more about, say, why the code
186 ;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
187 ;;
188 ;; So, here are my opinions/advice/guidelines:
189 ;;
190 ;; - Highlight conceptual objects, such as function and variable names, and
191 ;; different objects types differently, i.e., (a) and (b) above, highlight
192 ;; function names differently to variable names.
193 ;; - Keep the faces distinct from each other as far as possible.
194 ;; i.e., (a) above.
195 ;; - Use the same face for the same conceptual object, across all modes.
196 ;; i.e., (b) above, all modes that have items that can be thought of as, say,
197 ;; keywords, should be highlighted with the same face, etc.
198 ;; - Make the face attributes fit the concept as far as possible.
199 ;; i.e., function names might be a bold colour such as blue, comments might
200 ;; be a bright colour such as red, character strings might be brown, because,
201 ;; err, strings are brown (that was not the reason, please believe me).
202 ;; - Don't use a non-nil OVERRIDE unless you have a good reason.
203 ;; Only use OVERRIDE for special things that are easy to define, such as the
204 ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
205 ;; Don't use it to, say, highlight keywords in commented out code or strings.
206 ;; - Err, that's it.
207 \f
208 ;;; Code:
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."
228 ;; Define support mode groups here to impose `font-lock' group order.
230 "Font Lock support mode to cache fontification."
235 "Font Lock support mode to fontify lazily."
238 \f
239 ;; User variables.
242 "*Maximum size of a buffer for buffer fontification.
243 Only buffers less than this can be fontified when Font Lock mode is turned on.
244 If nil, means size is irrelevant.
245 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
246 where MAJOR-MODE is a symbol or t (meaning the default). For example:
247 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
248 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
249 for buffers in Rmail mode, and size is irrelevant otherwise."
264 "*Maximum decoration level for fontification.
265 If nil, use the default decoration (typically the minimum available).
266 If t, use the maximum decoration available.
267 If a number, use that level of decoration (or if not available the maximum).
268 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
269 where MAJOR-MODE is a symbol or t (meaning the default). For example:
270 ((c-mode . t) (c++-mode . 2) (t . 1))
271 means use the maximum decoration available for buffers in C mode, level 2
272 decoration for buffers in C++ mode, and level 1 decoration otherwise."
289 "*If non-nil, means show status messages for buffer fontification.
290 If a number, only buffers greater than this size have fontification messages."
297 "*Number of lines before the changed text to include in refontification."
301 \f
303 ;; Originally these variable values were face names such as `bold' etc.
304 ;; Now we create our own faces, but we keep these variables for compatibility
305 ;; and they give users another mechanism for changing face appearance.
306 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
307 ;; returns a face. So the easiest thing is to continue using these variables,
308 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
343 "Face name to use for easy to overlook negation.
352 ;; Fontification variables:
355 "A list of the keywords to highlight.
356 There are two kinds of values: user-level, and compiled.
358 A user-level keywords list is what a major mode or the user would
359 set up. Normally the list would come from `font-lock-defaults'.
360 through selection of a fontification level and evaluation of any
361 contained expressions. You can also alter it by calling
362 `font-lock-add-keywords' or `font-lock-remove-keywords' with MODE = nil.
364 Each element in a user-level keywords list should have one of these forms:
366 MATCHER
367 (MATCHER . MATCH)
368 (MATCHER . FACENAME)
369 (MATCHER . HIGHLIGHT)
370 (MATCHER HIGHLIGHT ...)
371 (eval . FORM)
373 where MATCHER can be either the regexp to search for, or the function name to
374 call to make the search (called with one argument, the limit of the search;
375 it should return non-nil, move point, and set `match-data' appropriately iff
376 it succeeds; like `re-search-forward' would).
377 MATCHER regexps can be generated via the function `regexp-opt'.
379 FORM is an expression, whose value should be a keyword element, evaluated when
380 the keyword is (first) used in a buffer. This feature can be used to provide a
381 keyword that can only be generated when Font Lock mode is actually turned on.
383 HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
386 typically only MATCH-HIGHLIGHT is required.
387 However, if an item or (typically) items are to be highlighted following the
388 instance of another item (the anchor), for example each instance of the
391 MATCH-HIGHLIGHT should be of the form:
393 (MATCH FACENAME [OVERRIDE [LAXMATCH]])
395 MATCH is the subexpression of MATCHER to be highlighted. FACENAME is an
396 expression whose value is the face name to use. Face default attributes
398 evaluate to a property list of the form (face FACE PROP1 VAL1 PROP2 VAL2 ...)
399 in which case all the listed text-properties will be set rather than
400 just FACE. In such a case, you will most likely want to put those
401 properties in `font-lock-extra-managed-props' or to override
402 `font-lock-unfontify-region-function'.
404 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
405 be overwritten. If `keep', only parts not already fontified are highlighted.
406 If `prepend' or `append', existing fontification is merged with the new, in
407 which the new or existing fontification, respectively, takes precedence.
408 If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER.
410 For example, an element of the form highlights (if not already highlighted):
413 variable `font-lock-keyword-face'.
415 the value of `font-lock-keyword-face'.
419 of `foo-bar-face', even if already highlighted.
420 (fubar-match 1 fubar-face)
421 the first subexpression within all occurrences of
422 whatever the function `fubar-match' finds and matches
423 in the value of `fubar-face'.
425 MATCH-ANCHORED should be of the form:
427 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
429 where MATCHER is a regexp to search for or the function name to call to make
430 the search, as for MATCH-HIGHLIGHT above, but with one exception; see below.
431 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
432 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
433 used to initialize before, and cleanup after, MATCHER is used. Typically,
434 PRE-MATCH-FORM is used to move to some position relative to the original
435 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
436 be used to move back, before resuming with MATCH-ANCHORED's parent's MATCHER.
438 For example, an element of the form highlights (if not already highlighted):
449 The above-mentioned exception is as follows. The limit of the MATCHER search
450 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
451 However, if PRE-MATCH-FORM returns a position greater than the position after
452 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
453 It is generally a bad idea to return a position greater than the end of the
454 line, i.e., cause the MATCHER search to span lines.
456 These regular expressions can match text which spans lines, although
457 it is better to avoid it if possible since updating them while editing
458 text is slower, and it is not guaranteed to be always correct when using
459 support modes like jit-lock or lazy-lock.
461 This variable is set by major modes via the variable `font-lock-defaults'.
462 Be careful when composing regexps for this list; a poorly written pattern can
463 dramatically slow things down!
465 A compiled keywords list starts with t. It is produced internal
466 by `font-lock-compile-keywords' from a user-level keywords list.
467 Its second element is the user-level keywords list that was
468 compiled. The remaining elements have the same form as
469 user-level keywords, but normally their values have been
473 "Alist of additional `font-lock-keywords' elements for major modes.
475 Each element has the form (MODE KEYWORDS . APPEND).
476 `font-lock-set-defaults' adds the elements in the list KEYWORDS to
477 `font-lock-keywords' when Font Lock is turned on in major mode MODE.
479 If APPEND is nil, KEYWORDS are added at the beginning of
480 `font-lock-keywords'. If it is `set', they are used to replace the
481 value of `font-lock-keywords'. If APPEND is any other non-nil value,
482 they are added at the end.
484 This is normally set via `font-lock-add-keywords' and
488 "Alist of `font-lock-keywords' elements to be removed for major modes.
490 Each element has the form (MODE . KEYWORDS). `font-lock-set-defaults'
491 removes the elements in the list KEYWORDS from `font-lock-keywords'
492 when Font Lock is turned on in major mode MODE.
494 This is normally set via `font-lock-add-keywords' and
498 "*Non-nil means Font Lock should not fontify comments or strings.
502 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
507 "Point up to which `font-lock-syntactic-keywords' has been applied.
508 If nil, this is ignored, in which case the syntactic fontification may
515 "Function to determine which face to use when fontifying syntactically.
516 The function is called with a single parameter (the state as returned by
517 `parse-partial-sexp' at the beginning of the region to highlight) and
521 "A list of the syntactic keywords to highlight.
522 Can be the list or the name of a function or variable whose value is the list.
523 See `font-lock-keywords' for a description of the form of this list;
524 the differences are listed below. MATCH-HIGHLIGHT should be of the form:
526 (MATCH 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 For example, an element of the form highlights syntactically:
536 a hash character when following a dollar character, with a SYNTAX of
538 specify hash characters to have comment start syntax, the element will only
539 highlight hash characters that do not follow dollar characters as comments
540 syntactically.
546 both single quotes which surround a single character, with a SYNTAX of
548 does not specify single quotes to have quote syntax, the element will only
549 highlight single quotes of the form 'c' as strings syntactically.
550 Other forms, such as foo'bar or 'fubar', will not be highlighted as strings.
555 "Non-nil means use this syntax table for fontifying.
556 If this is nil, the major mode's syntax table is used.
560 "*Non-nil means use this function to move back outside all constructs.
561 When called with no args it should move point backward to a place which
562 is not in a string or comment and not within any bracket-pairs (or else,
563 a place such that any bracket-pairs outside it can be ignored for Emacs
564 syntax analysis and fontification).
566 If this is nil, Font Lock uses `syntax-begin-function' to move back
567 outside of any comment, string, or sexp. This variable is semi-obsolete;
568 we recommend setting `syntax-begin-function' instead.
573 "*Non-nil means use this function to mark a block of text.
574 When called with no args it should leave point at the beginning of any
575 enclosing textual block and mark at the end.
579 "Function to use for fontifying the buffer.
583 "Function to use for unfontifying the buffer.
584 This is used when turning off Font Lock mode.
588 "Function to use for fontifying a region.
589 It should take two args, the beginning and end of the region, and an optional
590 third arg VERBOSE. If VERBOSE is non-nil, the function should print status
594 "Function to use for unfontifying a region.
595 It should take two args, the beginning and end of the region.
599 "List of Font Lock mode related modes that should not be turned on.
600 Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
604 "Whether font-lock should cater to multiline keywords.
605 If nil, don't try to handle multiline patterns.
606 If t, always handle multiline patterns.
607 If `undecided', don't try to handle multiline patterns until you see one.
611 \f
612 ;; Font Lock mode.
615 ;;
616 ;; We don't do this at the top-level as we only use non-autoloaded macros.
618 ;;
619 ;; Borrowed from lazy-lock.el.
620 ;; We use this to preserve or protect things when modifying text properties.
622 "Bind variables according to VARLIST and eval BODY restoring buffer state."
631 deactivate-mark
632 buffer-file-name
633 buffer-file-truename))
638 ;;
639 ;; Shut up the byte compiler.
642 ;;;###autoload
644 ;; Turn on Font Lock mode.
649 ;; Fontify the buffer if we have to.
652 nil)
658 ;; Turn off Font Lock mode.
664 ;;;###autoload
666 "Add highlighting KEYWORDS for MODE.
668 MODE should be a symbol, the major mode command name, such as `c-mode'
669 or nil. If nil, highlighting keywords are added for the current buffer.
670 KEYWORDS should be a list; see the variable `font-lock-keywords'.
671 By default they are added at the beginning of the current highlighting list.
672 If optional argument APPEND is `set', they are used to replace the current
673 highlighting list. If APPEND is any other non-nil value, they are added at the
674 end of the current highlighting list.
676 For example:
678 (font-lock-add-keywords 'c-mode
682 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
683 comments, and to fontify `and', `or' and `not' words as keywords.
685 The above procedure will only add the keywords for C mode, not
686 for modes derived from C mode. To add them for derived modes too,
687 pass nil for MODE and add the call to c-mode-hook.
689 For example:
691 (add-hook 'c-mode-hook
692 (lambda ()
693 (font-lock-add-keywords nil
696 font-lock-keyword-face)))))
698 The above procedure may fail to add keywords to derived modes if
699 some involved major mode does not follow the standard conventions.
700 File a bug report if this happens, so the major mode can be corrected.
702 Note that some modes have specialized support for additional patterns, e.g.,
703 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
704 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
706 ;; If MODE is non-nil, add the KEYWORDS and APPEND spec to
707 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
714 ;; Make sure that `font-lock-removed-keywords-alist' does not
715 ;; contain the new keywords.
718 ;; Otherwise set or add the keywords now.
719 ;; This is a no-op if it has been done already in this buffer
720 ;; for the correct major mode.
723 ;; Bring back the user-level (uncompiled) keywords.
726 ;; Now modify or replace them.
732 font-lock-keywords)))
736 ;; If the keywords were compiled before, compile them again.
742 "Update `font-lock-removed-keywords-alist' when adding new KEYWORDS to MODE."
743 ;; When font-lock is enabled first all keywords in the list
744 ;; `font-lock-keywords-alist' are added, then all keywords in the
745 ;; list `font-lock-removed-keywords-alist' are removed. If a
746 ;; keyword was once added, removed, and then added again it must be
747 ;; removed from the removed-keywords list. Otherwise the second add
748 ;; will not take effect.
752 ;; A new set of keywords is defined. Forget all about
753 ;; our old keywords that should be removed.
756 ;; Delete all previously removed keywords.
759 ;; Delete the mode cell if empty.
764 ;; Written by Anders Lindgren <andersl@andersl.com>.
765 ;;
766 ;; Case study:
767 ;; (I) The keywords are removed from a major mode.
768 ;; In this case the keyword could be local (i.e. added earlier by
769 ;; `font-lock-add-keywords'), global, or both.
770 ;;
771 ;; (a) In the local case we remove the keywords from the variable
772 ;; `font-lock-keywords-alist'.
773 ;;
774 ;; (b) The actual global keywords are not known at this time.
775 ;; All keywords are added to `font-lock-removed-keywords-alist',
776 ;; when font-lock is enabled those keywords are removed.
777 ;;
778 ;; Note that added keywords are taken out of the list of removed
779 ;; keywords. This ensure correct operation when the same keyword
780 ;; is added and removed several times.
781 ;;
782 ;; (II) The keywords are removed from the current buffer.
783 ;;;###autoload
785 "Remove highlighting KEYWORDS for MODE.
787 MODE should be a symbol, the major mode command name, such as `c-mode'
788 or nil. If nil, highlighting keywords are removed for the current buffer.
790 To make the removal apply to modes derived from MODE as well,
791 pass nil for MODE and add the call to MODE-hook. This may fail
792 for some derived modes if some involved major mode does not
793 follow the standard conventions. File a bug report if this
794 happens, so the major mode can be corrected."
796 ;; Remove one keyword at the time.
799 ;; If MODE is non-nil, remove the KEYWORD from
800 ;; `font-lock-keywords-alist'.
803 ;; `keywords-list-append-pair' is a cons with a list of
804 ;; keywords in the car top-cell and the original append
805 ;; argument in the cdr top-cell.
808 ;; Remove keyword list/append pair when the keyword list
809 ;; is empty and append doesn't specify `set'. (If it
810 ;; should be deleted then previously deleted keywords
811 ;; would appear again.)
818 ;; Final cleanup, remove major mode cell if last keyword
819 ;; was deleted.
823 ;; Remember the keyword in case it is not local.
829 font-lock-removed-keywords-alist))))))
831 ;; Otherwise remove it immediately.
834 ;; Bring back the user-level (uncompiled) keywords.
838 ;; Edit them.
844 ;; If the keywords were compiled before, compile them again.
848 \f
849 ;;; Font Lock Support mode.
851 ;; This is the code used to interface font-lock.el with any of its add-on
852 ;; packages, and provide the user interface. Packages that have their own
853 ;; local buffer fontification functions (see below) may have to call
854 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
855 ;; themselves.
858 "*Support mode for Font Lock mode.
859 Support modes speed up Font Lock mode by being choosy about when fontification
860 occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode'),
861 Lazy Lock mode (symbol `lazy-lock-mode'), and Just-in-time Lock mode (symbol
862 `jit-lock-mode'. See those modes for more info.
863 If nil, means support for Font Lock mode is never performed.
864 If a symbol, use that support mode.
865 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
866 where MAJOR-MODE is a symbol or t (meaning the default). For example:
867 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
868 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
869 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
871 The value of this variable is used when Font Lock mode is turned on."
887 ))
902 ;; Prepare for jit-lock
907 ;; Don't fontify eagerly (and don't abort if the buffer is large).
909 ;; Use jit-lock.
918 ;; Reset local vars to the non-jit-lock case.
926 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
927 ;; (jit-lock-mode
928 ;; (jit-lock-after-fontify-buffer))
935 ;; Useless as well. It's only called when:
936 ;; - turning off font-lock: it does not matter if we leave spurious
937 ;; `fontified' text props around since jit-lock-mode is also off.
938 ;; - font-lock-default-fontify-buffer fails: this is not run
939 ;; any more anyway. -sm
940 ;;
941 ;; (jit-lock-mode
942 ;; (jit-lock-after-unfontify-buffer))
946 ;;; End of Font Lock Support mode.
947 \f
948 ;;; Fontification functions.
950 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
951 ;; code to fontify a region, the function runs the function whose name is the
952 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
953 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
954 ;; which does contain the code to fontify a region. However, the value of the
955 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
956 ;; do anything. The indirection of the fontification functions gives major
957 ;; modes the capability of modifying the way font-lock.el fontifies. Major
958 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
959 ;; via the variable `font-lock-defaults'.
960 ;;
961 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
962 ;; font-lock.el uses its own function for buffer fontification. This function
963 ;; makes fontification be on a message-by-message basis and so visiting an
964 ;; RMAIL file is much faster. A clever implementation of the function might
965 ;; fontify the headers differently than the message body. (It should, and
966 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
967 ;; you?) This hints at a more interesting use...
968 ;;
969 ;; Languages that contain text normally contained in different major modes
970 ;; could define their own fontification functions that treat text differently
971 ;; depending on its context. For example, Perl mode could arrange that here
972 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
973 ;; rules one way and C code another. Neat!
974 ;;
975 ;; A further reason to use the fontification indirection feature is when the
976 ;; default syntactual fontification, or the default fontification in general,
977 ;; is not flexible enough for a particular major mode. For example, perhaps
978 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
979 ;; cope with. You need to write your own version of that function, e.g.,
980 ;; `hairy-fontify-syntactically-region', and make your own version of
981 ;; `hairy-fontify-region' call that function before calling
982 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
983 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
984 ;; would call your region fontification function instead of its own. For
985 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
986 ;; directives correctly and cleanly. (It is the same problem as fontifying
987 ;; multi-line strings and comments; regexps are not appropriate for the job.)
989 ;;;###autoload
991 "Fontify the current buffer the way the function `font-lock-mode' would."
1009 font-lock-verbose)))
1013 ;; Make sure we have the right `font-lock-keywords' etc.
1016 ;; Make sure we fontify etc. in the whole buffer.
1025 ;; We don't restore the old fontification, so it's best to unfontify.
1029 ;; Make sure we unfontify etc. in the whole buffer.
1037 "If non-nil, font-lock will work on the non-widened buffer.
1038 Useful for things like RMAIL and Info where the whole buffer is not
1049 ;; Use the fontification syntax table, if any.
1052 ;; check to see if we should expand the beg/end area for
1053 ;; proper multiline matches
1057 ;; We are just after or in a multiline match.
1069 ;; Now do the fontification.
1076 ;; Clean up.
1079 ;; The following must be rethought, since keywords can override fontification.
1080 ; ;; Now scan for keywords, but not if we are inside a comment now.
1081 ; (or (and (not font-lock-keywords-only)
1082 ; (let ((state (parse-partial-sexp beg end nil nil
1083 ; font-lock-cache-state)))
1084 ; (or (nth 4 state) (nth 7 state))))
1085 ; (font-lock-fontify-keywords-region beg end))
1088 "Additional text properties managed by font-lock.
1089 This is used by `font-lock-default-unfontify-region' to decide
1095 font-lock-extra-managed-props
1100 ;; Called when any modification is made to buffer text.
1106 ;; Rescan between start of lines enclosing the region.
1113 "Fontify some lines the way `font-lock-fontify-buffer' would.
1114 The lines could be a function or paragraph, or a specified number of lines.
1115 If ARG is given, fontify that many lines before and after point, or 16 lines if
1116 no ARG is given and `font-lock-mark-block-function' is nil.
1117 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1118 delimit the region to fontify."
1121 deactivate-mark)
1122 ;; Make sure we have the right `font-lock-keywords' etc.
1139 ;;; End of Fontification functions.
1140 \f
1141 ;;; Additional text property functions.
1143 ;; The following text property functions should be builtins. This means they
1144 ;; should be written in C and put with all the other text property functions.
1145 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1146 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1147 ;; in Lisp below and commented out. sm.
1150 "Prepend to one property of the text from START to END.
1151 Arguments PROP and VALUE specify the property and value to prepend to the value
1152 already in place. The resulting property values are always lists.
1153 Optional argument OBJECT is the string or buffer containing the text."
1160 object)
1164 "Append to one property of the text from START to END.
1165 Arguments PROP and VALUE specify the property and value to append to the value
1166 already in place. The resulting property values are always lists.
1167 Optional argument OBJECT is the string or buffer containing the text."
1174 object)
1178 "Fill in one property of the text from START to END.
1179 Arguments PROP and VALUE specify the property and value to put where none are
1180 already in place. Therefore existing property values are not overwritten.
1181 Optional argument OBJECT is the string or buffer containing the text."
1188 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1189 ;; is to `add-text-properties', etc.
1190 ;(defun remove-text-property (start end property &optional object)
1191 ; "Remove a property from text from START to END.
1192 ;Argument PROPERTY is the property to remove.
1193 ;Optional argument OBJECT is the string or buffer containing the text.
1194 ;Return t if the property was actually removed, nil otherwise."
1195 ; (remove-text-properties start end (list property) object))
1197 ;; For consistency: maybe this should be called `remove-single-property' like
1198 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1199 ;(defun remove-single-text-property (start end prop value &optional object)
1200 ; "Remove a specific property value from text from START to END.
1201 ;Arguments PROP and VALUE specify the property and value to remove. The
1202 ;resulting property values are not equal to VALUE nor lists containing VALUE.
1203 ;Optional argument OBJECT is the string or buffer containing the text."
1204 ; (let ((start (text-property-not-all start end prop nil object)) next prev)
1205 ; (while start
1206 ; (setq next (next-single-property-change start prop object end)
1207 ; prev (get-text-property start prop object))
1208 ; (cond ((and (symbolp prev) (eq value prev))
1209 ; (remove-text-property start next prop object))
1210 ; ((and (listp prev) (memq value prev))
1211 ; (let ((new (delq value prev)))
1212 ; (cond ((null new)
1213 ; (remove-text-property start next prop object))
1214 ; ((= (length new) 1)
1215 ; (put-text-property start next prop (car new) object))
1216 ; (t
1217 ; (put-text-property start next prop new object))))))
1218 ; (setq start (text-property-not-all next end prop nil object)))))
1220 ;;; End of Additional text property functions.
1221 \f
1222 ;;; Syntactic regexp fontification functions.
1224 ;; These syntactic keyword pass functions are identical to those keyword pass
1225 ;; functions below, with the following exceptions; (a) they operate on
1226 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1227 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1228 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1229 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1230 ;; LOUDLY as it is not likely to be intensive.
1233 "Apply HIGHLIGHT following a match.
1234 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1235 see `font-lock-syntactic-keywords'."
1241 ;; No match but we might not signal an error.
1247 ;; Flush the syntax-cache. I believe this is not necessary for
1248 ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can
1249 ;; still be necessary for other users of syntax-ppss anyway.
1253 ;; Cannot override existing fontification.
1257 ;; Override existing fontification.
1260 ;; Keep existing fontification.
1264 "Fontify according to KEYWORDS until LIMIT.
1265 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1266 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1268 ;; Evaluate PRE-MATCH-FORM.
1270 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1275 ;; Find an occurrence of `matcher' before `limit'.
1279 ;; Apply each highlight to this instance of `matcher'.
1284 ;; Evaluate POST-MATCH-FORM.
1288 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1289 START should be at the beginning of a line."
1290 ;; Ensure the beginning of the file is properly syntactic-fontified.
1295 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1298 font-lock-syntactic-keywords)))
1299 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1302 font-lock-syntactic-keywords)))
1303 ;; Get down to business.
1306 keyword matcher highlights)
1308 ;; Find an occurrence of `matcher' from `start' to `end'.
1314 ;; Apply each highlight to this instance of `matcher', which may be
1315 ;; specific highlights or more keywords anchored to `matcher'.
1321 end))
1325 ;;; End of Syntactic regexp fontification functions.
1326 \f
1327 ;;; Syntactic fontification functions.
1336 "Put proper face on each string and comment between START and END.
1337 START should be at the beginning of a line."
1342 state face beg)
1345 ;;
1346 ;; Find the `start' state.
1348 ;;
1349 ;; Find each interesting place between here and `end'.
1360 comment-start-skip))
1361 ;; Find the comment delimiters
1362 ;; and use font-lock-comment-delimiter-face for them.
1366 comment-start-skip))
1368 font-lock-comment-delimiter-face)))
1371 font-lock-comment-delimiter-face))))
1376 ;;; End of Syntactic fontification functions.
1377 \f
1378 ;;; Keyword regexp fontification functions.
1381 "Apply HIGHLIGHT following a match.
1382 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1387 ;; No match but we might not signal an error.
1396 ;; If `val' is nil, don't do anything. It is important to do it
1397 ;; explicitly, because when adding nil via things like
1398 ;; font-lock-append-text-property, the property is actually
1399 ;; changed from <face> to (<face>) which is undesirable. --Stef
1400 nil)
1402 ;; Cannot override existing fontification.
1406 ;; Override existing fontification.
1409 ;; Prepend to existing fontification.
1412 ;; Append to existing fontification.
1415 ;; Keep existing fontification.
1419 "Fontify according to KEYWORDS until LIMIT.
1420 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1421 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1424 ;; Evaluate PRE-MATCH-FORM.
1426 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1431 ;; this is a multiline anchored match
1432 ;; (setq font-lock-multiline t)
1436 limit
1439 ;; Find an occurrence of `matcher' before `limit'.
1444 ;; Apply each highlight to this instance of `matcher'.
1449 ;; Evaluate POST-MATCH-FORM.
1453 "Fontify according to `font-lock-keywords' between START and END.
1454 START should be at the beginning of a line.
1455 LOUDLY, if non-nil, allows progress-meter bar."
1463 keyword matcher highlights)
1464 ;;
1465 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1469 ;;
1470 ;; Find an occurrence of `matcher' from `start' to `end'.
1477 ;; Beware empty string matches since they will
1478 ;; loop indefinitely.
1485 ;; this is a multiline regexp match
1486 ;; (setq font-lock-multiline t)
1495 ;; Apply each highlight to this instance of `matcher', which may be
1496 ;; specific highlights or more keywords anchored to `matcher'.
1503 ;; Ensure forward progress. `pos' is a marker because anchored
1504 ;; keyword may add/delete text (this happens e.g. in grep.el).
1510 ;;; End of Keyword regexp fontification functions.
1511 \f
1512 ;; Various functions.
1515 "Compile KEYWORDS into the form (t KEYWORDS COMPILED...)
1516 Here each COMPILED is of the form (MATCHER HIGHLIGHT ...) as shown in the
1517 `font-lock-keywords' doc string.
1518 If REGEXP is non-nil, it means these keywords are used for
1519 `font-lock-keywords' rather than for `font-lock-syntactic-keywords'."
1521 keywords
1527 font-lock-beginning-of-syntax-function)
1530 ;; Try to detect when a string or comment contains something that
1531 ;; looks like a defun and would thus confuse font-lock.
1539 font-lock-comment-face))
1540 font-lock-warning-face)
1541 prepend)))))
1542 keywords))
1550 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1561 keyword)))
1564 "Evalulate KEYWORDS if a function (funcall) or variable (eval) name."
1566 keywords
1572 "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1573 Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
1576 alist))
1579 "Return LEVELth element of KEYWORDS.
1580 A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1581 \(1- (length KEYWORDS))."
1583 keywords)
1595 "Set fontification defaults appropriately for this mode.
1596 Sets various variables using `font-lock-defaults' (or, if nil, using
1597 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1598 ;; Set fontification defaults iff not previously set for correct major mode.
1608 font-lock-defaults-alist)))))
1616 ;; Syntactic fontification?
1619 ;; Case fold during regexp fontification?
1622 ;; Syntax table for regexp and syntactic fontification?
1627 ;; The character to modify may be a single CHAR or a STRING.
1633 ;; Syntax function for syntactic fontification?
1637 ;; Variable alist?
1640 ;; Set up `font-lock-keywords' last because its value might depend
1641 ;; on other settings (e.g. font-lock-compile-keywords uses
1642 ;; font-lock-beginning-of-syntax-function).
1645 ;; Local fontification?
1651 ;; Now compile the keywords.
1655 \f
1656 ;;; Colour etc. support.
1658 ;; Originally face attributes were specified via `font-lock-face-attributes'.
1659 ;; Users then changed the default face attributes by setting that variable.
1660 ;; However, we try and be back-compatible and respect its value if set except
1661 ;; for faces where M-x customize has been used to save changes for the face.
1667 ;; Rustle up a `defface' SPEC from a `font-lock-face-attributes' entry.
1674 face-spec)
1687 ;; But now we do it the custom way. Note that `defface' will not overwrite any
1688 ;; faces declared above via `custom-declare-face'.
1703 )
1705 )
1707 "Font Lock mode face used to highlight comments."
1718 "Font Lock mode face used to highlight comment delimiters."
1730 "Font Lock mode face used to highlight strings."
1735 "Font Lock mode face used to highlight documentation."
1747 "Font Lock mode face used to highlight keywords."
1759 "Font Lock mode face used to highlight builtins."
1769 "Font Lock mode face used to highlight function names."
1783 "Font Lock mode face used to highlight variable names."
1795 "Font Lock mode face used to highlight type and classes."
1809 "Font Lock mode face used to highlight constants and labels."
1819 "Font Lock mode face used to highlight warnings."
1824 "Font Lock mode face used to highlight easy to overlook negation."
1829 "Font Lock mode face used to highlight preprocessor directives."
1834 "Font Lock mode face for backslashes in Lisp regexp grouping constructs."
1839 "Font Lock mode face used to highlight grouping constructs in Lisp regexps."
1842 ;;; End of Colour etc. support.
1843 \f
1844 ;;; Menu support.
1846 ;; This section of code is commented out because Emacs does not have real menu
1847 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1848 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1849 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1850 ;; the entry for "Text Properties" something like:
1851 ;;
1852 ;; (define-key menu-bar-edit-menu [font-lock]
1853 ;; (cons "Syntax Highlighting" font-lock-menu))
1854 ;;
1855 ;; and remove a single ";" from the beginning of each line in the rest of this
1856 ;; section. Probably the mechanism for telling the menu code what are menu
1857 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1858 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1860 ;;;;###autoload
1861 ;(progn
1862 ; ;; Make the Font Lock menu.
1863 ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1864 ; ;; Add the menu items in reverse order.
1865 ; (define-key font-lock-menu [fontify-less]
1866 ; '("Less In Current Buffer" . font-lock-fontify-less))
1867 ; (define-key font-lock-menu [fontify-more]
1868 ; '("More In Current Buffer" . font-lock-fontify-more))
1869 ; (define-key font-lock-menu [font-lock-sep]
1870 ; '("--"))
1871 ; (define-key font-lock-menu [font-lock-mode]
1872 ; '("In Current Buffer" . font-lock-mode))
1873 ; (define-key font-lock-menu [global-font-lock-mode]
1874 ; '("In All Buffers" . global-font-lock-mode)))
1875 ;
1876 ;;;;###autoload
1877 ;(progn
1878 ; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1879 ; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1880 ; (put 'global-font-lock-mode 'menu-toggle t)
1881 ; (put 'font-lock-mode 'menu-toggle t)
1882 ; (put 'font-lock-fontify-more 'menu-enable '(identity))
1883 ; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1884 ;
1885 ; ;; Put the appropriate symbol property values on now. See above.
1886 ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
1887 ;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1888 ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1889 ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1890 ;
1891 ;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1892 ;
1893 ;(defun font-lock-fontify-level (level)
1894 ; (let ((font-lock-maximum-decoration level))
1895 ; (when font-lock-mode
1896 ; (font-lock-mode))
1897 ; (font-lock-mode)
1898 ; (when font-lock-verbose
1899 ; (message "Fontifying %s... level %d" (buffer-name) level))))
1900 ;
1901 ;(defun font-lock-fontify-less ()
1902 ; "Fontify the current buffer with less decoration.
1903 ;See `font-lock-maximum-decoration'."
1904 ; (interactive)
1905 ; ;; Check in case we get called interactively.
1906 ; (if (nth 1 font-lock-fontify-level)
1907 ; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1908 ; (error "No less decoration")))
1909 ;
1910 ;(defun font-lock-fontify-more ()
1911 ; "Fontify the current buffer with more decoration.
1912 ;See `font-lock-maximum-decoration'."
1913 ; (interactive)
1914 ; ;; Check in case we get called interactively.
1915 ; (if (nth 2 font-lock-fontify-level)
1916 ; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1917 ; (error "No more decoration")))
1918 ;
1919 ; ;; This should be called by `font-lock-set-defaults'.
1920 ;(defun font-lock-set-menu ()
1921 ; ;; Activate less/more fontification entries if there are multiple levels for
1922 ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
1923 ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
1924 ; (let ((keywords (or (nth 0 font-lock-defaults)
1925 ; (nth 1 (assq major-mode font-lock-defaults-alist))))
1926 ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1927 ; (make-local-variable 'font-lock-fontify-level)
1928 ; (if (or (symbolp keywords) (= (length keywords) 1))
1929 ; (font-lock-unset-menu)
1930 ; (cond ((eq level t)
1931 ; (setq level (1- (length keywords))))
1932 ; ((or (null level) (zerop level))
1933 ; ;; The default level is usually, but not necessarily, level 1.
1934 ; (setq level (- (length keywords)
1935 ; (length (member (eval (car keywords))
1936 ; (mapcar 'eval (cdr keywords))))))))
1937 ; (setq font-lock-fontify-level (list level (> level 1)
1938 ; (< level (1- (length keywords))))))))
1939 ;
1940 ; ;; This should be called by `font-lock-unset-defaults'.
1941 ;(defun font-lock-unset-menu ()
1942 ; ;; Deactivate less/more fontification entries.
1943 ; (setq font-lock-fontify-level nil))
1945 ;;; End of Menu support.
1946 \f
1947 ;;; Various regexp information shared by several modes.
1948 ; ;; Information specific to a single mode should go in its load library.
1950 ;; Font Lock support for C, C++, Objective-C and Java modes is now in
1951 ;; cc-fonts.el (and required by cc-mode.el). However, the below function
1952 ;; should stay in font-lock.el, since it is used by other libraries. sm.
1955 "Match, and move over, any declaration/definition item after point.
1956 Matches after point, but ignores leading whitespace and `*' characters.
1957 Does not move further than LIMIT.
1959 The expected syntax of a declaration/definition item is `word' (preceded by
1960 optional whitespace and `*' characters and proceeded by optional whitespace)
1961 optionally followed by a `('. Everything following the item (but belonging to
1962 it) is expected to be skip-able by `scan-sexps', and items are expected to be
1963 separated with a `,' and to be terminated with a `;'.
1965 Thus the regexp matches after point: word (
1966 ^^^^ ^
1967 Where the match subexpressions are: 1 2
1969 The item is delimited by (match-beginning 1) and (match-end 1).
1970 If (match-beginning 2) is non-nil, the item is followed by a `('.
1972 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
1975 ;; If `word' is followed by a double open-paren, it's probably
1976 ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one
1977 ;; word to try and match `myfun' rather than `P_'.
1982 ;; Looks like it was something else, so go back to where we
1983 ;; were and reset the match data by rematching.
1989 ;; Restrict to the LIMIT.
1992 ;; Move over any item value, etc., to the next item.
1997 \f
1998 ;; Lisp.
2004 ;; Function declarations.
2010 ;; Variable declarations.
2012 ;; Structure declarations.
2015 ;; Any whitespace and defined object.
2022 nil t))
2023 ;; Emacs Lisp autoload cookies.
2025 ;; Regexp negated char group.
2042 "eval-when"
2043 "with-category-table"
2052 ;; Control structures. Common Lisp forms.
2073 ;; Exit/Feature symbols as constants.
2078 ;; Erroneous structures.
2079 ("(\\(abort\\|assert\\|warn\\|check-type\\|cerror\\|error\\|signal\\)\\>" 1 font-lock-warning-face)
2080 ;; Words inside \\[] tend to be for `substitute-command-keys'.
2082 ;; Words inside `' tend to be symbol names.
2084 ;; Constant values.
2086 ;; ELisp and CLisp `&' keywords as types.
2088 ;; ELisp regexp grouping constructs
2091 ;; The following loop is needed to continue searching after matches
2092 ;; that do not occur in strings. The associated regexp matches one
2093 ;; of `\\\\' `\\(' `\\(?:' `\\|' `\\)'. `\\\\' has been included to
2094 ;; avoid highlighting, for example, `\\(' in `\\\\('.
2095 (while (re-search-forward "\\(\\\\\\\\\\)\\(?:\\(\\\\\\\\\\)\\|\\((\\(?:\\?:\\)?\\|[|)]\\)\\)" bound t)
2104 ;;; This is too general -- rms.
2105 ;;; A user complained that he has functions whose names start with `do'
2106 ;;; and that they get the wrong color.
2107 ;;; ;; CL `with-' and `do-' constructs
2108 ;;; ("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
2109 )))
2114 \f
2117 ;; arch-tag: 682327e4-64d8-4057-b20b-1fbb9f1fc54c
2118 ;;; font-lock.el ends here