| blob | 43a3029625ee9e279f24da3a62f65a1a366570d6 |
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. The syntactic pass
64 ;; involves a syntax table and a syntax parsing function to determine the
65 ;; context of different parts of a region of text. It is necessary because
66 ;; generally strings and/or comments can span lines, and so the context of a
67 ;; given region is not necessarily apparent from the content of that region.
68 ;; Because the regexp pass only works within a given region, it is not
69 ;; generally appropriate for syntactic fontification. The regexp pass involves
70 ;; searching for given regexps (or calling given functions) within the given
71 ;; region. For each match of the regexp (or non-nil value of the called
72 ;; function), `face' text properties are added appropriately.
74 ;;; How Font Lock mode supports modes or is supported by modes:
76 ;; Modes that support Font Lock mode do so by defining one or more variables
77 ;; whose values specify the fontification. Font Lock mode knows of these
78 ;; variable names from (a) the buffer local variable `font-lock-defaults', if
79 ;; non-nil, or (b) the global variable `font-lock-defaults-alist', if the major
80 ;; mode has an entry. (Font Lock mode is set up via (a) where a mode's
81 ;; patterns are distributed with the mode's package library, and (b) where a
82 ;; mode's patterns are distributed with font-lock.el itself. An example of (a)
83 ;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is
84 ;; (a); (b) is used where it is not clear which package library should contain
85 ;; the pattern definitions.) Font Lock mode chooses which variable to use for
86 ;; fontification based on `font-lock-maximum-decoration'.
87 ;;
88 ;; Font Lock mode fontification behaviour can be modified in a number of ways.
89 ;; See the below comments and the comments distributed throughout this file.
91 ;;; Constructing patterns:
93 ;; See the documentation for the variable `font-lock-keywords'.
94 ;;
95 ;; Nasty regexps of the form "bar\\(\\|lo\\)\\|f\\(oo\\|u\\(\\|bar\\)\\)\\|lo"
96 ;; are made thusly: (make-regexp '("foo" "fu" "fubar" "bar" "barlo" "lo")) for
97 ;; efficiency. See /pub/gnu/emacs/elisp-archive/functions/make-regexp.el.Z on
98 ;; archive.cis.ohio-state.edu for this and other functions not just by sm.
100 ;;; Adding patterns for modes that already support Font Lock:
102 ;; Though Font Lock highlighting patterns already exist for many modes, it's
103 ;; likely there's something that you want fontified that currently isn't, even
104 ;; at the maximum fontification level. You can add highlighting patterns via
105 ;; `font-lock-add-keywords'. For example, say in some C
106 ;; header file you #define the token `and' to expand to `&&', etc., to make
107 ;; your C code almost readable. In your ~/.emacs there could be:
108 ;;
109 ;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>"))
110 ;;
111 ;; Some modes provide specific ways to modify patterns based on the values of
112 ;; other variables. For example, additional C types can be specified via the
113 ;; variable `c-font-lock-extra-types'.
115 ;;; Adding patterns for modes that do not support Font Lock:
117 ;; Not all modes support Font Lock mode. If you (as a user of the mode) add
118 ;; patterns for a new mode, you must define in your ~/.emacs a variable or
119 ;; variables that specify regexp fontification. Then, you should indicate to
120 ;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what
121 ;; support is required. For example, say Foo mode should have the following
122 ;; regexps fontified case-sensitively, and comments and strings should not be
123 ;; fontified automagically. In your ~/.emacs there could be:
124 ;;
125 ;; (defvar foo-font-lock-keywords
126 ;; '(("\\<\\(one\\|two\\|three\\)\\>" . font-lock-keyword-face)
127 ;; ("\\<\\(four\\|five\\|six\\)\\>" . font-lock-type-face))
128 ;; "Default expressions to highlight in Foo mode.")
129 ;;
130 ;; (add-hook 'foo-mode-hook
131 ;; (function (lambda ()
132 ;; (make-local-variable 'font-lock-defaults)
133 ;; (setq font-lock-defaults '(foo-font-lock-keywords t)))))
135 ;;; Adding Font Lock support for modes:
137 ;; Of course, it would be better that the mode already supports Font Lock mode.
138 ;; The package author would do something similar to above. The mode must
139 ;; define at the top-level a variable or variables that specify regexp
140 ;; fontification. Then, the mode command should indicate to Font Lock mode,
141 ;; via `font-lock-defaults', exactly what support is required. For example,
142 ;; say Bar mode should have the following regexps fontified case-insensitively,
143 ;; and comments and strings should be fontified automagically. In bar.el there
144 ;; could be:
145 ;;
146 ;; (defvar bar-font-lock-keywords
147 ;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . font-lock-keyword-face)
148 ;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . font-lock-type-face))
149 ;; "Default expressions to highlight in Bar mode.")
150 ;;
151 ;; and within `bar-mode' there could be:
152 ;;
153 ;; (make-local-variable 'font-lock-defaults)
154 ;; (setq font-lock-defaults '(bar-font-lock-keywords nil t))
155 \f
156 ;; What is fontification for? You might say, "It's to make my code look nice."
157 ;; I think it should be for adding information in the form of cues. These cues
158 ;; should provide you with enough information to both (a) distinguish between
159 ;; different items, and (b) identify the item meanings, without having to read
160 ;; the items and think about it. Therefore, fontification allows you to think
161 ;; less about, say, the structure of code, and more about, say, why the code
162 ;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
163 ;;
164 ;; So, here are my opinions/advice/guidelines:
165 ;;
166 ;; - Highlight conceptual objects, such as function and variable names, and
167 ;; different objects types differently, i.e., (a) and (b) above, highlight
168 ;; function names differently to variable names.
169 ;; - Keep the faces distinct from each other as far as possible.
170 ;; i.e., (a) above.
171 ;; - Use the same face for the same conceptual object, across all modes.
172 ;; i.e., (b) above, all modes that have items that can be thought of as, say,
173 ;; keywords, should be highlighted with the same face, etc.
174 ;; - Make the face attributes fit the concept as far as possible.
175 ;; i.e., function names might be a bold colour such as blue, comments might
176 ;; be a bright colour such as red, character strings might be brown, because,
177 ;; err, strings are brown (that was not the reason, please believe me).
178 ;; - Don't use a non-nil OVERRIDE unless you have a good reason.
179 ;; Only use OVERRIDE for special things that are easy to define, such as the
180 ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
181 ;; Don't use it to, say, highlight keywords in commented out code or strings.
182 ;; - Err, that's it.
183 \f
184 ;;; Code:
186 ;; Define core `font-lock' group.
188 "Font Lock mode text highlighting package."
193 "Faces for highlighting text."
198 "Extra mode-specific type names for highlighting declarations."
201 ;; Define support mode groups here for nicer `font-lock' group order.
203 "Font Lock support mode to cache fontification."
209 "Font Lock support mode to fontify lazily."
213 \f
214 ;; User variables.
217 "*If non-nil, means show status messages for buffer fontification.
218 If a number, only buffers greater than this size have fontification messages."
225 "*Maximum decoration level for fontification.
226 If nil, use the default decoration (typically the minimum available).
227 If t, use the maximum decoration available.
228 If a number, use that level of decoration (or if not available the maximum).
229 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
230 where MAJOR-MODE is a symbol or t (meaning the default). For example:
231 ((c-mode . t) (c++-mode . 2) (t . 1))
232 means use the maximum decoration available for buffers in C mode, level 2
233 decoration for buffers in C++ mode, and level 1 decoration otherwise."
250 "*Maximum size of a buffer for buffer fontification.
251 Only buffers less than this can be fontified when Font Lock mode is turned on.
252 If nil, means size is irrelevant.
253 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
254 where MAJOR-MODE is a symbol or t (meaning the default). For example:
255 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
256 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
257 for buffers in Rmail mode, and size is irrelevant otherwise."
270 \f
271 ;; Fontification variables:
274 "*A list of the keywords to highlight.
275 Each element should be of the form:
277 MATCHER
278 (MATCHER . MATCH)
279 (MATCHER . FACENAME)
280 (MATCHER . HIGHLIGHT)
281 (MATCHER HIGHLIGHT ...)
282 (eval . FORM)
284 where HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
286 FORM is an expression, whose value should be a keyword element, evaluated when
287 the keyword is (first) used in a buffer. This feature can be used to provide a
288 keyword that can only be generated when Font Lock mode is actually turned on.
290 For highlighting single items, typically only MATCH-HIGHLIGHT is required.
291 However, if an item or (typically) items are to be highlighted following the
292 instance of another item (the anchor) then MATCH-ANCHORED may be required.
294 MATCH-HIGHLIGHT should be of the form:
296 (MATCH FACENAME OVERRIDE LAXMATCH)
298 Where MATCHER can be either the regexp to search for, or the function name to
299 call to make the search (called with one argument, the limit of the search).
300 MATCH is the subexpression of MATCHER to be highlighted. MATCH can be
301 calculated via the function `font-lock-keyword-depth'. FACENAME is an
302 expression whose value is the face name to use. FACENAME's default attributes
305 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
306 be overwritten. If `keep', only parts not already fontified are highlighted.
307 If `prepend' or `append', existing fontification is merged with the new, in
308 which the new or existing fontification, respectively, takes precedence.
309 If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER.
311 For example, an element of the form highlights (if not already highlighted):
314 variable `font-lock-keyword-face'.
316 the value of `font-lock-keyword-face'.
320 of `foo-bar-face', even if already highlighted.
322 MATCH-ANCHORED should be of the form:
324 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
326 Where MATCHER is as for MATCH-HIGHLIGHT with one exception; see below.
327 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
328 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
329 used to initialise before, and cleanup after, MATCHER is used. Typically,
330 PRE-MATCH-FORM is used to move to some position relative to the original
331 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
332 be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
334 For example, an element of the form highlights (if not already highlighted):
345 The above-mentioned exception is as follows. The limit of the MATCHER search
346 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
347 However, if PRE-MATCH-FORM returns a position greater than the position after
348 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
349 It is generally a bad idea to return a position greater than the end of the
350 line, i.e., cause the MATCHER search to span lines.
352 Note that the MATCH-ANCHORED feature is experimental; in the future, we may
353 replace it with other ways of providing this functionality.
355 These regular expressions should not match text which spans lines. While
357 when you edit the buffer does not, since it considers text one line at a time.
359 This variable is set by major modes via the variable `font-lock-defaults'.
360 Be careful when composing regexps for this list; a poorly written pattern can
363 ;; This variable is used by mode packages that support Font Lock mode by
364 ;; defining their own keywords to use for `font-lock-keywords'. (The mode
365 ;; command should make it buffer-local and set it to provide the set up.)
367 "Defaults for Font Lock mode specified by the major mode.
368 Defaults should be of the form:
370 (KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN ...)
372 KEYWORDS may be a symbol (a variable or function whose value is the keywords to
373 use for fontification) or a list of symbols. If KEYWORDS-ONLY is non-nil,
374 syntactic fontification (strings and comments) is not performed.
375 If CASE-FOLD is non-nil, the case of the keywords is ignored when fontifying.
376 If SYNTAX-ALIST is non-nil, it should be a list of cons pairs of the form
377 \(CHAR-OR-STRING . STRING) used to set the local Font Lock syntax table, for
378 keyword and syntactic fontification (see `modify-syntax-entry').
380 If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
381 backwards outside any enclosing syntactic block, for syntactic fontification.
382 Typical values are `beginning-of-line' (i.e., the start of the line is known to
383 be outside a syntactic block), or `beginning-of-defun' for programming modes or
384 `backward-paragraph' for textual modes (i.e., the mode-dependent function is
385 known to move outside a syntactic block). If nil, the beginning of the buffer
386 is used as a position outside of a syntactic block, in the worst case.
388 These item elements are used by Font Lock mode to set the variables
389 `font-lock-keywords', `font-lock-keywords-only',
390 `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
391 `font-lock-beginning-of-syntax-function', respectively.
393 Further item elements are alists of the form (VARIABLE . VALUE) and are in no
394 particular order. Each VARIABLE is made buffer-local before set to VALUE.
396 Currently, appropriate variables include `font-lock-mark-block-function'.
397 If this is non-nil, it should be a function with no args used to mark any
399 Typical values are `mark-defun' for programming modes or `mark-paragraph' for
400 textual modes (i.e., the mode-dependent function is known to put point and mark
401 around a text block relevant to that mode).
403 Other variables include those for buffer-specialised fontification functions,
404 `font-lock-fontify-buffer-function', `font-lock-unfontify-buffer-function',
405 `font-lock-fontify-region-function', `font-lock-unfontify-region-function',
408 ;; This variable is used where font-lock.el itself supplies the keywords.
411 ;; Thus the calculation of the cache is usually faster but not
412 ;; infallible, so we risk mis-fontification. sm.
415 c-font-lock-keywords-2 c-font-lock-keywords-3)
417 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
418 ;(font-lock-comment-start-regexp . "/[*/]")
424 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
425 ;(font-lock-comment-start-regexp . "/[*/]")
429 objc-font-lock-keywords-2 objc-font-lock-keywords-3)
431 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
432 ;(font-lock-comment-start-regexp . "/[*/]")
436 java-font-lock-keywords-2 java-font-lock-keywords-3)
438 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
439 ;(font-lock-comment-start-regexp . "/[*/]")
443 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
445 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
446 ;(font-lock-comment-start-regexp . ";")
451 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
452 ;(font-lock-comment-start-regexp . ";")
454 ;; For TeX modes we could use `backward-paragraph' for the same reason.
455 ;; But we don't, because paragraph breaks are arguably likely enough to
456 ;; occur within a genuine syntactic block to make it too risky.
457 ;; However, we do specify a MARK-BLOCK function as that cannot result
458 ;; in a mis-fontification even if it might not fontify enough. --sm.
461 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
462 ;(font-lock-comment-start-regexp . "%")
464 )
480 "Alist of fall-back Font Lock defaults for major modes.
481 Each item should be a list of the form:
483 (MAJOR-MODE . FONT-LOCK-DEFAULTS)
485 where MAJOR-MODE is a symbol and FONT-LOCK-DEFAULTS is a list of default
489 "*Alist of `font-lock-keywords' local to a `major-mode'.
493 "*Non-nil means Font Lock should not fontify comments or strings.
497 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
501 "Non-nil means use this syntax table for fontifying.
502 If this is nil, the major mode's syntax table is used.
505 ;; If this is nil, we only use the beginning of the buffer if we can't use
506 ;; `font-lock-cache-position' and `font-lock-cache-state'.
508 "*Non-nil means use this function to move back outside of a syntactic block.
509 When called with no args it should leave point at the beginning of any
510 enclosing syntactic block.
511 If this is nil, the beginning of the buffer is used (in the worst case).
515 "*Non-nil means use this function to mark a block of text.
516 When called with no args it should leave point at the beginning of any
517 enclosing textual block and mark at the end.
520 ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP.
521 ;(defvar font-lock-comment-start-regexp nil
522 ; "*Regexp to match the start of a comment.
523 ;This need not discriminate between genuine comments and quoted comment
524 ;characters or comment characters within strings.
525 ;If nil, `comment-start-skip' is used instead; see that variable for more info.
526 ;This is normally set via `font-lock-defaults'.")
529 "Function to use for fontifying the buffer.
533 "Function to use for unfontifying the buffer.
534 This is used when turning off Font Lock mode.
538 "Function to use for fontifying a region.
539 It should take two args, the beginning and end of the region, and an optional
540 third arg VERBOSE. If non-nil, the function should print status messages.
544 "Function to use for unfontifying a region.
545 It should take two args, the beginning and end of the region.
549 "List of Font Lock mode related modes that should not be turned on.
550 Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'.
556 ;;;###autoload
559 \f
560 ;; Font Lock mode.
563 ;;
564 ;; We don't do this at the top-level as we only use non-autoloaded macros.
566 ;;
567 ;; Borrowed from lazy-lock.el.
568 ;; We use this to preserve or protect things when modifying text properties.
570 "Bind variables according to VARLIST and eval BODY restoring buffer state."
574 before-change-functions after-change-functions
575 deactivate-mark buffer-file-name buffer-file-truename))))
581 ;;;###autoload
583 "Toggle Font Lock mode.
584 With arg, turn Font Lock mode on if and only if arg is positive.
586 When Font Lock mode is enabled, text is fontified as you type it:
588 - Comments are displayed in `font-lock-comment-face';
589 - Strings are displayed in `font-lock-string-face';
590 - Certain other expressions are displayed in other faces according to the
591 value of the variable `font-lock-keywords'.
593 You can enable Font Lock mode in any major mode automatically by turning on in
594 the major mode's hook. For example, put in your ~/.emacs:
596 (add-hook 'c-mode-hook 'turn-on-font-lock)
598 Alternatively, you can use Global Font Lock mode to automagically turn on Font
599 Lock mode in buffers whose major mode supports it and whose major mode is one
600 of `font-lock-global-modes'. For example, put in your ~/.emacs:
602 (global-font-lock-mode t)
604 There are a number of support modes that may be used to speed up Font Lock mode
605 in various ways, specified via the variable `font-lock-support-mode'. Where
606 major modes support different levels of fontification, you can use the variable
607 `font-lock-maximum-decoration' to specify which level you generally prefer.
608 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
609 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
611 For example, to specify that Font Lock mode use use Lazy Lock mode as a support
612 mode and use maximum levels of fontification, put in your ~/.emacs:
614 (setq font-lock-support-mode 'lazy-lock-mode)
615 (setq font-lock-maximum-decoration t)
617 To add your own highlighting for some major mode, and modify the highlighting
618 selected automatically via the variable `font-lock-maximum-decoration', you can
619 use `font-lock-add-keywords'.
621 To fontify a buffer, without turning on Font Lock mode and regardless of buffer
624 To fontify a block (the function or paragraph containing point, or a number of
625 lines around point), perhaps because modification on the current line caused
628 See the variable `font-lock-defaults-alist' for the Font Lock mode default
629 settings. You can set your own default settings for some mode, by setting a
630 buffer local value for `font-lock-defaults', via its mode hook."
632 ;; Don't turn on Font Lock mode if we don't have a display (we're running a
633 ;; batch job) or if the buffer is invisible (the name starts with a space).
640 ;; Turn on Font Lock mode.
647 ;; Fontify the buffer if we have to.
650 nil)
655 ;; Turn off Font Lock mode.
663 ;;;###autoload
665 "Turn on Font Lock mode conditionally.
666 Turn on only if the terminal can display it."
670 ;;;###autoload
672 "Add highlighting KEYWORDS for MAJOR-MODE.
673 MAJOR-MODE should be a symbol, the major mode command name, such as `c-mode'
674 or nil. If nil, highlighting keywords are added for the current buffer.
675 KEYWORDS should be a list; see the variable `font-lock-keywords'.
676 By default they are added at the beginning of the current highlighting list.
677 If optional argument APPEND is `set', they are used to replace the current
678 highlighting list. If APPEND is any other non-nil value, they are added at the
679 end of the current highlighting list.
681 For example:
683 (font-lock-add-keywords 'c-mode
687 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
688 comments, and to fontify `and', `or' and `not' words as keywords.
690 Note that some modes have specialised support for additional patterns, e.g.,
691 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
692 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
694 ;; If MAJOR-MODE is non-nil, add the KEYWORDS and APPEND spec to
695 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
701 ;; Otherwise if Font Lock mode is on, set or add the keywords now.
706 font-lock-keywords)))
710 \f
711 ;;; Global Font Lock mode.
713 ;; A few people have hassled in the past for a way to make it easier to turn on
714 ;; Font Lock mode, without the user needing to know for which modes s/he has to
715 ;; turn it on, perhaps the same way hilit19.el/hl319.el does. I've always
716 ;; balked at that way, as I see it as just re-moulding the same problem in
717 ;; another form. That is; some person would still have to keep track of which
718 ;; modes (which may not even be distributed with Emacs) support Font Lock mode.
719 ;; The list would always be out of date. And that person might have to be me.
721 ;; Implementation.
722 ;;
723 ;; In a previous discussion the following hack came to mind. It is a gross
724 ;; hack, but it generally works. We use the convention that major modes start
725 ;; by calling the function `kill-all-local-variables', which in turn runs
726 ;; functions on the hook variable `change-major-mode-hook'. We attach our
727 ;; function `font-lock-change-major-mode' to that hook. Of course, when this
728 ;; hook is run, the major mode is in the process of being changed and we do not
729 ;; know what the final major mode will be. So, `font-lock-change-major-mode'
730 ;; only (a) notes the name of the current buffer, and (b) adds our function
731 ;; `turn-on-font-lock-if-enabled' to the hook variables `find-file-hooks' and
732 ;; `post-command-hook' (for buffers that are not visiting files). By the time
733 ;; the functions on the first of these hooks to be run are run, the new major
734 ;; mode is assumed to be in place. This way we get a Font Lock function run
735 ;; when a major mode is turned on, without knowing major modes or their hooks.
736 ;;
737 ;; Naturally this requires that (a) major modes run `kill-all-local-variables',
738 ;; as they are supposed to do, and (b) the major mode is in place after the
739 ;; file is visited or the command that ran `kill-all-local-variables' has
740 ;; finished, whichever the sooner. Arguably, any major mode that does not
741 ;; follow the convension (a) is broken, and I can't think of any reason why (b)
742 ;; would not be met (except `gnudoit' on non-files). However, it is not clean.
743 ;;
744 ;; Probably the cleanest solution is to have each major mode function run some
745 ;; hook, e.g., `major-mode-hook', but maybe implementing that change is
746 ;; impractical. I am personally against making `setq' a macro or be advised,
747 ;; or have a special function such as `set-major-mode', but maybe someone can
748 ;; come up with another solution?
750 ;; User interface.
751 ;;
752 ;; Although Global Font Lock mode is a pseudo-mode, I think that the user
753 ;; interface should conform to the usual Emacs convention for modes, i.e., a
754 ;; command to toggle the feature (`global-font-lock-mode') with a variable for
755 ;; finer control of the mode's behaviour (`font-lock-global-modes').
756 ;;
757 ;; The feature should not be enabled by loading font-lock.el, since other
758 ;; mechanisms for turning on Font Lock mode, such as M-x font-lock-mode RET or
759 ;; (add-hook 'c-mode-hook 'turn-on-font-lock), would cause Font Lock mode to be
760 ;; turned on everywhere. That would not be intuitive or informative because
761 ;; loading a file tells you nothing about the feature or how to control it. It
762 ;; would also be contrary to the Principle of Least Surprise. sm.
768 "*Modes for which Font Lock mode is automagically turned on.
769 Global Font Lock mode is controlled by the `global-font-lock-mode' command.
770 If nil, means no modes have Font Lock mode automatically turned on.
771 If t, all modes that support Font Lock mode have it automatically turned on.
772 If a list, it should be a list of `major-mode' symbol names for which Font Lock
773 mode should be automatically turned on. The sense of the list is negated if it
774 begins with `not'. For example:
775 (c-mode c++-mode)
776 means that Font Lock mode is turned on for buffers in C and C++ modes only."
785 ;;;###autoload
787 "Toggle Global Font Lock mode.
788 With prefix ARG, turn Global Font Lock mode on if and only if ARG is positive.
789 Displays a message saying whether the mode is on or off if MESSAGE is non-nil.
790 Returns the new status of Global Font Lock mode (non-nil means on).
792 When Global Font Lock mode is enabled, Font Lock mode is automagically
793 turned on in a buffer if its major mode is one of `font-lock-global-modes'."
797 global-font-lock-mode)))
808 ;; Turn off Font Lock mode if it's on.
811 ;; Gross hack warning: Delicate readers should avert eyes now.
812 ;; Something is running `kill-all-local-variables', which generally means the
813 ;; major mode is being changed. Run `turn-on-font-lock-if-enabled' after the
814 ;; file is visited or the current command has finished.
820 ;; Gross hack warning: Delicate readers should avert eyes now.
821 ;; Turn on Font Lock mode if it's supported by the major mode and enabled by
822 ;; the user.
840 ;;; End of Global Font Lock mode.
841 \f
842 ;;; Font Lock Support mode.
844 ;; This is the code used to interface font-lock.el with any of its add-on
845 ;; packages, and provide the user interface. Packages that have their own
846 ;; local buffer fontification functions (see below) may have to call
847 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
848 ;; themselves.
851 "*Support mode for Font Lock mode.
852 Support modes speed up Font Lock mode by being choosy about when fontification
853 occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode') and
854 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
855 If nil, means support for Font Lock mode is never performed.
856 If a symbol, use that support mode.
857 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
858 where MAJOR-MODE is a symbol or t (meaning the default). For example:
859 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
860 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
861 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
863 The value of this variable is used when Font Lock mode is turned on."
876 ))
907 ;;; End of Font Lock Support mode.
908 \f
909 ;;; Fontification functions.
911 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
912 ;; code to fontify a region, the function runs the function whose name is the
913 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
914 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
915 ;; which does contain the code to fontify a region. However, the value of the
916 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
917 ;; do anything. The indirection of the fontification functions gives major
918 ;; modes the capability of modifying the way font-lock.el fontifies. Major
919 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
920 ;; via the variable `font-lock-defaults'.
921 ;;
922 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
923 ;; font-lock.el uses its own function for buffer fontification. This function
924 ;; makes fontification be on a message-by-message basis and so visiting an
925 ;; RMAIL file is much faster. A clever implementation of the function might
926 ;; fontify the headers differently than the message body. (It should, and
927 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
928 ;; you?) This hints at a more interesting use...
929 ;;
930 ;; Languages that contain text normally contained in different major modes
931 ;; could define their own fontification functions that treat text differently
932 ;; depending on its context. For example, Perl mode could arrange that here
933 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
934 ;; rules one way and C code another. Neat!
935 ;;
936 ;; A further reason to use the fontification indirection feature is when the
937 ;; default syntactual fontification, or the default fontification in general,
938 ;; is not flexible enough for a particular major mode. For example, perhaps
939 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
940 ;; cope with. You need to write your own version of that function, e.g.,
941 ;; `hairy-fontify-syntactically-region', and make your own version of
942 ;; `hairy-fontify-region' call that function before calling
943 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
944 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
945 ;; would call your region fontification function instead of its own. For
946 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
947 ;; directives correctly and cleanly. (It is the same problem as fontifying
948 ;; multi-line strings and comments; regexps are not appropriate for the job.)
950 ;;;###autoload
952 "Fontify the current buffer the way `font-lock-mode' would."
969 font-lock-verbose)))
972 ;; Make sure we have the right `font-lock-keywords' etc.
975 ;; Make sure we fontify etc. in the whole buffer.
984 ;; We don't restore the old fontification, so it's best to unfontify.
986 ;; Make sure we undo `font-lock-keywords' etc.
993 ;; Make sure we unfontify etc. in the whole buffer.
1005 ;; Use the fontification syntax table, if any.
1008 ;; Now do the fontification.
1013 ;; Clean up.
1016 ;; The following must be rethought, since keywords can override fontification.
1017 ; ;; Now scan for keywords, but not if we are inside a comment now.
1018 ; (or (and (not font-lock-keywords-only)
1019 ; (let ((state (parse-partial-sexp beg end nil nil
1020 ; font-lock-cache-state)))
1021 ; (or (nth 4 state) (nth 7 state))))
1022 ; (font-lock-fontify-keywords-region beg end))
1028 ;; Called when any modification is made to buffer text.
1032 ;; Rescan between start of lines enclosing the region.
1038 "Fontify some lines the way `font-lock-fontify-buffer' would.
1039 The lines could be a function or paragraph, or a specified number of lines.
1040 If ARG is given, fontify that many lines before and after point, or 16 lines if
1041 no ARG is given and `font-lock-mark-block-function' is nil.
1042 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
1043 delimit the region to fontify."
1046 ;; Make sure we have the right `font-lock-keywords' etc.
1062 ;;; End of Fontification functions.
1063 \f
1064 ;;; Syntactic fontification functions.
1066 ;; These record the parse state at a particular position, always the start of a
1067 ;; line. Used to make `font-lock-fontify-syntactically-region' faster.
1068 ;; Previously, `font-lock-cache-position' was just a buffer position. However,
1069 ;; under certain situations, this occasionally resulted in mis-fontification.
1070 ;; I think the "situations" were deletion with Lazy Lock mode's deferral. sm.
1075 "Put proper face on each string and comment between START and END.
1076 START should be at the beginning of a line."
1078 state string beg)
1081 ;;
1082 ;; Find the state at the `beginning-of-line' before `start'.
1084 ;; Use the cache for the state of `start'.
1086 ;; Find the state of `start'.
1088 ;; Use the state at the previous cache position, if any, or
1089 ;; otherwise calculate from `point-min'.
1093 font-lock-cache-state)))
1094 ;; Call the function to move outside any syntactic block.
1097 ;; Cache the state and position of `start'.
1100 ;;
1101 ;; If the region starts inside a string or comment, show the extent of it.
1107 font-lock-string-face
1108 font-lock-comment-face)))
1109 ;;
1110 ;; Find each interesting place between here and `end'.
1120 font-lock-string-face
1121 font-lock-comment-face)))))
1123 ;;; End of Syntactic fontification functions.
1124 \f
1125 ;;; Additional text property functions.
1127 ;; The following text property functions should be builtins. This means they
1128 ;; should be written in C and put with all the other text property functions.
1129 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1130 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1131 ;; in Lisp below and commented out. sm.
1134 "Prepend to one property of the text from START to END.
1135 Arguments PROP and VALUE specify the property and value to prepend to the value
1136 already in place. The resulting property values are always lists.
1137 Optional argument OBJECT is the string or buffer containing the text."
1144 object)
1148 "Append to one property of the text from START to END.
1149 Arguments PROP and VALUE specify the property and value to append to the value
1150 already in place. The resulting property values are always lists.
1151 Optional argument OBJECT is the string or buffer containing the text."
1158 object)
1162 "Fill in one property of the text from START to END.
1163 Arguments PROP and VALUE specify the property and value to put where none are
1164 already in place. Therefore existing property values are not overwritten.
1165 Optional argument OBJECT is the string or buffer containing the text."
1172 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1173 ;; is to `add-text-properties', etc.
1174 ;(defun remove-text-property (start end property &optional object)
1175 ; "Remove a property from text from START to END.
1176 ;Argument PROPERTY is the property to remove.
1177 ;Optional argument OBJECT is the string or buffer containing the text.
1178 ;Return t if the property was actually removed, nil otherwise."
1179 ; (remove-text-properties start end (list property) object))
1181 ;; For consistency: maybe this should be called `remove-single-property' like
1182 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1183 ;(defun remove-single-text-property (start end prop value &optional object)
1184 ; "Remove a specific property value from text from START to END.
1185 ;Arguments PROP and VALUE specify the property and value to remove. The
1186 ;resulting property values are not equal to VALUE nor lists containing VALUE.
1187 ;Optional argument OBJECT is the string or buffer containing the text."
1188 ; (let ((start (text-property-not-all start end prop nil object)) next prev)
1189 ; (while start
1190 ; (setq next (next-single-property-change start prop object end)
1191 ; prev (get-text-property start prop object))
1192 ; (cond ((and (symbolp prev) (eq value prev))
1193 ; (remove-text-property start next prop object))
1194 ; ((and (listp prev) (memq value prev))
1195 ; (let ((new (delq value prev)))
1196 ; (cond ((null new)
1197 ; (remove-text-property start next prop object))
1198 ; ((= (length new) 1)
1199 ; (put-text-property start next prop (car new) object))
1200 ; (t
1201 ; (put-text-property start next prop new object))))))
1202 ; (setq start (text-property-not-all next end prop nil object)))))
1204 ;;; End of Additional text property functions.
1205 \f
1206 ;;; Regexp fontification functions.
1209 "Apply HIGHLIGHT following a match.
1210 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1215 ;; No match but we might not signal an error.
1219 ;; Cannot override existing fontification.
1223 ;; Override existing fontification.
1226 ;; Prepend to existing fontification.
1229 ;; Append to existing fontification.
1232 ;; Keep existing fontification.
1236 "Fontify according to KEYWORDS until LIMIT.
1237 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1238 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1240 ;; Evaluate PRE-MATCH-FORM.
1242 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1247 ;; Find an occurrence of `matcher' before `limit'.
1251 ;; Apply each highlight to this instance of `matcher'.
1256 ;; Evaluate POST-MATCH-FORM.
1260 "Fontify according to `font-lock-keywords' between START and END.
1261 START should be at the beginning of a line."
1267 keyword matcher highlights)
1268 ;;
1269 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1273 ;;
1274 ;; Find an occurrence of `matcher' from `start' to `end'.
1280 ;; Apply each highlight to this instance of `matcher', which may be
1281 ;; specific highlights or more keywords anchored to `matcher'.
1290 ;;; End of Regexp fontification functions.
1291 \f
1292 ;; Various functions.
1295 ;; Compile KEYWORDS into the form (t KEYWORD ...) where KEYWORD is of the
1296 ;; form (MATCHER HIGHLIGHT ...) as shown in `font-lock-keywords' doc string.
1298 keywords
1307 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1318 keyword)))
1321 ;; Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1322 ;; Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t.
1325 alist))
1328 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1329 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
1331 keywords)
1342 "Set fontification defaults appropriately for this mode.
1343 Sets various variables using `font-lock-defaults' (or, if nil, using
1344 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1345 ;; Set fontification defaults.
1347 ;; Set iff not previously set.
1358 ;; Regexp fontification?
1361 ;; Local fontification?
1365 ;; Syntactic fontification?
1368 ;; Case fold during regexp fontification?
1371 ;; Syntax table for regexp and syntactic fontification?
1377 ;; The character to modify may be a single CHAR or a STRING.
1384 font-lock-syntax-table)
1387 ;; Syntax function for syntactic fontification?
1391 ;; Variable alist?
1401 "Unset fontification defaults. See `font-lock-set-defaults'."
1403 font-lock-keywords nil
1404 font-lock-keywords-only nil
1405 font-lock-keywords-case-fold-search nil
1406 font-lock-syntax-table nil
1407 font-lock-beginning-of-syntax-function nil)
1414 \f
1415 ;;; Colour etc. support.
1417 ;; Originally these variable values were face names such as `bold' etc.
1418 ;; Now we create our own faces, but we keep these variables for compatibility
1419 ;; and they give users another mechanism for changing face appearance.
1420 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
1421 ;; returns a face. So the easiest thing is to continue using these variables,
1422 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
1450 ;; Originally face attributes were specified via `font-lock-face-attributes'.
1451 ;; Users then changed the default face attributes by setting this variable.
1452 ;; However, we try and be back-compatible and respect its value if set except
1453 ;; for faces where M-x customize has been used to save changes for the face.
1459 ;; Rustle up a `defface' SPEC from a `font-lock-face-attributes' entry.
1466 face-spec)
1479 ;; But now we do it the custom way. Note that `defface' will not overwrite any
1480 ;; faces declared above via `custom-declare-face'.
1489 "Font Lock mode face used to highlight comments."
1498 "Font Lock mode face used to highlight strings."
1507 "Font Lock mode face used to highlight keywords."
1516 "Font Lock mode face used to highlight builtins."
1520 ;; Currently, Emacs/Custom does not support a :reverse or :invert spec.
1525 "Font Lock mode face used to highlight function names."
1536 "Font Lock mode face used to highlight variable names."
1545 "Font Lock mode face used to highlight types."
1556 "Font Lock mode face used to highlight references."
1560 ;; Currently, Emacs/Custom does not support a :reverse or :invert spec.
1565 "Font Lock mode face used to highlight warnings."
1568 ;;; End of Colour etc. support.
1569 \f
1570 ;;; Menu support.
1572 ;; This section of code is commented out because Emacs does not have real menu
1573 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1574 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1575 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1576 ;; the entry for "Text Properties" something like:
1577 ;;
1578 ;; (define-key menu-bar-edit-menu [font-lock]
1579 ;; '("Syntax Highlighting" . font-lock-menu))
1580 ;;
1581 ;; and remove a single ";" from the beginning of each line in the rest of this
1582 ;; section. Probably the mechanism for telling the menu code what are menu
1583 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1584 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1586 ;;;;###autoload
1587 ;(progn
1588 ; ;; Make the Font Lock menu.
1589 ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1590 ; ;; Add the menu items in reverse order.
1591 ; (define-key font-lock-menu [fontify-less]
1592 ; '("Less In Current Buffer" . font-lock-fontify-less))
1593 ; (define-key font-lock-menu [fontify-more]
1594 ; '("More In Current Buffer" . font-lock-fontify-more))
1595 ; (define-key font-lock-menu [font-lock-sep]
1596 ; '("--"))
1597 ; (define-key font-lock-menu [font-lock-mode]
1598 ; '("In Current Buffer" . font-lock-mode))
1599 ; (define-key font-lock-menu [global-font-lock-mode]
1600 ; '("In All Buffers" . global-font-lock-mode)))
1601 ;
1602 ;;;;###autoload
1603 ;(progn
1604 ; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1605 ; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1606 ; (put 'global-font-lock-mode 'menu-toggle t)
1607 ; (put 'font-lock-mode 'menu-toggle t)
1608 ; (put 'font-lock-fontify-more 'menu-enable '(identity))
1609 ; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1610 ;
1611 ;;; Put the appropriate symbol property values on now. See above.
1612 ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode))
1613 ;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1614 ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1615 ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1616 ;
1617 ;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1618 ;
1619 ;(defun font-lock-fontify-level (level)
1620 ; (let ((font-lock-maximum-decoration level))
1621 ; (when font-lock-mode
1622 ; (font-lock-mode))
1623 ; (font-lock-mode)
1624 ; (when font-lock-verbose
1625 ; (message "Fontifying %s... level %d" (buffer-name) level))))
1626 ;
1627 ;(defun font-lock-fontify-less ()
1628 ; "Fontify the current buffer with less decoration.
1629 ;See `font-lock-maximum-decoration'."
1630 ; (interactive)
1631 ; ;; Check in case we get called interactively.
1632 ; (if (nth 1 font-lock-fontify-level)
1633 ; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1634 ; (error "No less decoration")))
1635 ;
1636 ;(defun font-lock-fontify-more ()
1637 ; "Fontify the current buffer with more decoration.
1638 ;See `font-lock-maximum-decoration'."
1639 ; (interactive)
1640 ; ;; Check in case we get called interactively.
1641 ; (if (nth 2 font-lock-fontify-level)
1642 ; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1643 ; (error "No more decoration")))
1644 ;
1645 ;;; This should be called by `font-lock-set-defaults'.
1646 ;(defun font-lock-set-menu ()
1647 ; ;; Activate less/more fontification entries if there are multiple levels for
1648 ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
1649 ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
1650 ; (let ((keywords (or (nth 0 font-lock-defaults)
1651 ; (nth 1 (assq major-mode font-lock-defaults-alist))))
1652 ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1653 ; (make-local-variable 'font-lock-fontify-level)
1654 ; (if (or (symbolp keywords) (= (length keywords) 1))
1655 ; (font-lock-unset-menu)
1656 ; (cond ((eq level t)
1657 ; (setq level (1- (length keywords))))
1658 ; ((or (null level) (zerop level))
1659 ; ;; The default level is usually, but not necessarily, level 1.
1660 ; (setq level (- (length keywords)
1661 ; (length (member (eval (car keywords))
1662 ; (mapcar 'eval (cdr keywords))))))))
1663 ; (setq font-lock-fontify-level (list level (> level 1)
1664 ; (< level (1- (length keywords))))))))
1665 ;
1666 ;;; This should be called by `font-lock-unset-defaults'.
1667 ;(defun font-lock-unset-menu ()
1668 ; ;; Deactivate less/more fontification entries.
1669 ; (setq font-lock-fontify-level nil))
1671 ;;; End of Menu support.
1672 \f
1673 ;;; Various regexp information shared by several modes.
1674 ;;; Information specific to a single mode should go in its load library.
1676 ;; Font Lock support for C, C++, Objective-C and Java modes will one day be in
1677 ;; some cc-font.el (and required by cc-mode.el). However, the below function
1678 ;; should stay in font-lock.el, since it is used by other libraries. sm.
1681 "Match, and move over, any declaration/definition item after point.
1682 Matches after point, but ignores leading whitespace and `*' characters.
1683 Does not move further than LIMIT.
1685 The expected syntax of a declaration/definition item is `word', possibly ending
1686 with optional whitespace and a `('. Everything following the item (but
1687 belonging to it) is expected to by skip-able by `scan-sexps', and items are
1688 expected to be separated with a `,' and to be terminated with a `;'.
1690 Thus the regexp matches after point: word (
1691 ^^^^ ^
1692 Where the match subexpressions are: 1 2
1694 The item is delimited by (match-beginning 1) and (match-end 1).
1695 If (match-beginning 2) is non-nil, the item is followed by a `('.
1697 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
1702 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
1705 ;; Move over any item value, etc., to the next item.
1712 "Return the depth of KEYWORD regexp.
1713 This means the number of parenthesized expressions."
1717 count))
1723 ;;
1724 ;; Definitions.
1726 ;; Function declarations.
1730 ;; Variable declarations.
1732 ;; Structure declarations.
1735 ;; Any whitespace and defined object.
1742 nil t))
1743 ;;
1744 ;; Emacs Lisp autoload cookies.
1748 ))
1755 ;;
1756 ;; Control structures. Emacs Lisp forms.
1758 ; (make-regexp
1759 ; '("cond" "if" "while" "let\\*?" "prog[nv12*]?" "catch" "throw"
1760 ; "inline" "save-restriction" "save-excursion" "save-window-excursion"
1761 ; "save-selected-window" "save-match-data" "save-current-buffer"
1762 ; "unwind-protect" "condition-case" "track-mouse" "dont-compile"
1763 ; "eval-after-load" "eval-and-compile" "eval-when" "eval-when-compile"
1764 ; "with-output-to-temp-buffer" "with-timeout" "with-current-buffer"
1765 ; "with-temp-buffer" "with-temp-file"))
1778 ;;
1779 ;; Control structures. Common Lisp forms.
1781 ; (make-regexp
1782 ; '("when" "unless" "case" "ecase" "typecase" "etypecase"
1783 ; "loop" "do\\*?" "dotimes" "dolist"
1784 ; "proclaim" "declaim" "declare"
1785 ; "lexical-let\\*?" "flet" "labels" "return" "return-from"))
1792 ;;
1793 ;; Feature symbols as references.
1796 ;;
1797 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1799 ;;
1800 ;; Words inside `' tend to be symbol names.
1802 ;;
1803 ;; CLisp `:' keywords as builtins.
1805 ;;
1806 ;; ELisp and CLisp `&' keywords as types.
1808 )))
1819 ;;
1820 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1821 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1823 ;; Function names.
1825 ;; Macro names, as variable names. A bit dubious, this.
1827 ;; Class names.
1828 "-class"
1830 ;; Any whitespace and declared object.
1837 nil t))
1838 ;;
1839 ;; Control structures.
1840 ;(make-regexp '("begin" "call-with-current-continuation" "call/cc"
1841 ; "call-with-input-file" "call-with-output-file" "case" "cond"
1842 ; "do" "else" "for-each" "if" "lambda"
1843 ; "let\\*?" "let-syntax" "letrec" "letrec-syntax"
1844 ; ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1845 ; "and" "or" "delay"
1846 ; ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
1847 ; ;;"quasiquote" "quote" "unquote" "unquote-splicing"
1848 ; "map" "syntax" "syntax-rules"))
1857 ;;
1858 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
1860 ;;
1861 ;; Scheme `:' keywords as references.
1863 ))
1868 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
1869 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
1870 ; 2 font-lock-function-name-face)
1871 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
1872 ; 2 font-lock-reference-face)
1873 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1874 ; ;; not be able to display those fonts.
1875 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
1876 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
1877 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
1878 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
1879 ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
1886 ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1887 ;; not be able to display those fonts.
1888 ;; LaTeX2e: \emph{This is emphasized}.
1890 ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
1893 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables.
1897 \f
1898 ;;; User choices.
1900 ;; These provide a means to fontify types not defined by the language. Those
1901 ;; types might be the user's own or they might be generally accepted and used.
1902 ;; Generally accepted types are used to provide default variable values.
1905 "Widget `:type' for members of the custom group `font-lock-extra-types'.
1906 Members should `:load' the package `font-lock' to use this widget."
1912 "*List of extra types to fontify in C mode.
1913 Each list item should be a regexp not containing word-delimiters.
1915 ending in _t are treated as type names.
1917 The value of this variable is used when Font Lock mode is turned on."
1922 "*List of extra types to fontify in C++ mode.
1923 Each list item should be a regexp not containing word-delimiters.
1925 name.
1927 The value of this variable is used when Font Lock mode is turned on."
1932 "*List of extra types to fontify in Objective-C mode.
1933 Each list item should be a regexp not containing word-delimiters.
1935 Class, BOOL, IMP and SEL are treated as type names.
1937 The value of this variable is used when Font Lock mode is turned on."
1942 "*List of extra types to fontify in Java mode.
1943 Each list item should be a regexp not containing word-delimiters.
1945 words (and words conforming to the Java id spec) are treated as type names.
1947 The value of this variable is used when Font Lock mode is turned on."
1950 \f
1951 ;;; C.
1953 ;; [Murmur murmur murmur] Maestro, drum-roll please... [Murmur murmur murmur.]
1954 ;; Ahem. [Murmur murmur murmur] Lay-dees an Gennel-men. [Murmur murmur shhh!]
1955 ;; I am most proud and humbly honoured today [murmur murmur cough] to present
1956 ;; to you good people, the winner of the Second Millennium Award for The Most
1957 ;; Hairy Language Syntax. [Ahhh!] All rise please. [Shuffle shuffle
1958 ;; shuffle.] And a round of applause please. For... The C Language! [Roar.]
1959 ;;
1960 ;; Thank you... You are too kind... It is with a feeling of great privilege
1961 ;; and indeed emotion [sob] that I accept this award. It has been a long hard
1962 ;; road. But we know our destiny. And our future. For we must not rest.
1963 ;; There are more tokens to overload, more shoehorn, more methodologies. But
1964 ;; more is a plus! [Ha ha ha.] And more means plus! [Ho ho ho.] The future
1965 ;; is C++! [Ohhh!] The Third Millennium Award... Will be ours! [Roar.]
1971 "Medium level highlighting for C mode.
1975 "Gaudy level highlighting for C mode.
1979 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while")
1982 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
1983 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
1984 ; "void" "volatile" "const")
1991 c-font-lock-extra-types)
1994 )
1997 ;;
1998 ;; These are all anchored at the beginning of line for speed.
1999 ;; Note that `c++-font-lock-keywords-1' depends on `c-font-lock-keywords-1'.
2000 ;;
2001 ;; Fontify function name definitions (GNU style; without type on line).
2003 ;;
2004 ;; Fontify error directives.
2006 ;;
2007 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2010 ;;
2011 ;; Fontify function macro names.
2013 ;;
2014 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2018 ;;
2019 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2022 ))
2027 ;;
2028 ;; Simple regexps for speed.
2029 ;;
2030 ;; Fontify all type specifiers.
2033 ;;
2034 ;; Fontify all builtin keywords (except case, default and goto; see below).
2036 ;;
2037 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2040 ;; Anders Lindgren <andersl@csd.uu.se> points out that it is quicker to use
2041 ;; MATCH-ANCHORED to effectively anchor the regexp on the left.
2045 )))
2049 ;;
2050 ;; More complicated regexps for more complete highlighting for types.
2051 ;; We still have to fontify type specifiers individually, as C is so hairy.
2053 ;;
2054 ;; Fontify all storage classes and type specifiers, plus their items.
2058 ;; Fontify each declaration item.
2060 ;; Start with point after all type specifiers.
2064 ;; Finish with point after first type specifier.
2066 ;; Fontify as a variable or function name.
2068 font-lock-function-name-face
2069 font-lock-variable-name-face)))))
2070 ;;
2071 ;; Fontify structures, or typedef names, plus their items.
2076 font-lock-function-name-face
2077 font-lock-variable-name-face))))
2078 ;;
2079 ;; Fontify anything at beginning of line as a declaration or definition.
2085 font-lock-function-name-face
2086 font-lock-variable-name-face))))
2087 )))
2088 )
2091 "Default expressions to highlight in C mode.
2093 \f
2094 ;;; C++.
2100 "Medium level highlighting for C++ mode.
2104 "Gaudy level highlighting for C++ mode.
2108 ;; Regexp matches after point: word<word>::word (
2109 ;; ^^^^ ^^^^ ^^^^ ^
2110 ;; Where the match subexpressions are: 1 3 5 6
2111 ;;
2112 ;; Item is delimited by (match-beginning 1) and (match-end 1).
2113 ;; If (match-beginning 3) is non-nil, that part of the item incloses a `<>'.
2114 ;; If (match-beginning 5) is non-nil, that part of the item follows a `::'.
2115 ;; If (match-beginning 6) is non-nil, the item is followed by a `('.
2118 ;; Skip any leading whitespace.
2120 ;; This is `c++-type-spec' from below. (Hint hint!)
2124 ;; Match any trailing parenthesis.
2129 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2132 ;; Move over any item value, etc., to the next item.
2139 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
2140 ; "asm" "catch" "delete" "new" "operator" "sizeof" "this" "throw" "try"
2141 ; ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new.
2142 ; "static_cast" "dynamic_cast" "const_cast" "reinterpret_cast")
2151 ;; Taken from Stroustrup, minus keywords otherwise fontified.
2159 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2160 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2161 ; "void" "volatile" "const" "inline" "friend" "bool"
2162 ; "virtual" "complex" "template"
2163 ; ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new.
2164 ; "namespace" "using")
2176 ;;
2177 ;; A brave attempt to match templates following a type and/or match
2178 ;; class membership. See and sync the above function
2179 ;; `font-lock-match-c++-style-declaration-item-and-skip-to-next'.
2182 ;; If the string is a type, it may be followed by the cruft above.
2184 ;;
2185 ;; Parenthesis depth of user-defined types not forgetting their cruft.
2188 )
2191 ;;
2192 ;; The list `c-font-lock-keywords-1' less that for function names.
2195 ;;
2196 ;; Class names etc.
2201 font-lock-type-face
2205 ;;
2206 ;; Fontify function name definitions, possibly incorporating class names.
2209 font-lock-type-face
2210 font-lock-function-name-face))
2213 )))
2218 ;;
2219 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2223 ;;
2224 ;; Fontify operator overloading.
2228 ;;
2229 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2235 ;;
2236 ;; Fontify other builtin keywords.
2238 ;;
2239 ;; Eric Hopper <hopper@omnifarious.mn.org> says `true' and `false' are new.
2241 )))
2245 ;;
2246 ;; More complicated regexps for more complete highlighting for types.
2248 ;;
2249 ;; Fontify all storage classes and type specifiers, plus their items.
2253 ;; Fontify each declaration item.
2255 ;; Start with point after all type specifiers.
2259 ;; Finish with point after first type specifier.
2261 ;; Fontify as a variable or function name.
2263 font-lock-type-face)
2268 font-lock-function-name-face
2270 ;;
2271 ;; Fontify structures, or typedef names, plus their items.
2276 font-lock-function-name-face
2277 font-lock-variable-name-face))))
2278 ;;
2279 ;; Fontify anything at beginning of line as a declaration or definition.
2285 font-lock-type-face)
2290 font-lock-function-name-face
2292 )))
2293 )
2296 "Default expressions to highlight in C++ mode.
2298 \f
2299 ;;; Objective-C.
2305 "Medium level highlighting for Objective-C mode.
2309 "Gaudy level highlighting for Objective-C mode.
2312 ;; Regexps written with help from Stephen Peters <speters@us.oracle.com> and
2313 ;; Jacques Duthen Prestataire <duthen@cegelec-red.fr>.
2315 ; '("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
2316 ; "sizeof" "self" "super")
2322 ; '("auto" "extern" "register" "static" "typedef" "struct" "union"
2323 ; "enum" "signed" "unsigned" "short" "long" "int" "char"
2324 ; "float" "double" "void" "volatile" "const"
2325 ; "id" "oneway" "in" "out" "inout" "bycopy" "byref")
2332 objc-font-lock-extra-types)
2335 )
2338 ;;
2339 ;; The list `c-font-lock-keywords-1' less that for function names.
2342 ;;
2343 ;; Fontify compiler directives.
2348 ;;
2349 ;; Fontify method names and arguments. Oh Lordy!
2350 ;; First, on the same line as the function declaration.
2356 nil nil
2360 ;; Second, on lines following the function declaration.
2366 )))
2371 ;;
2372 ;; Simple regexps for speed.
2373 ;;
2374 ;; Fontify all type specifiers.
2378 ;;
2379 ;; Fontify all builtin keywords (except case, default and goto; see below).
2381 ;;
2382 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2385 ;; Fontify tags iff sole statement on line, otherwise we detect selectors.
2389 ;;
2390 ;; Fontify null object pointers.
2392 )))
2396 ;;
2397 ;; More complicated regexps for more complete highlighting for types.
2398 ;; We still have to fontify type specifiers individually, as C is so hairy.
2400 ;;
2401 ;; Fontify all storage classes and type specifiers, plus their items.
2405 ;; Fontify each declaration item.
2407 ;; Start with point after all type specifiers.
2411 ;; Finish with point after first type specifier.
2413 ;; Fontify as a variable or function name.
2415 font-lock-function-name-face
2416 font-lock-variable-name-face)))))
2417 ;;
2418 ;; Fontify structures, or typedef names, plus their items.
2423 font-lock-function-name-face
2424 font-lock-variable-name-face))))
2425 ;;
2426 ;; Fontify anything at beginning of line as a declaration or definition.
2432 font-lock-function-name-face
2433 font-lock-variable-name-face))))
2434 )))
2435 )
2438 "Default expressions to highlight in Objective-C mode.
2440 \f
2441 ;;; Java.
2447 "Medium level highlighting for Java mode.
2451 "Gaudy level highlighting for Java mode.
2454 ;; Regexps written with help from Fred White <fwhite@bbn.com> and
2455 ;; Anders Lindgren <andersl@csd.uu.se>.
2458 ; '("catch" "do" "else" "super" "this" "finally" "for" "if"
2459 ;; ;; Anders Lindgren <andersl@csd.uu.se> says these have gone.
2460 ;; "cast" "byvalue" "future" "generic" "operator" "var"
2461 ;; "inner" "outer" "rest"
2462 ; "interface" "return" "switch" "throw" "try" "while")
2467 ;;
2468 ;; These are immediately followed by an object name.
2474 ;;
2475 ;; These are eventually followed by an object name.
2477 ; '("abstract" "const" "final" "synchronized" "transient" "static"
2478 ;; ;; Anders Lindgren <andersl@csd.uu.se> says this has gone.
2479 ;; "threadsafe"
2480 ; "volatile" "public" "private" "protected" "native")
2484 ;;
2485 ;; Random types immediately followed by an object name.
2490 )
2493 ;;
2494 ;; Fontify class names.
2497 ;;
2498 ;; Fontify package names in import directives.
2501 ))
2506 ;;
2507 ;; Fontify all builtin type specifiers.
2510 ;;
2511 ;; Fontify all builtin keywords (except below).
2513 ;;
2514 ;; Fontify keywords and targets, and case default/goto tags.
2520 ;;
2521 ;; Fontify keywords and types; the first can be followed by a type list.
2530 ;;
2531 ;; Fontify all constants.
2533 ;;
2534 ;; Javadoc tags within comments.
2540 )))
2544 ;;
2545 ;; More complicated regexps for more complete highlighting for types.
2546 ;; We still have to fontify type specifiers individually, as Java is hairy.
2548 ;;
2549 ;; Fontify random types in casts.
2553 ;; Fontify the type name.
2555 ;;
2556 ;; Fontify random types immediately followed by an item or items.
2561 ;; Fontify the type name.
2567 ;; Fontify each declaration item.
2569 ;; Start and finish with point after the type specifier.
2574 ;; Fontify as a variable or function name.
2576 font-lock-function-name-face
2577 font-lock-variable-name-face)))))
2578 ;;
2579 ;; Fontify those that are immediately followed by an item or items.
2582 ;; Fontify each declaration item.
2584 ;; Start and finish with point after the type specifier.
2586 ;; Fontify as a variable or function name.
2588 font-lock-function-name-face
2589 font-lock-variable-name-face))))
2590 ;;
2591 ;; Fontify those that are eventually followed by an item or items.
2596 ;; Fontify each declaration item.
2598 ;; Start with point after all type specifiers.
2600 ;; Finish with point after first type specifier.
2602 ;; Fontify as a variable or function name.
2604 font-lock-function-name-face
2605 font-lock-variable-name-face))))
2606 )))
2607 )
2610 "Default expressions to highlight in Java mode.
2612 \f
2613 ;; Install ourselves:
2618 ;; Provide ourselves:
2622 ;;; font-lock.el ends here