| blob | 80c9f62af7a71dfaadd6bb7a9f66776809228751 |
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, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Author: jwz, then rms, then sm
8 ;; Maintainer: FSF
9 ;; Keywords: languages, faces
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Commentary:
30 ;; Font Lock mode is a minor mode that causes your comments to be displayed in
31 ;; one face, strings in another, reserved words in another, and so on.
32 ;;
33 ;; Comments will be displayed in `font-lock-comment-face'.
34 ;; Strings will be displayed in `font-lock-string-face'.
35 ;; Regexps are used to display selected patterns in other faces.
36 ;;
37 ;; To make the text you type be fontified, use M-x font-lock-mode RET.
38 ;; When this minor mode is on, the faces of the current line are updated with
39 ;; every insertion or deletion.
40 ;;
41 ;; To turn Font Lock mode on automatically, add this to your ~/.emacs file:
42 ;;
43 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock)
44 ;;
45 ;; Or if you want to turn Font Lock mode on in many modes:
46 ;;
47 ;; (global-font-lock-mode t)
48 ;;
49 ;; Fontification for a particular mode may be available in a number of levels
50 ;; of decoration. The higher the level, the more decoration, but the more time
51 ;; it takes to fontify. See the variable `font-lock-maximum-decoration', and
52 ;; also the variable `font-lock-maximum-size'. Support modes for Font Lock
53 ;; mode can be used to speed up Font Lock mode. See `font-lock-support-mode'.
54 \f
55 ;;; How Font Lock mode fontifies:
57 ;; When Font Lock mode is turned on in a buffer, it (a) fontifies the entire
58 ;; buffer and (b) installs one of its fontification functions on one of the
59 ;; hook variables that are run by Emacs after every buffer change (i.e., an
60 ;; insertion or deletion). Fontification means the replacement of `face' text
61 ;; properties in a given region; Emacs displays text with these `face' text
62 ;; properties appropriately.
63 ;;
64 ;; Fontification normally involves syntactic (i.e., strings and comments) and
65 ;; regexp (i.e., keywords and everything else) passes. There are actually
66 ;; three passes; (a) the syntactic keyword pass, (b) the syntactic pass and (c)
67 ;; the keyword pass. Confused?
68 ;;
69 ;; The syntactic keyword pass places `syntax-table' text properties in the
70 ;; buffer according to the variable `font-lock-syntactic-keywords'. It is
71 ;; necessary because Emacs' syntax table is not powerful enough to describe all
72 ;; the different syntactic constructs required by the sort of people who decide
73 ;; that a single quote can be syntactic or not depending on the time of day.
74 ;; (What sort of person could decide to overload the meaning of a quote?)
75 ;; Obviously the syntactic keyword pass must occur before the syntactic pass.
76 ;;
77 ;; The syntactic pass places `face' text properties in the buffer according to
78 ;; syntactic context, i.e., according to the buffer's syntax table and buffer
79 ;; text's `syntax-table' text properties. It involves using a syntax parsing
80 ;; function to determine the context of different parts of a region of text. A
81 ;; syntax parsing function is necessary because generally strings and/or
82 ;; comments can span lines, and so the context of a given region is not
83 ;; necessarily apparent from the content of that region. Because the keyword
84 ;; pass only works within a given region, it is not generally appropriate for
85 ;; syntactic fontification. This is the first fontification pass that makes
86 ;; changes visible to the user; it fontifies strings and comments.
87 ;;
88 ;; The keyword pass places `face' text properties in the buffer according to
89 ;; the variable `font-lock-keywords'. It involves searching for given regexps
90 ;; (or calling given search functions) within the given region. This is the
91 ;; second fontification pass that makes changes visible to the user; it
92 ;; fontifies language reserved words, etc.
93 ;;
94 ;; Oh, and the answer is, "Yes, obviously just about everything should be done
95 ;; in a single syntactic pass, but the only syntactic parser available
96 ;; understands only strings and comments." Perhaps one day someone will write
97 ;; some syntactic parsers for common languages and a son-of-font-lock.el could
98 ;; use them rather then relying so heavily on the keyword (regexp) pass.
100 ;;; How Font Lock mode supports modes or is supported by modes:
102 ;; Modes that support Font Lock mode do so by defining one or more variables
103 ;; whose values specify the fontification. Font Lock mode knows of these
104 ;; variable names from (a) the buffer local variable `font-lock-defaults', if
105 ;; non-nil, or (b) the global variable `font-lock-defaults-alist', if the major
106 ;; mode has an entry. (Font Lock mode is set up via (a) where a mode's
107 ;; patterns are distributed with the mode's package library, and (b) where a
108 ;; mode's patterns are distributed with font-lock.el itself. An example of (a)
109 ;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is
110 ;; (a); (b) is used where it is not clear which package library should contain
111 ;; the pattern definitions.) Font Lock mode chooses which variable to use for
112 ;; fontification based on `font-lock-maximum-decoration'.
113 ;;
114 ;; Font Lock mode fontification behaviour can be modified in a number of ways.
115 ;; See the below comments and the comments distributed throughout this file.
117 ;;; Constructing patterns:
119 ;; See the documentation for the variable `font-lock-keywords'.
120 ;;
121 ;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and
122 ;; `font-lock-syntactic-keywords' can be generated via the function
123 ;; `regexp-opt'.
125 ;;; Adding patterns for modes that already support Font Lock:
127 ;; Though Font Lock highlighting patterns already exist for many modes, it's
128 ;; likely there's something that you want fontified that currently isn't, even
129 ;; at the maximum fontification level. You can add highlighting patterns via
130 ;; `font-lock-add-keywords'. For example, say in some C
131 ;; header file you #define the token `and' to expand to `&&', etc., to make
132 ;; your C code almost readable. In your ~/.emacs there could be:
133 ;;
134 ;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>"))
135 ;;
136 ;; Some modes provide specific ways to modify patterns based on the values of
137 ;; other variables. For example, additional C types can be specified via the
138 ;; variable `c-font-lock-extra-types'.
140 ;;; Adding patterns for modes that do not support Font Lock:
142 ;; Not all modes support Font Lock mode. If you (as a user of the mode) add
143 ;; patterns for a new mode, you must define in your ~/.emacs a variable or
144 ;; variables that specify regexp fontification. Then, you should indicate to
145 ;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what
146 ;; support is required. For example, say Foo mode should have the following
147 ;; regexps fontified case-sensitively, and comments and strings should not be
148 ;; fontified automagically. In your ~/.emacs there could be:
149 ;;
150 ;; (defvar foo-font-lock-keywords
151 ;; '(("\\<\\(one\\|two\\|three\\)\\>" . font-lock-keyword-face)
152 ;; ("\\<\\(four\\|five\\|six\\)\\>" . font-lock-type-face))
153 ;; "Default expressions to highlight in Foo mode.")
154 ;;
155 ;; (add-hook 'foo-mode-hook
156 ;; (lambda ()
157 ;; (set (make-local-variable 'font-lock-defaults)
158 ;; '(foo-font-lock-keywords t))))
160 ;;; Adding Font Lock support for modes:
162 ;; Of course, it would be better that the mode already supports Font Lock mode.
163 ;; The package author would do something similar to above. The mode must
164 ;; define at the top-level a variable or variables that specify regexp
165 ;; fontification. Then, the mode command should indicate to Font Lock mode,
166 ;; via `font-lock-defaults', exactly what support is required. For example,
167 ;; say Bar mode should have the following regexps fontified case-insensitively,
168 ;; and comments and strings should be fontified automagically. In bar.el there
169 ;; could be:
170 ;;
171 ;; (defvar bar-font-lock-keywords
172 ;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . font-lock-keyword-face)
173 ;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . font-lock-type-face))
174 ;; "Default expressions to highlight in Bar mode.")
175 ;;
176 ;; and within `bar-mode' there could be:
177 ;;
178 ;; (set (make-local-variable 'font-lock-defaults)
179 ;; '(bar-font-lock-keywords nil t))
180 \f
181 ;; What is fontification for? You might say, "It's to make my code look nice."
182 ;; I think it should be for adding information in the form of cues. These cues
183 ;; should provide you with enough information to both (a) distinguish between
184 ;; different items, and (b) identify the item meanings, without having to read
185 ;; the items and think about it. Therefore, fontification allows you to think
186 ;; less about, say, the structure of code, and more about, say, why the code
187 ;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
188 ;;
189 ;; So, here are my opinions/advice/guidelines:
190 ;;
191 ;; - Highlight conceptual objects, such as function and variable names, and
192 ;; different objects types differently, i.e., (a) and (b) above, highlight
193 ;; function names differently to variable names.
194 ;; - Keep the faces distinct from each other as far as possible.
195 ;; i.e., (a) above.
196 ;; - Use the same face for the same conceptual object, across all modes.
197 ;; i.e., (b) above, all modes that have items that can be thought of as, say,
198 ;; keywords, should be highlighted with the same face, etc.
199 ;; - Make the face attributes fit the concept as far as possible.
200 ;; i.e., function names might be a bold colour such as blue, comments might
201 ;; be a bright colour such as red, character strings might be brown, because,
202 ;; err, strings are brown (that was not the reason, please believe me).
203 ;; - Don't use a non-nil OVERRIDE unless you have a good reason.
204 ;; Only use OVERRIDE for special things that are easy to define, such as the
205 ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
206 ;; Don't use it to, say, highlight keywords in commented out code or strings.
207 ;; - Err, that's it.
208 \f
209 ;;; Code:
213 ;; Define core `font-lock' group.
215 "Font Lock mode text highlighting package."
221 "Faces for highlighting text."
226 "Extra mode-specific type names for highlighting declarations."
228 \f
229 ;; User variables.
232 "*Maximum size of a buffer for buffer fontification.
233 Only buffers less than this can be fontified when Font Lock mode is turned on.
234 If nil, means size is irrelevant.
235 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
236 where MAJOR-MODE is a symbol or t (meaning the default). For example:
237 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
238 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
239 for buffers in Rmail mode, and size is irrelevant otherwise."
254 "*Maximum decoration level for fontification.
255 If nil, use the default decoration (typically the minimum available).
256 If t, use the maximum decoration available.
257 If a number, use that level of decoration (or if not available the maximum).
258 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
259 where MAJOR-MODE is a symbol or t (meaning the default). For example:
260 ((c-mode . t) (c++-mode . 2) (t . 1))
261 means use the maximum decoration available for buffers in C mode, level 2
262 decoration for buffers in C++ mode, and level 1 decoration otherwise."
279 "*If non-nil, means show status messages for buffer fontification.
280 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.
327 "Face name to use for easy to overlook negation.
336 ;; Fontification variables:
339 "A list of the keywords to highlight.
340 There are two kinds of values: user-level, and compiled.
342 A user-level keywords list is what a major mode or the user would
343 set up. Normally the list would come from `font-lock-defaults'.
344 through selection of a fontification level and evaluation of any
345 contained expressions. You can also alter it by calling
346 `font-lock-add-keywords' or `font-lock-remove-keywords' with MODE = nil.
348 Each element in a user-level keywords list should have one of these forms:
350 MATCHER
351 (MATCHER . SUBEXP)
352 (MATCHER . FACENAME)
353 (MATCHER . HIGHLIGHT)
354 (MATCHER HIGHLIGHT ...)
355 (eval . FORM)
357 where MATCHER can be either the regexp to search for, or the function name to
358 call to make the search (called with one argument, the limit of the search;
359 it should return non-nil, move point, and set `match-data' appropriately if
360 it succeeds; like `re-search-forward' would).
361 MATCHER regexps can be generated via the function `regexp-opt'.
363 FORM is an expression, whose value should be a keyword element, evaluated when
364 the keyword is (first) used in a buffer. This feature can be used to provide a
365 keyword that can only be generated when Font Lock mode is actually turned on.
367 HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
370 typically only MATCH-HIGHLIGHT is required.
371 However, if an item or (typically) items are to be highlighted following the
372 instance of another item (the anchor), for example each instance of the
375 MATCH-HIGHLIGHT should be of the form:
377 (SUBEXP FACENAME [OVERRIDE [LAXMATCH]])
379 SUBEXP is the number of the subexpression of MATCHER to be highlighted.
381 FACENAME is an expression whose value is the face name to use.
382 Instead of a face, FACENAME can evaluate to a property list
383 of the form (face FACE PROP1 VAL1 PROP2 VAL2 ...)
384 in which case all the listed text-properties will be set rather than
385 just FACE. In such a case, you will most likely want to put those
386 properties in `font-lock-extra-managed-props' or to override
387 `font-lock-unfontify-region-function'.
389 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
390 be overwritten. If `keep', only parts not already fontified are highlighted.
391 If `prepend' or `append', existing fontification is merged with the new, in
392 which the new or existing fontification, respectively, takes precedence.
393 If LAXMATCH is non-nil, that means don't signal an error if there is
394 no match for SUBEXP in MATCHER.
396 For example, an element of the form highlights (if not already highlighted):
399 variable `font-lock-keyword-face'.
401 the value of `font-lock-keyword-face'.
405 of `foo-bar-face', even if already highlighted.
406 (fubar-match 1 fubar-face)
407 the first subexpression within all occurrences of
408 whatever the function `fubar-match' finds and matches
409 in the value of `fubar-face'.
411 MATCH-ANCHORED should be of the form:
413 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
415 where MATCHER is a regexp to search for or the function name to call to make
416 the search, as for MATCH-HIGHLIGHT above, but with one exception; see below.
417 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
418 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
419 used to initialize before, and cleanup after, MATCHER is used. Typically,
420 PRE-MATCH-FORM is used to move to some position relative to the original
421 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
422 be used to move back, before resuming with MATCH-ANCHORED's parent's MATCHER.
424 For example, an element of the form highlights (if not already highlighted):
435 The above-mentioned exception is as follows. The limit of the MATCHER search
436 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
437 However, if PRE-MATCH-FORM returns a position greater than the position after
438 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
439 It is generally a bad idea to return a position greater than the end of the
440 line, i.e., cause the MATCHER search to span lines.
442 These regular expressions can match text which spans lines, although
443 it is better to avoid it if possible since updating them while editing
444 text is slower, and it is not guaranteed to be always correct when using
445 support modes like jit-lock or lazy-lock.
447 This variable is set by major modes via the variable `font-lock-defaults'.
448 Be careful when composing regexps for this list; a poorly written pattern can
449 dramatically slow things down!
451 A compiled keywords list starts with t. It is produced internal
452 by `font-lock-compile-keywords' from a user-level keywords list.
453 Its second element is the user-level keywords list that was
454 compiled. The remaining elements have the same form as
455 user-level keywords, but normally their values have been
459 "Alist of additional `font-lock-keywords' elements for major modes.
461 Each element has the form (MODE KEYWORDS . HOW).
462 `font-lock-set-defaults' adds the elements in the list KEYWORDS to
463 `font-lock-keywords' when Font Lock is turned on in major mode MODE.
465 If HOW is nil, KEYWORDS are added at the beginning of
466 `font-lock-keywords'. If it is `set', they are used to replace the
467 value of `font-lock-keywords'. If HOW is any other non-nil value,
468 they are added at the end.
470 This is normally set via `font-lock-add-keywords' and
475 "Alist of `font-lock-keywords' elements to be removed for major modes.
477 Each element has the form (MODE . KEYWORDS). `font-lock-set-defaults'
478 removes the elements in the list KEYWORDS from `font-lock-keywords'
479 when Font Lock is turned on in major mode MODE.
481 This is normally set via `font-lock-add-keywords' and
485 "*Non-nil means Font Lock should not fontify comments or strings.
489 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
494 "Point up to which `font-lock-syntactic-keywords' has been applied.
495 If nil, this is ignored, in which case the syntactic fontification may
502 "Function to determine which face to use when fontifying syntactically.
503 The function is called with a single parameter (the state as returned by
504 `parse-partial-sexp' at the beginning of the region to highlight) and
508 "A list of the syntactic keywords to put syntax properties on.
509 The value can be the list itself, or the name of a function or variable
510 whose value is the list.
512 See `font-lock-keywords' for a description of the form of this list;
513 only the differences are stated here. MATCH-HIGHLIGHT should be of the form:
515 (SUBEXP SYNTAX OVERRIDE LAXMATCH)
517 where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax
518 table, a cons cell (as returned by `string-to-syntax') or an expression whose
519 value is such a form. OVERRIDE cannot be `prepend' or `append'.
521 Here are two examples of elements of `font-lock-syntactic-keywords'
522 and what they do:
527 dollar-sign character. Hash characters in other contexts will still
528 follow whatever the syntax table says about the hash character.
534 gives a pair single-quotes, which surround a single character, a SYNTAX of
536 contexts will not be affected.
541 "Non-nil means use this syntax table for fontifying.
542 If this is nil, the major mode's syntax table is used.
546 "*Non-nil means use this function to move back outside all constructs.
547 When called with no args it should move point backward to a place which
548 is not in a string or comment and not within any bracket-pairs (or else,
549 a place such that any bracket-pairs outside it can be ignored for Emacs
550 syntax analysis and fontification).
552 If this is nil, Font Lock uses `syntax-begin-function' to move back
553 outside of any comment, string, or sexp. This variable is semi-obsolete;
554 we recommend setting `syntax-begin-function' instead.
559 "*Non-nil means use this function to mark a block of text.
560 When called with no args it should leave point at the beginning of any
561 enclosing textual block and mark at the end.
565 "Function to use for fontifying the buffer.
569 "Function to use for unfontifying the buffer.
570 This is used when turning off Font Lock mode.
574 "Function to use for fontifying a region.
575 It should take two args, the beginning and end of the region, and an optional
576 third arg VERBOSE. If VERBOSE is non-nil, the function should print status
580 "Function to use for unfontifying a region.
581 It should take two args, the beginning and end of the region.
585 "List of Font Lock mode related modes that should not be turned on.
586 Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
590 "Whether font-lock should cater to multiline keywords.
591 If nil, don't try to handle multiline patterns.
592 If t, always handle multiline patterns.
593 If `undecided', don't try to handle multiline patterns until you see one.
597 \f
598 ;; Font Lock mode.
601 ;;
602 ;; We don't do this at the top-level as we only use non-autoloaded macros.
604 ;;
605 ;; Borrowed from lazy-lock.el.
606 ;; We use this to preserve or protect things when modifying text properties.
608 "Bind variables according to VARLIST and eval BODY restoring buffer state."
617 deactivate-mark
618 buffer-file-name
619 buffer-file-truename))
625 ;;
626 ;; Shut up the byte compiler.
630 ;; Turn on Font Lock mode.
635 ;; Fontify the buffer if we have to.
638 nil)
644 ;; Turn off Font Lock mode.
651 "Add highlighting KEYWORDS for MODE.
653 MODE should be a symbol, the major mode command name, such as `c-mode'
654 or nil. If nil, highlighting keywords are added for the current buffer.
655 KEYWORDS should be a list; see the variable `font-lock-keywords'.
656 By default they are added at the beginning of the current highlighting list.
657 If optional argument HOW is `set', they are used to replace the current
658 highlighting list. If HOW is any other non-nil value, they are added at the
659 end of the current highlighting list.
661 For example:
663 (font-lock-add-keywords 'c-mode
667 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
668 comments, and to fontify `and', `or' and `not' words as keywords.
670 The above procedure will only add the keywords for C mode, not
671 for modes derived from C mode. To add them for derived modes too,
672 pass nil for MODE and add the call to c-mode-hook.
674 For example:
676 (add-hook 'c-mode-hook
677 (lambda ()
678 (font-lock-add-keywords nil
681 font-lock-keyword-face)))))
683 The above procedure may fail to add keywords to derived modes if
684 some involved major mode does not follow the standard conventions.
685 File a bug report if this happens, so the major mode can be corrected.
687 Note that some modes have specialized support for additional patterns, e.g.,
688 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
689 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
691 ;; If MODE is non-nil, add the KEYWORDS and HOW spec to
692 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
699 ;; Make sure that `font-lock-removed-keywords-alist' does not
700 ;; contain the new keywords.
705 ;; The major mode has not set any keywords, so when we enabled
706 ;; font-lock-mode it only enabled the font-core.el part, not the
707 ;; font-lock-mode-internal. Try again.
711 ;; Otherwise set or add the keywords now.
712 ;; This is a no-op if it has been done already in this buffer
713 ;; for the correct major mode.
716 ;; Bring back the user-level (uncompiled) keywords.
719 ;; Now modify or replace them.
725 font-lock-keywords)))
729 ;; If the keywords were compiled before, compile them again.
735 "Update `font-lock-removed-keywords-alist' when adding new KEYWORDS to MODE."
736 ;; When font-lock is enabled first all keywords in the list
737 ;; `font-lock-keywords-alist' are added, then all keywords in the
738 ;; list `font-lock-removed-keywords-alist' are removed. If a
739 ;; keyword was once added, removed, and then added again it must be
740 ;; removed from the removed-keywords list. Otherwise the second add
741 ;; will not take effect.
745 ;; A new set of keywords is defined. Forget all about
746 ;; our old keywords that should be removed.
749 ;; Delete all previously removed keywords.
752 ;; Delete the mode cell if empty.
757 ;; Written by Anders Lindgren <andersl@andersl.com>.
758 ;;
759 ;; Case study:
760 ;; (I) The keywords are removed from a major mode.
761 ;; In this case the keyword could be local (i.e. added earlier by
762 ;; `font-lock-add-keywords'), global, or both.
763 ;;
764 ;; (a) In the local case we remove the keywords from the variable
765 ;; `font-lock-keywords-alist'.
766 ;;
767 ;; (b) The actual global keywords are not known at this time.
768 ;; All keywords are added to `font-lock-removed-keywords-alist',
769 ;; when font-lock is enabled those keywords are removed.
770 ;;
771 ;; Note that added keywords are taken out of the list of removed
772 ;; keywords. This ensure correct operation when the same keyword
773 ;; is added and removed several times.
774 ;;
775 ;; (II) The keywords are removed from the current buffer.
777 "Remove highlighting KEYWORDS for MODE.
779 MODE should be a symbol, the major mode command name, such as `c-mode'
780 or nil. If nil, highlighting keywords are removed for the current buffer.
782 To make the removal apply to modes derived from MODE as well,
783 pass nil for MODE and add the call to MODE-hook. This may fail
784 for some derived modes if some involved major mode does not
785 follow the standard conventions. File a bug report if this
786 happens, so the major mode can be corrected."
788 ;; Remove one keyword at the time.
791 ;; If MODE is non-nil, remove the KEYWORD from
792 ;; `font-lock-keywords-alist'.
795 ;; `keywords-list-how-pair' is a cons with a list of
796 ;; keywords in the car top-cell and the original how
797 ;; argument in the cdr top-cell.
800 ;; Remove keyword list/how pair when the keyword list
801 ;; is empty and how doesn't specify `set'. (If it
802 ;; should be deleted then previously deleted keywords
803 ;; would appear again.)
810 ;; Final cleanup, remove major mode cell if last keyword
811 ;; was deleted.
815 ;; Remember the keyword in case it is not local.
821 font-lock-removed-keywords-alist))))))
823 ;; Otherwise remove it immediately.
826 ;; Bring back the user-level (uncompiled) keywords.
830 ;; Edit them.
836 ;; If the keywords were compiled before, compile them again.
840 \f
841 ;;; Font Lock Support mode.
843 ;; This is the code used to interface font-lock.el with any of its add-on
844 ;; packages, and provide the user interface. Packages that have their own
845 ;; local buffer fontification functions (see below) may have to call
846 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
847 ;; themselves.
850 "*Support mode for Font Lock mode.
851 Support modes speed up Font Lock mode by being choosy about when fontification
852 occurs. The default support mode, Just-in-time Lock mode (symbol
853 `jit-lock-mode'), is recommended.
855 Other, older support modes are Fast Lock mode (symbol `fast-lock-mode') and
856 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
857 However, they are no longer recommended, as Just-in-time Lock mode is better.
859 If nil, means support for Font Lock mode is never performed.
860 If a symbol, use that support mode.
861 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
862 where MAJOR-MODE is a symbol or t (meaning the default). For example:
863 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
864 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
865 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
867 The value of this variable is used when Font Lock mode is turned on."
883 ))
905 ;; Prepare for jit-lock
910 ;; Don't fontify eagerly (and don't abort if the buffer is large).
912 ;; Use jit-lock.
915 ;; Tell jit-lock how we extend the region to refontify.
917 'font-lock-extend-jit-lock-region-after-change
918 nil t)))))
925 ;; Reset local vars to the non-jit-lock case.
933 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
934 ;; (jit-lock-mode
935 ;; (jit-lock-after-fontify-buffer))
942 ;; Useless as well. It's only called when:
943 ;; - turning off font-lock: it does not matter if we leave spurious
944 ;; `fontified' text props around since jit-lock-mode is also off.
945 ;; - font-lock-default-fontify-buffer fails: this is not run
946 ;; any more anyway. -sm
947 ;;
948 ;; (jit-lock-mode
949 ;; (jit-lock-after-unfontify-buffer))
953 ;;; End of Font Lock Support mode.
954 \f
955 ;;; Fontification functions.
957 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
958 ;; code to fontify a region, the function runs the function whose name is the
959 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
960 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
961 ;; which does contain the code to fontify a region. However, the value of the
962 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
963 ;; do anything. The indirection of the fontification functions gives major
964 ;; modes the capability of modifying the way font-lock.el fontifies. Major
965 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
966 ;; via the variable `font-lock-defaults'.
967 ;;
968 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
969 ;; font-lock.el uses its own function for buffer fontification. This function
970 ;; makes fontification be on a message-by-message basis and so visiting an
971 ;; RMAIL file is much faster. A clever implementation of the function might
972 ;; fontify the headers differently than the message body. (It should, and
973 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
974 ;; you?) This hints at a more interesting use...
975 ;;
976 ;; Languages that contain text normally contained in different major modes
977 ;; could define their own fontification functions that treat text differently
978 ;; depending on its context. For example, Perl mode could arrange that here
979 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
980 ;; rules one way and C code another. Neat!
981 ;;
982 ;; A further reason to use the fontification indirection feature is when the
983 ;; default syntactual fontification, or the default fontification in general,
984 ;; is not flexible enough for a particular major mode. For example, perhaps
985 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
986 ;; cope with. You need to write your own version of that function, e.g.,
987 ;; `hairy-fontify-syntactically-region', and make your own version of
988 ;; `hairy-fontify-region' call that function before calling
989 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
990 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
991 ;; would call your region fontification function instead of its own. For
992 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
993 ;; directives correctly and cleanly. (It is the same problem as fontifying
994 ;; multi-line strings and comments; regexps are not appropriate for the job.)
997 "A function that determines the region to refontify after a change.
999 This variable is either nil, or is a function that determines the
1000 region to refontify after a change.
1001 It is usually set by the major mode via `font-lock-defaults'.
1002 Font-lock calls this function after each buffer change.
1004 The function is given three parameters, the standard BEG, END, and OLD-LEN
1005 from `after-change-functions'. It should return either a cons of the beginning
1006 and end buffer positions \(in that order) of the region to refontify, or nil
1007 \(which directs the caller to fontify a default region).
1008 This function should preserve the match-data.
1013 "Fontify the current buffer the way the function `font-lock-mode' would."
1033 font-lock-verbose)))
1037 ;; Make sure we fontify etc. in the whole buffer.
1046 ;; We don't restore the old fontification, so it's best to unfontify.
1050 ;; Make sure we unfontify etc. in the whole buffer.
1058 "If non-nil, font-lock will work on the non-widened buffer.
1059 Useful for things like RMAIL and Info where the whole buffer is not
1066 ;; This use of font-lock-multiline property is unreliable but is just
1067 ;; a handy heuristic: in case you don't have a function that does
1068 ;; /identification/ of multiline elements, you may still occasionally
1069 ;; discover them by accident (or you may /identify/ them but not in all
1070 ;; cases), in which case the font-lock-multiline property can help make
1071 ;; sure you will properly *re*identify them during refontification.
1072 font-lock-extend-region-multiline)
1073 "Special hook run just before proceeding to fontify a region.
1074 This is used to allow major modes to help font-lock find safe buffer positions
1075 as beginning and end of the fontified region. Its most common use is to solve
1076 the problem of /identification/ of multiline elements by providing a function
1077 that tries to find such elements and move the boundaries such that they do
1078 not fall in the middle of one.
1079 Each function is called with no argument; it is expected to adjust the
1080 dynamically bound variables `font-lock-beg' and `font-lock-end'; and return
1081 non-nil if it did make such an adjustment.
1082 These functions are run in turn repeatedly until they all return nil.
1084 ;; Mark it as a special hook which doesn't use any global setting
1085 ;; (i.e. doesn't obey the element t in the buffer-local value).
1089 "Move fontification boundaries away from any `font-lock-multiline' property."
1097 ;;
1103 changed))
1106 "Move fontification boundaries to beginning of lines."
1116 changed))
1126 ;; Use the fontification syntax table, if any.
1129 ;; Extend the region to fontify so that it starts and ends at
1130 ;; safe places.
1138 ;; If there's been a change, we should go through
1139 ;; the list again since this new position may
1140 ;; warrant a different answer from one of the fun
1141 ;; we've already seen.
1142 font-lock-extend-region-functions)))
1144 ;; Now do the fontification.
1151 ;; Clean up.
1154 ;; The following must be rethought, since keywords can override fontification.
1155 ;; ;; Now scan for keywords, but not if we are inside a comment now.
1156 ;; (or (and (not font-lock-keywords-only)
1157 ;; (let ((state (parse-partial-sexp beg end nil nil
1158 ;; font-lock-cache-state)))
1159 ;; (or (nth 4 state) (nth 7 state))))
1160 ;; (font-lock-fontify-keywords-region beg end))
1163 "Additional text properties managed by font-lock.
1164 This is used by `font-lock-default-unfontify-region' to decide
1170 font-lock-extra-managed-props
1175 ;; Called when any modification is made to buffer text.
1182 beg end old-len))))
1185 ;; Fontify the region the major mode has specified.
1187 ;; Fontify the whole lines which enclose the region.
1188 ;; Actually, this is not needed because
1189 ;; font-lock-default-fontify-region already rounds up to a whole
1190 ;; number of lines.
1191 ;; (setq beg (progn (goto-char beg) (line-beginning-position))
1192 ;; end (progn (goto-char end) (line-beginning-position 2)))
1194 ;; Rounding up to a whole number of lines should include the
1195 ;; line right after `end'. Typical case: the first char of
1196 ;; the line was deleted. Or a \n was inserted in the middle
1197 ;; of a line.
1203 "Function meant for `jit-lock-after-change-extend-region-functions'.
1204 This function does 2 things:
1205 - extend the region so that it not only includes the part that was modified
1206 but also the surrounding text whose highlighting may change as a consequence.
1207 - anticipate (part of) the region extension that will happen later in
1208 `font-lock-default-fontify-region', in order to avoid the need for
1209 double-redisplay in `jit-lock-fontify-now'."
1211 ;; First extend the region as font-lock-after-change-function would.
1214 beg end old-len))))
1218 ;; Then extend the region obeying font-lock-multiline properties,
1219 ;; indicating which part of the buffer needs to be refontified.
1220 ;; !!! This is the *main* user of font-lock-multiline property !!!
1221 ;; font-lock-after-change-function could/should also do that, but it
1222 ;; doesn't need to because font-lock-default-fontify-region does
1223 ;; it anyway. Here OTOH we have no guarantee that
1224 ;; font-lock-default-fontify-region will be executed on this region
1225 ;; any time soon.
1226 ;; Note: contrary to font-lock-default-fontify-region, we do not do
1227 ;; any loop here because we are not looking for a safe spot: we just
1228 ;; mark the text whose appearance may need to change as a result of
1229 ;; the buffer modification.
1241 ;; Rounding up to a whole number of lines should include the
1242 ;; line right after `end'. Typical case: the first char of
1243 ;; the line was deleted. Or a \n was inserted in the middle
1244 ;; of a line.
1246 ;; Finally, pre-enlarge the region to a whole number of lines, to try
1247 ;; and anticipate what font-lock-default-fontify-region will do, so as to
1248 ;; avoid double-redisplay.
1249 ;; We could just run `font-lock-extend-region-functions', but since
1250 ;; the only purpose is to avoid the double-redisplay, we prefer to
1251 ;; do here only the part that is cheap and most likely to be useful.
1253 font-lock-extend-region-functions)
1262 "Fontify some lines the way `font-lock-fontify-buffer' would.
1263 The lines could be a function or paragraph, or a specified number of lines.
1264 If ARG is given, fontify that many lines before and after point, or 16 lines if
1265 no ARG is given and `font-lock-mark-block-function' is nil.
1266 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1267 delimit the region to fontify."
1270 deactivate-mark)
1271 ;; Make sure we have the right `font-lock-keywords' etc.
1285 ;;; End of Fontification functions.
1286 \f
1287 ;;; Additional text property functions.
1289 ;; The following text property functions should be builtins. This means they
1290 ;; should be written in C and put with all the other text property functions.
1291 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1292 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1293 ;; in Lisp below and commented out. sm.
1296 "Prepend to one property of the text from START to END.
1297 Arguments PROP and VALUE specify the property and value to prepend to the value
1298 already in place. The resulting property values are always lists.
1299 Optional argument OBJECT is the string or buffer containing the text."
1304 ;; Canonicalize old forms of face property.
1312 object)
1316 "Append to one property of the text from START to END.
1317 Arguments PROP and VALUE specify the property and value to append to the value
1318 already in place. The resulting property values are always lists.
1319 Optional argument OBJECT is the string or buffer containing the text."
1324 ;; Canonicalize old forms of face property.
1332 object)
1336 "Fill in one property of the text from START to END.
1337 Arguments PROP and VALUE specify the property and value to put where none are
1338 already in place. Therefore existing property values are not overwritten.
1339 Optional argument OBJECT is the string or buffer containing the text."
1346 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1347 ;; is to `add-text-properties', etc.
1348 ;;(defun remove-text-property (start end property &optional object)
1349 ;; "Remove a property from text from START to END.
1350 ;;Argument PROPERTY is the property to remove.
1351 ;;Optional argument OBJECT is the string or buffer containing the text.
1352 ;;Return t if the property was actually removed, nil otherwise."
1353 ;; (remove-text-properties start end (list property) object))
1355 ;; For consistency: maybe this should be called `remove-single-property' like
1356 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1357 ;;(defun remove-single-text-property (start end prop value &optional object)
1358 ;; "Remove a specific property value from text from START to END.
1359 ;;Arguments PROP and VALUE specify the property and value to remove. The
1360 ;;resulting property values are not equal to VALUE nor lists containing VALUE.
1361 ;;Optional argument OBJECT is the string or buffer containing the text."
1362 ;; (let ((start (text-property-not-all start end prop nil object)) next prev)
1363 ;; (while start
1364 ;; (setq next (next-single-property-change start prop object end)
1365 ;; prev (get-text-property start prop object))
1366 ;; (cond ((and (symbolp prev) (eq value prev))
1367 ;; (remove-text-property start next prop object))
1368 ;; ((and (listp prev) (memq value prev))
1369 ;; (let ((new (delq value prev)))
1370 ;; (cond ((null new)
1371 ;; (remove-text-property start next prop object))
1372 ;; ((= (length new) 1)
1373 ;; (put-text-property start next prop (car new) object))
1374 ;; (t
1375 ;; (put-text-property start next prop new object))))))
1376 ;; (setq start (text-property-not-all next end prop nil object)))))
1378 ;;; End of Additional text property functions.
1379 \f
1380 ;;; Syntactic regexp fontification functions.
1382 ;; These syntactic keyword pass functions are identical to those keyword pass
1383 ;; functions below, with the following exceptions; (a) they operate on
1384 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1385 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1386 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1387 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1388 ;; LOUDLY as it is not likely to be intensive.
1391 "Apply HIGHLIGHT following a match.
1392 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1393 see `font-lock-syntactic-keywords'."
1399 ;; No match but we might not signal an error.
1405 ;; Flush the syntax-cache. I believe this is not necessary for
1406 ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can
1407 ;; still be necessary for other users of syntax-ppss anyway.
1411 ;; Cannot override existing fontification.
1415 ;; Override existing fontification.
1418 ;; Keep existing fontification.
1422 "Fontify according to KEYWORDS until LIMIT.
1423 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1424 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1426 ;; Evaluate PRE-MATCH-FORM.
1428 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1433 ;; Find an occurrence of `matcher' before `limit'.
1437 ;; Apply each highlight to this instance of `matcher'.
1442 ;; Evaluate POST-MATCH-FORM.
1446 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1447 START should be at the beginning of a line."
1448 ;; Ensure the beginning of the file is properly syntactic-fontified.
1453 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1456 font-lock-syntactic-keywords)))
1457 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1460 font-lock-syntactic-keywords
1461 t)))
1462 ;; Get down to business.
1465 keyword matcher highlights)
1467 ;; Find an occurrence of `matcher' from `start' to `end'.
1473 ;; Apply each highlight to this instance of `matcher', which may be
1474 ;; specific highlights or more keywords anchored to `matcher'.
1480 end))
1484 ;;; End of Syntactic regexp fontification functions.
1485 \f
1486 ;;; Syntactic fontification functions.
1495 "Put proper face on each string and comment between START and END.
1496 START should be at the beginning of a line."
1501 state face beg)
1504 ;;
1505 ;; Find the `start' state.
1507 ;;
1508 ;; Find each interesting place between here and `end'.
1519 comment-start-skip))
1520 ;; Find the comment delimiters
1521 ;; and use font-lock-comment-delimiter-face for them.
1525 comment-start-skip))
1527 font-lock-comment-delimiter-face)))
1530 font-lock-comment-delimiter-face))))
1535 ;;; End of Syntactic fontification functions.
1536 \f
1537 ;;; Keyword regexp fontification functions.
1540 "Apply HIGHLIGHT following a match.
1541 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1546 ;; No match but we might not signal an error.
1555 ;; If `val' is nil, don't do anything. It is important to do it
1556 ;; explicitly, because when adding nil via things like
1557 ;; font-lock-append-text-property, the property is actually
1558 ;; changed from <face> to (<face>) which is undesirable. --Stef
1559 nil)
1561 ;; Cannot override existing fontification.
1565 ;; Override existing fontification.
1568 ;; Prepend to existing fontification.
1571 ;; Append to existing fontification.
1574 ;; Keep existing fontification.
1578 "Fontify according to KEYWORDS until LIMIT.
1579 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1580 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1583 ;; Evaluate PRE-MATCH-FORM.
1585 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1590 ;; this is a multiline anchored match
1591 ;; (setq font-lock-multiline t)
1595 limit
1598 ;; Find an occurrence of `matcher' before `limit'.
1603 ;; Apply each highlight to this instance of `matcher'.
1608 ;; Evaluate POST-MATCH-FORM.
1612 "Fontify according to `font-lock-keywords' between START and END.
1613 START should be at the beginning of a line.
1614 LOUDLY, if non-nil, allows progress-meter bar."
1622 keyword matcher highlights)
1623 ;;
1624 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1628 ;;
1629 ;; Find an occurrence of `matcher' from `start' to `end'.
1636 ;; Beware empty string matches since they will
1637 ;; loop indefinitely.
1644 ;; this is a multiline regexp match
1645 ;; (setq font-lock-multiline t)
1654 ;; Apply each highlight to this instance of `matcher', which may be
1655 ;; specific highlights or more keywords anchored to `matcher'.
1662 ;; Ensure forward progress. `pos' is a marker because anchored
1663 ;; keyword may add/delete text (this happens e.g. in grep.el).
1669 ;;; End of Keyword regexp fontification functions.
1670 \f
1671 ;; Various functions.
1674 "Compile KEYWORDS into the form (t KEYWORDS COMPILED...)
1675 Here each COMPILED is of the form (MATCHER HIGHLIGHT ...) as shown in the
1676 `font-lock-keywords' doc string.
1677 If SYNTACTIC-KEYWORDS is non-nil, it means these keywords are used for
1678 `font-lock-syntactic-keywords' rather than for `font-lock-keywords'."
1680 ;; This should never happen. But some external packages sometimes
1681 ;; call font-lock in unexpected and incorrect ways. It's important to
1682 ;; stop processing at this point, otherwise we may end up changing the
1683 ;; global value of font-lock-keywords and break highlighting in many
1684 ;; other buffers.
1687 keywords
1694 syntax-begin-function)))
1698 ;; Try to detect when a string or comment contains something that
1699 ;; looks like a defun and would thus confuse font-lock.
1707 font-lock-comment-face))
1710 prepend)))))
1711 keywords))
1719 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1730 keyword)))
1733 "Evalulate KEYWORDS if a function (funcall) or variable (eval) name."
1735 keywords
1741 "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1742 Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
1745 alist))
1748 "Return LEVELth element of KEYWORDS.
1749 A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1750 \(1- (length KEYWORDS))."
1752 keywords)
1764 "Set fontification defaults appropriately for this mode.
1765 Sets various variables using `font-lock-defaults' (or, if nil, using
1766 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1767 ;; Set fontification defaults if not previously set for correct major mode.
1777 font-lock-defaults-alist)))))
1785 ;; Syntactic fontification?
1789 ;; Case fold during regexp fontification?
1793 ;; Syntax table for regexp and syntactic fontification?
1799 ;; The character to modify may be a single CHAR or a STRING.
1805 ;; Syntax function for syntactic fontification?
1810 ;; Variable alist?
1813 ;; Set up `font-lock-keywords' last because its value might depend
1814 ;; on other settings (e.g. font-lock-compile-keywords uses
1815 ;; font-lock-beginning-of-syntax-function).
1818 ;; Local fontification?
1824 ;; Now compile the keywords.
1828 \f
1829 ;;; Colour etc. support.
1831 ;; Note that `defface' will not overwrite any faces declared above via
1832 ;; `custom-declare-face'.
1849 )
1851 "Font Lock mode face used to highlight comments."
1862 "Font Lock mode face used to highlight comment delimiters."
1874 "Font Lock mode face used to highlight strings."
1879 "Font Lock mode face used to highlight documentation."
1891 "Font Lock mode face used to highlight keywords."
1903 "Font Lock mode face used to highlight builtins."
1913 "Font Lock mode face used to highlight function names."
1927 "Font Lock mode face used to highlight variable names."
1939 "Font Lock mode face used to highlight type and classes."
1953 "Font Lock mode face used to highlight constants and labels."
1963 "Font Lock mode face used to highlight warnings."
1968 "Font Lock mode face used to highlight easy to overlook negation."
1973 "Font Lock mode face used to highlight preprocessor directives."
1978 "Font Lock mode face for backslashes in Lisp regexp grouping constructs."
1983 "Font Lock mode face used to highlight grouping constructs in Lisp regexps."
1986 ;;; End of Colour etc. support.
1987 \f
1988 ;;; Menu support.
1990 ;; This section of code is commented out because Emacs does not have real menu
1991 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1992 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1993 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1994 ;; the entry for "Text Properties" something like:
1995 ;;
1996 ;; (define-key menu-bar-edit-menu [font-lock]
1997 ;; (cons "Syntax Highlighting" font-lock-menu))
1998 ;;
1999 ;; and remove a single ";" from the beginning of each line in the rest of this
2000 ;; section. Probably the mechanism for telling the menu code what are menu
2001 ;; buttons and when they are on or off needs tweaking. I have assumed that the
2002 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
2004 ;;;;;###autoload
2005 ;;(progn
2006 ;; ;; Make the Font Lock menu.
2007 ;; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
2008 ;; ;; Add the menu items in reverse order.
2009 ;; (define-key font-lock-menu [fontify-less]
2010 ;; '("Less In Current Buffer" . font-lock-fontify-less))
2011 ;; (define-key font-lock-menu [fontify-more]
2012 ;; '("More In Current Buffer" . font-lock-fontify-more))
2013 ;; (define-key font-lock-menu [font-lock-sep]
2014 ;; '("--"))
2015 ;; (define-key font-lock-menu [font-lock-mode]
2016 ;; '("In Current Buffer" . font-lock-mode))
2017 ;; (define-key font-lock-menu [global-font-lock-mode]
2018 ;; '("In All Buffers" . global-font-lock-mode)))
2019 ;;
2020 ;;;;;###autoload
2021 ;;(progn
2022 ;; ;; We put the appropriate `menu-enable' etc. symbol property values on when
2023 ;; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
2024 ;; (put 'global-font-lock-mode 'menu-toggle t)
2025 ;; (put 'font-lock-mode 'menu-toggle t)
2026 ;; (put 'font-lock-fontify-more 'menu-enable '(identity))
2027 ;; (put 'font-lock-fontify-less 'menu-enable '(identity)))
2028 ;;
2029 ;; ;; Put the appropriate symbol property values on now. See above.
2030 ;;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
2031 ;;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
2032 ;;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
2033 ;;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
2034 ;;
2035 ;;(defvar font-lock-fontify-level nil) ; For less/more fontification.
2036 ;;
2037 ;;(defun font-lock-fontify-level (level)
2038 ;; (let ((font-lock-maximum-decoration level))
2039 ;; (when font-lock-mode
2040 ;; (font-lock-mode))
2041 ;; (font-lock-mode)
2042 ;; (when font-lock-verbose
2043 ;; (message "Fontifying %s... level %d" (buffer-name) level))))
2044 ;;
2045 ;;(defun font-lock-fontify-less ()
2046 ;; "Fontify the current buffer with less decoration.
2047 ;;See `font-lock-maximum-decoration'."
2048 ;; (interactive)
2049 ;; ;; Check in case we get called interactively.
2050 ;; (if (nth 1 font-lock-fontify-level)
2051 ;; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
2052 ;; (error "No less decoration")))
2053 ;;
2054 ;;(defun font-lock-fontify-more ()
2055 ;; "Fontify the current buffer with more decoration.
2056 ;;See `font-lock-maximum-decoration'."
2057 ;; (interactive)
2058 ;; ;; Check in case we get called interactively.
2059 ;; (if (nth 2 font-lock-fontify-level)
2060 ;; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
2061 ;; (error "No more decoration")))
2062 ;;
2063 ;; ;; This should be called by `font-lock-set-defaults'.
2064 ;;(defun font-lock-set-menu ()
2065 ;; ;; Activate less/more fontification entries if there are multiple levels for
2066 ;; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
2067 ;; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
2068 ;; (let ((keywords (or (nth 0 font-lock-defaults)
2069 ;; (nth 1 (assq major-mode font-lock-defaults-alist))))
2070 ;; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
2071 ;; (make-local-variable 'font-lock-fontify-level)
2072 ;; (if (or (symbolp keywords) (= (length keywords) 1))
2073 ;; (font-lock-unset-menu)
2074 ;; (cond ((eq level t)
2075 ;; (setq level (1- (length keywords))))
2076 ;; ((or (null level) (zerop level))
2077 ;; ;; The default level is usually, but not necessarily, level 1.
2078 ;; (setq level (- (length keywords)
2079 ;; (length (member (eval (car keywords))
2080 ;; (mapcar 'eval (cdr keywords))))))))
2081 ;; (setq font-lock-fontify-level (list level (> level 1)
2082 ;; (< level (1- (length keywords))))))))
2083 ;;
2084 ;; ;; This should be called by `font-lock-unset-defaults'.
2085 ;;(defun font-lock-unset-menu ()
2086 ;; ;; Deactivate less/more fontification entries.
2087 ;; (setq font-lock-fontify-level nil))
2089 ;;; End of Menu support.
2090 \f
2091 ;;; Various regexp information shared by several modes.
2092 ;; ;; Information specific to a single mode should go in its load library.
2094 ;; Font Lock support for C, C++, Objective-C and Java modes is now in
2095 ;; cc-fonts.el (and required by cc-mode.el). However, the below function
2096 ;; should stay in font-lock.el, since it is used by other libraries. sm.
2099 "Match, and move over, any declaration/definition item after point.
2100 Matches after point, but ignores leading whitespace and `*' characters.
2101 Does not move further than LIMIT.
2103 The expected syntax of a declaration/definition item is `word' (preceded by
2104 optional whitespace and `*' characters and proceeded by optional whitespace)
2105 optionally followed by a `('. Everything following the item (but belonging to
2106 it) is expected to be skip-able by `scan-sexps', and items are expected to be
2107 separated with a `,' and to be terminated with a `;'.
2109 Thus the regexp matches after point: word (
2110 ^^^^ ^
2111 Where the match subexpressions are: 1 2
2113 The item is delimited by (match-beginning 1) and (match-end 1).
2114 If (match-beginning 2) is non-nil, the item is followed by a `('.
2116 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
2119 ;; If `word' is followed by a double open-paren, it's probably
2120 ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one
2121 ;; word to try and match `myfun' rather than `P_'.
2126 ;; Looks like it was something else, so go back to where we
2127 ;; were and reset the match data by rematching.
2133 ;; Restrict to the LIMIT.
2136 ;; Move over any item value, etc., to the next item.
2143 ;; C preprocessor(cpp) is used outside of C, C++ and Objective-C source file.
2144 ;; e.g. assembler code and GNU linker script in Linux kernel.
2145 ;; `cpp-font-lock-keywords' is handy for modes for the files.
2146 ;;
2147 ;; Here we cannot use `regexp-opt' because because regex-opt is not preloaded
2148 ;; while font-lock.el is preloaded to emacs. So values pre-calculated with
2149 ;; regexp-opt are used here.
2151 ;; `cpp-font-lock-keywords-source-directives' is calculated from:
2152 ;;
2153 ;; (regexp-opt
2154 ;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
2155 ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning"))
2156 ;;
2158 "define\\|e\\(?:l\\(?:if\\|se\\)\\|ndif\\|rror\\)\\|file\\|i\\(?:f\\(?:n?def\\)?\\|mport\\|nclude\\)\\|line\\|pragma\\|undef\\|warning"
2161 ;; `cpp-font-lock-keywords-source-depth' is calculated from:
2162 ;;
2163 ;; (regexp-opt-depth (regexp-opt
2164 ;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
2165 ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning")))
2166 ;;
2168 "An integer representing regular expression depth of `cpp-font-lock-keywords-source-directives'.
2175 ;;
2176 ;; Fontify error directives.
2178 ;;
2179 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2182 ;;
2183 ;; Fontify function macro names.
2186 ;;
2187 ;; Macro arguments.
2192 limit)
2193 t))
2195 ;;
2196 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2200 ;;
2201 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2208 "Font lock keyords for C preprocessor directives.
2209 `c-mode', `c++-mode' and `objc-mode' have their own
2210 font lock keyords for C preprocessor directives. This definition is for the
2211 other modes in which C preprocessor directives are used. e.g. `asm-mode' and
2214 \f
2215 ;; Lisp.
2221 ;; Function declarations.
2228 ;; Variable declarations.
2230 ;; Structure declarations.
2233 ;; Any whitespace and defined object.
2240 nil t))
2241 ;; Emacs Lisp autoload cookies. Supports the slightly different
2242 ;; forms used by mh-e, calendar, etc.
2244 ;; Regexp negated char group.
2271 ;; Control structures. Common Lisp forms.
2292 ;; Exit/Feature symbols as constants.
2297 ;; Erroneous structures.
2298 ("(\\(abort\\|assert\\|warn\\|check-type\\|cerror\\|error\\|signal\\)\\>" 1 font-lock-warning-face)
2299 ;; Words inside \\[] tend to be for `substitute-command-keys'.
2301 ;; Words inside `' tend to be symbol names.
2303 ;; Constant values.
2305 ;; ELisp and CLisp `&' keywords as types.
2307 ;; ELisp regexp grouping constructs
2310 ;; The following loop is needed to continue searching after matches
2311 ;; that do not occur in strings. The associated regexp matches one
2312 ;; of `\\\\' `\\(' `\\(?:' `\\|' `\\)'. `\\\\' has been included to
2313 ;; avoid highlighting, for example, `\\(' in `\\\\('.
2314 (while (re-search-forward "\\(\\\\\\\\\\)\\(?:\\(\\\\\\\\\\)\\|\\((\\(?:\\?[0-9]*:\\)?\\|[|)]\\)\\)" bound t)
2323 ;;; This is too general -- rms.
2324 ;;; A user complained that he has functions whose names start with `do'
2325 ;;; and that they get the wrong color.
2326 ;;; ;; CL `with-' and `do-' constructs
2327 ;;; ("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
2328 )))
2333 \f
2336 ;; arch-tag: 682327e4-64d8-4057-b20b-1fbb9f1fc54c
2337 ;;; font-lock.el ends here