| blob | a8ecf18c5ed2611558cb51cad1252de69e319ef9 |
1 ;;; font-lock.el --- Electric font lock mode
3 ;; Copyright (C) 1992, 93, 94, 95, 96, 97, 98, 1999, 2000, 2001, 2002
4 ;; 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."
236 "Font Lock support mode to fontify lazily."
242 "Font Lock support mode to fontify just-in-time."
247 \f
248 ;; User variables.
251 "*Maximum size of a buffer for buffer fontification.
252 Only buffers less than this can be fontified when Font Lock mode is turned on.
253 If nil, means size is irrelevant.
254 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
255 where MAJOR-MODE is a symbol or t (meaning the default). For example:
256 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
257 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
258 for buffers in Rmail mode, and size is irrelevant otherwise."
273 "*Maximum decoration level for fontification.
274 If nil, use the default decoration (typically the minimum available).
275 If t, use the maximum decoration available.
276 If a number, use that level of decoration (or if not available the maximum).
277 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
278 where MAJOR-MODE is a symbol or t (meaning the default). For example:
279 ((c-mode . t) (c++-mode . 2) (t . 1))
280 means use the maximum decoration available for buffers in C mode, level 2
281 decoration for buffers in C++ mode, and level 1 decoration otherwise."
298 "*If non-nil, means show status messages for buffer fontification.
299 If a number, only buffers greater than this size have fontification messages."
304 \f
306 ;; Originally these variable values were face names such as `bold' etc.
307 ;; Now we create our own faces, but we keep these variables for compatibility
308 ;; and they give users another mechanism for changing face appearance.
309 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
310 ;; returns a face. So the easiest thing is to continue using these variables,
311 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
345 ;; Fontification variables:
348 "A list of the keywords to highlight.
349 Each element should have one of these forms:
351 MATCHER
352 (MATCHER . MATCH)
353 (MATCHER . FACENAME)
354 (MATCHER . HIGHLIGHT)
355 (MATCHER HIGHLIGHT ...)
356 (eval . FORM)
358 where MATCHER can be either the regexp to search for, or the function name to
359 call to make the search (called with one argument, the limit of the search) and
360 return non-nil if it succeeds (and set `match-data' appropriately).
361 MATCHER regexps can be generated via the function `regexp-opt'.
363 FORM is an expression, whose value should be a keyword element, evaluated when
364 the keyword is (first) used in a buffer. This feature can be used to provide a
365 keyword that can only be generated when Font Lock mode is actually turned on.
367 HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
370 typically only MATCH-HIGHLIGHT is required.
371 However, if an item or (typically) items are to be highlighted following the
372 instance of another item (the anchor), for example each instance of the
375 MATCH-HIGHLIGHT should be of the form:
377 (MATCH FACENAME OVERRIDE LAXMATCH)
379 MATCH is the subexpression of MATCHER to be highlighted. FACENAME is an
380 expression whose value is the face name to use. Face default attributes
382 evaluate to a property list of the form (face VAL1 PROP2 VAL2 PROP3 VAL3 ...)
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, no error is signaled if there is no MATCH in MATCHER.
394 For example, an element of the form highlights (if not already highlighted):
397 variable `font-lock-keyword-face'.
399 the value of `font-lock-keyword-face'.
403 of `foo-bar-face', even if already highlighted.
404 (fubar-match 1 fubar-face)
405 the first subexpression within all occurrences of
406 whatever the function `fubar-match' finds and matches
407 in the value of `fubar-face'.
409 MATCH-ANCHORED should be of the form:
411 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
413 where MATCHER is a regexp to search for or the function name to call to make
414 the search, as for MATCH-HIGHLIGHT above, but with one exception; see below.
415 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
416 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
417 used to initialise before, and cleanup after, MATCHER is used. Typically,
418 PRE-MATCH-FORM is used to move to some position relative to the original
419 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
420 be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
422 For example, an element of the form highlights (if not already highlighted):
433 The above-mentioned exception is as follows. The limit of the MATCHER search
434 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
435 However, if PRE-MATCH-FORM returns a position greater than the position after
436 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
437 It is generally a bad idea to return a position greater than the end of the
438 line, i.e., cause the MATCHER search to span lines.
440 These regular expressions can match text which spans lines, although
441 it is better to avoid it if possible since updating them while editing
442 text is slower, and it is not guaranteed to be always correct when using
443 support modes like jit-lock or lazy-lock.
445 This variable is set by major modes via the variable `font-lock-defaults'.
446 Be careful when composing regexps for this list; a poorly written pattern can
450 "*Alist of `font-lock-keywords' local to a `major-mode'.
451 This is normally set via `font-lock-add-keywords' and
455 "*Alist of `font-lock-keywords' removed from `major-mode'.
456 This is normally set via `font-lock-add-keywords' and
460 "*Non-nil means Font Lock should not fontify comments or strings.
464 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
469 "Point up to which `font-lock-syntactic-keywords' has been applied.
470 If nil, this is ignored, in which case the syntactic fontification may
477 "Function to determine which face to use when fontifying syntactically.
478 The function is called with a single parameter (the state as returned by
479 `parse-partial-sexp' at the beginning of the region to highlight) and
483 "A list of the syntactic keywords to highlight.
484 Can be the list or the name of a function or variable whose value is the list.
485 See `font-lock-keywords' for a description of the form of this list;
486 the differences are listed below. MATCH-HIGHLIGHT should be of the form:
488 (MATCH SYNTAX OVERRIDE LAXMATCH)
490 where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax
491 table, a cons cell (as returned by `string-to-syntax') or an expression whose
492 value is such a form. OVERRIDE cannot be `prepend' or `append'.
494 For example, an element of the form highlights syntactically:
498 a hash character when following a dollar character, with a SYNTAX of
500 specify hash characters to have comment start syntax, the element will only
501 highlight hash characters that do not follow dollar characters as comments
502 syntactically.
508 both single quotes which surround a single character, with a SYNTAX of
510 does not specify single quotes to have quote syntax, the element will only
511 highlight single quotes of the form 'c' as strings syntactically.
512 Other forms, such as foo'bar or 'fubar', will not be highlighted as strings.
517 "Non-nil means use this syntax table for fontifying.
518 If this is nil, the major mode's syntax table is used.
522 "*Non-nil means use this function to move back outside all constructs.
523 When called with no args it should move point backward to a place which
524 is not in a string or comment and not within any bracket-pairs (or else,
525 a place such that any bracket-pairs outside it can be ignored for Emacs
526 syntax analysis and fontification).
528 If this is nil, the beginning of the buffer is used, which is
529 always correct but tends to be slow.
530 This is normally set via `font-lock-defaults'.
531 This variable is semi-obsolete; we recommend setting
535 "*Non-nil means use this function to mark a block of text.
536 When called with no args it should leave point at the beginning of any
537 enclosing textual block and mark at the end.
541 "Function to use for fontifying the buffer.
545 "Function to use for unfontifying the buffer.
546 This is used when turning off Font Lock mode.
550 "Function to use for fontifying a region.
551 It should take two args, the beginning and end of the region, and an optional
552 third arg VERBOSE. If non-nil, the function should print status messages.
556 "Function to use for unfontifying a region.
557 It should take two args, the beginning and end of the region.
561 "List of Font Lock mode related modes that should not be turned on.
562 Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and
565 \f
566 ;; Font Lock mode.
569 ;;
570 ;; We don't do this at the top-level as we only use non-autoloaded macros.
572 ;;
573 ;; Borrowed from lazy-lock.el.
574 ;; We use this to preserve or protect things when modifying text properties.
576 "Bind variables according to VARLIST and eval BODY restoring buffer state."
584 deactivate-mark
585 buffer-file-name
586 buffer-file-truename))
593 ;;
594 ;; Shut up the byte compiler.
597 ;;;###autoload
599 "Add highlighting KEYWORDS for MODE.
600 MODE should be a symbol, the major mode command name, such as `c-mode'
601 or nil. If nil, highlighting keywords are added for the current buffer.
602 KEYWORDS should be a list; see the variable `font-lock-keywords'.
603 By default they are added at the beginning of the current highlighting list.
604 If optional argument APPEND is `set', they are used to replace the current
605 highlighting list. If APPEND is any other non-nil value, they are added at the
606 end of the current highlighting list.
608 For example:
610 (font-lock-add-keywords 'c-mode
614 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
615 comments, and to fontify `and', `or' and `not' words as keywords.
617 When used from an elisp package (such as a minor mode), it is recommended
618 to use nil for MODE (and place the call in a loop or on a hook) to avoid
619 subtle problems due to details of the implementation.
621 Note that some modes have specialized support for additional patterns, e.g.,
622 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
623 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
625 ;; If MODE is non-nil, add the KEYWORDS and APPEND spec to
626 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
633 ;; Make sure that `font-lock-removed-keywords-alist' does not
634 ;; contain the new keywords.
637 ;; Otherwise set or add the keywords now.
644 font-lock-keywords)))
650 ;; Update `font-lock-removed-keywords-alist' when adding new
651 ;; KEYWORDS to MODE.
652 ;;
653 ;; When font-lock is enabled first all keywords in the list
654 ;; `font-lock-keywords-alist' are added, then all keywords in the
655 ;; list `font-lock-removed-keywords-alist' are removed. If a
656 ;; keyword was once added, removed, and then added again it must be
657 ;; removed from the removed-keywords list. Otherwise the second add
658 ;; will not take effect.
662 ;; A new set of keywords is defined. Forget all about
663 ;; our old keywords that should be removed.
666 ;; Delete all previously removed keywords.
669 ;; Delete the mode cell if empty.
674 ;; Written by Anders Lindgren <andersl@andersl.com>.
675 ;;
676 ;; Case study:
677 ;; (I) The keywords are removed from a major mode.
678 ;; In this case the keyword could be local (i.e. added earlier by
679 ;; `font-lock-add-keywords'), global, or both.
680 ;;
681 ;; (a) In the local case we remove the keywords from the variable
682 ;; `font-lock-keywords-alist'.
683 ;;
684 ;; (b) The actual global keywords are not known at this time.
685 ;; All keywords are added to `font-lock-removed-keywords-alist',
686 ;; when font-lock is enabled those keywords are removed.
687 ;;
688 ;; Note that added keywords are taken out of the list of removed
689 ;; keywords. This ensure correct operation when the same keyword
690 ;; is added and removed several times.
691 ;;
692 ;; (II) The keywords are removed from the current buffer.
693 ;;;###autoload
695 "Remove highlighting KEYWORDS for MODE.
697 MODE should be a symbol, the major mode command name, such as `c-mode'
698 or nil. If nil, highlighting keywords are removed for the current buffer.
700 When used from an elisp package (such as a minor mode), it is recommended
701 to use nil for MODE (and place the call in a loop or on a hook) to avoid
702 subtle problems due to details of the implementation."
704 ;; Remove one keyword at the time.
707 ;; If MODE is non-nil, remove the KEYWORD from
708 ;; `font-lock-keywords-alist'.
711 ;; `keywords-list-append-pair' is a cons with a list of
712 ;; keywords in the car top-cell and the original append
713 ;; argument in the cdr top-cell.
716 ;; Remove keyword list/append pair when the keyword list
717 ;; is empty and append doesn't specify `set'. (If it
718 ;; should be deleted then previously deleted keywords
719 ;; would appear again.)
726 ;; Final cleanup, remove major mode cell if last keyword
727 ;; was deleted.
731 ;; Remember the keyword in case it is not local.
737 font-lock-removed-keywords-alist))))))
739 ;; Otherwise remove it immediately.
745 ;; The keywords might be compiled.
747 font-lock-keywords)))))))
748 \f
749 ;;; Font Lock Support mode.
751 ;; This is the code used to interface font-lock.el with any of its add-on
752 ;; packages, and provide the user interface. Packages that have their own
753 ;; local buffer fontification functions (see below) may have to call
754 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
755 ;; themselves.
758 "*Support mode for Font Lock mode.
759 Support modes speed up Font Lock mode by being choosy about when fontification
760 occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode'),
761 Lazy Lock mode (symbol `lazy-lock-mode'), and Just-in-time Lock mode (symbol
762 `jit-lock-mode'. See those modes for more info.
763 If nil, means support for Font Lock mode is never performed.
764 If a symbol, use that support mode.
765 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
766 where MAJOR-MODE is a symbol or t (meaning the default). For example:
767 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
768 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
769 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
771 The value of this variable is used when Font Lock mode is turned on."
787 ))
802 ;; Prepare for jit-lock
807 ;; Don't fontify eagerly (and don't abort is the buffer is large).
809 ;; Use jit-lock.
818 ;; Reset local vars to the non-jit-lock case.
826 ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
827 ;; (jit-lock-mode
828 ;; (jit-lock-after-fontify-buffer))
835 ;; Useless as well. It's only called when:
836 ;; - turning off font-lock: it does not matter if we leave spurious
837 ;; `fontified' text props around since jit-lock-mode is also off.
838 ;; - font-lock-default-fontify-buffer fails: this is not run
839 ;; any more anyway. -sm
840 ;;
841 ;; (jit-lock-mode
842 ;; (jit-lock-after-unfontify-buffer))
846 ;;; End of Font Lock Support mode.
847 \f
848 ;;; Fontification functions.
850 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
851 ;; code to fontify a region, the function runs the function whose name is the
852 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
853 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
854 ;; which does contain the code to fontify a region. However, the value of the
855 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
856 ;; do anything. The indirection of the fontification functions gives major
857 ;; modes the capability of modifying the way font-lock.el fontifies. Major
858 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
859 ;; via the variable `font-lock-defaults'.
860 ;;
861 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
862 ;; font-lock.el uses its own function for buffer fontification. This function
863 ;; makes fontification be on a message-by-message basis and so visiting an
864 ;; RMAIL file is much faster. A clever implementation of the function might
865 ;; fontify the headers differently than the message body. (It should, and
866 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
867 ;; you?) This hints at a more interesting use...
868 ;;
869 ;; Languages that contain text normally contained in different major modes
870 ;; could define their own fontification functions that treat text differently
871 ;; depending on its context. For example, Perl mode could arrange that here
872 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
873 ;; rules one way and C code another. Neat!
874 ;;
875 ;; A further reason to use the fontification indirection feature is when the
876 ;; default syntactual fontification, or the default fontification in general,
877 ;; is not flexible enough for a particular major mode. For example, perhaps
878 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
879 ;; cope with. You need to write your own version of that function, e.g.,
880 ;; `hairy-fontify-syntactically-region', and make your own version of
881 ;; `hairy-fontify-region' call that function before calling
882 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
883 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
884 ;; would call your region fontification function instead of its own. For
885 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
886 ;; directives correctly and cleanly. (It is the same problem as fontifying
887 ;; multi-line strings and comments; regexps are not appropriate for the job.)
889 ;;;###autoload
891 "Fontify the current buffer the way the function `font-lock-mode' would."
908 font-lock-verbose)))
912 ;; Make sure we have the right `font-lock-keywords' etc.
915 ;; Make sure we fontify etc. in the whole buffer.
924 ;; We don't restore the old fontification, so it's best to unfontify.
928 ;; Make sure we unfontify etc. in the whole buffer.
936 "If non-nil, font-lock will work on the non-widened buffer.
937 Useful for things like RMAIL and Info where the whole buffer is not
947 ;; Use the fontification syntax table, if any.
950 ;; check to see if we should expand the beg/end area for
951 ;; proper multiline matches
955 ;; We are just after or in a multiline match.
967 ;; Now do the fontification.
974 ;; Clean up.
977 ;; The following must be rethought, since keywords can override fontification.
978 ; ;; Now scan for keywords, but not if we are inside a comment now.
979 ; (or (and (not font-lock-keywords-only)
980 ; (let ((state (parse-partial-sexp beg end nil nil
981 ; font-lock-cache-state)))
982 ; (or (nth 4 state) (nth 7 state))))
983 ; (font-lock-fontify-keywords-region beg end))
986 "Additional text properties managed by font-lock.
987 This is used by `font-lock-default-unfontify-region' to decide
994 font-lock-extra-managed-props
999 ;; Called when any modification is made to buffer text.
1004 ;; Rescan between start of lines enclosing the region.
1010 "Fontify some lines the way `font-lock-fontify-buffer' would.
1011 The lines could be a function or paragraph, or a specified number of lines.
1012 If ARG is given, fontify that many lines before and after point, or 16 lines if
1013 no ARG is given and `font-lock-mark-block-function' is nil.
1014 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1015 delimit the region to fontify."
1018 deactivate-mark)
1019 ;; Make sure we have the right `font-lock-keywords' etc.
1036 ;;; End of Fontification functions.
1037 \f
1038 ;;; Additional text property functions.
1040 ;; The following text property functions should be builtins. This means they
1041 ;; should be written in C and put with all the other text property functions.
1042 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1043 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1044 ;; in Lisp below and commented out. sm.
1047 "Prepend to one property of the text from START to END.
1048 Arguments PROP and VALUE specify the property and value to prepend to the value
1049 already in place. The resulting property values are always lists.
1050 Optional argument OBJECT is the string or buffer containing the text."
1057 object)
1061 "Append to one property of the text from START to END.
1062 Arguments PROP and VALUE specify the property and value to append to the value
1063 already in place. The resulting property values are always lists.
1064 Optional argument OBJECT is the string or buffer containing the text."
1071 object)
1075 "Fill in one property of the text from START to END.
1076 Arguments PROP and VALUE specify the property and value to put where none are
1077 already in place. Therefore existing property values are not overwritten.
1078 Optional argument OBJECT is the string or buffer containing the text."
1085 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1086 ;; is to `add-text-properties', etc.
1087 ;(defun remove-text-property (start end property &optional object)
1088 ; "Remove a property from text from START to END.
1089 ;Argument PROPERTY is the property to remove.
1090 ;Optional argument OBJECT is the string or buffer containing the text.
1091 ;Return t if the property was actually removed, nil otherwise."
1092 ; (remove-text-properties start end (list property) object))
1094 ;; For consistency: maybe this should be called `remove-single-property' like
1095 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1096 ;(defun remove-single-text-property (start end prop value &optional object)
1097 ; "Remove a specific property value from text from START to END.
1098 ;Arguments PROP and VALUE specify the property and value to remove. The
1099 ;resulting property values are not equal to VALUE nor lists containing VALUE.
1100 ;Optional argument OBJECT is the string or buffer containing the text."
1101 ; (let ((start (text-property-not-all start end prop nil object)) next prev)
1102 ; (while start
1103 ; (setq next (next-single-property-change start prop object end)
1104 ; prev (get-text-property start prop object))
1105 ; (cond ((and (symbolp prev) (eq value prev))
1106 ; (remove-text-property start next prop object))
1107 ; ((and (listp prev) (memq value prev))
1108 ; (let ((new (delq value prev)))
1109 ; (cond ((null new)
1110 ; (remove-text-property start next prop object))
1111 ; ((= (length new) 1)
1112 ; (put-text-property start next prop (car new) object))
1113 ; (t
1114 ; (put-text-property start next prop new object))))))
1115 ; (setq start (text-property-not-all next end prop nil object)))))
1117 ;;; End of Additional text property functions.
1118 \f
1119 ;;; Syntactic regexp fontification functions.
1121 ;; These syntactic keyword pass functions are identical to those keyword pass
1122 ;; functions below, with the following exceptions; (a) they operate on
1123 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1124 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1125 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1126 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1127 ;; LOUDLY as it is not likely to be intensive.
1130 "Apply HIGHLIGHT following a match.
1131 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1132 see `font-lock-syntactic-keywords'."
1138 ;; No match but we might not signal an error.
1144 ;; Flush the syntax-cache. I believe this is not necessary for
1145 ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can
1146 ;; still be necessary for other users of syntax-ppss anyway.
1150 ;; Cannot override existing fontification.
1154 ;; Override existing fontification.
1157 ;; Keep existing fontification.
1161 "Fontify according to KEYWORDS until LIMIT.
1162 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1163 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1165 ;; Evaluate PRE-MATCH-FORM.
1167 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1172 ;; Find an occurrence of `matcher' before `limit'.
1176 ;; Apply each highlight to this instance of `matcher'.
1181 ;; Evaluate POST-MATCH-FORM.
1185 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1186 START should be at the beginning of a line."
1187 ;; Ensure the beginning of the file is properly syntactic-fontified.
1192 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1195 font-lock-syntactic-keywords)))
1196 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1199 font-lock-syntactic-keywords)))
1200 ;; Get down to business.
1203 keyword matcher highlights)
1205 ;; Find an occurrence of `matcher' from `start' to `end'.
1211 ;; Apply each highlight to this instance of `matcher', which may be
1212 ;; specific highlights or more keywords anchored to `matcher'.
1218 end))
1222 ;;; End of Syntactic regexp fontification functions.
1223 \f
1224 ;;; Syntactic fontification functions.
1227 "Put proper face on each string and comment between START and END.
1228 START should be at the beginning of a line."
1232 ;;
1233 ;; Find the state at the `beginning-of-line' before `start'.
1235 ;;
1236 ;; Find each interesting place between here and `end'.
1249 ;;; End of Syntactic fontification functions.
1250 \f
1251 ;;; Keyword regexp fontification functions.
1254 "Apply HIGHLIGHT following a match.
1255 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1260 ;; No match but we might not signal an error.
1269 ;; Cannot override existing fontification.
1273 ;; Override existing fontification.
1276 ;; Prepend to existing fontification.
1279 ;; Append to existing fontification.
1282 ;; Keep existing fontification.
1286 "Fontify according to KEYWORDS until LIMIT.
1287 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1288 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1291 ;; Evaluate PRE-MATCH-FORM.
1293 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1298 ;; this is a multiline anchored match
1299 ;; (setq font-lock-multiline t)
1303 limit
1306 ;; Find an occurrence of `matcher' before `limit'.
1311 ;; Apply each highlight to this instance of `matcher'.
1316 ;; Evaluate POST-MATCH-FORM.
1320 "Fontify according to `font-lock-keywords' between START and END.
1321 START should be at the beginning of a line.
1322 LOUDLY, if non-nil, allows progress-meter bar."
1329 keyword matcher highlights)
1330 ;;
1331 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1335 ;;
1336 ;; Find an occurrence of `matcher' from `start' to `end'.
1347 ;; this is a multiline regexp match
1348 ;; (setq font-lock-multiline t)
1357 ;; Apply each highlight to this instance of `matcher', which may be
1358 ;; specific highlights or more keywords anchored to `matcher'.
1367 ;;; End of Keyword regexp fontification functions.
1368 \f
1369 ;; Various functions.
1372 "Compile KEYWORDS into the form (t KEYWORD ...).
1373 Here KEYWORD is of the form (MATCHER HIGHLIGHT ...) as shown in the
1374 `font-lock-keywords' doc string.
1375 If REGEXP is non-nil, it means these keywords are used for
1376 `font-lock-keywords' rather than for `font-lock-syntactic-keywords'."
1378 keywords
1382 font-lock-beginning-of-syntax-function)
1385 ;; Try to detect when a string or comment contains something that
1386 ;; looks like a defun and would thus confuse font-lock.
1394 font-lock-comment-face))
1395 font-lock-warning-face)
1396 prepend)))))
1397 keywords))
1405 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1416 keyword)))
1419 "Evalulate KEYWORDS if a function (funcall) or variable (eval) name."
1421 keywords
1427 "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1428 Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
1431 alist))
1434 "Return LEVELth element of KEYWORDS.
1435 A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to
1436 \(1- (length KEYWORDS))."
1438 keywords)
1456 ;; Syntactic fontification?
1459 ;; Case fold during regexp fontification?
1462 ;; Syntax table for regexp and syntactic fontification?
1467 ;; The character to modify may be a single CHAR or a STRING.
1473 ;; Syntax function for syntactic fontification?
1477 ;; Variable alist?
1480 ;; Setup `font-lock-keywords' last because its value might depend
1481 ;; on other settings (e.g. font-lock-compile-keywords uses
1482 ;; font-lock-beginning-of-syntax-function).
1485 ;; Local fontification?
1491 \f
1492 ;;; Colour etc. support.
1494 ;; Originally face attributes were specified via `font-lock-face-attributes'.
1495 ;; Users then changed the default face attributes by setting that variable.
1496 ;; However, we try and be back-compatible and respect its value if set except
1497 ;; for faces where M-x customize has been used to save changes for the face.
1503 ;; Rustle up a `defface' SPEC from a `font-lock-face-attributes' entry.
1510 face-spec)
1523 ;; But now we do it the custom way. Note that `defface' will not overwrite any
1524 ;; faces declared above via `custom-declare-face'.
1535 "Font Lock mode face used to highlight comments."
1545 "Font Lock mode face used to highlight strings."
1550 "Font Lock mode face used to highlight documentation."
1560 "Font Lock mode face used to highlight keywords."
1570 "Font Lock mode face used to highlight builtins."
1578 "Font Lock mode face used to highlight function names."
1590 "Font Lock mode face used to highlight variable names."
1600 "Font Lock mode face used to highlight type and classes."
1612 "Font Lock mode face used to highlight constants and labels."
1620 "Font Lock mode face used to highlight warnings."
1623 ;;; End of Colour etc. support.
1624 \f
1625 ;;; Menu support.
1627 ;; This section of code is commented out because Emacs does not have real menu
1628 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1629 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1630 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1631 ;; the entry for "Text Properties" something like:
1632 ;;
1633 ;; (define-key menu-bar-edit-menu [font-lock]
1634 ;; (cons "Syntax Highlighting" font-lock-menu))
1635 ;;
1636 ;; and remove a single ";" from the beginning of each line in the rest of this
1637 ;; section. Probably the mechanism for telling the menu code what are menu
1638 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1639 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1641 ;;;;###autoload
1642 ;(progn
1643 ; ;; Make the Font Lock menu.
1644 ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1645 ; ;; Add the menu items in reverse order.
1646 ; (define-key font-lock-menu [fontify-less]
1647 ; '("Less In Current Buffer" . font-lock-fontify-less))
1648 ; (define-key font-lock-menu [fontify-more]
1649 ; '("More In Current Buffer" . font-lock-fontify-more))
1650 ; (define-key font-lock-menu [font-lock-sep]
1651 ; '("--"))
1652 ; (define-key font-lock-menu [font-lock-mode]
1653 ; '("In Current Buffer" . font-lock-mode))
1654 ; (define-key font-lock-menu [global-font-lock-mode]
1655 ; '("In All Buffers" . global-font-lock-mode)))
1656 ;
1657 ;;;;###autoload
1658 ;(progn
1659 ; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1660 ; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1661 ; (put 'global-font-lock-mode 'menu-toggle t)
1662 ; (put 'font-lock-mode 'menu-toggle t)
1663 ; (put 'font-lock-fontify-more 'menu-enable '(identity))
1664 ; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1665 ;
1666 ;;; Put the appropriate symbol property values on now. See above.
1667 ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)
1668 ;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1669 ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1670 ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1671 ;
1672 ;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1673 ;
1674 ;(defun font-lock-fontify-level (level)
1675 ; (let ((font-lock-maximum-decoration level))
1676 ; (when font-lock-mode
1677 ; (font-lock-mode))
1678 ; (font-lock-mode)
1679 ; (when font-lock-verbose
1680 ; (message "Fontifying %s... level %d" (buffer-name) level))))
1681 ;
1682 ;(defun font-lock-fontify-less ()
1683 ; "Fontify the current buffer with less decoration.
1684 ;See `font-lock-maximum-decoration'."
1685 ; (interactive)
1686 ; ;; Check in case we get called interactively.
1687 ; (if (nth 1 font-lock-fontify-level)
1688 ; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1689 ; (error "No less decoration")))
1690 ;
1691 ;(defun font-lock-fontify-more ()
1692 ; "Fontify the current buffer with more decoration.
1693 ;See `font-lock-maximum-decoration'."
1694 ; (interactive)
1695 ; ;; Check in case we get called interactively.
1696 ; (if (nth 2 font-lock-fontify-level)
1697 ; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1698 ; (error "No more decoration")))
1699 ;
1700 ;;; This should be called by `font-lock-set-defaults'.
1701 ;(defun font-lock-set-menu ()
1702 ; ;; Activate less/more fontification entries if there are multiple levels for
1703 ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
1704 ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
1705 ; (let ((keywords (or (nth 0 font-lock-defaults)
1706 ; (nth 1 (assq major-mode font-lock-defaults-alist))))
1707 ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1708 ; (make-local-variable 'font-lock-fontify-level)
1709 ; (if (or (symbolp keywords) (= (length keywords) 1))
1710 ; (font-lock-unset-menu)
1711 ; (cond ((eq level t)
1712 ; (setq level (1- (length keywords))))
1713 ; ((or (null level) (zerop level))
1714 ; ;; The default level is usually, but not necessarily, level 1.
1715 ; (setq level (- (length keywords)
1716 ; (length (member (eval (car keywords))
1717 ; (mapcar 'eval (cdr keywords))))))))
1718 ; (setq font-lock-fontify-level (list level (> level 1)
1719 ; (< level (1- (length keywords))))))))
1720 ;
1721 ;;; This should be called by `font-lock-unset-defaults'.
1722 ;(defun font-lock-unset-menu ()
1723 ; ;; Deactivate less/more fontification entries.
1724 ; (setq font-lock-fontify-level nil))
1726 ;;; End of Menu support.
1727 \f
1728 ;;; Various regexp information shared by several modes.
1729 ;;; Information specific to a single mode should go in its load library.
1731 ;; Font Lock support for C, C++, Objective-C and Java modes will one day be in
1732 ;; some cc-font.el (and required by cc-mode.el). However, the below function
1733 ;; should stay in font-lock.el, since it is used by other libraries. sm.
1736 "Match, and move over, any declaration/definition item after point.
1737 Matches after point, but ignores leading whitespace and `*' characters.
1738 Does not move further than LIMIT.
1740 The expected syntax of a declaration/definition item is `word' (preceded by
1741 optional whitespace and `*' characters and proceeded by optional whitespace)
1742 optionally followed by a `('. Everything following the item (but belonging to
1743 it) is expected to by skip-able by `scan-sexps', and items are expected to be
1744 separated with a `,' and to be terminated with a `;'.
1746 Thus the regexp matches after point: word (
1747 ^^^^ ^
1748 Where the match subexpressions are: 1 2
1750 The item is delimited by (match-beginning 1) and (match-end 1).
1751 If (match-beginning 2) is non-nil, the item is followed by a `('.
1753 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
1756 ;; If `word' is followed by a double open-paren, it's probably
1757 ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one
1758 ;; word to try and match `myfun' rather than `P_'.
1763 ;; Looks like it was something else, so go back to where we
1764 ;; were and reset the match data by rematching.
1770 ;; Restrict to the LIMIT.
1773 ;; Move over any item value, etc., to the next item.
1778 \f
1779 ;; Lisp.
1784 ;;
1785 ;; Definitions.
1787 ;; Function declarations.
1793 ;; Variable declarations.
1795 ;; Structure declarations.
1798 ;; Any whitespace and defined object.
1805 nil t))
1806 ;;
1807 ;; Emacs Lisp autoload cookies.
1809 ))
1816 ;;
1817 ;; Control structures. Emacs Lisp forms.
1827 "eval-when"
1834 ;;
1835 ;; Control structures. Common Lisp forms.
1849 ;;
1850 ;; Exit/Feature symbols as constants.
1855 ;;
1856 ;; Erroneous structures.
1858 ;;
1859 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1861 ;;
1862 ;; Words inside `' tend to be symbol names.
1864 ;;
1865 ;; Constant values.
1867 ;;
1868 ;; ELisp and CLisp `&' keywords as types.
1870 ;;
1871 ;; CL `with-' and `do-' constructs
1873 )))
1878 \f
1879 ;;; User choices.
1881 ;; These provide a means to fontify types not defined by the language. Those
1882 ;; types might be the user's own or they might be generally accepted and used.
1883 ;; Generally accepted types are used to provide default variable values.
1886 "Widget `:type' for members of the custom group `font-lock-extra-types'.
1887 Members should `:load' the package `font-lock' to use this widget."
1892 "*List of extra types to fontify in C mode.
1893 Each list item should be a regexp not containing word-delimiters.
1895 ending in _t are treated as type names.
1897 The value of this variable is used when Font Lock mode is turned on."
1911 "type_info"
1914 "*List of extra types to fontify in C++ mode.
1915 Each list item should be a regexp not containing word-delimiters.
1917 name.
1919 The value of this variable is used when Font Lock mode is turned on."
1924 "*List of extra types to fontify in Objective-C mode.
1925 Each list item should be a regexp not containing word-delimiters.
1927 Class, BOOL, IMP and SEL are treated as type names.
1929 The value of this variable is used when Font Lock mode is turned on."
1935 "*List of extra types to fontify in Java mode.
1936 Each list item should be a regexp not containing word-delimiters.
1938 capitalised words (that conform to the Java id spec) and URL are treated as
1939 type names.
1941 The value of this variable is used when Font Lock mode is turned on."
1944 \f
1945 ;;; C.
1947 ;; [Murmur murmur murmur] Maestro, drum-roll please... [Murmur murmur murmur.]
1948 ;; Ahem. [Murmur murmur murmur] Lay-dees an Gennel-men. [Murmur murmur shhh!]
1949 ;; I am most proud and humbly honoured today [murmur murmur cough] to present
1950 ;; to you good people, the winner of the Second Millennium Award for The Most
1951 ;; Hairy Language Syntax. [Ahhh!] All rise please. [Shuffle shuffle
1952 ;; shuffle.] And a round of applause please. For... The C Language! [Roar.]
1953 ;;
1954 ;; Thank you... You are too kind... It is with a feeling of great privilege
1955 ;; and indeed emotion [sob] that I accept this award. It has been a long hard
1956 ;; road. But we know our destiny. And our future. For we must not rest.
1957 ;; There are more tokens to overload, more shoehorn, more methodologies. But
1958 ;; more is a plus! [Ha ha ha.] And more means plus! [Ho ho ho.] The future
1959 ;; is C++! [Ohhh!] The Third Millennium Award... Will be ours! [Roar.]
1965 ;; Type related, but we don't do anything special.
1968 ;; Dan Nicolaescu <done@gnu.org> says this is new.
1969 "restrict"
1970 ;; Henrik Enberg <henrik@enberg.org> says this is new.
1984 ;; Henrik Enberg <henrik@enberg.org> says these are new.
1986 c-font-lock-extra-types)
1999 ;;
2000 ;; These are all anchored at the beginning of line for speed.
2001 ;; Note that `c++-font-lock-keywords-1' depends on `c-font-lock-keywords-1'.
2002 ;;
2003 ;; Fontify function name definitions (GNU style; without type on line).
2005 ;;
2006 ;; Fontify error directives.
2008 ;;
2009 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2012 ;;
2013 ;; Fontify function macro names.
2015 ;;
2016 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2020 ;;
2021 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2033 ;;
2034 ;; Simple regexps for speed.
2035 ;;
2036 ;; Fontify all type names.
2039 ;;
2040 ;; Fontify all builtin keywords (except case, default and goto; see below).
2042 ;;
2043 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2047 ;; Return limit of search.
2049 nil
2051 ;; Anders Lindgren <andersl@andersl.com> points out that it is quicker
2052 ;; to use MATCH-ANCHORED to effectively anchor the regexp on the left.
2053 ;; This must come after the one for keywords and targets.
2054 ;; Note: the lack of `:' in the first char-range prevents `bar' from being
2055 ;; highlighted in "foo: bar:". But adding `:' would break cases like
2056 ;; "test1 ? test2 ? foo : bar : baz".
2060 ))
2065 ;;
2066 ;; More complicated regexps for more complete highlighting for types.
2067 ;; We still have to fontify type specifiers individually, as C is so hairy.
2069 ;;
2070 ;; Fontify all storage types, plus their items.
2074 ;; Fontify each declaration item.
2076 ;; Start with point after all type specifiers.
2081 ;; Finish with point after first type specifier.
2083 ;; Fontify as a variable or function name.
2085 font-lock-function-name-face
2086 font-lock-variable-name-face)))))
2087 ;;
2088 ;; Fontify all storage specs and types, plus their items.
2094 ;; Finish with point after the variable name if
2095 ;; there is one.
2098 ;; Fontify as a variable or function name.
2100 font-lock-function-name-face
2102 ;;
2103 ;; Fontify structures, or typedef names, plus their items.
2109 ;;
2110 ;; Fontify anything at beginning of line as a declaration or definition.
2117 font-lock-function-name-face
2118 font-lock-variable-name-face))))
2119 ))
2120 "Gaudy level highlighting for C mode.
2126 ;; Check whether the string is properly terminated.
2130 ;; We're inside a string, at EOL and there was no \.
2131 font-lock-warning-face
2132 font-lock-string-face))
2134 ;; `doxygen' uses /*! while others use /**.
2136 font-lock-doc-face font-lock-comment-face))))
2139 "Default expressions to highlight in C mode.
2141 \f
2142 ;;; C++.
2145 ;; Regexp matches after point: word<word>::word (
2146 ;; ^^^^ ^^^^ ^^^^ ^
2147 ;; Where the match subexpressions are: 1 3 5 6
2148 ;;
2149 ;; Item is delimited by (match-beginning 1) and (match-end 1).
2150 ;; If (match-beginning 3) is non-nil, that part of the item incloses a `<>'.
2151 ;; If (match-beginning 5) is non-nil, that part of the item follows a `::'.
2152 ;; If (match-beginning 6) is non-nil, the item is followed by a `('.
2155 ;; Skip any leading whitespace.
2157 ;; This is `c++-type-spec' from below. (Hint hint!)
2161 ;; Match any trailing parenthesis.
2166 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2169 ;; Move over any item value, etc., to the next item.
2176 ;; Match C++ constructors and destructors inside class declarations.
2182 ;; Don't match function pointer declarations, e.g.:
2183 ;; Foo (*fptr)();
2191 res))
2198 "typeid"
2199 ;; Branko Cibej <branko.cibej@hermes.si> says this is new.
2200 "export"
2201 ;; Mark Mitchell <mmitchell@usa.net> says these are new.
2203 ;; Alain Picard <ap@abelard.apana.org.au> suggests treating these
2204 ;; as keywords not types.
2208 ;; Standard C++ operator names.
2214 ;; Taken from Stroustrup, minus keywords otherwise fontified.
2223 ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new.
2238 ;;
2239 ;; A brave attempt to match templates following a type and/or match
2240 ;; class membership. See and sync the above function
2241 ;; `font-lock-match-c++-style-declaration-item-and-skip-to-next'.
2245 ;; If the string is a type, it may be followed by the cruft above.
2248 ;;
2249 ;; Parenthesis depth of user-defined types not forgetting their cruft.
2252 )
2255 ;;
2256 ;; The list `c-font-lock-keywords-1' less that for function names.
2259 ;;
2260 ;; Fontify function name definitions, possibly incorporating class names.
2263 font-lock-type-face
2264 font-lock-function-name-face))
2267 ))
2273 ;;
2274 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2278 ;;
2279 ;; Fontify operator overloading.
2283 ;;
2284 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2288 ;; Return limit of search.
2295 nil
2297 font-lock-type-face
2299 ;; This must come after the one for keywords and targets.
2303 ;;
2304 ;; Fontify other builtin keywords.
2306 ;;
2307 ;; Eric Hopper <hopper@omnifarious.mn.org> says `true' and `false' are new.
2309 ))
2310 "Medium level highlighting for C++ mode.
2315 ;;
2316 ;; More complicated regexps for more complete highlighting for types.
2318 ;;
2319 ;; Fontify all storage classes and type specifiers, plus their items.
2323 ;; The name of any template type.
2325 ;; Fontify each declaration item.
2327 ;; Start with point after all type specifiers.
2332 ;; Finish with point after first type specifier.
2334 ;; Fontify as a variable or function name.
2336 font-lock-type-face)
2338 font-lock-function-name-face)
2340 font-lock-variable-name-face)))
2343 font-lock-function-name-face
2345 ;;
2346 ;; Fontify all storage specs and types, plus their items.
2349 ;; The name of any template type.
2351 ;; The name of any type.
2353 font-lock-type-face nil t)
2354 ;; Fontify each declaration item.
2356 ;; Start with point after all type specifiers.
2358 ;; Finish with point after first type specifier.
2359 nil
2360 ;; Fontify as a variable or function name.
2362 font-lock-type-face)
2364 font-lock-function-name-face)
2366 font-lock-variable-name-face)))
2369 font-lock-function-name-face
2371 ;;
2372 ;; Fontify structures, or typedef names, plus their items.
2378 ;;
2379 ;; Fontify anything at beginning of line as a declaration or definition.
2386 font-lock-type-face)
2391 font-lock-function-name-face
2393 ;;
2394 ;; Fontify constructors and destructors inside class declarations.
2397 ))
2398 "Gaudy level highlighting for C++ mode.
2400 )
2403 "Default expressions to highlight in C++ mode.
2405 \f
2406 ;;; Objective-C.
2408 ;; Regexps written with help from Stephen Peters <speters@us.oracle.com> and
2409 ;; Jacques Duthen Prestataire <duthen@cegelec-red.fr>.
2431 objc-font-lock-extra-types)
2435 )
2438 ;;
2439 ;; The list `c-font-lock-keywords-1' less that for function names.
2442 ;;
2443 ;; Fontify compiler directives.
2448 ;;
2449 ;; Fontify method names and arguments. Oh Lordy!
2450 ;; First, on the same line as the function declaration.
2455 nil nil
2458 ;; Second, on lines following the function declaration.
2463 ))
2469 ;;
2470 ;; Simple regexps for speed.
2471 ;;
2472 ;; Fontify all type specifiers.
2476 ;;
2477 ;; Fontify all builtin keywords (except case, default and goto; see below).
2479 ;;
2480 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2483 ;; Fontify tags iff sole statement on line, otherwise we detect selectors.
2484 ;; This must come after the one for keywords and targets.
2488 ;;
2489 ;; Fontify null object pointers.
2491 ))
2492 "Medium level highlighting for Objective-C mode.
2497 ;;
2498 ;; More complicated regexps for more complete highlighting for types.
2499 ;; We still have to fontify type specifiers individually, as C is so hairy.
2501 ;;
2502 ;; Fontify all storage classes and type specifiers, plus their items.
2506 ;; Fontify each declaration item.
2508 ;; Start with point after all type specifiers.
2513 ;; Finish with point after first type specifier.
2515 ;; Fontify as a variable or function name.
2517 font-lock-function-name-face
2518 font-lock-variable-name-face)))))
2519 ;;
2520 ;; Fontify all storage specs and types, plus their items.
2522 ;; The name of any type.
2524 ;; Fontify each declaration item.
2527 ;; Fontify as a variable or function name.
2529 font-lock-function-name-face
2530 font-lock-variable-name-face))))
2531 ;;
2532 ;; Fontify structures, or typedef names, plus their items.
2538 ;;
2539 ;; Fontify anything at beginning of line as a declaration or definition.
2546 font-lock-function-name-face
2547 font-lock-variable-name-face))))
2548 ))
2549 "Gaudy level highlighting for Objective-C mode.
2551 )
2554 "Default expressions to highlight in Objective-C mode.
2556 \f
2557 ;;; Java.
2559 ;; Regexps written with help from Fred White <fwhite@bbn.com>,
2560 ;; Anders Lindgren <andersl@andersl.com> and Carl Manning <caroma@ai.mit.edu>.
2565 ;; Anders Lindgren <andersl@andersl.com> says these have gone.
2566 ;; "cast" "byvalue" "future" "generic" "operator" "var"
2567 ;; "inner" "outer" "rest"
2570 ;;
2571 ;; Classes immediately followed by an object name.
2578 java-font-lock-extra-types)
2581 ;;
2582 ;; These are eventually followed by an object name.
2587 ;; Anders Lindgren <andersl@andersl.com> says this has gone.
2588 ;; "threadsafe"
2590 ;; Carl Manning <caroma@ai.mit.edu> says this is new.
2592 )
2595 ;;
2596 ;; Fontify class names.
2599 ;;
2600 ;; Fontify package names in import directives.
2606 )
2612 ;;
2613 ;; Fontify class names.
2617 ;;
2618 ;; Fontify all builtin keywords (except below).
2620 ;;
2621 ;; Fontify keywords and targets, and case default/goto tags.
2624 ;; This must come after the one for keywords and targets.
2628 ;;
2629 ;; Fontify all constants.
2631 ;;
2632 ;; Javadoc tags within comments.
2647 ))
2648 "Medium level highlighting for Java mode.
2653 ;;
2654 ;; More complicated regexps for more complete highlighting for types.
2655 ;; We still have to fontify type specifiers individually, as Java is hairy.
2657 ;;
2658 ;; Fontify random types immediately followed by an item or items.
2663 ;; Fontify each declaration item.
2665 ;; Start and finish with point after the type specifier.
2669 ;; Fontify as a variable or function name.
2671 font-lock-function-name-face
2672 font-lock-variable-name-face)))))
2673 ;;
2674 ;; Fontify those that are eventually followed by an item or items.
2679 ;; Fontify each declaration item.
2681 ;; Start with point after all type specifiers.
2684 ;; Finish with point after first type specifier.
2686 ;; Fontify as a variable or function name.
2688 font-lock-function-name-face
2689 font-lock-variable-name-face))))
2690 ))
2691 "Gaudy level highlighting for Java mode.
2693 )
2696 "Default expressions to highlight in Java mode.
2698 \f
2699 ;; Provide ourselves:
2704 ;; Check whether the string is properly terminated.
2708 ;; We're inside a string, at EOL. The JLS says that:
2709 ;; It is a compile-time error for a line terminator to
2710 ;; appear after the opening " and before the closing
2711 ;; matching ".
2712 font-lock-warning-face
2713 font-lock-string-face))
2716 font-lock-doc-face
2717 font-lock-comment-face))))
2724 ;;; font-lock.el ends here