| blob | cced6a13ca2eb939d06c19580319ea8db06c38d5 |
1 ;;; font-lock.el --- Electric font lock mode
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004 2005 Free Software Foundation, Inc.
6 ;; Author: jwz, then rms, then sm
7 ;; Maintainer: FSF
8 ;; Keywords: languages, faces
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; Font Lock mode is a minor mode that causes your comments to be displayed in
30 ;; one face, strings in another, reserved words in another, and so on.
31 ;;
32 ;; Comments will be displayed in `font-lock-comment-face'.
33 ;; Strings will be displayed in `font-lock-string-face'.
34 ;; Regexps are used to display selected patterns in other faces.
35 ;;
36 ;; To make the text you type be fontified, use M-x font-lock-mode RET.
37 ;; When this minor mode is on, the faces of the current line are updated with
38 ;; every insertion or deletion.
39 ;;
40 ;; To turn Font Lock mode on automatically, add this to your ~/.emacs file:
41 ;;
42 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock)
43 ;;
44 ;; Or if you want to turn Font Lock mode on in many modes:
45 ;;
46 ;; (global-font-lock-mode t)
47 ;;
48 ;; Fontification for a particular mode may be available in a number of levels
49 ;; of decoration. The higher the level, the more decoration, but the more time
50 ;; it takes to fontify. See the variable `font-lock-maximum-decoration', and
51 ;; also the variable `font-lock-maximum-size'. Support modes for Font Lock
52 ;; mode can be used to speed up Font Lock mode. See `font-lock-support-mode'.
53 \f
54 ;;; How Font Lock mode fontifies:
56 ;; When Font Lock mode is turned on in a buffer, it (a) fontifies the entire
57 ;; buffer and (b) installs one of its fontification functions on one of the
58 ;; hook variables that are run by Emacs after every buffer change (i.e., an
59 ;; insertion or deletion). Fontification means the replacement of `face' text
60 ;; properties in a given region; Emacs displays text with these `face' text
61 ;; properties appropriately.
62 ;;
63 ;; Fontification normally involves syntactic (i.e., strings and comments) and
64 ;; regexp (i.e., keywords and everything else) passes. There are actually
65 ;; three passes; (a) the syntactic keyword pass, (b) the syntactic pass and (c)
66 ;; the keyword pass. Confused?
67 ;;
68 ;; The syntactic keyword pass places `syntax-table' text properties in the
69 ;; buffer according to the variable `font-lock-syntactic-keywords'. It is
70 ;; necessary because Emacs' syntax table is not powerful enough to describe all
71 ;; the different syntactic constructs required by the sort of people who decide
72 ;; that a single quote can be syntactic or not depending on the time of day.
73 ;; (What sort of person could decide to overload the meaning of a quote?)
74 ;; Obviously the syntactic keyword pass must occur before the syntactic pass.
75 ;;
76 ;; The syntactic pass places `face' text properties in the buffer according to
77 ;; syntactic context, i.e., according to the buffer's syntax table and buffer
78 ;; text's `syntax-table' text properties. It involves using a syntax parsing
79 ;; function to determine the context of different parts of a region of text. A
80 ;; syntax parsing function is necessary because generally strings and/or
81 ;; comments can span lines, and so the context of a given region is not
82 ;; necessarily apparent from the content of that region. Because the keyword
83 ;; pass only works within a given region, it is not generally appropriate for
84 ;; syntactic fontification. This is the first fontification pass that makes
85 ;; changes visible to the user; it fontifies strings and comments.
86 ;;
87 ;; The keyword pass places `face' text properties in the buffer according to
88 ;; the variable `font-lock-keywords'. It involves searching for given regexps
89 ;; (or calling given search functions) within the given region. This is the
90 ;; second fontification pass that makes changes visible to the user; it
91 ;; fontifies language reserved words, etc.
92 ;;
93 ;; Oh, and the answer is, "Yes, obviously just about everything should be done
94 ;; in a single syntactic pass, but the only syntactic parser available
95 ;; understands only strings and comments." Perhaps one day someone will write
96 ;; some syntactic parsers for common languages and a son-of-font-lock.el could
97 ;; use them rather then relying so heavily on the keyword (regexp) pass.
99 ;;; How Font Lock mode supports modes or is supported by modes:
101 ;; Modes that support Font Lock mode do so by defining one or more variables
102 ;; whose values specify the fontification. Font Lock mode knows of these
103 ;; variable names from (a) the buffer local variable `font-lock-defaults', if
104 ;; non-nil, or (b) the global variable `font-lock-defaults-alist', if the major
105 ;; mode has an entry. (Font Lock mode is set up via (a) where a mode's
106 ;; patterns are distributed with the mode's package library, and (b) where a
107 ;; mode's patterns are distributed with font-lock.el itself. An example of (a)
108 ;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is
109 ;; (a); (b) is used where it is not clear which package library should contain
110 ;; the pattern definitions.) Font Lock mode chooses which variable to use for
111 ;; fontification based on `font-lock-maximum-decoration'.
112 ;;
113 ;; Font Lock mode fontification behaviour can be modified in a number of ways.
114 ;; See the below comments and the comments distributed throughout this file.
116 ;;; Constructing patterns:
118 ;; See the documentation for the variable `font-lock-keywords'.
119 ;;
120 ;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and
121 ;; `font-lock-syntactic-keywords' can be generated via the function
122 ;; `regexp-opt'.
124 ;;; Adding patterns for modes that already support Font Lock:
126 ;; Though Font Lock highlighting patterns already exist for many modes, it's
127 ;; likely there's something that you want fontified that currently isn't, even
128 ;; at the maximum fontification level. You can add highlighting patterns via
129 ;; `font-lock-add-keywords'. For example, say in some C
130 ;; header file you #define the token `and' to expand to `&&', etc., to make
131 ;; your C code almost readable. In your ~/.emacs there could be:
132 ;;
133 ;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>"))
134 ;;
135 ;; Some modes provide specific ways to modify patterns based on the values of
136 ;; other variables. For example, additional C types can be specified via the
137 ;; variable `c-font-lock-extra-types'.
139 ;;; Adding patterns for modes that do not support Font Lock:
141 ;; Not all modes support Font Lock mode. If you (as a user of the mode) add
142 ;; patterns for a new mode, you must define in your ~/.emacs a variable or
143 ;; variables that specify regexp fontification. Then, you should indicate to
144 ;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what
145 ;; support is required. For example, say Foo mode should have the following
146 ;; regexps fontified case-sensitively, and comments and strings should not be
147 ;; fontified automagically. In your ~/.emacs there could be:
148 ;;
149 ;; (defvar foo-font-lock-keywords
150 ;; '(("\\<\\(one\\|two\\|three\\)\\>" . font-lock-keyword-face)
151 ;; ("\\<\\(four\\|five\\|six\\)\\>" . font-lock-type-face))
152 ;; "Default expressions to highlight in Foo mode.")
153 ;;
154 ;; (add-hook 'foo-mode-hook
155 ;; (lambda ()
156 ;; (make-local-variable 'font-lock-defaults)
157 ;; (setq font-lock-defaults '(foo-font-lock-keywords t))))
159 ;;; Adding Font Lock support for modes:
161 ;; Of course, it would be better that the mode already supports Font Lock mode.
162 ;; The package author would do something similar to above. The mode must
163 ;; define at the top-level a variable or variables that specify regexp
164 ;; fontification. Then, the mode command should indicate to Font Lock mode,
165 ;; via `font-lock-defaults', exactly what support is required. For example,
166 ;; say Bar mode should have the following regexps fontified case-insensitively,
167 ;; and comments and strings should be fontified automagically. In bar.el there
168 ;; could be:
169 ;;
170 ;; (defvar bar-font-lock-keywords
171 ;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . font-lock-keyword-face)
172 ;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . font-lock-type-face))
173 ;; "Default expressions to highlight in Bar mode.")
174 ;;
175 ;; and within `bar-mode' there could be:
176 ;;
177 ;; (make-local-variable 'font-lock-defaults)
178 ;; (setq font-lock-defaults '(bar-font-lock-keywords nil t))
179 \f
180 ;; What is fontification for? You might say, "It's to make my code look nice."
181 ;; I think it should be for adding information in the form of cues. These cues
182 ;; should provide you with enough information to both (a) distinguish between
183 ;; different items, and (b) identify the item meanings, without having to read
184 ;; the items and think about it. Therefore, fontification allows you to think
185 ;; less about, say, the structure of code, and more about, say, why the code
186 ;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
187 ;;
188 ;; So, here are my opinions/advice/guidelines:
189 ;;
190 ;; - Highlight conceptual objects, such as function and variable names, and
191 ;; different objects types differently, i.e., (a) and (b) above, highlight
192 ;; function names differently to variable names.
193 ;; - Keep the faces distinct from each other as far as possible.
194 ;; i.e., (a) above.
195 ;; - Use the same face for the same conceptual object, across all modes.
196 ;; i.e., (b) above, all modes that have items that can be thought of as, say,
197 ;; keywords, should be highlighted with the same face, etc.
198 ;; - Make the face attributes fit the concept as far as possible.
199 ;; i.e., function names might be a bold colour such as blue, comments might
200 ;; be a bright colour such as red, character strings might be brown, because,
201 ;; err, strings are brown (that was not the reason, please believe me).
202 ;; - Don't use a non-nil OVERRIDE unless you have a good reason.
203 ;; Only use OVERRIDE for special things that are easy to define, such as the
204 ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
205 ;; Don't use it to, say, highlight keywords in commented out code or strings.
206 ;; - Err, that's it.
207 \f
208 ;;; Code:
212 ;; Define core `font-lock' group.
214 "Font Lock mode text highlighting package."
220 "Faces for highlighting text."
225 "Extra mode-specific type names for highlighting declarations."
228 ;; Define support mode groups here to impose `font-lock' group order.
230 "Font Lock support mode to cache fontification."
235 "Font Lock support mode to fontify lazily."
238 \f
239 ;; User variables.
242 "*Maximum size of a buffer for buffer fontification.
243 Only buffers less than this can be fontified when Font Lock mode is turned on.
244 If nil, means size is irrelevant.
245 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
246 where MAJOR-MODE is a symbol or t (meaning the default). For example:
247 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
248 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
249 for buffers in Rmail mode, and size is irrelevant otherwise."
264 "*Maximum decoration level for fontification.
265 If nil, use the default decoration (typically the minimum available).
266 If t, use the maximum decoration available.
267 If a number, use that level of decoration (or if not available the maximum).
268 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
269 where MAJOR-MODE is a symbol or t (meaning the default). For example:
270 ((c-mode . t) (c++-mode . 2) (t . 1))
271 means use the maximum decoration available for buffers in C mode, level 2
272 decoration for buffers in C++ mode, and level 1 decoration otherwise."
289 "*If non-nil, means show status messages for buffer fontification.
290 If a number, only buffers greater than this size have fontification messages."
297 "*Number of lines before the changed text to include in refontification."
301 \f
303 ;; Originally these variable values were face names such as `bold' etc.
304 ;; Now we create our own faces, but we keep these variables for compatibility
305 ;; and they give users another mechanism for changing face appearance.
306 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
307 ;; returns a face. So the easiest thing is to continue using these variables,
308 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
345 ;; Fontification variables:
348 "A list of the keywords to highlight.
349 There are two kinds of values: user-level, and compiled.
351 A user-level keywords list is what a major mode or the user would
352 set up. Normally the list would come from `font-lock-defaults'.
353 through selection of a fontification level and evaluation of any
354 contained expressions. You can also alter it by calling
355 `font-lock-add-keywords' or `font-lock-remove-keywords' with MODE = nil.
357 Each element in a user-level keywords list should have one of these forms:
359 MATCHER
360 (MATCHER . MATCH)
361 (MATCHER . FACENAME)
362 (MATCHER . HIGHLIGHT)
363 (MATCHER HIGHLIGHT ...)
364 (eval . FORM)
366 where MATCHER can be either the regexp to search for, or the function name to
367 call to make the search (called with one argument, the limit of the search;
368 it should return non-nil, move point, and set `match-data' appropriately iff
369 it succeeds; like `re-search-forward' would).
370 MATCHER regexps can be generated via the function `regexp-opt'.
372 FORM is an expression, whose value should be a keyword element, evaluated when
373 the keyword is (first) used in a buffer. This feature can be used to provide a
374 keyword that can only be generated when Font Lock mode is actually turned on.
376 HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
379 typically only MATCH-HIGHLIGHT is required.
380 However, if an item or (typically) items are to be highlighted following the
381 instance of another item (the anchor), for example each instance of the
384 MATCH-HIGHLIGHT should be of the form:
386 (MATCH FACENAME [[OVERRIDE [LAXMATCH]])
388 MATCH is the subexpression of MATCHER to be highlighted. FACENAME is an
389 expression whose value is the face name to use. Face default attributes
391 evaluate to a property list of the form (face FACE PROP1 VAL1 PROP2 VAL2 ...)
392 in which case all the listed text-properties will be set rather than
393 just FACE. In such a case, you will most likely want to put those
394 properties in `font-lock-extra-managed-props' or to override
395 `font-lock-unfontify-region-function'.
397 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
398 be overwritten. If `keep', only parts not already fontified are highlighted.
399 If `prepend' or `append', existing fontification is merged with the new, in
400 which the new or existing fontification, respectively, takes precedence.
401 If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER.
403 For example, an element of the form highlights (if not already highlighted):
406 variable `font-lock-keyword-face'.
408 the value of `font-lock-keyword-face'.
412 of `foo-bar-face', even if already highlighted.
413 (fubar-match 1 fubar-face)
414 the first subexpression within all occurrences of
415 whatever the function `fubar-match' finds and matches
416 in the value of `fubar-face'.
418 MATCH-ANCHORED should be of the form:
420 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
422 where MATCHER is a regexp to search for or the function name to call to make
423 the search, as for MATCH-HIGHLIGHT above, but with one exception; see below.
424 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
425 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
426 used to initialise before, and cleanup after, MATCHER is used. Typically,
427 PRE-MATCH-FORM is used to move to some position relative to the original
428 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
429 be used to move back, before resuming with MATCH-ANCHORED's parent's MATCHER.
431 For example, an element of the form highlights (if not already highlighted):
442 The above-mentioned exception is as follows. The limit of the MATCHER search
443 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
444 However, if PRE-MATCH-FORM returns a position greater than the position after
445 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
446 It is generally a bad idea to return a position greater than the end of the
447 line, i.e., cause the MATCHER search to span lines.
449 These regular expressions can match text which spans lines, although
450 it is better to avoid it if possible since updating them while editing
451 text is slower, and it is not guaranteed to be always correct when using
452 support modes like jit-lock or lazy-lock.
454 This variable is set by major modes via the variable `font-lock-defaults'.
455 Be careful when composing regexps for this list; a poorly written pattern can
456 dramatically slow things down!
458 A compiled keywords list starts with t. It is produced internal
459 by `font-lock-compile-keywords' from a user-level keywords list.
460 Its second element is the user-level keywords list that was
461 compiled. The remaining elements have the same form as
462 user-level keywords, but normally their values have been
466 "*Alist of `font-lock-keywords' local to a `major-mode'.
467 This is normally set via `font-lock-add-keywords' and
471 "*Alist of `font-lock-keywords' removed from `major-mode'.
472 This is normally set via `font-lock-add-keywords' and
476 "*Non-nil means Font Lock should not fontify comments or strings.
480 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
485 "Point up to which `font-lock-syntactic-keywords' has been applied.
486 If nil, this is ignored, in which case the syntactic fontification may
493 "Function to determine which face to use when fontifying syntactically.
494 The function is called with a single parameter (the state as returned by
495 `parse-partial-sexp' at the beginning of the region to highlight) and
499 "A list of the syntactic keywords to highlight.
500 Can be the list or the name of a function or variable whose value is the list.
501 See `font-lock-keywords' for a description of the form of this list;
502 the differences are listed below. MATCH-HIGHLIGHT should be of the form:
504 (MATCH SYNTAX OVERRIDE LAXMATCH)
506 where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax
507 table, a cons cell (as returned by `string-to-syntax') or an expression whose
508 value is such a form. OVERRIDE cannot be `prepend' or `append'.
510 For example, an element of the form highlights syntactically:
514 a hash character when following a dollar character, with a SYNTAX of
516 specify hash characters to have comment start syntax, the element will only
517 highlight hash characters that do not follow dollar characters as comments
518 syntactically.
524 both single quotes which surround a single character, with a SYNTAX of
526 does not specify single quotes to have quote syntax, the element will only
527 highlight single quotes of the form 'c' as strings syntactically.
528 Other forms, such as foo'bar or 'fubar', will not be highlighted as strings.
533 "Non-nil means use this syntax table for fontifying.
534 If this is nil, the major mode's syntax table is used.
538 "*Non-nil means use this function to move back outside all constructs.
539 When called with no args it should move point backward to a place which
540 is not in a string or comment and not within any bracket-pairs (or else,
541 a place such that any bracket-pairs outside it can be ignored for Emacs
542 syntax analysis and fontification).
544 If this is nil, the beginning of the buffer is used, which is
545 always correct but tends to be slow.
546 This is normally set via `font-lock-defaults'.
547 This variable is semi-obsolete; we recommend setting
551 "*Non-nil means use this function to mark a block of text.
552 When called with no args it should leave point at the beginning of any
553 enclosing textual block and mark at the end.
557 "Function to use for fontifying the buffer.
561 "Function to use for unfontifying the buffer.
562 This is used when turning off Font Lock mode.
566 "Function to use for fontifying a region.
567 It should take two args, the beginning and end of the region, and an optional
568 third arg VERBOSE. If non-nil, the function should print status messages.
572 "Function to use for unfontifying a region.
573 It should take two args, the beginning and end of the region.
577 "List of Font Lock mode related modes that should not be turned on.
578 Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
582 "Whether font-lock should cater to multiline keywords.
583 If nil, don't try to handle multiline patterns.
584 If t, always handle multiline patterns.
585 If `undecided', don't try to handle multiline patterns until you see one.
589 \f
590 ;; Font Lock mode.
593 ;;
594 ;; We don't do this at the top-level as we only use non-autoloaded macros.
596 ;;
597 ;; Borrowed from lazy-lock.el.
598 ;; We use this to preserve or protect things when modifying text properties.
600 "Bind variables according to VARLIST and eval BODY restoring buffer state."
608 deactivate-mark
609 buffer-file-name
610 buffer-file-truename))
617 ;;
618 ;; Shut up the byte compiler.
621 ;;;###autoload
623 ;; Turn on Font Lock mode.
628 ;; Fontify the buffer if we have to.
631 nil)
637 ;; Turn off Font Lock mode.
643 ;;;###autoload
645 "Add highlighting KEYWORDS for MODE.
646 MODE should be a symbol, the major mode command name, such as `c-mode'
647 or nil. If nil, highlighting keywords are added for the current buffer.
648 KEYWORDS should be a list; see the variable `font-lock-keywords'.
649 By default they are added at the beginning of the current highlighting list.
650 If optional argument APPEND is `set', they are used to replace the current
651 highlighting list. If APPEND is any other non-nil value, they are added at the
652 end of the current highlighting list.
654 For example:
656 (font-lock-add-keywords 'c-mode
660 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
661 comments, and to fontify `and', `or' and `not' words as keywords.
663 When used from an elisp package (such as a minor mode), it is recommended
664 to use nil for MODE (and place the call in a loop or on a hook) to avoid
665 subtle problems due to details of the implementation.
667 Note that some modes have specialized support for additional patterns, e.g.,
668 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
669 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
671 ;; If MODE is non-nil, add the KEYWORDS and APPEND spec to
672 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
679 ;; Make sure that `font-lock-removed-keywords-alist' does not
680 ;; contain the new keywords.
683 ;; Otherwise set or add the keywords now.
684 ;; This is a no-op if it has been done already in this buffer.
687 ;; Bring back the user-level (uncompiled) keywords.
690 ;; Now modify or replace them.
696 font-lock-keywords)))
700 ;; If the keywords were compiled before, compile them again.
706 ;; Update `font-lock-removed-keywords-alist' when adding new
707 ;; KEYWORDS to MODE.
708 ;;
709 ;; When font-lock is enabled first all keywords in the list
710 ;; `font-lock-keywords-alist' are added, then all keywords in the
711 ;; list `font-lock-removed-keywords-alist' are removed. If a
712 ;; keyword was once added, removed, and then added again it must be
713 ;; removed from the removed-keywords list. Otherwise the second add
714 ;; will not take effect.
718 ;; A new set of keywords is defined. Forget all about
719 ;; our old keywords that should be removed.
722 ;; Delete all previously removed keywords.
725 ;; Delete the mode cell if empty.
730 ;; Written by Anders Lindgren <andersl@andersl.com>.
731 ;;
732 ;; Case study:
733 ;; (I) The keywords are removed from a major mode.
734 ;; In this case the keyword could be local (i.e. added earlier by
735 ;; `font-lock-add-keywords'), global, or both.
736 ;;
737 ;; (a) In the local case we remove the keywords from the variable
738 ;; `font-lock-keywords-alist'.
739 ;;
740 ;; (b) The actual global keywords are not known at this time.
741 ;; All keywords are added to `font-lock-removed-keywords-alist',
742 ;; when font-lock is enabled those keywords are removed.
743 ;;
744 ;; Note that added keywords are taken out of the list of removed
745 ;; keywords. This ensure correct operation when the same keyword
746 ;; is added and removed several times.
747 ;;
748 ;; (II) The keywords are removed from the current buffer.
749 ;;;###autoload
751 "Remove highlighting KEYWORDS for MODE.
753 MODE should be a symbol, the major mode command name, such as `c-mode'
754 or nil. If nil, highlighting keywords are removed for the current buffer.
756 When used from an elisp package (such as a minor mode), it is recommended
757 to use nil for MODE (and place the call in a loop or on a hook) to avoid
758 subtle problems due to details of the implementation."
760 ;; Remove one keyword at the time.
763 ;; If MODE is non-nil, remove the KEYWORD from
764 ;; `font-lock-keywords-alist'.
767 ;; `keywords-list-append-pair' is a cons with a list of
768 ;; keywords in the car top-cell and the original append
769 ;; argument in the cdr top-cell.
772 ;; Remove keyword list/append pair when the keyword list
773 ;; is empty and append doesn't specify `set'. (If it
774 ;; should be deleted then previously deleted keywords
775 ;; would appear again.)
782 ;; Final cleanup, remove major mode cell if last keyword
783 ;; was deleted.
787 ;; Remember the keyword in case it is not local.
793 font-lock-removed-keywords-alist))))))
795 ;; Otherwise remove it immediately.
798 ;; Bring back the user-level (uncompiled) keywords.
802 ;; Edit them.
808 ;; If the keywords were compiled before, compile them again.
812 \f
813 ;;; Font Lock Support mode.
815 ;; This is the code used to interface font-lock.el with any of its add-on
816 ;; packages, and provide the user interface. Packages that have their own
817 ;; local buffer fontification functions (see below) may have to call
818 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
819 ;; themselves.
822 "*Support mode for Font Lock mode.
823 Support modes speed up Font Lock mode by being choosy about when fontification
824 occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode'),
825 Lazy Lock mode (symbol `lazy-lock-mode'), and Just-in-time Lock mode (symbol
826 `jit-lock-mode'. See those modes for more info.
827 If nil, means support for Font Lock mode is never performed.
828 If a symbol, use that support mode.
829 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
830 where MAJOR-MODE is a symbol or t (meaning the default). For example:
831 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
832 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
833 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
835 The value of this variable is used when Font Lock mode is turned on."
851 ))
866 ;; Prepare for jit-lock
871 ;; Don't fontify eagerly (and don't abort is the buffer is large).
873 ;; Use jit-lock.
882 ;; Reset local vars to the non-jit-lock case.
890 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
891 ;; (jit-lock-mode
892 ;; (jit-lock-after-fontify-buffer))
899 ;; Useless as well. It's only called when:
900 ;; - turning off font-lock: it does not matter if we leave spurious
901 ;; `fontified' text props around since jit-lock-mode is also off.
902 ;; - font-lock-default-fontify-buffer fails: this is not run
903 ;; any more anyway. -sm
904 ;;
905 ;; (jit-lock-mode
906 ;; (jit-lock-after-unfontify-buffer))
910 ;;; End of Font Lock Support mode.
911 \f
912 ;;; Fontification functions.
914 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
915 ;; code to fontify a region, the function runs the function whose name is the
916 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
917 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
918 ;; which does contain the code to fontify a region. However, the value of the
919 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
920 ;; do anything. The indirection of the fontification functions gives major
921 ;; modes the capability of modifying the way font-lock.el fontifies. Major
922 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
923 ;; via the variable `font-lock-defaults'.
924 ;;
925 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
926 ;; font-lock.el uses its own function for buffer fontification. This function
927 ;; makes fontification be on a message-by-message basis and so visiting an
928 ;; RMAIL file is much faster. A clever implementation of the function might
929 ;; fontify the headers differently than the message body. (It should, and
930 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
931 ;; you?) This hints at a more interesting use...
932 ;;
933 ;; Languages that contain text normally contained in different major modes
934 ;; could define their own fontification functions that treat text differently
935 ;; depending on its context. For example, Perl mode could arrange that here
936 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
937 ;; rules one way and C code another. Neat!
938 ;;
939 ;; A further reason to use the fontification indirection feature is when the
940 ;; default syntactual fontification, or the default fontification in general,
941 ;; is not flexible enough for a particular major mode. For example, perhaps
942 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
943 ;; cope with. You need to write your own version of that function, e.g.,
944 ;; `hairy-fontify-syntactically-region', and make your own version of
945 ;; `hairy-fontify-region' call that function before calling
946 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
947 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
948 ;; would call your region fontification function instead of its own. For
949 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
950 ;; directives correctly and cleanly. (It is the same problem as fontifying
951 ;; multi-line strings and comments; regexps are not appropriate for the job.)
953 ;;;###autoload
955 "Fontify the current buffer the way the function `font-lock-mode' would."
973 font-lock-verbose)))
977 ;; Make sure we have the right `font-lock-keywords' etc.
980 ;; Make sure we fontify etc. in the whole buffer.
989 ;; We don't restore the old fontification, so it's best to unfontify.
993 ;; Make sure we unfontify etc. in the whole buffer.
1001 "If non-nil, font-lock will work on the non-widened buffer.
1002 Useful for things like RMAIL and Info where the whole buffer is not
1012 ;; Use the fontification syntax table, if any.
1015 ;; check to see if we should expand the beg/end area for
1016 ;; proper multiline matches
1020 ;; We are just after or in a multiline match.
1032 ;; Now do the fontification.
1039 ;; Clean up.
1042 ;; The following must be rethought, since keywords can override fontification.
1043 ; ;; Now scan for keywords, but not if we are inside a comment now.
1044 ; (or (and (not font-lock-keywords-only)
1045 ; (let ((state (parse-partial-sexp beg end nil nil
1046 ; font-lock-cache-state)))
1047 ; (or (nth 4 state) (nth 7 state))))
1048 ; (font-lock-fontify-keywords-region beg end))
1051 "Additional text properties managed by font-lock.
1052 This is used by `font-lock-default-unfontify-region' to decide
1058 font-lock-extra-managed-props
1063 ;; Called when any modification is made to buffer text.
1069 ;; Rescan between start of lines enclosing the region.
1076 "Fontify some lines the way `font-lock-fontify-buffer' would.
1077 The lines could be a function or paragraph, or a specified number of lines.
1078 If ARG is given, fontify that many lines before and after point, or 16 lines if
1079 no ARG is given and `font-lock-mark-block-function' is nil.
1080 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1081 delimit the region to fontify."
1084 deactivate-mark)
1085 ;; Make sure we have the right `font-lock-keywords' etc.
1102 ;;; End of Fontification functions.
1103 \f
1104 ;;; Additional text property functions.
1106 ;; The following text property functions should be builtins. This means they
1107 ;; should be written in C and put with all the other text property functions.
1108 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1109 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1110 ;; in Lisp below and commented out. sm.
1113 "Prepend to one property of the text from START to END.
1114 Arguments PROP and VALUE specify the property and value to prepend to the value
1115 already in place. The resulting property values are always lists.
1116 Optional argument OBJECT is the string or buffer containing the text."
1123 object)
1127 "Append to one property of the text from START to END.
1128 Arguments PROP and VALUE specify the property and value to append to the value
1129 already in place. The resulting property values are always lists.
1130 Optional argument OBJECT is the string or buffer containing the text."
1137 object)
1141 "Fill in one property of the text from START to END.
1142 Arguments PROP and VALUE specify the property and value to put where none are
1143 already in place. Therefore existing property values are not overwritten.
1144 Optional argument OBJECT is the string or buffer containing the text."
1151 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1152 ;; is to `add-text-properties', etc.
1153 ;(defun remove-text-property (start end property &optional object)
1154 ; "Remove a property from text from START to END.
1155 ;Argument PROPERTY is the property to remove.
1156 ;Optional argument OBJECT is the string or buffer containing the text.
1157 ;Return t if the property was actually removed, nil otherwise."
1158 ; (remove-text-properties start end (list property) object))
1160 ;; For consistency: maybe this should be called `remove-single-property' like
1161 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1162 ;(defun remove-single-text-property (start end prop value &optional object)
1163 ; "Remove a specific property value from text from START to END.
1164 ;Arguments PROP and VALUE specify the property and value to remove. The
1165 ;resulting property values are not equal to VALUE nor lists containing VALUE.
1166 ;Optional argument OBJECT is the string or buffer containing the text."
1167 ; (let ((start (text-property-not-all start end prop nil object)) next prev)
1168 ; (while start
1169 ; (setq next (next-single-property-change start prop object end)
1170 ; prev (get-text-property start prop object))
1171 ; (cond ((and (symbolp prev) (eq value prev))
1172 ; (remove-text-property start next prop object))
1173 ; ((and (listp prev) (memq value prev))
1174 ; (let ((new (delq value prev)))
1175 ; (cond ((null new)
1176 ; (remove-text-property start next prop object))
1177 ; ((= (length new) 1)
1178 ; (put-text-property start next prop (car new) object))
1179 ; (t
1180 ; (put-text-property start next prop new object))))))
1181 ; (setq start (text-property-not-all next end prop nil object)))))
1183 ;;; End of Additional text property functions.
1184 \f
1185 ;;; Syntactic regexp fontification functions.
1187 ;; These syntactic keyword pass functions are identical to those keyword pass
1188 ;; functions below, with the following exceptions; (a) they operate on
1189 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1190 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1191 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1192 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1193 ;; LOUDLY as it is not likely to be intensive.
1196 "Apply HIGHLIGHT following a match.
1197 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1198 see `font-lock-syntactic-keywords'."
1204 ;; No match but we might not signal an error.
1210 ;; Flush the syntax-cache. I believe this is not necessary for
1211 ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can
1212 ;; still be necessary for other users of syntax-ppss anyway.
1216 ;; Cannot override existing fontification.
1220 ;; Override existing fontification.
1223 ;; Keep existing fontification.
1227 "Fontify according to KEYWORDS until LIMIT.
1228 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1229 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1231 ;; Evaluate PRE-MATCH-FORM.
1233 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1238 ;; Find an occurrence of `matcher' before `limit'.
1242 ;; Apply each highlight to this instance of `matcher'.
1247 ;; Evaluate POST-MATCH-FORM.
1251 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1252 START should be at the beginning of a line."
1253 ;; Ensure the beginning of the file is properly syntactic-fontified.
1258 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1261 font-lock-syntactic-keywords)))
1262 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1265 font-lock-syntactic-keywords)))
1266 ;; Get down to business.
1269 keyword matcher highlights)
1271 ;; Find an occurrence of `matcher' from `start' to `end'.
1277 ;; Apply each highlight to this instance of `matcher', which may be
1278 ;; specific highlights or more keywords anchored to `matcher'.
1284 end))
1288 ;;; End of Syntactic regexp fontification functions.
1289 \f
1290 ;;; Syntactic fontification functions.
1293 "Put proper face on each string and comment between START and END.
1294 START should be at the beginning of a line."
1298 ;;
1299 ;; Find the `start' state.
1301 ;;
1302 ;; Find each interesting place between here and `end'.
1315 ;;; End of Syntactic fontification functions.
1316 \f
1317 ;;; Keyword regexp fontification functions.
1320 "Apply HIGHLIGHT following a match.
1321 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1326 ;; No match but we might not signal an error.
1335 ;; If `val' is nil, don't do anything. It is important to do it
1336 ;; explicitly, because when adding nil via things like
1337 ;; font-lock-append-text-property, the property is actually
1338 ;; changed from <face> to (<face>) which is undesirable. --Stef
1339 nil)
1341 ;; Cannot override existing fontification.
1345 ;; Override existing fontification.
1348 ;; Prepend to existing fontification.
1351 ;; Append to existing fontification.
1354 ;; Keep existing fontification.
1358 "Fontify according to KEYWORDS until LIMIT.
1359 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1360 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1363 ;; Evaluate PRE-MATCH-FORM.
1365 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1370 ;; this is a multiline anchored match
1371 ;; (setq font-lock-multiline t)
1375 limit
1378 ;; Find an occurrence of `matcher' before `limit'.
1383 ;; Apply each highlight to this instance of `matcher'.
1388 ;; Evaluate POST-MATCH-FORM.
1392 "Fontify according to `font-lock-keywords' between START and END.
1393 START should be at the beginning of a line.
1394 LOUDLY, if non-nil, allows progress-meter bar."
1401 keyword matcher highlights)
1402 ;;
1403 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1407 ;;
1408 ;; Find an occurrence of `matcher' from `start' to `end'.
1419 ;; this is a multiline regexp match
1420 ;; (setq font-lock-multiline t)
1429 ;; Apply each highlight to this instance of `matcher', which may be
1430 ;; specific highlights or more keywords anchored to `matcher'.
1437 ;; Ensure forward progress.
1442 ;;; End of Keyword regexp fontification functions.
1443 \f
1444 ;; Various functions.
1447 "Compile KEYWORDS into the form (t KEYWORDS COMPILED...)
1448 Here each COMPILED is of the form (MATCHER HIGHLIGHT ...) as shown in the
1449 `font-lock-keywords' doc string.
1450 If REGEXP is non-nil, it means these keywords are used for
1451 `font-lock-keywords' rather than for `font-lock-syntactic-keywords'."
1453 keywords
1459 font-lock-beginning-of-syntax-function)
1462 ;; Try to detect when a string or comment contains something that
1463 ;; looks like a defun and would thus confuse font-lock.
1471 font-lock-comment-face))
1472 font-lock-warning-face)
1473 prepend)))))
1474 keywords))
1482 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1493 keyword)))
1496 "Evalulate KEYWORDS if a function (funcall) or variable (eval) name."
1498 keywords
1504 "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1505 Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
1508 alist))
1511 "Return LEVELth element of KEYWORDS.
1512 A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1513 \(1- (length KEYWORDS))."
1515 keywords)
1526 "Set fontification defaults appropriately for this mode.
1527 Sets various variables using `font-lock-defaults' (or, if nil, using
1528 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1529 ;; Set fontification defaults iff not previously set.
1537 font-lock-defaults-alist)))))
1545 ;; Syntactic fontification?
1548 ;; Case fold during regexp fontification?
1551 ;; Syntax table for regexp and syntactic fontification?
1556 ;; The character to modify may be a single CHAR or a STRING.
1562 ;; Syntax function for syntactic fontification?
1566 ;; Variable alist?
1569 ;; Set up `font-lock-keywords' last because its value might depend
1570 ;; on other settings (e.g. font-lock-compile-keywords uses
1571 ;; font-lock-beginning-of-syntax-function).
1574 ;; Local fontification?
1580 ;; Now compile the keywords.
1584 \f
1585 ;;; Colour etc. support.
1587 ;; Originally face attributes were specified via `font-lock-face-attributes'.
1588 ;; Users then changed the default face attributes by setting that variable.
1589 ;; However, we try and be back-compatible and respect its value if set except
1590 ;; for faces where M-x customize has been used to save changes for the face.
1596 ;; Rustle up a `defface' SPEC from a `font-lock-face-attributes' entry.
1603 face-spec)
1616 ;; But now we do it the custom way. Note that `defface' will not overwrite any
1617 ;; faces declared above via `custom-declare-face'.
1636 "Font Lock mode face used to highlight comments."
1648 "Font Lock mode face used to highlight strings."
1653 "Font Lock mode face used to highlight documentation."
1665 "Font Lock mode face used to highlight keywords."
1677 "Font Lock mode face used to highlight builtins."
1687 "Font Lock mode face used to highlight function names."
1701 "Font Lock mode face used to highlight variable names."
1713 "Font Lock mode face used to highlight type and classes."
1727 "Font Lock mode face used to highlight constants and labels."
1737 "Font Lock mode face used to highlight warnings."
1742 "Font Lock mode face used to highlight preprocessor directives."
1745 ;;; End of Colour etc. support.
1746 \f
1747 ;;; Menu support.
1749 ;; This section of code is commented out because Emacs does not have real menu
1750 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1751 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1752 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1753 ;; the entry for "Text Properties" something like:
1754 ;;
1755 ;; (define-key menu-bar-edit-menu [font-lock]
1756 ;; (cons "Syntax Highlighting" font-lock-menu))
1757 ;;
1758 ;; and remove a single ";" from the beginning of each line in the rest of this
1759 ;; section. Probably the mechanism for telling the menu code what are menu
1760 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1761 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1763 ;;;;###autoload
1764 ;(progn
1765 ; ;; Make the Font Lock menu.
1766 ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1767 ; ;; Add the menu items in reverse order.
1768 ; (define-key font-lock-menu [fontify-less]
1769 ; '("Less In Current Buffer" . font-lock-fontify-less))
1770 ; (define-key font-lock-menu [fontify-more]
1771 ; '("More In Current Buffer" . font-lock-fontify-more))
1772 ; (define-key font-lock-menu [font-lock-sep]
1773 ; '("--"))
1774 ; (define-key font-lock-menu [font-lock-mode]
1775 ; '("In Current Buffer" . font-lock-mode))
1776 ; (define-key font-lock-menu [global-font-lock-mode]
1777 ; '("In All Buffers" . global-font-lock-mode)))
1778 ;
1779 ;;;;###autoload
1780 ;(progn
1781 ; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1782 ; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1783 ; (put 'global-font-lock-mode 'menu-toggle t)
1784 ; (put 'font-lock-mode 'menu-toggle t)
1785 ; (put 'font-lock-fontify-more 'menu-enable '(identity))
1786 ; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1787 ;
1788 ;;; Put the appropriate symbol property values on now. See above.
1789 ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
1790 ;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1791 ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1792 ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1793 ;
1794 ;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1795 ;
1796 ;(defun font-lock-fontify-level (level)
1797 ; (let ((font-lock-maximum-decoration level))
1798 ; (when font-lock-mode
1799 ; (font-lock-mode))
1800 ; (font-lock-mode)
1801 ; (when font-lock-verbose
1802 ; (message "Fontifying %s... level %d" (buffer-name) level))))
1803 ;
1804 ;(defun font-lock-fontify-less ()
1805 ; "Fontify the current buffer with less decoration.
1806 ;See `font-lock-maximum-decoration'."
1807 ; (interactive)
1808 ; ;; Check in case we get called interactively.
1809 ; (if (nth 1 font-lock-fontify-level)
1810 ; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1811 ; (error "No less decoration")))
1812 ;
1813 ;(defun font-lock-fontify-more ()
1814 ; "Fontify the current buffer with more decoration.
1815 ;See `font-lock-maximum-decoration'."
1816 ; (interactive)
1817 ; ;; Check in case we get called interactively.
1818 ; (if (nth 2 font-lock-fontify-level)
1819 ; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1820 ; (error "No more decoration")))
1821 ;
1822 ;;; This should be called by `font-lock-set-defaults'.
1823 ;(defun font-lock-set-menu ()
1824 ; ;; Activate less/more fontification entries if there are multiple levels for
1825 ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
1826 ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
1827 ; (let ((keywords (or (nth 0 font-lock-defaults)
1828 ; (nth 1 (assq major-mode font-lock-defaults-alist))))
1829 ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1830 ; (make-local-variable 'font-lock-fontify-level)
1831 ; (if (or (symbolp keywords) (= (length keywords) 1))
1832 ; (font-lock-unset-menu)
1833 ; (cond ((eq level t)
1834 ; (setq level (1- (length keywords))))
1835 ; ((or (null level) (zerop level))
1836 ; ;; The default level is usually, but not necessarily, level 1.
1837 ; (setq level (- (length keywords)
1838 ; (length (member (eval (car keywords))
1839 ; (mapcar 'eval (cdr keywords))))))))
1840 ; (setq font-lock-fontify-level (list level (> level 1)
1841 ; (< level (1- (length keywords))))))))
1842 ;
1843 ;;; This should be called by `font-lock-unset-defaults'.
1844 ;(defun font-lock-unset-menu ()
1845 ; ;; Deactivate less/more fontification entries.
1846 ; (setq font-lock-fontify-level nil))
1848 ;;; End of Menu support.
1849 \f
1850 ;;; Various regexp information shared by several modes.
1851 ;;; Information specific to a single mode should go in its load library.
1853 ;; Font Lock support for C, C++, Objective-C and Java modes is now in
1854 ;; cc-fonts.el (and required by cc-mode.el). However, the below function
1855 ;; should stay in font-lock.el, since it is used by other libraries. sm.
1858 "Match, and move over, any declaration/definition item after point.
1859 Matches after point, but ignores leading whitespace and `*' characters.
1860 Does not move further than LIMIT.
1862 The expected syntax of a declaration/definition item is `word' (preceded by
1863 optional whitespace and `*' characters and proceeded by optional whitespace)
1864 optionally followed by a `('. Everything following the item (but belonging to
1865 it) is expected to be skip-able by `scan-sexps', and items are expected to be
1866 separated with a `,' and to be terminated with a `;'.
1868 Thus the regexp matches after point: word (
1869 ^^^^ ^
1870 Where the match subexpressions are: 1 2
1872 The item is delimited by (match-beginning 1) and (match-end 1).
1873 If (match-beginning 2) is non-nil, the item is followed by a `('.
1875 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
1878 ;; If `word' is followed by a double open-paren, it's probably
1879 ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one
1880 ;; word to try and match `myfun' rather than `P_'.
1885 ;; Looks like it was something else, so go back to where we
1886 ;; were and reset the match data by rematching.
1892 ;; Restrict to the LIMIT.
1895 ;; Move over any item value, etc., to the next item.
1900 \f
1901 ;; Lisp.
1906 ;;
1907 ;; Definitions.
1909 ;; Function declarations.
1915 ;; Variable declarations.
1917 ;; Structure declarations.
1920 ;; Any whitespace and defined object.
1927 nil t))
1928 ;;
1929 ;; Emacs Lisp autoload cookies.
1931 ))
1938 ;;
1939 ;; Control structures. Emacs Lisp forms.
1949 "eval-when"
1950 "with-category-table"
1959 ;;
1960 ;; Control structures. Common Lisp forms.
1981 ;;
1982 ;; Exit/Feature symbols as constants.
1987 ;;
1988 ;; Erroneous structures.
1989 '("(\\(abort\\|assert\\|warn\\|check-type\\|cerror\\|error\\|signal\\)\\>" 1 font-lock-warning-face)
1990 ;;
1991 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1993 ;;
1994 ;; Words inside `' tend to be symbol names.
1996 ;;
1997 ;; Constant values.
1999 ;;
2000 ;; ELisp and CLisp `&' keywords as types.
2002 ;;
2003 ;;; This is too general -- rms.
2004 ;;; A user complained that he has functions whose names start with `do'
2005 ;;; and that they get the wrong color.
2006 ;;; ;; CL `with-' and `do-' constructs
2007 ;;; '("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
2008 )))
2013 \f
2016 ;; arch-tag: 682327e4-64d8-4057-b20b-1fbb9f1fc54c
2017 ;;; font-lock.el ends here