| blob | 4fd933e3191e9337f92ebfe79510026bd9c17e5a |
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 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 ;; (set (make-local-variable 'font-lock-defaults)
157 ;; '(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 ;; (set (make-local-variable 'font-lock-defaults)
178 ;; '(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."
227 \f
228 ;; User variables.
231 "*Maximum size of a buffer for buffer fontification.
232 Only buffers less than this can be fontified when Font Lock mode is turned on.
233 If nil, means size is irrelevant.
234 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
235 where MAJOR-MODE is a symbol or t (meaning the default). For example:
236 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
237 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
238 for buffers in Rmail mode, and size is irrelevant otherwise."
253 "*Maximum decoration level for fontification.
254 If nil, use the default decoration (typically the minimum available).
255 If t, use the maximum decoration available.
256 If a number, use that level of decoration (or if not available the maximum).
257 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
258 where MAJOR-MODE is a symbol or t (meaning the default). For example:
259 ((c-mode . t) (c++-mode . 2) (t . 1))
260 means use the maximum decoration available for buffers in C mode, level 2
261 decoration for buffers in C++ mode, and level 1 decoration otherwise."
278 "*If non-nil, means show status messages for buffer fontification.
279 If a number, only buffers greater than this size have fontification messages."
284 \f
286 ;; Originally these variable values were face names such as `bold' etc.
287 ;; Now we create our own faces, but we keep these variables for compatibility
288 ;; and they give users another mechanism for changing face appearance.
289 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
290 ;; returns a face. So the easiest thing is to continue using these variables,
291 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
326 "Face name to use for easy to overlook negation.
335 ;; Fontification variables:
338 "A list of the keywords to highlight.
339 There are two kinds of values: user-level, and compiled.
341 A user-level keywords list is what a major mode or the user would
342 set up. Normally the list would come from `font-lock-defaults'.
343 through selection of a fontification level and evaluation of any
344 contained expressions. You can also alter it by calling
345 `font-lock-add-keywords' or `font-lock-remove-keywords' with MODE = nil.
347 Each element in a user-level keywords list should have one of these forms:
349 MATCHER
350 (MATCHER . SUBEXP)
351 (MATCHER . FACENAME)
352 (MATCHER . HIGHLIGHT)
353 (MATCHER HIGHLIGHT ...)
354 (eval . FORM)
356 where MATCHER can be either the regexp to search for, or the function name to
357 call to make the search (called with one argument, the limit of the search;
358 it should return non-nil, move point, and set `match-data' appropriately iff
359 it succeeds; like `re-search-forward' would).
360 MATCHER regexps can be generated via the function `regexp-opt'.
362 FORM is an expression, whose value should be a keyword element, evaluated when
363 the keyword is (first) used in a buffer. This feature can be used to provide a
364 keyword that can only be generated when Font Lock mode is actually turned on.
366 HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
369 typically only MATCH-HIGHLIGHT is required.
370 However, if an item or (typically) items are to be highlighted following the
371 instance of another item (the anchor), for example each instance of the
374 MATCH-HIGHLIGHT should be of the form:
376 (SUBEXP FACENAME [OVERRIDE [LAXMATCH]])
378 SUBEXP is the number of the subexpression of MATCHER to be highlighted.
380 FACENAME is an expression whose value is the face name to use.
381 Instead of a face, FACENAME can evaluate to a property list
382 of the form (face FACE PROP1 VAL1 PROP2 VAL2 ...)
383 in which case all the listed text-properties will be set rather than
384 just FACE. In such a case, you will most likely want to put those
385 properties in `font-lock-extra-managed-props' or to override
386 `font-lock-unfontify-region-function'.
388 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
389 be overwritten. If `keep', only parts not already fontified are highlighted.
390 If `prepend' or `append', existing fontification is merged with the new, in
391 which the new or existing fontification, respectively, takes precedence.
392 If LAXMATCH is non-nil, that means don't signal an error if there is
393 no match for SUBEXP in MATCHER.
395 For example, an element of the form highlights (if not already highlighted):
398 variable `font-lock-keyword-face'.
400 the value of `font-lock-keyword-face'.
404 of `foo-bar-face', even if already highlighted.
405 (fubar-match 1 fubar-face)
406 the first subexpression within all occurrences of
407 whatever the function `fubar-match' finds and matches
408 in the value of `fubar-face'.
410 MATCH-ANCHORED should be of the form:
412 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
414 where MATCHER is a regexp to search for or the function name to call to make
415 the search, as for MATCH-HIGHLIGHT above, but with one exception; see below.
416 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
417 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
418 used to initialize before, and cleanup after, MATCHER is used. Typically,
419 PRE-MATCH-FORM is used to move to some position relative to the original
420 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
421 be used to move back, before resuming with MATCH-ANCHORED's parent's MATCHER.
423 For example, an element of the form highlights (if not already highlighted):
434 The above-mentioned exception is as follows. The limit of the MATCHER search
435 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
436 However, if PRE-MATCH-FORM returns a position greater than the position after
437 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
438 It is generally a bad idea to return a position greater than the end of the
439 line, i.e., cause the MATCHER search to span lines.
441 These regular expressions can match text which spans lines, although
442 it is better to avoid it if possible since updating them while editing
443 text is slower, and it is not guaranteed to be always correct when using
444 support modes like jit-lock or lazy-lock.
446 This variable is set by major modes via the variable `font-lock-defaults'.
447 Be careful when composing regexps for this list; a poorly written pattern can
448 dramatically slow things down!
450 A compiled keywords list starts with t. It is produced internal
451 by `font-lock-compile-keywords' from a user-level keywords list.
452 Its second element is the user-level keywords list that was
453 compiled. The remaining elements have the same form as
454 user-level keywords, but normally their values have been
458 "Alist of additional `font-lock-keywords' elements for major modes.
460 Each element has the form (MODE KEYWORDS . HOW).
461 `font-lock-set-defaults' adds the elements in the list KEYWORDS to
462 `font-lock-keywords' when Font Lock is turned on in major mode MODE.
464 If HOW is nil, KEYWORDS are added at the beginning of
465 `font-lock-keywords'. If it is `set', they are used to replace the
466 value of `font-lock-keywords'. If HOW is any other non-nil value,
467 they are added at the end.
469 This is normally set via `font-lock-add-keywords' and
474 "Alist of `font-lock-keywords' elements to be removed for major modes.
476 Each element has the form (MODE . KEYWORDS). `font-lock-set-defaults'
477 removes the elements in the list KEYWORDS from `font-lock-keywords'
478 when Font Lock is turned on in major mode MODE.
480 This is normally set via `font-lock-add-keywords' and
484 "*Non-nil means Font Lock should not fontify comments or strings.
488 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
493 "Point up to which `font-lock-syntactic-keywords' has been applied.
494 If nil, this is ignored, in which case the syntactic fontification may
501 "Function to determine which face to use when fontifying syntactically.
502 The function is called with a single parameter (the state as returned by
503 `parse-partial-sexp' at the beginning of the region to highlight) and
507 "A list of the syntactic keywords to put syntax properties on.
508 The value can be the list itself, or the name of a function or variable
509 whose value is the list.
511 See `font-lock-keywords' for a description of the form of this list;
512 only the differences are stated here. MATCH-HIGHLIGHT should be of the form:
514 (SUBEXP SYNTAX OVERRIDE LAXMATCH)
516 where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax
517 table, a cons cell (as returned by `string-to-syntax') or an expression whose
518 value is such a form. OVERRIDE cannot be `prepend' or `append'.
520 Here are two examples of elements of `font-lock-syntactic-keywords'
521 and what they do:
526 dollar-sign character. Hash characters in other contexts will still
527 follow whatever the syntax table says about the hash character.
533 gives a pair single-quotes, which surround a single character, a SYNTAX of
535 contexts will not be affected.
540 "Non-nil means use this syntax table for fontifying.
541 If this is nil, the major mode's syntax table is used.
545 "*Non-nil means use this function to move back outside all constructs.
546 When called with no args it should move point backward to a place which
547 is not in a string or comment and not within any bracket-pairs (or else,
548 a place such that any bracket-pairs outside it can be ignored for Emacs
549 syntax analysis and fontification).
551 If this is nil, Font Lock uses `syntax-begin-function' to move back
552 outside of any comment, string, or sexp. This variable is semi-obsolete;
553 we recommend setting `syntax-begin-function' instead.
558 "*Non-nil means use this function to mark a block of text.
559 When called with no args it should leave point at the beginning of any
560 enclosing textual block and mark at the end.
564 "Function to use for fontifying the buffer.
568 "Function to use for unfontifying the buffer.
569 This is used when turning off Font Lock mode.
573 "Function to use for fontifying a region.
574 It should take two args, the beginning and end of the region, and an optional
575 third arg VERBOSE. If VERBOSE is non-nil, the function should print status
579 "Function to use for unfontifying a region.
580 It should take two args, the beginning and end of the region.
584 "List of Font Lock mode related modes that should not be turned on.
585 Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
589 "Whether font-lock should cater to multiline keywords.
590 If nil, don't try to handle multiline patterns.
591 If t, always handle multiline patterns.
592 If `undecided', don't try to handle multiline patterns until you see one.
596 \f
597 ;; Font Lock mode.
600 ;;
601 ;; We don't do this at the top-level as we only use non-autoloaded macros.
603 ;;
604 ;; Borrowed from lazy-lock.el.
605 ;; We use this to preserve or protect things when modifying text properties.
607 "Bind variables according to VARLIST and eval BODY restoring buffer state."
616 deactivate-mark
617 buffer-file-name
618 buffer-file-truename))
623 ;;
624 ;; Shut up the byte compiler.
628 ;; Turn on Font Lock mode.
633 ;; Fontify the buffer if we have to.
636 nil)
642 ;; Turn off Font Lock mode.
649 "Add highlighting KEYWORDS for MODE.
651 MODE should be a symbol, the major mode command name, such as `c-mode'
652 or nil. If nil, highlighting keywords are added for the current buffer.
653 KEYWORDS should be a list; see the variable `font-lock-keywords'.
654 By default they are added at the beginning of the current highlighting list.
655 If optional argument HOW is `set', they are used to replace the current
656 highlighting list. If HOW is any other non-nil value, they are added at the
657 end of the current highlighting list.
659 For example:
661 (font-lock-add-keywords 'c-mode
665 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
666 comments, and to fontify `and', `or' and `not' words as keywords.
668 The above procedure will only add the keywords for C mode, not
669 for modes derived from C mode. To add them for derived modes too,
670 pass nil for MODE and add the call to c-mode-hook.
672 For example:
674 (add-hook 'c-mode-hook
675 (lambda ()
676 (font-lock-add-keywords nil
679 font-lock-keyword-face)))))
681 The above procedure may fail to add keywords to derived modes if
682 some involved major mode does not follow the standard conventions.
683 File a bug report if this happens, so the major mode can be corrected.
685 Note that some modes have specialized support for additional patterns, e.g.,
686 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
687 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
689 ;; If MODE is non-nil, add the KEYWORDS and HOW spec to
690 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
697 ;; Make sure that `font-lock-removed-keywords-alist' does not
698 ;; contain the new keywords.
703 ;; The major mode has not set any keywords, so when we enabled
704 ;; font-lock-mode it only enabled the font-core.el part, not the
705 ;; font-lock-mode-internal. Try again.
709 ;; Otherwise set or add the keywords now.
710 ;; This is a no-op if it has been done already in this buffer
711 ;; for the correct major mode.
714 ;; Bring back the user-level (uncompiled) keywords.
717 ;; Now modify or replace them.
723 font-lock-keywords)))
727 ;; If the keywords were compiled before, compile them again.
733 "Update `font-lock-removed-keywords-alist' when adding new KEYWORDS to MODE."
734 ;; When font-lock is enabled first all keywords in the list
735 ;; `font-lock-keywords-alist' are added, then all keywords in the
736 ;; list `font-lock-removed-keywords-alist' are removed. If a
737 ;; keyword was once added, removed, and then added again it must be
738 ;; removed from the removed-keywords list. Otherwise the second add
739 ;; will not take effect.
743 ;; A new set of keywords is defined. Forget all about
744 ;; our old keywords that should be removed.
747 ;; Delete all previously removed keywords.
750 ;; Delete the mode cell if empty.
755 ;; Written by Anders Lindgren <andersl@andersl.com>.
756 ;;
757 ;; Case study:
758 ;; (I) The keywords are removed from a major mode.
759 ;; In this case the keyword could be local (i.e. added earlier by
760 ;; `font-lock-add-keywords'), global, or both.
761 ;;
762 ;; (a) In the local case we remove the keywords from the variable
763 ;; `font-lock-keywords-alist'.
764 ;;
765 ;; (b) The actual global keywords are not known at this time.
766 ;; All keywords are added to `font-lock-removed-keywords-alist',
767 ;; when font-lock is enabled those keywords are removed.
768 ;;
769 ;; Note that added keywords are taken out of the list of removed
770 ;; keywords. This ensure correct operation when the same keyword
771 ;; is added and removed several times.
772 ;;
773 ;; (II) The keywords are removed from the current buffer.
775 "Remove highlighting KEYWORDS for MODE.
777 MODE should be a symbol, the major mode command name, such as `c-mode'
778 or nil. If nil, highlighting keywords are removed for the current buffer.
780 To make the removal apply to modes derived from MODE as well,
781 pass nil for MODE and add the call to MODE-hook. This may fail
782 for some derived modes if some involved major mode does not
783 follow the standard conventions. File a bug report if this
784 happens, so the major mode can be corrected."
786 ;; Remove one keyword at the time.
789 ;; If MODE is non-nil, remove the KEYWORD from
790 ;; `font-lock-keywords-alist'.
793 ;; `keywords-list-how-pair' is a cons with a list of
794 ;; keywords in the car top-cell and the original how
795 ;; argument in the cdr top-cell.
798 ;; Remove keyword list/how pair when the keyword list
799 ;; is empty and how doesn't specify `set'. (If it
800 ;; should be deleted then previously deleted keywords
801 ;; would appear again.)
808 ;; Final cleanup, remove major mode cell if last keyword
809 ;; was deleted.
813 ;; Remember the keyword in case it is not local.
819 font-lock-removed-keywords-alist))))))
821 ;; Otherwise remove it immediately.
824 ;; Bring back the user-level (uncompiled) keywords.
828 ;; Edit them.
834 ;; If the keywords were compiled before, compile them again.
838 \f
839 ;;; Font Lock Support mode.
841 ;; This is the code used to interface font-lock.el with any of its add-on
842 ;; packages, and provide the user interface. Packages that have their own
843 ;; local buffer fontification functions (see below) may have to call
844 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
845 ;; themselves.
848 "*Support mode for Font Lock mode.
849 Support modes speed up Font Lock mode by being choosy about when fontification
850 occurs. The default support mode, Just-in-time Lock mode (symbol
851 `jit-lock-mode'), is recommended.
853 Other, older support modes are Fast Lock mode (symbol `fast-lock-mode') and
854 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
855 However, they are no longer recommended, as Just-in-time Lock mode is better.
857 If nil, means support for Font Lock mode is never performed.
858 If a symbol, use that support mode.
859 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
860 where MAJOR-MODE is a symbol or t (meaning the default). For example:
861 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
862 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
863 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
865 The value of this variable is used when Font Lock mode is turned on."
881 ))
896 ;; Prepare for jit-lock
901 ;; Don't fontify eagerly (and don't abort if the buffer is large).
903 ;; Use jit-lock.
906 ;; Tell jit-lock how we extend the region to refontify.
908 'font-lock-extend-jit-lock-region-after-change
909 nil t)))))
916 ;; Reset local vars to the non-jit-lock case.
924 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
925 ;; (jit-lock-mode
926 ;; (jit-lock-after-fontify-buffer))
933 ;; Useless as well. It's only called when:
934 ;; - turning off font-lock: it does not matter if we leave spurious
935 ;; `fontified' text props around since jit-lock-mode is also off.
936 ;; - font-lock-default-fontify-buffer fails: this is not run
937 ;; any more anyway. -sm
938 ;;
939 ;; (jit-lock-mode
940 ;; (jit-lock-after-unfontify-buffer))
944 ;;; End of Font Lock Support mode.
945 \f
946 ;;; Fontification functions.
948 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
949 ;; code to fontify a region, the function runs the function whose name is the
950 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
951 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
952 ;; which does contain the code to fontify a region. However, the value of the
953 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
954 ;; do anything. The indirection of the fontification functions gives major
955 ;; modes the capability of modifying the way font-lock.el fontifies. Major
956 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
957 ;; via the variable `font-lock-defaults'.
958 ;;
959 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
960 ;; font-lock.el uses its own function for buffer fontification. This function
961 ;; makes fontification be on a message-by-message basis and so visiting an
962 ;; RMAIL file is much faster. A clever implementation of the function might
963 ;; fontify the headers differently than the message body. (It should, and
964 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
965 ;; you?) This hints at a more interesting use...
966 ;;
967 ;; Languages that contain text normally contained in different major modes
968 ;; could define their own fontification functions that treat text differently
969 ;; depending on its context. For example, Perl mode could arrange that here
970 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
971 ;; rules one way and C code another. Neat!
972 ;;
973 ;; A further reason to use the fontification indirection feature is when the
974 ;; default syntactual fontification, or the default fontification in general,
975 ;; is not flexible enough for a particular major mode. For example, perhaps
976 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
977 ;; cope with. You need to write your own version of that function, e.g.,
978 ;; `hairy-fontify-syntactically-region', and make your own version of
979 ;; `hairy-fontify-region' call that function before calling
980 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
981 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
982 ;; would call your region fontification function instead of its own. For
983 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
984 ;; directives correctly and cleanly. (It is the same problem as fontifying
985 ;; multi-line strings and comments; regexps are not appropriate for the job.)
988 "A function that determines the region to refontify after a change.
990 This variable is either nil, or is a function that determines the
991 region to refontify after a change.
992 It is usually set by the major mode via `font-lock-defaults'.
993 Font-lock calls this function after each buffer change.
995 The function is given three parameters, the standard BEG, END, and OLD-LEN
996 from `after-change-functions'. It should return either a cons of the beginning
997 and end buffer positions \(in that order) of the region to refontify, or nil
998 \(which directs the caller to fontify a default region).
999 This function should preserve the match-data.
1003 "Fontify the current buffer the way the function `font-lock-mode' would."
1023 font-lock-verbose)))
1027 ;; Make sure we fontify etc. in the whole buffer.
1036 ;; We don't restore the old fontification, so it's best to unfontify.
1040 ;; Make sure we unfontify etc. in the whole buffer.
1048 "If non-nil, font-lock will work on the non-widened buffer.
1049 Useful for things like RMAIL and Info where the whole buffer is not
1056 ;; This use of font-lock-multiline property is unreliable but is just
1057 ;; a handy heuristic: in case you don't have a function that does
1058 ;; /identification/ of multiline elements, you may still occasionally
1059 ;; discover them by accident (or you may /identify/ them but not in all
1060 ;; cases), in which case the font-lock-multiline property can help make
1061 ;; sure you will properly *re*identify them during refontification.
1062 font-lock-extend-region-multiline)
1063 "Special hook run just before proceeding to fontify a region.
1064 This is used to allow major modes to help font-lock find safe buffer positions
1065 as beginning and end of the fontified region. Its most common use is to solve
1066 the problem of /identification/ of multiline elements by providing a function
1067 that tries to find such elements and move the boundaries such that they do
1068 not fall in the middle of one.
1069 Each function is called with no argument; it is expected to adjust the
1070 dynamically bound variables `font-lock-beg' and `font-lock-end'; and return
1071 non-nil iff it did make such an adjustment.
1072 These functions are run in turn repeatedly until they all return nil.
1074 ;; Mark it as a special hook which doesn't use any global setting
1075 ;; (i.e. doesn't obey the element t in the buffer-local value).
1079 "Move fontification boundaries away from any `font-lock-multiline' property."
1087 ;;
1093 changed))
1096 "Move fontification boundaries to beginning of lines."
1106 changed))
1116 ;; Use the fontification syntax table, if any.
1119 ;; Extend the region to fontify so that it starts and ends at
1120 ;; safe places.
1128 ;; If there's been a change, we should go through
1129 ;; the list again since this new position may
1130 ;; warrant a different answer from one of the fun
1131 ;; we've already seen.
1132 font-lock-extend-region-functions)))
1134 ;; Now do the fontification.
1141 ;; Clean up.
1144 ;; The following must be rethought, since keywords can override fontification.
1145 ;; ;; Now scan for keywords, but not if we are inside a comment now.
1146 ;; (or (and (not font-lock-keywords-only)
1147 ;; (let ((state (parse-partial-sexp beg end nil nil
1148 ;; font-lock-cache-state)))
1149 ;; (or (nth 4 state) (nth 7 state))))
1150 ;; (font-lock-fontify-keywords-region beg end))
1153 "Additional text properties managed by font-lock.
1154 This is used by `font-lock-default-unfontify-region' to decide
1160 font-lock-extra-managed-props
1165 ;; Called when any modification is made to buffer text.
1172 beg end old-len))))
1175 ;; Fontify the region the major mode has specified.
1177 ;; Fontify the whole lines which enclose the region.
1178 ;; Actually, this is not needed because
1179 ;; font-lock-default-fontify-region already rounds up to a whole
1180 ;; number of lines.
1181 ;; (setq beg (progn (goto-char beg) (line-beginning-position))
1182 ;; end (progn (goto-char end) (line-beginning-position 2)))
1184 ;; Rounding up to a whole number of lines should include the
1185 ;; line right after `end'. Typical case: the first char of
1186 ;; the line was deleted. Or a \n was inserted in the middle
1187 ;; of a line.
1193 "Function meant for `jit-lock-after-change-extend-region-functions'.
1194 This function does 2 things:
1195 - extend the region so that it not only includes the part that was modified
1196 but also the surrounding text whose highlighting may change as a consequence.
1197 - anticipate (part of) the region extension that will happen later in
1198 `font-lock-default-fontify-region', in order to avoid the need for
1199 double-redisplay in `jit-lock-fontify-now'."
1201 ;; First extend the region as font-lock-after-change-function would.
1204 beg end old-len))))
1208 ;; Then extend the region obeying font-lock-multiline properties,
1209 ;; indicating which part of the buffer needs to be refontified.
1210 ;; !!! This is the *main* user of font-lock-multiline property !!!
1211 ;; font-lock-after-change-function could/should also do that, but it
1212 ;; doesn't need to because font-lock-default-fontify-region does
1213 ;; it anyway. Here OTOH we have no guarantee that
1214 ;; font-lock-default-fontify-region will be executed on this region
1215 ;; any time soon.
1216 ;; Note: contrary to font-lock-default-fontify-region, we do not do
1217 ;; any loop here because we are not looking for a safe spot: we just
1218 ;; mark the text whose appearance may need to change as a result of
1219 ;; the buffer modification.
1231 ;; Rounding up to a whole number of lines should include the
1232 ;; line right after `end'. Typical case: the first char of
1233 ;; the line was deleted. Or a \n was inserted in the middle
1234 ;; of a line.
1236 ;; Finally, pre-enlarge the region to a whole number of lines, to try
1237 ;; and anticipate what font-lock-default-fontify-region will do, so as to
1238 ;; avoid double-redisplay.
1239 ;; We could just run `font-lock-extend-region-functions', but since
1240 ;; the only purpose is to avoid the double-redisplay, we prefer to
1241 ;; do here only the part that is cheap and most likely to be useful.
1243 font-lock-extend-region-functions)
1252 "Fontify some lines the way `font-lock-fontify-buffer' would.
1253 The lines could be a function or paragraph, or a specified number of lines.
1254 If ARG is given, fontify that many lines before and after point, or 16 lines if
1255 no ARG is given and `font-lock-mark-block-function' is nil.
1256 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1257 delimit the region to fontify."
1260 deactivate-mark)
1261 ;; Make sure we have the right `font-lock-keywords' etc.
1279 ;;; End of Fontification functions.
1280 \f
1281 ;;; Additional text property functions.
1283 ;; The following text property functions should be builtins. This means they
1284 ;; should be written in C and put with all the other text property functions.
1285 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1286 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1287 ;; in Lisp below and commented out. sm.
1290 "Prepend to one property of the text from START to END.
1291 Arguments PROP and VALUE specify the property and value to prepend to the value
1292 already in place. The resulting property values are always lists.
1293 Optional argument OBJECT is the string or buffer containing the text."
1300 object)
1304 "Append to one property of the text from START to END.
1305 Arguments PROP and VALUE specify the property and value to append to the value
1306 already in place. The resulting property values are always lists.
1307 Optional argument OBJECT is the string or buffer containing the text."
1314 object)
1318 "Fill in one property of the text from START to END.
1319 Arguments PROP and VALUE specify the property and value to put where none are
1320 already in place. Therefore existing property values are not overwritten.
1321 Optional argument OBJECT is the string or buffer containing the text."
1328 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1329 ;; is to `add-text-properties', etc.
1330 ;;(defun remove-text-property (start end property &optional object)
1331 ;; "Remove a property from text from START to END.
1332 ;;Argument PROPERTY is the property to remove.
1333 ;;Optional argument OBJECT is the string or buffer containing the text.
1334 ;;Return t if the property was actually removed, nil otherwise."
1335 ;; (remove-text-properties start end (list property) object))
1337 ;; For consistency: maybe this should be called `remove-single-property' like
1338 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1339 ;;(defun remove-single-text-property (start end prop value &optional object)
1340 ;; "Remove a specific property value from text from START to END.
1341 ;;Arguments PROP and VALUE specify the property and value to remove. The
1342 ;;resulting property values are not equal to VALUE nor lists containing VALUE.
1343 ;;Optional argument OBJECT is the string or buffer containing the text."
1344 ;; (let ((start (text-property-not-all start end prop nil object)) next prev)
1345 ;; (while start
1346 ;; (setq next (next-single-property-change start prop object end)
1347 ;; prev (get-text-property start prop object))
1348 ;; (cond ((and (symbolp prev) (eq value prev))
1349 ;; (remove-text-property start next prop object))
1350 ;; ((and (listp prev) (memq value prev))
1351 ;; (let ((new (delq value prev)))
1352 ;; (cond ((null new)
1353 ;; (remove-text-property start next prop object))
1354 ;; ((= (length new) 1)
1355 ;; (put-text-property start next prop (car new) object))
1356 ;; (t
1357 ;; (put-text-property start next prop new object))))))
1358 ;; (setq start (text-property-not-all next end prop nil object)))))
1360 ;;; End of Additional text property functions.
1361 \f
1362 ;;; Syntactic regexp fontification functions.
1364 ;; These syntactic keyword pass functions are identical to those keyword pass
1365 ;; functions below, with the following exceptions; (a) they operate on
1366 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1367 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1368 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1369 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1370 ;; LOUDLY as it is not likely to be intensive.
1373 "Apply HIGHLIGHT following a match.
1374 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1375 see `font-lock-syntactic-keywords'."
1381 ;; No match but we might not signal an error.
1387 ;; Flush the syntax-cache. I believe this is not necessary for
1388 ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can
1389 ;; still be necessary for other users of syntax-ppss anyway.
1393 ;; Cannot override existing fontification.
1397 ;; Override existing fontification.
1400 ;; Keep existing fontification.
1404 "Fontify according to KEYWORDS until LIMIT.
1405 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1406 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1408 ;; Evaluate PRE-MATCH-FORM.
1410 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1415 ;; Find an occurrence of `matcher' before `limit'.
1419 ;; Apply each highlight to this instance of `matcher'.
1424 ;; Evaluate POST-MATCH-FORM.
1428 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1429 START should be at the beginning of a line."
1430 ;; Ensure the beginning of the file is properly syntactic-fontified.
1435 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1438 font-lock-syntactic-keywords)))
1439 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1442 font-lock-syntactic-keywords
1443 t)))
1444 ;; Get down to business.
1447 keyword matcher highlights)
1449 ;; Find an occurrence of `matcher' from `start' to `end'.
1455 ;; Apply each highlight to this instance of `matcher', which may be
1456 ;; specific highlights or more keywords anchored to `matcher'.
1462 end))
1466 ;;; End of Syntactic regexp fontification functions.
1467 \f
1468 ;;; Syntactic fontification functions.
1477 "Put proper face on each string and comment between START and END.
1478 START should be at the beginning of a line."
1483 state face beg)
1486 ;;
1487 ;; Find the `start' state.
1489 ;;
1490 ;; Find each interesting place between here and `end'.
1501 comment-start-skip))
1502 ;; Find the comment delimiters
1503 ;; and use font-lock-comment-delimiter-face for them.
1507 comment-start-skip))
1509 font-lock-comment-delimiter-face)))
1512 font-lock-comment-delimiter-face))))
1517 ;;; End of Syntactic fontification functions.
1518 \f
1519 ;;; Keyword regexp fontification functions.
1522 "Apply HIGHLIGHT following a match.
1523 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1528 ;; No match but we might not signal an error.
1537 ;; If `val' is nil, don't do anything. It is important to do it
1538 ;; explicitly, because when adding nil via things like
1539 ;; font-lock-append-text-property, the property is actually
1540 ;; changed from <face> to (<face>) which is undesirable. --Stef
1541 nil)
1543 ;; Cannot override existing fontification.
1547 ;; Override existing fontification.
1550 ;; Prepend to existing fontification.
1553 ;; Append to existing fontification.
1556 ;; Keep existing fontification.
1560 "Fontify according to KEYWORDS until LIMIT.
1561 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1562 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1565 ;; Evaluate PRE-MATCH-FORM.
1567 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1572 ;; this is a multiline anchored match
1573 ;; (setq font-lock-multiline t)
1577 limit
1580 ;; Find an occurrence of `matcher' before `limit'.
1585 ;; Apply each highlight to this instance of `matcher'.
1590 ;; Evaluate POST-MATCH-FORM.
1594 "Fontify according to `font-lock-keywords' between START and END.
1595 START should be at the beginning of a line.
1596 LOUDLY, if non-nil, allows progress-meter bar."
1604 keyword matcher highlights)
1605 ;;
1606 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1610 ;;
1611 ;; Find an occurrence of `matcher' from `start' to `end'.
1618 ;; Beware empty string matches since they will
1619 ;; loop indefinitely.
1626 ;; this is a multiline regexp match
1627 ;; (setq font-lock-multiline t)
1636 ;; Apply each highlight to this instance of `matcher', which may be
1637 ;; specific highlights or more keywords anchored to `matcher'.
1644 ;; Ensure forward progress. `pos' is a marker because anchored
1645 ;; keyword may add/delete text (this happens e.g. in grep.el).
1651 ;;; End of Keyword regexp fontification functions.
1652 \f
1653 ;; Various functions.
1656 "Compile KEYWORDS into the form (t KEYWORDS COMPILED...)
1657 Here each COMPILED is of the form (MATCHER HIGHLIGHT ...) as shown in the
1658 `font-lock-keywords' doc string.
1659 If SYNTACTIC-KEYWORDS is non-nil, it means these keywords are used for
1660 `font-lock-syntactic-keywords' rather than for `font-lock-keywords'."
1662 ;; This should never happen. But some external packages sometimes
1663 ;; call font-lock in unexpected and incorrect ways. It's important to
1664 ;; stop processing at this point, otherwise we may end up changing the
1665 ;; global value of font-lock-keywords and break highlighting in many
1666 ;; other buffers.
1669 keywords
1676 syntax-begin-function)))
1680 ;; Try to detect when a string or comment contains something that
1681 ;; looks like a defun and would thus confuse font-lock.
1689 font-lock-comment-face))
1692 prepend)))))
1693 keywords))
1701 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1712 keyword)))
1715 "Evalulate KEYWORDS if a function (funcall) or variable (eval) name."
1717 keywords
1723 "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1724 Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
1727 alist))
1730 "Return LEVELth element of KEYWORDS.
1731 A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1732 \(1- (length KEYWORDS))."
1734 keywords)
1746 "Set fontification defaults appropriately for this mode.
1747 Sets various variables using `font-lock-defaults' (or, if nil, using
1748 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1749 ;; Set fontification defaults iff not previously set for correct major mode.
1759 font-lock-defaults-alist)))))
1767 ;; Syntactic fontification?
1770 ;; Case fold during regexp fontification?
1773 ;; Syntax table for regexp and syntactic fontification?
1778 ;; The character to modify may be a single CHAR or a STRING.
1784 ;; Syntax function for syntactic fontification?
1788 ;; Variable alist?
1791 ;; Set up `font-lock-keywords' last because its value might depend
1792 ;; on other settings (e.g. font-lock-compile-keywords uses
1793 ;; font-lock-beginning-of-syntax-function).
1796 ;; Local fontification?
1802 ;; Now compile the keywords.
1806 \f
1807 ;;; Colour etc. support.
1809 ;; Note that `defface' will not overwrite any faces declared above via
1810 ;; `custom-declare-face'.
1825 )
1827 )
1829 "Font Lock mode face used to highlight comments."
1840 "Font Lock mode face used to highlight comment delimiters."
1852 "Font Lock mode face used to highlight strings."
1857 "Font Lock mode face used to highlight documentation."
1869 "Font Lock mode face used to highlight keywords."
1881 "Font Lock mode face used to highlight builtins."
1891 "Font Lock mode face used to highlight function names."
1905 "Font Lock mode face used to highlight variable names."
1917 "Font Lock mode face used to highlight type and classes."
1931 "Font Lock mode face used to highlight constants and labels."
1941 "Font Lock mode face used to highlight warnings."
1946 "Font Lock mode face used to highlight easy to overlook negation."
1951 "Font Lock mode face used to highlight preprocessor directives."
1956 "Font Lock mode face for backslashes in Lisp regexp grouping constructs."
1961 "Font Lock mode face used to highlight grouping constructs in Lisp regexps."
1964 ;;; End of Colour etc. support.
1965 \f
1966 ;;; Menu support.
1968 ;; This section of code is commented out because Emacs does not have real menu
1969 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1970 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1971 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1972 ;; the entry for "Text Properties" something like:
1973 ;;
1974 ;; (define-key menu-bar-edit-menu [font-lock]
1975 ;; (cons "Syntax Highlighting" font-lock-menu))
1976 ;;
1977 ;; and remove a single ";" from the beginning of each line in the rest of this
1978 ;; section. Probably the mechanism for telling the menu code what are menu
1979 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1980 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1982 ;;;;;###autoload
1983 ;;(progn
1984 ;; ;; Make the Font Lock menu.
1985 ;; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1986 ;; ;; Add the menu items in reverse order.
1987 ;; (define-key font-lock-menu [fontify-less]
1988 ;; '("Less In Current Buffer" . font-lock-fontify-less))
1989 ;; (define-key font-lock-menu [fontify-more]
1990 ;; '("More In Current Buffer" . font-lock-fontify-more))
1991 ;; (define-key font-lock-menu [font-lock-sep]
1992 ;; '("--"))
1993 ;; (define-key font-lock-menu [font-lock-mode]
1994 ;; '("In Current Buffer" . font-lock-mode))
1995 ;; (define-key font-lock-menu [global-font-lock-mode]
1996 ;; '("In All Buffers" . global-font-lock-mode)))
1997 ;;
1998 ;;;;;###autoload
1999 ;;(progn
2000 ;; ;; We put the appropriate `menu-enable' etc. symbol property values on when
2001 ;; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
2002 ;; (put 'global-font-lock-mode 'menu-toggle t)
2003 ;; (put 'font-lock-mode 'menu-toggle t)
2004 ;; (put 'font-lock-fontify-more 'menu-enable '(identity))
2005 ;; (put 'font-lock-fontify-less 'menu-enable '(identity)))
2006 ;;
2007 ;; ;; Put the appropriate symbol property values on now. See above.
2008 ;;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
2009 ;;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
2010 ;;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
2011 ;;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
2012 ;;
2013 ;;(defvar font-lock-fontify-level nil) ; For less/more fontification.
2014 ;;
2015 ;;(defun font-lock-fontify-level (level)
2016 ;; (let ((font-lock-maximum-decoration level))
2017 ;; (when font-lock-mode
2018 ;; (font-lock-mode))
2019 ;; (font-lock-mode)
2020 ;; (when font-lock-verbose
2021 ;; (message "Fontifying %s... level %d" (buffer-name) level))))
2022 ;;
2023 ;;(defun font-lock-fontify-less ()
2024 ;; "Fontify the current buffer with less decoration.
2025 ;;See `font-lock-maximum-decoration'."
2026 ;; (interactive)
2027 ;; ;; Check in case we get called interactively.
2028 ;; (if (nth 1 font-lock-fontify-level)
2029 ;; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
2030 ;; (error "No less decoration")))
2031 ;;
2032 ;;(defun font-lock-fontify-more ()
2033 ;; "Fontify the current buffer with more decoration.
2034 ;;See `font-lock-maximum-decoration'."
2035 ;; (interactive)
2036 ;; ;; Check in case we get called interactively.
2037 ;; (if (nth 2 font-lock-fontify-level)
2038 ;; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
2039 ;; (error "No more decoration")))
2040 ;;
2041 ;; ;; This should be called by `font-lock-set-defaults'.
2042 ;;(defun font-lock-set-menu ()
2043 ;; ;; Activate less/more fontification entries if there are multiple levels for
2044 ;; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
2045 ;; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
2046 ;; (let ((keywords (or (nth 0 font-lock-defaults)
2047 ;; (nth 1 (assq major-mode font-lock-defaults-alist))))
2048 ;; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
2049 ;; (make-local-variable 'font-lock-fontify-level)
2050 ;; (if (or (symbolp keywords) (= (length keywords) 1))
2051 ;; (font-lock-unset-menu)
2052 ;; (cond ((eq level t)
2053 ;; (setq level (1- (length keywords))))
2054 ;; ((or (null level) (zerop level))
2055 ;; ;; The default level is usually, but not necessarily, level 1.
2056 ;; (setq level (- (length keywords)
2057 ;; (length (member (eval (car keywords))
2058 ;; (mapcar 'eval (cdr keywords))))))))
2059 ;; (setq font-lock-fontify-level (list level (> level 1)
2060 ;; (< level (1- (length keywords))))))))
2061 ;;
2062 ;; ;; This should be called by `font-lock-unset-defaults'.
2063 ;;(defun font-lock-unset-menu ()
2064 ;; ;; Deactivate less/more fontification entries.
2065 ;; (setq font-lock-fontify-level nil))
2067 ;;; End of Menu support.
2068 \f
2069 ;;; Various regexp information shared by several modes.
2070 ;; ;; Information specific to a single mode should go in its load library.
2072 ;; Font Lock support for C, C++, Objective-C and Java modes is now in
2073 ;; cc-fonts.el (and required by cc-mode.el). However, the below function
2074 ;; should stay in font-lock.el, since it is used by other libraries. sm.
2077 "Match, and move over, any declaration/definition item after point.
2078 Matches after point, but ignores leading whitespace and `*' characters.
2079 Does not move further than LIMIT.
2081 The expected syntax of a declaration/definition item is `word' (preceded by
2082 optional whitespace and `*' characters and proceeded by optional whitespace)
2083 optionally followed by a `('. Everything following the item (but belonging to
2084 it) is expected to be skip-able by `scan-sexps', and items are expected to be
2085 separated with a `,' and to be terminated with a `;'.
2087 Thus the regexp matches after point: word (
2088 ^^^^ ^
2089 Where the match subexpressions are: 1 2
2091 The item is delimited by (match-beginning 1) and (match-end 1).
2092 If (match-beginning 2) is non-nil, the item is followed by a `('.
2094 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
2097 ;; If `word' is followed by a double open-paren, it's probably
2098 ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one
2099 ;; word to try and match `myfun' rather than `P_'.
2104 ;; Looks like it was something else, so go back to where we
2105 ;; were and reset the match data by rematching.
2111 ;; Restrict to the LIMIT.
2114 ;; Move over any item value, etc., to the next item.
2120 ;; C preprocessor(cpp) is used outside of C, C++ and Objective-C source file.
2121 ;; e.g. assembler code and GNU linker script in Linux kernel.
2122 ;; `cpp-font-lock-keywords' is handy for modes for the files.
2123 ;;
2124 ;; Here we cannot use `regexp-opt' because because regex-opt is not preloaded
2125 ;; while font-lock.el is preloaded to emacs. So values pre-calculated with
2126 ;; regexp-opt are used here.
2128 ;; `cpp-font-lock-keywords-source-directives' is calculated from:
2129 ;;
2130 ;; (regexp-opt
2131 ;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
2132 ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning"))
2133 ;;
2135 "define\\|e\\(?:l\\(?:if\\|se\\)\\|ndif\\|rror\\)\\|file\\|i\\(?:f\\(?:n?def\\)?\\|mport\\|nclude\\)\\|line\\|pragma\\|undef\\|warning"
2138 ;; `cpp-font-lock-keywords-source-depth' is calculated from:
2139 ;;
2140 ;; (regexp-opt-depth (regexp-opt
2141 ;; '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
2142 ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning")))
2143 ;;
2145 "An integer representing regular expression depth of `cpp-font-lock-keywords-source-directives'.
2152 ;;
2153 ;; Fontify error directives.
2155 ;;
2156 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2159 ;;
2160 ;; Fontify function macro names.
2163 ;;
2164 ;; Macro arguments.
2169 limit)
2170 t))
2172 ;;
2173 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2177 ;;
2178 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2185 "Font lock keyords for C preprocessor directives.
2186 `c-mode', `c++-mode' and `objc-mode' have their own
2187 font lock keyords for C preprocessor directives. This definition is for the
2188 other modes in which C preprocessor directives are used. e.g. `asm-mode' and
2191 \f
2192 ;; Lisp.
2198 ;; Function declarations.
2205 ;; Variable declarations.
2207 ;; Structure declarations.
2210 ;; Any whitespace and defined object.
2217 nil t))
2218 ;; Emacs Lisp autoload cookies.
2220 ;; Regexp negated char group.
2247 ;; Control structures. Common Lisp forms.
2268 ;; Exit/Feature symbols as constants.
2273 ;; Erroneous structures.
2274 ("(\\(abort\\|assert\\|warn\\|check-type\\|cerror\\|error\\|signal\\)\\>" 1 font-lock-warning-face)
2275 ;; Words inside \\[] tend to be for `substitute-command-keys'.
2277 ;; Words inside `' tend to be symbol names.
2279 ;; Constant values.
2281 ;; ELisp and CLisp `&' keywords as types.
2283 ;; ELisp regexp grouping constructs
2286 ;; The following loop is needed to continue searching after matches
2287 ;; that do not occur in strings. The associated regexp matches one
2288 ;; of `\\\\' `\\(' `\\(?:' `\\|' `\\)'. `\\\\' has been included to
2289 ;; avoid highlighting, for example, `\\(' in `\\\\('.
2290 (while (re-search-forward "\\(\\\\\\\\\\)\\(?:\\(\\\\\\\\\\)\\|\\((\\(?:\\?[0-9]*:\\)?\\|[|)]\\)\\)" bound t)
2299 ;;; This is too general -- rms.
2300 ;;; A user complained that he has functions whose names start with `do'
2301 ;;; and that they get the wrong color.
2302 ;;; ;; CL `with-' and `do-' constructs
2303 ;;; ("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
2304 )))
2309 \f
2312 ;; arch-tag: 682327e4-64d8-4057-b20b-1fbb9f1fc54c
2313 ;;; font-lock.el ends here