| blob | 6007c1869c19fd8fd46b0c42e6c2de2b72d9920e |
1 ;;; font-lock.el --- Electric font lock mode
3 ;; Copyright (C) 1992, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
5 ;; Author: jwz, then rms, then sm <simon@gnu.ai.mit.edu>
6 ;; Maintainer: FSF
7 ;; Keywords: languages, faces
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;; Font Lock mode is a minor mode that causes your comments to be displayed in
29 ;; one face, strings in another, reserved words in another, and so on.
30 ;;
31 ;; Comments will be displayed in `font-lock-comment-face'.
32 ;; Strings will be displayed in `font-lock-string-face'.
33 ;; Regexps are used to display selected patterns in other faces.
34 ;;
35 ;; To make the text you type be fontified, use M-x font-lock-mode RET.
36 ;; When this minor mode is on, the faces of the current line are updated with
37 ;; every insertion or deletion.
38 ;;
39 ;; To turn Font Lock mode on automatically, add this to your ~/.emacs file:
40 ;;
41 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock)
42 ;;
43 ;; Or if you want to turn Font Lock mode on in many modes:
44 ;;
45 ;; (global-font-lock-mode t)
46 ;;
47 ;; Fontification for a particular mode may be available in a number of levels
48 ;; of decoration. The higher the level, the more decoration, but the more time
49 ;; it takes to fontify. See the variable `font-lock-maximum-decoration', and
50 ;; also the variable `font-lock-maximum-size'. Support modes for Font Lock
51 ;; mode can be used to speed up Font Lock mode. See `font-lock-support-mode'.
52 \f
53 ;;; How Font Lock mode fontifies:
55 ;; When Font Lock mode is turned on in a buffer, it (a) fontifies the entire
56 ;; buffer and (b) installs one of its fontification functions on one of the
57 ;; hook variables that are run by Emacs after every buffer change (i.e., an
58 ;; insertion or deletion). Fontification means the replacement of `face' text
59 ;; properties in a given region; Emacs displays text with these `face' text
60 ;; properties appropriately.
61 ;;
62 ;; Fontification normally involves syntactic (i.e., strings and comments) and
63 ;; regexp (i.e., keywords and everything else) passes. There are actually
64 ;; three passes; (a) the syntactic keyword pass, (b) the syntactic pass and (c)
65 ;; the keyword pass. Confused?
66 ;;
67 ;; The syntactic keyword pass places `syntax-table' text properties in the
68 ;; buffer according to the variable `font-lock-syntactic-keywords'. It is
69 ;; necessary because Emacs' syntax table is not powerful enough to describe all
70 ;; the different syntactic constructs required by the sort of people who decide
71 ;; that a single quote can be syntactic or not depending on the time of day.
72 ;; (What sort of person could decide to overload the meaning of a quote?)
73 ;; Obviously the syntactic keyword pass must occur before the syntactic pass.
74 ;;
75 ;; The syntactic pass places `face' text properties in the buffer according to
76 ;; syntactic context, i.e., according to the buffer's syntax table and buffer
77 ;; text's `syntax-table' text properties. It involves using a syntax parsing
78 ;; function to determine the context of different parts of a region of text. A
79 ;; syntax parsing function is necessary because generally strings and/or
80 ;; comments can span lines, and so the context of a given region is not
81 ;; necessarily apparent from the content of that region. Because the keyword
82 ;; pass only works within a given region, it is not generally appropriate for
83 ;; syntactic fontification. This is the first fontification pass that makes
84 ;; changes visible to the user; it fontifies strings and comments.
85 ;;
86 ;; The keyword pass places `face' text properties in the buffer according to
87 ;; the variable `font-lock-keywords'. It involves searching for given regexps
88 ;; (or calling given search functions) within the given region. This is the
89 ;; second fontification pass that makes changes visible to the user; it
90 ;; fontifies language reserved words, etc.
91 ;;
92 ;; Oh, and the answer is, "Yes, obviously just about everything should be done
93 ;; in a single syntactic pass, but the only syntactic parser available
94 ;; understands only strings and comments." Perhaps one day someone will write
95 ;; some syntactic parsers for common languages and a son-of-font-lock.el could
96 ;; use them rather then relying so heavily on the keyword (regexp) pass.
98 ;;; How Font Lock mode supports modes or is supported by modes:
100 ;; Modes that support Font Lock mode do so by defining one or more variables
101 ;; whose values specify the fontification. Font Lock mode knows of these
102 ;; variable names from (a) the buffer local variable `font-lock-defaults', if
103 ;; non-nil, or (b) the global variable `font-lock-defaults-alist', if the major
104 ;; mode has an entry. (Font Lock mode is set up via (a) where a mode's
105 ;; patterns are distributed with the mode's package library, and (b) where a
106 ;; mode's patterns are distributed with font-lock.el itself. An example of (a)
107 ;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is
108 ;; (a); (b) is used where it is not clear which package library should contain
109 ;; the pattern definitions.) Font Lock mode chooses which variable to use for
110 ;; fontification based on `font-lock-maximum-decoration'.
111 ;;
112 ;; Font Lock mode fontification behaviour can be modified in a number of ways.
113 ;; See the below comments and the comments distributed throughout this file.
115 ;;; Constructing patterns:
117 ;; See the documentation for the variable `font-lock-keywords'.
118 ;;
119 ;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and
120 ;; `font-lock-syntactic-keywords' can be generated via the function
121 ;; `regexp-opt', and their depth counted via the function `regexp-opt-depth'.
123 ;;; Adding patterns for modes that already support Font Lock:
125 ;; Though Font Lock highlighting patterns already exist for many modes, it's
126 ;; likely there's something that you want fontified that currently isn't, even
127 ;; at the maximum fontification level. You can add highlighting patterns via
128 ;; `font-lock-add-keywords'. For example, say in some C
129 ;; header file you #define the token `and' to expand to `&&', etc., to make
130 ;; your C code almost readable. In your ~/.emacs there could be:
131 ;;
132 ;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>"))
133 ;;
134 ;; Some modes provide specific ways to modify patterns based on the values of
135 ;; other variables. For example, additional C types can be specified via the
136 ;; variable `c-font-lock-extra-types'.
138 ;;; Adding patterns for modes that do not support Font Lock:
140 ;; Not all modes support Font Lock mode. If you (as a user of the mode) add
141 ;; patterns for a new mode, you must define in your ~/.emacs a variable or
142 ;; variables that specify regexp fontification. Then, you should indicate to
143 ;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what
144 ;; support is required. For example, say Foo mode should have the following
145 ;; regexps fontified case-sensitively, and comments and strings should not be
146 ;; fontified automagically. In your ~/.emacs there could be:
147 ;;
148 ;; (defvar foo-font-lock-keywords
149 ;; '(("\\<\\(one\\|two\\|three\\)\\>" . font-lock-keyword-face)
150 ;; ("\\<\\(four\\|five\\|six\\)\\>" . font-lock-type-face))
151 ;; "Default expressions to highlight in Foo mode.")
152 ;;
153 ;; (add-hook 'foo-mode-hook
154 ;; (function (lambda ()
155 ;; (make-local-variable 'font-lock-defaults)
156 ;; (setq font-lock-defaults '(foo-font-lock-keywords t)))))
158 ;;; Adding Font Lock support for modes:
160 ;; Of course, it would be better that the mode already supports Font Lock mode.
161 ;; The package author would do something similar to above. The mode must
162 ;; define at the top-level a variable or variables that specify regexp
163 ;; fontification. Then, the mode command should indicate to Font Lock mode,
164 ;; via `font-lock-defaults', exactly what support is required. For example,
165 ;; say Bar mode should have the following regexps fontified case-insensitively,
166 ;; and comments and strings should be fontified automagically. In bar.el there
167 ;; could be:
168 ;;
169 ;; (defvar bar-font-lock-keywords
170 ;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . font-lock-keyword-face)
171 ;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . font-lock-type-face))
172 ;; "Default expressions to highlight in Bar mode.")
173 ;;
174 ;; and within `bar-mode' there could be:
175 ;;
176 ;; (make-local-variable 'font-lock-defaults)
177 ;; (setq font-lock-defaults '(bar-font-lock-keywords nil t))
178 \f
179 ;; What is fontification for? You might say, "It's to make my code look nice."
180 ;; I think it should be for adding information in the form of cues. These cues
181 ;; should provide you with enough information to both (a) distinguish between
182 ;; different items, and (b) identify the item meanings, without having to read
183 ;; the items and think about it. Therefore, fontification allows you to think
184 ;; less about, say, the structure of code, and more about, say, why the code
185 ;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
186 ;;
187 ;; So, here are my opinions/advice/guidelines:
188 ;;
189 ;; - Highlight conceptual objects, such as function and variable names, and
190 ;; different objects types differently, i.e., (a) and (b) above, highlight
191 ;; function names differently to variable names.
192 ;; - Keep the faces distinct from each other as far as possible.
193 ;; i.e., (a) above.
194 ;; - Use the same face for the same conceptual object, across all modes.
195 ;; i.e., (b) above, all modes that have items that can be thought of as, say,
196 ;; keywords, should be highlighted with the same face, etc.
197 ;; - Make the face attributes fit the concept as far as possible.
198 ;; i.e., function names might be a bold colour such as blue, comments might
199 ;; be a bright colour such as red, character strings might be brown, because,
200 ;; err, strings are brown (that was not the reason, please believe me).
201 ;; - Don't use a non-nil OVERRIDE unless you have a good reason.
202 ;; Only use OVERRIDE for special things that are easy to define, such as the
203 ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
204 ;; Don't use it to, say, highlight keywords in commented out code or strings.
205 ;; - Err, that's it.
206 \f
207 ;;; Code:
209 ;; Define core `font-lock' group.
211 "Font Lock mode text highlighting package."
216 "Faces for highlighting text."
221 "Extra mode-specific type names for highlighting declarations."
224 ;; Define support mode groups here to impose `font-lock' group order.
226 "Font Lock support mode to cache fontification."
232 "Font Lock support mode to fontify lazily."
236 \f
237 ;; User variables.
240 "*Maximum size of a buffer for buffer fontification.
241 Only buffers less than this can be fontified when Font Lock mode is turned on.
242 If nil, means size is irrelevant.
243 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
244 where MAJOR-MODE is a symbol or t (meaning the default). For example:
245 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
246 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
247 for buffers in Rmail mode, and size is irrelevant otherwise."
262 "*Maximum decoration level for fontification.
263 If nil, use the default decoration (typically the minimum available).
264 If t, use the maximum decoration available.
265 If a number, use that level of decoration (or if not available the maximum).
266 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
267 where MAJOR-MODE is a symbol or t (meaning the default). For example:
268 ((c-mode . t) (c++-mode . 2) (t . 1))
269 means use the maximum decoration available for buffers in C mode, level 2
270 decoration for buffers in C++ mode, and level 1 decoration otherwise."
287 "*If non-nil, means show status messages for buffer fontification.
288 If a number, only buffers greater than this size have fontification messages."
293 \f
294 ;; Fontification variables:
297 "A list of the keywords to highlight.
298 Each element should be of the form:
300 MATCHER
301 (MATCHER . MATCH)
302 (MATCHER . FACENAME)
303 (MATCHER . HIGHLIGHT)
304 (MATCHER HIGHLIGHT ...)
305 (eval . FORM)
307 where HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
309 FORM is an expression, whose value should be a keyword element, evaluated when
310 the keyword is (first) used in a buffer. This feature can be used to provide a
311 keyword that can only be generated when Font Lock mode is actually turned on.
313 For highlighting single items, typically only MATCH-HIGHLIGHT is required.
314 However, if an item or (typically) items are to be highlighted following the
315 instance of another item (the anchor) then MATCH-ANCHORED may be required.
317 MATCH-HIGHLIGHT should be of the form:
319 (MATCH FACENAME OVERRIDE LAXMATCH)
321 Where MATCHER can be either the regexp to search for, or the function name to
322 call to make the search (called with one argument, the limit of the search).
323 MATCHER regexps can be generated via the function `regexp-opt'. MATCH is the
324 subexpression of MATCHER to be highlighted. MATCH can be calculated via the
325 function `regexp-opt-depth'. FACENAME is an expression whose value is the face
328 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
329 be overwritten. If `keep', only parts not already fontified are highlighted.
330 If `prepend' or `append', existing fontification is merged with the new, in
331 which the new or existing fontification, respectively, takes precedence.
332 If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER.
334 For example, an element of the form highlights (if not already highlighted):
337 variable `font-lock-keyword-face'.
339 the value of `font-lock-keyword-face'.
343 of `foo-bar-face', even if already highlighted.
345 MATCH-ANCHORED should be of the form:
347 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
349 Where MATCHER is as for MATCH-HIGHLIGHT with one exception; see below.
350 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
351 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
352 used to initialise before, and cleanup after, MATCHER is used. Typically,
353 PRE-MATCH-FORM is used to move to some position relative to the original
354 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
355 be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
357 For example, an element of the form highlights (if not already highlighted):
368 The above-mentioned exception is as follows. The limit of the MATCHER search
369 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
370 However, if PRE-MATCH-FORM returns a position greater than the position after
371 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
372 It is generally a bad idea to return a position greater than the end of the
373 line, i.e., cause the MATCHER search to span lines.
375 Note that the MATCH-ANCHORED feature is experimental; in the future, we may
376 replace it with other ways of providing this functionality.
378 These regular expressions should not match text which spans lines. While
380 when you edit the buffer does not, since it considers text one line at a time.
382 This variable is set by major modes via the variable `font-lock-defaults'.
383 Be careful when composing regexps for this list; a poorly written pattern can
386 ;; This variable is used by mode packages that support Font Lock mode by
387 ;; defining their own keywords to use for `font-lock-keywords'. (The mode
388 ;; command should make it buffer-local and set it to provide the set up.)
390 "Defaults for Font Lock mode specified by the major mode.
391 Defaults should be of the form:
393 (KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN ...)
395 KEYWORDS may be a symbol (a variable or function whose value is the keywords to
396 use for fontification) or a list of symbols. If KEYWORDS-ONLY is non-nil,
397 syntactic fontification (strings and comments) is not performed.
398 If CASE-FOLD is non-nil, the case of the keywords is ignored when fontifying.
399 If SYNTAX-ALIST is non-nil, it should be a list of cons pairs of the form
400 \(CHAR-OR-STRING . STRING) used to set the local Font Lock syntax table, for
401 keyword and syntactic fontification (see `modify-syntax-entry').
403 If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
404 backwards outside any enclosing syntactic block, for syntactic fontification.
405 Typical values are `beginning-of-line' (i.e., the start of the line is known to
406 be outside a syntactic block), or `beginning-of-defun' for programming modes or
407 `backward-paragraph' for textual modes (i.e., the mode-dependent function is
408 known to move outside a syntactic block). If nil, the beginning of the buffer
409 is used as a position outside of a syntactic block, in the worst case.
411 These item elements are used by Font Lock mode to set the variables
412 `font-lock-keywords', `font-lock-keywords-only',
413 `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
414 `font-lock-beginning-of-syntax-function', respectively.
416 Further item elements are alists of the form (VARIABLE . VALUE) and are in no
417 particular order. Each VARIABLE is made buffer-local before set to VALUE.
419 Currently, appropriate variables include `font-lock-mark-block-function'.
420 If this is non-nil, it should be a function with no args used to mark any
422 Typical values are `mark-defun' for programming modes or `mark-paragraph' for
423 textual modes (i.e., the mode-dependent function is known to put point and mark
424 around a text block relevant to that mode).
426 Other variables include those for buffer-specialised fontification functions,
427 `font-lock-fontify-buffer-function', `font-lock-unfontify-buffer-function',
428 `font-lock-fontify-region-function', `font-lock-unfontify-region-function',
431 ;; This variable is used where font-lock.el itself supplies the keywords.
434 ;; Thus the calculation of the cache is usually faster but not
435 ;; infallible, so we risk mis-fontification. sm.
438 c-font-lock-keywords-2 c-font-lock-keywords-3)
440 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
441 ;(font-lock-comment-start-regexp . "/[*/]")
447 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
448 ;(font-lock-comment-start-regexp . "/[*/]")
452 objc-font-lock-keywords-2 objc-font-lock-keywords-3)
454 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
455 ;(font-lock-comment-start-regexp . "/[*/]")
459 java-font-lock-keywords-2 java-font-lock-keywords-3)
461 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
462 ;(font-lock-comment-start-regexp . "/[*/]")
466 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
468 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
469 ;(font-lock-comment-start-regexp . ";")
473 scheme-font-lock-keywords-1 scheme-font-lock-keywords-2)
475 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
476 ;(font-lock-comment-start-regexp . ";")
478 ;; For TeX modes we could use `backward-paragraph' for the same reason.
479 ;; But we don't, because paragraph breaks are arguably likely enough to
480 ;; occur within a genuine syntactic block to make it too risky.
481 ;; However, we do specify a MARK-BLOCK function as that cannot result
482 ;; in a mis-fontification even if it might not fontify enough. --sm.
485 tex-font-lock-keywords-1 tex-font-lock-keywords-2)
487 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
488 ;(font-lock-comment-start-regexp . "%")
490 )
506 "Alist of fall-back Font Lock defaults for major modes.
507 Each item should be a list of the form:
509 (MAJOR-MODE . FONT-LOCK-DEFAULTS)
511 where MAJOR-MODE is a symbol and FONT-LOCK-DEFAULTS is a list of default
515 "*Alist of `font-lock-keywords' local to a `major-mode'.
519 "*Non-nil means Font Lock should not fontify comments or strings.
523 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
527 "A list of the syntactic keywords to highlight.
528 Can be the list or the name of a function or variable whose value is the list.
529 See `font-lock-keywords' for a description of the form of this list;
530 the differences are listed below. MATCH-HIGHLIGHT should be of the form:
532 (MATCH SYNTAX OVERRIDE LAXMATCH)
534 where SYNTAX can be of the form (SYNTAX-CODE . MATCHING-CHAR), the name of a
535 syntax table, or an expression whose value is such a form or a syntax table.
536 OVERRIDE cannot be `prepend' or `append'.
541 "Non-nil means use this syntax table for fontifying.
542 If this is nil, the major mode's syntax table is used.
545 ;; If this is nil, we only use the beginning of the buffer if we can't use
546 ;; `font-lock-cache-position' and `font-lock-cache-state'.
548 "*Non-nil means use this function to move back outside of a syntactic block.
549 When called with no args it should leave point at the beginning of any
550 enclosing syntactic block.
551 If this is nil, the beginning of the buffer is used (in the worst case).
555 "*Non-nil means use this function to mark a block of text.
556 When called with no args it should leave point at the beginning of any
557 enclosing textual block and mark at the end.
560 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
561 ;(defvar font-lock-comment-start-regexp nil
562 ; "*Regexp to match the start of a comment.
563 ;This need not discriminate between genuine comments and quoted comment
564 ;characters or comment characters within strings.
565 ;If nil, `comment-start-skip' is used instead; see that variable for more info.
566 ;This is normally set via `font-lock-defaults'.")
569 "Function to use for fontifying the buffer.
573 "Function to use for unfontifying the buffer.
574 This is used when turning off Font Lock mode.
578 "Function to use for fontifying a region.
579 It should take two args, the beginning and end of the region, and an optional
580 third arg VERBOSE. If non-nil, the function should print status messages.
584 "Function to use for unfontifying a region.
585 It should take two args, the beginning and end of the region.
589 "List of Font Lock mode related modes that should not be turned on.
590 Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'.
596 ;;;###autoload
599 \f
600 ;; Font Lock mode.
603 ;;
604 ;; We don't do this at the top-level as we only use non-autoloaded macros.
606 ;;
607 ;; Borrowed from lazy-lock.el.
608 ;; We use this to preserve or protect things when modifying text properties.
610 "Bind variables according to VARLIST and eval BODY restoring buffer state."
614 before-change-functions after-change-functions
615 deactivate-mark buffer-file-name buffer-file-truename))))
621 ;;;###autoload
623 "Toggle Font Lock mode.
624 With arg, turn Font Lock mode on if and only if arg is positive.
626 When Font Lock mode is enabled, text is fontified as you type it:
628 - Comments are displayed in `font-lock-comment-face';
629 - Strings are displayed in `font-lock-string-face';
630 - Certain other expressions are displayed in other faces according to the
631 value of the variable `font-lock-keywords'.
633 You can enable Font Lock mode in any major mode automatically by turning on in
634 the major mode's hook. For example, put in your ~/.emacs:
636 (add-hook 'c-mode-hook 'turn-on-font-lock)
638 Alternatively, you can use Global Font Lock mode to automagically turn on Font
639 Lock mode in buffers whose major mode supports it and whose major mode is one
640 of `font-lock-global-modes'. For example, put in your ~/.emacs:
642 (global-font-lock-mode t)
644 There are a number of support modes that may be used to speed up Font Lock mode
645 in various ways, specified via the variable `font-lock-support-mode'. Where
646 major modes support different levels of fontification, you can use the variable
647 `font-lock-maximum-decoration' to specify which level you generally prefer.
648 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
649 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
651 For example, to specify that Font Lock mode use use Lazy Lock mode as a support
652 mode and use maximum levels of fontification, put in your ~/.emacs:
654 (setq font-lock-support-mode 'lazy-lock-mode)
655 (setq font-lock-maximum-decoration t)
657 To add your own highlighting for some major mode, and modify the highlighting
658 selected automatically via the variable `font-lock-maximum-decoration', you can
659 use `font-lock-add-keywords'.
661 To fontify a buffer, without turning on Font Lock mode and regardless of buffer
664 To fontify a block (the function or paragraph containing point, or a number of
665 lines around point), perhaps because modification on the current line caused
668 See the variable `font-lock-defaults-alist' for the Font Lock mode default
669 settings. You can set your own default settings for some mode, by setting a
670 buffer local value for `font-lock-defaults', via its mode hook."
672 ;; Don't turn on Font Lock mode if we don't have a display (we're running a
673 ;; batch job) or if the buffer is invisible (the name starts with a space).
680 ;; Turn on Font Lock mode.
687 ;; Fontify the buffer if we have to.
690 nil)
695 ;; Turn off Font Lock mode.
703 ;;;###autoload
705 "Turn on Font Lock mode conditionally.
706 Turn on only if the terminal can display it."
710 ;;;###autoload
712 "Add highlighting KEYWORDS for MAJOR-MODE.
713 MAJOR-MODE should be a symbol, the major mode command name, such as `c-mode'
714 or nil. If nil, highlighting keywords are added for the current buffer.
715 KEYWORDS should be a list; see the variable `font-lock-keywords'.
716 By default they are added at the beginning of the current highlighting list.
717 If optional argument APPEND is `set', they are used to replace the current
718 highlighting list. If APPEND is any other non-nil value, they are added at the
719 end of the current highlighting list.
721 For example:
723 (font-lock-add-keywords 'c-mode
727 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
728 comments, and to fontify `and', `or' and `not' words as keywords.
730 Note that some modes have specialised support for additional patterns, e.g.,
731 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
732 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
734 ;; If MAJOR-MODE is non-nil, add the KEYWORDS and APPEND spec to
735 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
741 ;; Otherwise if Font Lock mode is on, set or add the keywords now.
746 font-lock-keywords)))
750 \f
751 ;;; Global Font Lock mode.
753 ;; A few people have hassled in the past for a way to make it easier to turn on
754 ;; Font Lock mode, without the user needing to know for which modes s/he has to
755 ;; turn it on, perhaps the same way hilit19.el/hl319.el does. I've always
756 ;; balked at that way, as I see it as just re-moulding the same problem in
757 ;; another form. That is; some person would still have to keep track of which
758 ;; modes (which may not even be distributed with Emacs) support Font Lock mode.
759 ;; The list would always be out of date. And that person might have to be me.
761 ;; Implementation.
762 ;;
763 ;; In a previous discussion the following hack came to mind. It is a gross
764 ;; hack, but it generally works. We use the convention that major modes start
765 ;; by calling the function `kill-all-local-variables', which in turn runs
766 ;; functions on the hook variable `change-major-mode-hook'. We attach our
767 ;; function `font-lock-change-major-mode' to that hook. Of course, when this
768 ;; hook is run, the major mode is in the process of being changed and we do not
769 ;; know what the final major mode will be. So, `font-lock-change-major-mode'
770 ;; only (a) notes the name of the current buffer, and (b) adds our function
771 ;; `turn-on-font-lock-if-enabled' to the hook variables `find-file-hooks' and
772 ;; `post-command-hook' (for buffers that are not visiting files). By the time
773 ;; the functions on the first of these hooks to be run are run, the new major
774 ;; mode is assumed to be in place. This way we get a Font Lock function run
775 ;; when a major mode is turned on, without knowing major modes or their hooks.
776 ;;
777 ;; Naturally this requires that (a) major modes run `kill-all-local-variables',
778 ;; as they are supposed to do, and (b) the major mode is in place after the
779 ;; file is visited or the command that ran `kill-all-local-variables' has
780 ;; finished, whichever the sooner. Arguably, any major mode that does not
781 ;; follow the convension (a) is broken, and I can't think of any reason why (b)
782 ;; would not be met (except `gnudoit' on non-files). However, it is not clean.
783 ;;
784 ;; Probably the cleanest solution is to have each major mode function run some
785 ;; hook, e.g., `major-mode-hook', but maybe implementing that change is
786 ;; impractical. I am personally against making `setq' a macro or be advised,
787 ;; or have a special function such as `set-major-mode', but maybe someone can
788 ;; come up with another solution?
790 ;; User interface.
791 ;;
792 ;; Although Global Font Lock mode is a pseudo-mode, I think that the user
793 ;; interface should conform to the usual Emacs convention for modes, i.e., a
794 ;; command to toggle the feature (`global-font-lock-mode') with a variable for
795 ;; finer control of the mode's behaviour (`font-lock-global-modes').
796 ;;
797 ;; The feature should not be enabled by loading font-lock.el, since other
798 ;; mechanisms for turning on Font Lock mode, such as M-x font-lock-mode RET or
799 ;; (add-hook 'c-mode-hook 'turn-on-font-lock), would cause Font Lock mode to be
800 ;; turned on everywhere. That would not be intuitive or informative because
801 ;; loading a file tells you nothing about the feature or how to control it. It
802 ;; would also be contrary to the Principle of Least Surprise. sm.
806 ;;;###autoload
808 "Toggle Global Font Lock mode.
809 With prefix ARG, turn Global Font Lock mode on if and only if ARG is positive.
810 Displays a message saying whether the mode is on or off if MESSAGE is non-nil.
811 Returns the new status of Global Font Lock mode (non-nil means on).
813 When Global Font Lock mode is enabled, Font Lock mode is automagically
814 turned on in a buffer if its major mode is one of `font-lock-global-modes'."
818 global-font-lock-mode)))
828 ;; Naughty hack. This variable was originally a `defvar' to keep track of
829 ;; whether Global Font Lock mode was turned on or not. As a `defcustom' with
830 ;; special `:set' and `:require' forms, we can provide custom mode control.
832 "Toggle Global Font Lock mode.
833 When Global Font Lock mode is enabled, Font Lock mode is automagically
834 turned on in a buffer if its major mode is one of `font-lock-global-modes'.
843 "*Modes for which Font Lock mode is automagically turned on.
844 Global Font Lock mode is controlled by the `global-font-lock-mode' command.
845 If nil, means no modes have Font Lock mode automatically turned on.
846 If t, all modes that support Font Lock mode have it automatically turned on.
847 If a list, it should be a list of `major-mode' symbol names for which Font Lock
848 mode should be automatically turned on. The sense of the list is negated if it
849 begins with `not'. For example:
850 (c-mode c++-mode)
851 means that Font Lock mode is turned on for buffers in C and C++ modes only."
861 ;; Turn off Font Lock mode if it's on.
864 ;; Gross hack warning: Delicate readers should avert eyes now.
865 ;; Something is running `kill-all-local-variables', which generally means the
866 ;; major mode is being changed. Run `turn-on-font-lock-if-enabled' after the
867 ;; file is visited or the current command has finished.
873 ;; Gross hack warning: Delicate readers should avert eyes now.
874 ;; Turn on Font Lock mode if it's supported by the major mode and enabled by
875 ;; the user.
893 ;;; End of Global Font Lock mode.
894 \f
895 ;;; Font Lock Support mode.
897 ;; This is the code used to interface font-lock.el with any of its add-on
898 ;; packages, and provide the user interface. Packages that have their own
899 ;; local buffer fontification functions (see below) may have to call
900 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
901 ;; themselves.
904 "*Support mode for Font Lock mode.
905 Support modes speed up Font Lock mode by being choosy about when fontification
906 occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode') and
907 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
908 If nil, means support for Font Lock mode is never performed.
909 If a symbol, use that support mode.
910 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
911 where MAJOR-MODE is a symbol or t (meaning the default). For example:
912 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
913 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
914 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
916 The value of this variable is used when Font Lock mode is turned on."
929 ))
960 ;;; End of Font Lock Support mode.
961 \f
962 ;;; Fontification functions.
964 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
965 ;; code to fontify a region, the function runs the function whose name is the
966 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
967 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
968 ;; which does contain the code to fontify a region. However, the value of the
969 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
970 ;; do anything. The indirection of the fontification functions gives major
971 ;; modes the capability of modifying the way font-lock.el fontifies. Major
972 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
973 ;; via the variable `font-lock-defaults'.
974 ;;
975 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
976 ;; font-lock.el uses its own function for buffer fontification. This function
977 ;; makes fontification be on a message-by-message basis and so visiting an
978 ;; RMAIL file is much faster. A clever implementation of the function might
979 ;; fontify the headers differently than the message body. (It should, and
980 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
981 ;; you?) This hints at a more interesting use...
982 ;;
983 ;; Languages that contain text normally contained in different major modes
984 ;; could define their own fontification functions that treat text differently
985 ;; depending on its context. For example, Perl mode could arrange that here
986 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
987 ;; rules one way and C code another. Neat!
988 ;;
989 ;; A further reason to use the fontification indirection feature is when the
990 ;; default syntactual fontification, or the default fontification in general,
991 ;; is not flexible enough for a particular major mode. For example, perhaps
992 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
993 ;; cope with. You need to write your own version of that function, e.g.,
994 ;; `hairy-fontify-syntactically-region', and make your own version of
995 ;; `hairy-fontify-region' call that function before calling
996 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
997 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
998 ;; would call your region fontification function instead of its own. For
999 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
1000 ;; directives correctly and cleanly. (It is the same problem as fontifying
1001 ;; multi-line strings and comments; regexps are not appropriate for the job.)
1003 ;;;###autoload
1005 "Fontify the current buffer the way `font-lock-mode' would."
1022 font-lock-verbose)))
1025 ;; Make sure we have the right `font-lock-keywords' etc.
1028 ;; Make sure we fontify etc. in the whole buffer.
1037 ;; We don't restore the old fontification, so it's best to unfontify.
1039 ;; Make sure we undo `font-lock-keywords' etc.
1046 ;; Make sure we unfontify etc. in the whole buffer.
1060 ;; Use the fontification syntax table, if any.
1063 ;; Now do the fontification.
1070 ;; Clean up.
1073 ;; The following must be rethought, since keywords can override fontification.
1074 ; ;; Now scan for keywords, but not if we are inside a comment now.
1075 ; (or (and (not font-lock-keywords-only)
1076 ; (let ((state (parse-partial-sexp beg end nil nil
1077 ; font-lock-cache-state)))
1078 ; (or (nth 4 state) (nth 7 state))))
1079 ; (font-lock-fontify-keywords-region beg end))
1085 ;; Called when any modification is made to buffer text.
1090 ;; Rescan between start of lines enclosing the region.
1096 "Fontify some lines the way `font-lock-fontify-buffer' would.
1097 The lines could be a function or paragraph, or a specified number of lines.
1098 If ARG is given, fontify that many lines before and after point, or 16 lines if
1099 no ARG is given and `font-lock-mark-block-function' is nil.
1100 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1101 delimit the region to fontify."
1104 deactivate-mark)
1105 ;; Make sure we have the right `font-lock-keywords' etc.
1121 ;;; End of Fontification functions.
1122 \f
1123 ;;; Additional text property functions.
1125 ;; The following text property functions should be builtins. This means they
1126 ;; should be written in C and put with all the other text property functions.
1127 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1128 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1129 ;; in Lisp below and commented out. sm.
1132 "Prepend to one property of the text from START to END.
1133 Arguments PROP and VALUE specify the property and value to prepend to the value
1134 already in place. The resulting property values are always lists.
1135 Optional argument OBJECT is the string or buffer containing the text."
1142 object)
1146 "Append to one property of the text from START to END.
1147 Arguments PROP and VALUE specify the property and value to append to the value
1148 already in place. The resulting property values are always lists.
1149 Optional argument OBJECT is the string or buffer containing the text."
1156 object)
1160 "Fill in one property of the text from START to END.
1161 Arguments PROP and VALUE specify the property and value to put where none are
1162 already in place. Therefore existing property values are not overwritten.
1163 Optional argument OBJECT is the string or buffer containing the text."
1170 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1171 ;; is to `add-text-properties', etc.
1172 ;(defun remove-text-property (start end property &optional object)
1173 ; "Remove a property from text from START to END.
1174 ;Argument PROPERTY is the property to remove.
1175 ;Optional argument OBJECT is the string or buffer containing the text.
1176 ;Return t if the property was actually removed, nil otherwise."
1177 ; (remove-text-properties start end (list property) object))
1179 ;; For consistency: maybe this should be called `remove-single-property' like
1180 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1181 ;(defun remove-single-text-property (start end prop value &optional object)
1182 ; "Remove a specific property value from text from START to END.
1183 ;Arguments PROP and VALUE specify the property and value to remove. The
1184 ;resulting property values are not equal to VALUE nor lists containing VALUE.
1185 ;Optional argument OBJECT is the string or buffer containing the text."
1186 ; (let ((start (text-property-not-all start end prop nil object)) next prev)
1187 ; (while start
1188 ; (setq next (next-single-property-change start prop object end)
1189 ; prev (get-text-property start prop object))
1190 ; (cond ((and (symbolp prev) (eq value prev))
1191 ; (remove-text-property start next prop object))
1192 ; ((and (listp prev) (memq value prev))
1193 ; (let ((new (delq value prev)))
1194 ; (cond ((null new)
1195 ; (remove-text-property start next prop object))
1196 ; ((= (length new) 1)
1197 ; (put-text-property start next prop (car new) object))
1198 ; (t
1199 ; (put-text-property start next prop new object))))))
1200 ; (setq start (text-property-not-all next end prop nil object)))))
1202 ;;; End of Additional text property functions.
1203 \f
1204 ;;; Syntactic regexp fontification functions.
1206 ;; These syntactic keyword pass functions are identical to those keyword pass
1207 ;; functions below, with the following exceptions; (a) they operate on
1208 ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed
1209 ;; is less of an issue, (c) eval of property value does not occur JIT as speed
1210 ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it
1211 ;; makes no sense for `syntax-table' property values, (e) they do not do it
1212 ;; LOUDLY as it is not likely to be intensive.
1215 "Apply HIGHLIGHT following a match.
1216 HIGHLIGHT should be of the form MATCH-HIGHLIGHT,
1217 see `font-lock-syntactic-keywords'."
1225 ;; No match but we might not signal an error.
1229 ;; Cannot override existing fontification.
1233 ;; Override existing fontification.
1236 ;; Keep existing fontification.
1240 "Fontify according to KEYWORDS until LIMIT.
1241 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1242 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1244 ;; Evaluate PRE-MATCH-FORM.
1246 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1251 ;; Find an occurrence of `matcher' before `limit'.
1255 ;; Apply each highlight to this instance of `matcher'.
1260 ;; Evaluate POST-MATCH-FORM.
1264 "Fontify according to `font-lock-syntactic-keywords' between START and END.
1265 START should be at the beginning of a line."
1266 ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords.
1269 font-lock-syntactic-keywords)))
1270 ;; If `font-lock-syntactic-keywords' is not compiled, compile it.
1273 font-lock-syntactic-keywords)))
1274 ;; Get down to business.
1277 keyword matcher highlights)
1279 ;; Find an occurrence of `matcher' from `start' to `end'.
1285 ;; Apply each highlight to this instance of `matcher', which may be
1286 ;; specific highlights or more keywords anchored to `matcher'.
1292 end))
1296 ;;; End of Syntactic regexp fontification functions.
1297 \f
1298 ;;; Syntactic fontification functions.
1300 ;; These record the parse state at a particular position, always the start of a
1301 ;; line. Used to make `font-lock-fontify-syntactically-region' faster.
1302 ;; Previously, `font-lock-cache-position' was just a buffer position. However,
1303 ;; under certain situations, this occasionally resulted in mis-fontification.
1304 ;; I think the "situations" were deletion with Lazy Lock mode's deferral. sm.
1309 "Put proper face on each string and comment between START and END.
1310 START should be at the beginning of a line."
1312 state string beg)
1315 ;;
1316 ;; Find the state at the `beginning-of-line' before `start'.
1318 ;; Use the cache for the state of `start'.
1320 ;; Find the state of `start'.
1322 ;; Use the state at the previous cache position, if any, or
1323 ;; otherwise calculate from `point-min'.
1327 font-lock-cache-state)))
1328 ;; Call the function to move outside any syntactic block.
1331 ;; Cache the state and position of `start'.
1334 ;;
1335 ;; If the region starts inside a string or comment, show the extent of it.
1341 font-lock-string-face
1342 font-lock-comment-face)))
1343 ;;
1344 ;; Find each interesting place between here and `end'.
1354 font-lock-string-face
1355 font-lock-comment-face)))))
1357 ;;; End of Syntactic fontification functions.
1358 \f
1359 ;;; Keyword regexp fontification functions.
1362 "Apply HIGHLIGHT following a match.
1363 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1368 ;; No match but we might not signal an error.
1372 ;; Cannot override existing fontification.
1376 ;; Override existing fontification.
1379 ;; Prepend to existing fontification.
1382 ;; Append to existing fontification.
1385 ;; Keep existing fontification.
1389 "Fontify according to KEYWORDS until LIMIT.
1390 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1391 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1393 ;; Evaluate PRE-MATCH-FORM.
1395 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1400 ;; Find an occurrence of `matcher' before `limit'.
1404 ;; Apply each highlight to this instance of `matcher'.
1409 ;; Evaluate POST-MATCH-FORM.
1413 "Fontify according to `font-lock-keywords' between START and END.
1414 START should be at the beginning of a line."
1420 keyword matcher highlights)
1421 ;;
1422 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1426 ;;
1427 ;; Find an occurrence of `matcher' from `start' to `end'.
1433 ;; Apply each highlight to this instance of `matcher', which may be
1434 ;; specific highlights or more keywords anchored to `matcher'.
1443 ;;; End of Keyword regexp fontification functions.
1444 \f
1445 ;; Various functions.
1448 ;; Compile KEYWORDS into the form (t KEYWORD ...) where KEYWORD is of the
1449 ;; form (MATCHER HIGHLIGHT ...) as shown in `font-lock-keywords' doc string.
1451 keywords
1460 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1471 keyword)))
1474 ;; Evalulate KEYWORDS if a function (funcall) or variable (eval) name.
1476 keywords
1482 ;; Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1483 ;; Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t.
1486 alist))
1489 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1490 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
1492 keywords)
1503 "Set fontification defaults appropriately for this mode.
1504 Sets various variables using `font-lock-defaults' (or, if nil, using
1505 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1506 ;; Set fontification defaults.
1508 ;; Set iff not previously set.
1519 ;; Regexp fontification?
1522 ;; Local fontification?
1526 ;; Syntactic fontification?
1529 ;; Case fold during regexp fontification?
1532 ;; Syntax table for regexp and syntactic fontification?
1538 ;; The character to modify may be a single CHAR or a STRING.
1545 font-lock-syntax-table)
1548 ;; Syntax function for syntactic fontification?
1552 ;; Variable alist?
1562 "Unset fontification defaults. See `font-lock-set-defaults'."
1564 font-lock-keywords nil
1565 font-lock-keywords-only nil
1566 font-lock-keywords-case-fold-search nil
1567 font-lock-syntax-table nil
1568 font-lock-beginning-of-syntax-function nil)
1575 \f
1576 ;;; Colour etc. support.
1578 ;; Originally these variable values were face names such as `bold' etc.
1579 ;; Now we create our own faces, but we keep these variables for compatibility
1580 ;; and they give users another mechanism for changing face appearance.
1581 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
1582 ;; returns a face. So the easiest thing is to continue using these variables,
1583 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
1611 ;; Originally face attributes were specified via `font-lock-face-attributes'.
1612 ;; Users then changed the default face attributes by setting that variable.
1613 ;; However, we try and be back-compatible and respect its value if set except
1614 ;; for faces where M-x customize has been used to save changes for the face.
1620 ;; Rustle up a `defface' SPEC from a `font-lock-face-attributes' entry.
1627 face-spec)
1640 ;; But now we do it the custom way. Note that `defface' will not overwrite any
1641 ;; faces declared above via `custom-declare-face'.
1650 "Font Lock mode face used to highlight comments."
1659 "Font Lock mode face used to highlight strings."
1668 "Font Lock mode face used to highlight keywords."
1677 "Font Lock mode face used to highlight builtins."
1684 "Font Lock mode face used to highlight function names."
1695 "Font Lock mode face used to highlight variable names."
1704 "Font Lock mode face used to highlight types."
1715 "Font Lock mode face used to highlight references."
1722 "Font Lock mode face used to highlight warnings."
1725 ;;; End of Colour etc. support.
1726 \f
1727 ;;; Menu support.
1729 ;; This section of code is commented out because Emacs does not have real menu
1730 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1731 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1732 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1733 ;; the entry for "Text Properties" something like:
1734 ;;
1735 ;; (define-key menu-bar-edit-menu [font-lock]
1736 ;; '("Syntax Highlighting" . font-lock-menu))
1737 ;;
1738 ;; and remove a single ";" from the beginning of each line in the rest of this
1739 ;; section. Probably the mechanism for telling the menu code what are menu
1740 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1741 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1743 ;;;;###autoload
1744 ;(progn
1745 ; ;; Make the Font Lock menu.
1746 ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1747 ; ;; Add the menu items in reverse order.
1748 ; (define-key font-lock-menu [fontify-less]
1749 ; '("Less In Current Buffer" . font-lock-fontify-less))
1750 ; (define-key font-lock-menu [fontify-more]
1751 ; '("More In Current Buffer" . font-lock-fontify-more))
1752 ; (define-key font-lock-menu [font-lock-sep]
1753 ; '("--"))
1754 ; (define-key font-lock-menu [font-lock-mode]
1755 ; '("In Current Buffer" . font-lock-mode))
1756 ; (define-key font-lock-menu [global-font-lock-mode]
1757 ; '("In All Buffers" . global-font-lock-mode)))
1758 ;
1759 ;;;;###autoload
1760 ;(progn
1761 ; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1762 ; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1763 ; (put 'global-font-lock-mode 'menu-toggle t)
1764 ; (put 'font-lock-mode 'menu-toggle t)
1765 ; (put 'font-lock-fontify-more 'menu-enable '(identity))
1766 ; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1767 ;
1768 ;;; Put the appropriate symbol property values on now. See above.
1769 ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode))
1770 ;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1771 ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1772 ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1773 ;
1774 ;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1775 ;
1776 ;(defun font-lock-fontify-level (level)
1777 ; (let ((font-lock-maximum-decoration level))
1778 ; (when font-lock-mode
1779 ; (font-lock-mode))
1780 ; (font-lock-mode)
1781 ; (when font-lock-verbose
1782 ; (message "Fontifying %s... level %d" (buffer-name) level))))
1783 ;
1784 ;(defun font-lock-fontify-less ()
1785 ; "Fontify the current buffer with less decoration.
1786 ;See `font-lock-maximum-decoration'."
1787 ; (interactive)
1788 ; ;; Check in case we get called interactively.
1789 ; (if (nth 1 font-lock-fontify-level)
1790 ; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1791 ; (error "No less decoration")))
1792 ;
1793 ;(defun font-lock-fontify-more ()
1794 ; "Fontify the current buffer with more decoration.
1795 ;See `font-lock-maximum-decoration'."
1796 ; (interactive)
1797 ; ;; Check in case we get called interactively.
1798 ; (if (nth 2 font-lock-fontify-level)
1799 ; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1800 ; (error "No more decoration")))
1801 ;
1802 ;;; This should be called by `font-lock-set-defaults'.
1803 ;(defun font-lock-set-menu ()
1804 ; ;; Activate less/more fontification entries if there are multiple levels for
1805 ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
1806 ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
1807 ; (let ((keywords (or (nth 0 font-lock-defaults)
1808 ; (nth 1 (assq major-mode font-lock-defaults-alist))))
1809 ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1810 ; (make-local-variable 'font-lock-fontify-level)
1811 ; (if (or (symbolp keywords) (= (length keywords) 1))
1812 ; (font-lock-unset-menu)
1813 ; (cond ((eq level t)
1814 ; (setq level (1- (length keywords))))
1815 ; ((or (null level) (zerop level))
1816 ; ;; The default level is usually, but not necessarily, level 1.
1817 ; (setq level (- (length keywords)
1818 ; (length (member (eval (car keywords))
1819 ; (mapcar 'eval (cdr keywords))))))))
1820 ; (setq font-lock-fontify-level (list level (> level 1)
1821 ; (< level (1- (length keywords))))))))
1822 ;
1823 ;;; This should be called by `font-lock-unset-defaults'.
1824 ;(defun font-lock-unset-menu ()
1825 ; ;; Deactivate less/more fontification entries.
1826 ; (setq font-lock-fontify-level nil))
1828 ;;; End of Menu support.
1829 \f
1830 ;;; Various regexp information shared by several modes.
1831 ;;; Information specific to a single mode should go in its load library.
1833 ;; Font Lock support for C, C++, Objective-C and Java modes will one day be in
1834 ;; some cc-font.el (and required by cc-mode.el). However, the below function
1835 ;; should stay in font-lock.el, since it is used by other libraries. sm.
1838 "Match, and move over, any declaration/definition item after point.
1839 Matches after point, but ignores leading whitespace and `*' characters.
1840 Does not move further than LIMIT.
1842 The expected syntax of a declaration/definition item is `word' (preceded by
1843 optional whitespace and `*' characters and proceeded by optional whitespace)
1844 optionally followed by a `('. Everything following the item (but belonging to
1845 it) is expected to by skip-able by `scan-sexps', and items are expected to be
1846 separated with a `,' and to be terminated with a `;'.
1848 Thus the regexp matches after point: word (
1849 ^^^^ ^
1850 Where the match subexpressions are: 1 2
1852 The item is delimited by (match-beginning 1) and (match-end 1).
1853 If (match-beginning 2) is non-nil, the item is followed by a `('.
1855 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
1860 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
1863 ;; Move over any item value, etc., to the next item.
1868 \f
1869 ;; Lisp.
1874 ;;
1875 ;; Definitions.
1877 ;; Function declarations.
1881 ;; Variable declarations.
1883 ;; Structure declarations.
1886 ;; Any whitespace and defined object.
1893 nil t))
1894 ;;
1895 ;; Emacs Lisp autoload cookies.
1899 ))
1906 ;;
1907 ;; Control structures. Emacs Lisp forms.
1923 ;;
1924 ;; Control structures. Common Lisp forms.
1934 ;;
1935 ;; Feature symbols as references.
1938 ;;
1939 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1941 ;;
1942 ;; Words inside `' tend to be symbol names.
1944 ;;
1945 ;; CLisp `:' keywords as builtins.
1947 ;;
1948 ;; ELisp and CLisp `&' keywords as types.
1950 )))
1955 \f
1956 ;; Scheme.
1961 ;;
1962 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1963 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1965 ;; Function names.
1967 ;; Macro names, as variable names. A bit dubious, this.
1969 ;; Class names.
1970 "-class"
1972 ;; Any whitespace and declared object.
1979 nil t))
1980 ))
1987 ;;
1988 ;; Control structures.
1996 ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1998 ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
1999 ;;"quasiquote" "quote" "unquote" "unquote-splicing"
2002 ;;
2003 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
2005 ;;
2006 ;; Scheme `:' keywords as references.
2008 )))
2013 \f
2014 ;; TeX.
2016 ;(defvar tex-font-lock-keywords
2017 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
2018 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2019 ; 2 font-lock-function-name-face)
2020 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2021 ; 2 font-lock-reference-face)
2022 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2023 ; ;; not be able to display those fonts.
2024 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
2025 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
2026 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
2027 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
2028 ; ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
2029 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2030 ; 2 font-lock-function-name-face)
2031 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2032 ; 2 font-lock-reference-face)
2033 ; ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
2034 ; "\\\\\\([a-zA-Z@]+\\|.\\)"
2035 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2036 ; ;; not be able to display those fonts.
2037 ; ;; LaTeX2e: \emph{This is emphasized}.
2038 ; ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
2039 ; ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
2040 ; ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
2041 ; 3 (if (match-beginning 2) 'bold 'italic) keep)
2042 ; ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
2043 ; ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
2044 ; 3 (if (match-beginning 2) 'bold 'italic) keep))
2046 ;; Rewritten with the help of Alexandra Bac <abac@welcome.disi.unige.it>.
2050 ;; Names of commands whose arg should be fontified as heading, etc.
2052 ;; These commands have optional args.
2060 "newtheorem"
2063 t))
2067 t))
2071 t))
2075 t))
2076 ;; Miscellany.
2082 )
2084 ;;
2085 ;; Heading args.
2092 ;;
2093 ;; Variable args.
2097 ;;
2098 ;; Include args.
2105 ;;
2106 ;; Definitions. I think.
2109 )))
2116 ;; Names of commands whose arg should be fontified with fonts.
2121 ;;
2122 ;; Names of commands whose arg should be fontified as a citation.
2125 t))
2129 t))
2130 ;;
2131 ;; Names of commands that should be fontified.
2137 t))
2139 ;;
2140 ;; Miscellany.
2146 )
2148 ;;
2149 ;; Citation args.
2156 ;;
2157 ;; Command names, special and general.
2160 ;;
2161 ;; Font environments. It seems a bit dubious to use `bold' etc. faces
2162 ;; since we might not be able to display those fonts.
2172 ;;
2173 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for tables.
2177 ))))
2182 \f
2183 ;;; User choices.
2185 ;; These provide a means to fontify types not defined by the language. Those
2186 ;; types might be the user's own or they might be generally accepted and used.
2187 ;; Generally accepted types are used to provide default variable values.
2190 "Widget `:type' for members of the custom group `font-lock-extra-types'.
2191 Members should `:load' the package `font-lock' to use this widget."
2196 "*List of extra types to fontify in C mode.
2197 Each list item should be a regexp not containing word-delimiters.
2199 ending in _t are treated as type names.
2201 The value of this variable is used when Font Lock mode is turned on."
2206 "*List of extra types to fontify in C++ mode.
2207 Each list item should be a regexp not containing word-delimiters.
2209 name.
2211 The value of this variable is used when Font Lock mode is turned on."
2216 "*List of extra types to fontify in Objective-C mode.
2217 Each list item should be a regexp not containing word-delimiters.
2219 Class, BOOL, IMP and SEL are treated as type names.
2221 The value of this variable is used when Font Lock mode is turned on."
2226 "*List of extra types to fontify in Java mode.
2227 Each list item should be a regexp not containing word-delimiters.
2229 words (and words conforming to the Java id spec) are treated as type names.
2231 The value of this variable is used when Font Lock mode is turned on."
2234 \f
2235 ;;; C.
2237 ;; [Murmur murmur murmur] Maestro, drum-roll please... [Murmur murmur murmur.]
2238 ;; Ahem. [Murmur murmur murmur] Lay-dees an Gennel-men. [Murmur murmur shhh!]
2239 ;; I am most proud and humbly honoured today [murmur murmur cough] to present
2240 ;; to you good people, the winner of the Second Millennium Award for The Most
2241 ;; Hairy Language Syntax. [Ahhh!] All rise please. [Shuffle shuffle
2242 ;; shuffle.] And a round of applause please. For... The C Language! [Roar.]
2243 ;;
2244 ;; Thank you... You are too kind... It is with a feeling of great privilege
2245 ;; and indeed emotion [sob] that I accept this award. It has been a long hard
2246 ;; road. But we know our destiny. And our future. For we must not rest.
2247 ;; There are more tokens to overload, more shoehorn, more methodologies. But
2248 ;; more is a plus! [Ha ha ha.] And more means plus! [Ho ho ho.] The future
2249 ;; is C++! [Ohhh!] The Third Millennium Award... Will be ours! [Roar.]
2255 "Medium level highlighting for C mode.
2259 "Gaudy level highlighting for C mode.
2274 c-font-lock-extra-types)
2277 )
2280 ;;
2281 ;; These are all anchored at the beginning of line for speed.
2282 ;; Note that `c++-font-lock-keywords-1' depends on `c-font-lock-keywords-1'.
2283 ;;
2284 ;; Fontify function name definitions (GNU style; without type on line).
2286 ;;
2287 ;; Fontify error directives.
2289 ;;
2290 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2293 ;;
2294 ;; Fontify function macro names.
2296 ;;
2297 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2301 ;;
2302 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2305 ))
2310 ;;
2311 ;; Simple regexps for speed.
2312 ;;
2313 ;; Fontify all type specifiers.
2316 ;;
2317 ;; Fontify all builtin keywords (except case, default and goto; see below).
2319 ;;
2320 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2323 ;; Anders Lindgren <andersl@csd.uu.se> points out that it is quicker to use
2324 ;; MATCH-ANCHORED to effectively anchor the regexp on the left.
2328 )))
2332 ;;
2333 ;; More complicated regexps for more complete highlighting for types.
2334 ;; We still have to fontify type specifiers individually, as C is so hairy.
2336 ;;
2337 ;; Fontify all storage classes and type specifiers, plus their items.
2341 ;; Fontify each declaration item.
2343 ;; Start with point after all type specifiers.
2347 ;; Finish with point after first type specifier.
2349 ;; Fontify as a variable or function name.
2351 font-lock-function-name-face
2352 font-lock-variable-name-face)))))
2353 ;;
2354 ;; Fontify structures, or typedef names, plus their items.
2359 font-lock-function-name-face
2360 font-lock-variable-name-face))))
2361 ;;
2362 ;; Fontify anything at beginning of line as a declaration or definition.
2368 font-lock-function-name-face
2369 font-lock-variable-name-face))))
2370 )))
2371 )
2374 "Default expressions to highlight in C mode.
2376 \f
2377 ;;; C++.
2383 "Medium level highlighting for C++ mode.
2387 "Gaudy level highlighting for C++ mode.
2391 ;; Regexp matches after point: word<word>::word (
2392 ;; ^^^^ ^^^^ ^^^^ ^
2393 ;; Where the match subexpressions are: 1 3 5 6
2394 ;;
2395 ;; Item is delimited by (match-beginning 1) and (match-end 1).
2396 ;; If (match-beginning 3) is non-nil, that part of the item incloses a `<>'.
2397 ;; If (match-beginning 5) is non-nil, that part of the item follows a `::'.
2398 ;; If (match-beginning 6) is non-nil, the item is followed by a `('.
2401 ;; Skip any leading whitespace.
2403 ;; This is `c++-type-spec' from below. (Hint hint!)
2407 ;; Match any trailing parenthesis.
2412 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2415 ;; Move over any item value, etc., to the next item.
2427 ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new.
2432 ;; Taken from Stroustrup, minus keywords otherwise fontified.
2448 ;;
2449 ;; A brave attempt to match templates following a type and/or match
2450 ;; class membership. See and sync the above function
2451 ;; `font-lock-match-c++-style-declaration-item-and-skip-to-next'.
2454 ;; If the string is a type, it may be followed by the cruft above.
2456 ;;
2457 ;; Parenthesis depth of user-defined types not forgetting their cruft.
2460 )
2463 ;;
2464 ;; The list `c-font-lock-keywords-1' less that for function names.
2467 ;;
2468 ;; Class names etc.
2473 font-lock-type-face
2477 ;;
2478 ;; Fontify function name definitions, possibly incorporating class names.
2481 font-lock-type-face
2482 font-lock-function-name-face))
2485 )))
2490 ;;
2491 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2495 ;;
2496 ;; Fontify operator overloading.
2500 ;;
2501 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2507 ;;
2508 ;; Fontify other builtin keywords.
2510 ;;
2511 ;; Eric Hopper <hopper@omnifarious.mn.org> says `true' and `false' are new.
2513 )))
2517 ;;
2518 ;; More complicated regexps for more complete highlighting for types.
2520 ;;
2521 ;; Fontify all storage classes and type specifiers, plus their items.
2525 ;; Fontify each declaration item.
2527 ;; Start with point after all type specifiers.
2531 ;; Finish with point after first type specifier.
2533 ;; Fontify as a variable or function name.
2535 font-lock-type-face)
2540 font-lock-function-name-face
2542 ;;
2543 ;; Fontify structures, or typedef names, plus their items.
2548 font-lock-function-name-face
2549 font-lock-variable-name-face))))
2550 ;;
2551 ;; Fontify anything at beginning of line as a declaration or definition.
2557 font-lock-type-face)
2562 font-lock-function-name-face
2564 )))
2565 )
2568 "Default expressions to highlight in C++ mode.
2570 \f
2571 ;;; Objective-C.
2577 "Medium level highlighting for Objective-C mode.
2581 "Gaudy level highlighting for Objective-C mode.
2584 ;; Regexps written with help from Stephen Peters <speters@us.oracle.com> and
2585 ;; Jacques Duthen Prestataire <duthen@cegelec-red.fr>.
2599 objc-font-lock-extra-types)
2602 )
2605 ;;
2606 ;; The list `c-font-lock-keywords-1' less that for function names.
2609 ;;
2610 ;; Fontify compiler directives.
2615 ;;
2616 ;; Fontify method names and arguments. Oh Lordy!
2617 ;; First, on the same line as the function declaration.
2623 nil nil
2627 ;; Second, on lines following the function declaration.
2633 )))
2638 ;;
2639 ;; Simple regexps for speed.
2640 ;;
2641 ;; Fontify all type specifiers.
2645 ;;
2646 ;; Fontify all builtin keywords (except case, default and goto; see below).
2648 ;;
2649 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2652 ;; Fontify tags iff sole statement on line, otherwise we detect selectors.
2656 ;;
2657 ;; Fontify null object pointers.
2659 )))
2663 ;;
2664 ;; More complicated regexps for more complete highlighting for types.
2665 ;; We still have to fontify type specifiers individually, as C is so hairy.
2667 ;;
2668 ;; Fontify all storage classes and type specifiers, plus their items.
2672 ;; Fontify each declaration item.
2674 ;; Start with point after all type specifiers.
2678 ;; Finish with point after first type specifier.
2680 ;; Fontify as a variable or function name.
2682 font-lock-function-name-face
2683 font-lock-variable-name-face)))))
2684 ;;
2685 ;; Fontify structures, or typedef names, plus their items.
2690 font-lock-function-name-face
2691 font-lock-variable-name-face))))
2692 ;;
2693 ;; Fontify anything at beginning of line as a declaration or definition.
2699 font-lock-function-name-face
2700 font-lock-variable-name-face))))
2701 )))
2702 )
2705 "Default expressions to highlight in Objective-C mode.
2707 \f
2708 ;;; Java.
2714 "Medium level highlighting for Java mode.
2718 "Gaudy level highlighting for Java mode.
2721 ;; Regexps written with help from Fred White <fwhite@bbn.com> and
2722 ;; Anders Lindgren <andersl@csd.uu.se>.
2727 ;; Anders Lindgren <andersl@csd.uu.se> says these have gone.
2728 ;; "cast" "byvalue" "future" "generic" "operator" "var"
2729 ;; "inner" "outer" "rest"
2731 ;;
2732 ;; These are immediately followed by an object name.
2737 ;;
2738 ;; These are eventually followed by an object name.
2743 ;; Anders Lindgren <andersl@csd.uu.se> says this has gone.
2744 ;; "threadsafe"
2746 ;;
2747 ;; Random types immediately followed by an object name.
2752 )
2755 ;;
2756 ;; Fontify class names.
2759 ;;
2760 ;; Fontify package names in import directives.
2763 ))
2768 ;;
2769 ;; Fontify all builtin type specifiers.
2772 ;;
2773 ;; Fontify all builtin keywords (except below).
2775 ;;
2776 ;; Fontify keywords and targets, and case default/goto tags.
2782 ;;
2783 ;; Fontify keywords and types; the first can be followed by a type list.
2792 ;;
2793 ;; Fontify all constants.
2795 ;;
2796 ;; Javadoc tags within comments.
2802 )))
2806 ;;
2807 ;; More complicated regexps for more complete highlighting for types.
2808 ;; We still have to fontify type specifiers individually, as Java is hairy.
2810 ;;
2811 ;; Fontify random types in casts.
2815 ;; Fontify the type name.
2817 ;;
2818 ;; Fontify random types immediately followed by an item or items.
2823 ;; Fontify the type name.
2829 ;; Fontify each declaration item.
2831 ;; Start and finish with point after the type specifier.
2836 ;; Fontify as a variable or function name.
2838 font-lock-function-name-face
2839 font-lock-variable-name-face)))))
2840 ;;
2841 ;; Fontify those that are immediately followed by an item or items.
2844 ;; Fontify each declaration item.
2846 ;; Start and finish with point after the type specifier.
2848 ;; Fontify as a variable or function name.
2850 font-lock-function-name-face
2851 font-lock-variable-name-face))))
2852 ;;
2853 ;; Fontify those that are eventually followed by an item or items.
2858 ;; Fontify each declaration item.
2860 ;; Start with point after all type specifiers.
2862 ;; Finish with point after first type specifier.
2864 ;; Fontify as a variable or function name.
2866 font-lock-function-name-face
2867 font-lock-variable-name-face))))
2868 )))
2869 )
2872 "Default expressions to highlight in Java mode.
2874 \f
2875 ;; Install ourselves:
2880 ;; Provide ourselves:
2884 ;;; font-lock.el ends here