| blob | 81ed9d61541d9d3658d5878fe9ac10fdbcd90790 |
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 ;; User variables.
189 "*If non-nil, means show status messages for buffer fontification.
192 ;;;###autoload
194 "*Maximum decoration level for fontification.
195 If nil, use the default decoration (typically the minimum available).
196 If t, use the maximum decoration available.
197 If a number, use that level of decoration (or if not available the maximum).
198 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
199 where MAJOR-MODE is a symbol or t (meaning the default). For example:
200 ((c-mode . t) (c++-mode . 2) (t . 1))
201 means use the maximum decoration available for buffers in C mode, level 2
204 ;;;###autoload
206 "*Maximum size of a buffer for buffer fontification.
207 Only buffers less than this can be fontified when Font Lock mode is turned on.
208 If nil, means size is irrelevant.
209 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
210 where MAJOR-MODE is a symbol or t (meaning the default). For example:
211 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
212 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
214 \f
215 ;; Fontification variables:
217 ;; Originally these variable values were face names such as `bold' etc.
218 ;; Now we create our own faces, but we keep these variables for compatibility
219 ;; and they give users another mechanism for changing face appearance.
220 ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that
221 ;; returns a face. So the easiest thing is to continue using these variables,
222 ;; rather than sometimes evaling FACENAME and sometimes not. sm.
251 "*A list of the keywords to highlight.
252 Each element should be of the form:
254 MATCHER
255 (MATCHER . MATCH)
256 (MATCHER . FACENAME)
257 (MATCHER . HIGHLIGHT)
258 (MATCHER HIGHLIGHT ...)
259 (eval . FORM)
261 where HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
263 FORM is an expression, whose value should be a keyword element, evaluated when
264 the keyword is (first) used in a buffer. This feature can be used to provide a
265 keyword that can only be generated when Font Lock mode is actually turned on.
267 For highlighting single items, typically only MATCH-HIGHLIGHT is required.
268 However, if an item or (typically) items are to be highlighted following the
269 instance of another item (the anchor) then MATCH-ANCHORED may be required.
271 MATCH-HIGHLIGHT should be of the form:
273 (MATCH FACENAME OVERRIDE LAXMATCH)
275 Where MATCHER can be either the regexp to search for, or the function name to
276 call to make the search (called with one argument, the limit of the search).
277 MATCH is the subexpression of MATCHER to be highlighted. MATCH can be
278 calculated via the function `font-lock-keyword-depth'. FACENAME is an
279 expression whose value is the face name to use. FACENAME's default attributes
280 can be defined via the variable `font-lock-face-attributes'.
282 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
283 be overwritten. If `keep', only parts not already fontified are highlighted.
284 If `prepend' or `append', existing fontification is merged with the new, in
285 which the new or existing fontification, respectively, takes precedence.
286 If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER.
288 For example, an element of the form highlights (if not already highlighted):
291 variable `font-lock-keyword-face'.
293 the value of `font-lock-keyword-face'.
297 of `foo-bar-face', even if already highlighted.
299 MATCH-ANCHORED should be of the form:
301 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
303 Where MATCHER is as for MATCH-HIGHLIGHT with one exception; see below.
304 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
305 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
306 used to initialise before, and cleanup after, MATCHER is used. Typically,
307 PRE-MATCH-FORM is used to move to some position relative to the original
308 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
309 be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
311 For example, an element of the form highlights (if not already highlighted):
322 The above-mentioned exception is as follows. The limit of the MATCHER search
323 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
324 However, if PRE-MATCH-FORM returns a position greater than the position after
325 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
326 It is generally a bad idea to return a position greater than the end of the
327 line, i.e., cause the MATCHER search to span lines.
329 Note that the MATCH-ANCHORED feature is experimental; in the future, we may
330 replace it with other ways of providing this functionality.
332 These regular expressions should not match text which spans lines. While
334 when you edit the buffer does not, since it considers text one line at a time.
336 This variable is set by major modes via the variable `font-lock-defaults'.
337 Be careful when composing regexps for this list; a poorly written pattern can
340 ;; This variable is used by mode packages that support Font Lock mode by
341 ;; defining their own keywords to use for `font-lock-keywords'. (The mode
342 ;; command should make it buffer-local and set it to provide the set up.)
344 "Defaults for Font Lock mode specified by the major mode.
345 Defaults should be of the form:
347 (KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN ...)
349 KEYWORDS may be a symbol (a variable or function whose value is the keywords to
350 use for fontification) or a list of symbols. If KEYWORDS-ONLY is non-nil,
351 syntactic fontification (strings and comments) is not performed.
352 If CASE-FOLD is non-nil, the case of the keywords is ignored when fontifying.
353 If SYNTAX-ALIST is non-nil, it should be a list of cons pairs of the form
354 \(CHAR-OR-STRING . STRING) used to set the local Font Lock syntax table, for
355 keyword and syntactic fontification (see `modify-syntax-entry').
357 If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
358 backwards outside any enclosing syntactic block, for syntactic fontification.
359 Typical values are `beginning-of-line' (i.e., the start of the line is known to
360 be outside a syntactic block), or `beginning-of-defun' for programming modes or
361 `backward-paragraph' for textual modes (i.e., the mode-dependent function is
362 known to move outside a syntactic block). If nil, the beginning of the buffer
363 is used as a position outside of a syntactic block, in the worst case.
365 These item elements are used by Font Lock mode to set the variables
366 `font-lock-keywords', `font-lock-keywords-only',
367 `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
368 `font-lock-beginning-of-syntax-function', respectively.
370 Further item elements are alists of the form (VARIABLE . VALUE) and are in no
371 particular order. Each VARIABLE is made buffer-local before set to VALUE.
373 Currently, appropriate variables include `font-lock-mark-block-function'.
374 If this is non-nil, it should be a function with no args used to mark any
376 Typical values are `mark-defun' for programming modes or `mark-paragraph' for
377 textual modes (i.e., the mode-dependent function is known to put point and mark
378 around a text block relevant to that mode).
380 Other variables include those for buffer-specialised fontification functions,
381 `font-lock-fontify-buffer-function', `font-lock-unfontify-buffer-function',
382 `font-lock-fontify-region-function', `font-lock-unfontify-region-function',
383 `font-lock-comment-start-regexp', `font-lock-inhibit-thing-lock' and
386 ;; This variable is used where font-lock.el itself supplies the keywords.
389 ;; Thus the calculation of the cache is usually faster but not
390 ;; infallible, so we risk mis-fontification. sm.
393 c-font-lock-keywords-2 c-font-lock-keywords-3)
405 objc-font-lock-keywords-2 objc-font-lock-keywords-3)
411 java-font-lock-keywords-2 java-font-lock-keywords-3)
417 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
426 ;; For TeX modes we could use `backward-paragraph' for the same reason.
427 ;; But we don't, because paragraph breaks are arguably likely enough to
428 ;; occur within a genuine syntactic block to make it too risky.
429 ;; However, we do specify a MARK-BLOCK function as that cannot result
430 ;; in a mis-fontification even if it might not fontify enough. --sm.
435 )
451 "Alist of fall-back Font Lock defaults for major modes.
452 Each item should be a list of the form:
454 (MAJOR-MODE . FONT-LOCK-DEFAULTS)
456 where MAJOR-MODE is a symbol and FONT-LOCK-DEFAULTS is a list of default
460 "*Alist of `font-lock-keywords' local to a `major-mode'.
464 "*Non-nil means Font Lock should not fontify comments or strings.
468 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
472 "Non-nil means use this syntax table for fontifying.
473 If this is nil, the major mode's syntax table is used.
476 ;; If this is nil, we only use the beginning of the buffer if we can't use
477 ;; `font-lock-cache-position' and `font-lock-cache-state'.
479 "*Non-nil means use this function to move back outside of a syntactic block.
480 When called with no args it should leave point at the beginning of any
481 enclosing syntactic block.
482 If this is nil, the beginning of the buffer is used (in the worst case).
486 "*Non-nil means use this function to mark a block of text.
487 When called with no args it should leave point at the beginning of any
488 enclosing textual block and mark at the end.
492 "*Regexp to match the start of a comment.
493 This need not discriminate between genuine comments and quoted comment
494 characters or comment characters within strings.
495 If nil, `comment-start-skip' is used instead; see that variable for more info.
499 "Function to use for fontifying the buffer.
503 "Function to use for unfontifying the buffer.
504 This is used when turning off Font Lock mode.
508 "Function to use for fontifying a region.
509 It should take two args, the beginning and end of the region, and an optional
510 third arg VERBOSE. If non-nil, the function should print status messages.
514 "Function to use for unfontifying a region.
515 It should take two args, the beginning and end of the region.
519 "List of Font Lock mode related modes that should not be turned on.
520 Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'.
526 ;;;###autoload
529 \f
530 ;; Font Lock mode.
533 ;;
534 ;; We don't do this at the top-level as we only use non-autoloaded macros.
536 ;;
537 ;; Borrowed from lazy-lock.el.
538 ;; We use this to preserve or protect things when modifying text properties.
540 "Bind variables according to VARLIST and eval BODY restoring buffer state."
544 before-change-functions after-change-functions
545 deactivate-mark buffer-file-name buffer-file-truename))))
551 ;;;###autoload
553 "Toggle Font Lock mode.
554 With arg, turn Font Lock mode on if and only if arg is positive.
556 When Font Lock mode is enabled, text is fontified as you type it:
558 - Comments are displayed in `font-lock-comment-face';
559 - Strings are displayed in `font-lock-string-face';
560 - Certain other expressions are displayed in other faces according to the
561 value of the variable `font-lock-keywords'.
563 You can enable Font Lock mode in any major mode automatically by turning on in
564 the major mode's hook. For example, put in your ~/.emacs:
566 (add-hook 'c-mode-hook 'turn-on-font-lock)
568 Alternatively, you can use Global Font Lock mode to automagically turn on Font
569 Lock mode in buffers whose major mode supports it and whose major mode is one
570 of `font-lock-global-modes'. For example, put in your ~/.emacs:
572 (global-font-lock-mode t)
574 There are a number of support modes that may be used to speed up Font Lock mode
575 in various ways, specified via the variable `font-lock-support-mode'. Where
576 major modes support different levels of fontification, you can use the variable
577 `font-lock-maximum-decoration' to specify which level you generally prefer.
578 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
579 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
581 For example, to specify that Font Lock mode use use Lazy Lock mode as a support
582 mode and use maximum levels of fontification, put in your ~/.emacs:
584 (setq font-lock-support-mode 'lazy-lock-mode)
585 (setq font-lock-maximum-decoration t)
587 To add your own highlighting for some major mode, and modify the highlighting
588 selected automatically via the variable `font-lock-maximum-decoration', you can
589 use `font-lock-add-keywords'.
591 To fontify a buffer, without turning on Font Lock mode and regardless of buffer
594 To fontify a block (the function or paragraph containing point, or a number of
595 lines around point), perhaps because modification on the current line caused
598 The default Font Lock mode faces and their attributes are defined in the
599 variable `font-lock-face-attributes', and Font Lock mode default settings in
600 the variable `font-lock-defaults-alist'. You can set your own default settings
601 for some mode, by setting a buffer local value for `font-lock-defaults', via
602 its mode hook."
604 ;; Don't turn on Font Lock mode if we don't have a display (we're running a
605 ;; batch job) or if the buffer is invisible (the name starts with a space).
612 ;; Turn on Font Lock mode.
619 ;; Fontify the buffer if we have to.
622 nil)
627 ;; Turn off Font Lock mode.
635 ;;;###autoload
637 "Turn on Font Lock mode conditionally.
638 Turn on only if the terminal can display it."
642 ;;;###autoload
644 "Add highlighting KEYWORDS for MAJOR-MODE.
645 MAJOR-MODE should be a symbol, the major mode command name, such as `c-mode'
646 or nil. If nil, highlighting keywords are added for the current buffer.
647 KEYWORDS should be a list; see the variable `font-lock-keywords'.
648 By default they are added at the beginning of the current highlighting list.
649 If optional argument APPEND is `set', they are used to replace the current
650 highlighting list. If APPEND is any other non-nil value, they are added at the
651 end of the current highlighting list.
653 For example:
655 (font-lock-add-keywords 'c-mode
659 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
660 comments, and to fontify `and', `or' and `not' words as keywords.
662 Note that some modes have specialised support for additional patterns, e.g.,
663 see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types',
664 `objc-font-lock-extra-types' and `java-font-lock-extra-types'."
666 ;; If MAJOR-MODE is non-nil, add the KEYWORDS and APPEND spec to
667 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
673 ;; Otherwise if Font Lock mode is on, set or add the keywords now.
678 font-lock-keywords)))
682 \f
683 ;;; Global Font Lock mode.
685 ;; A few people have hassled in the past for a way to make it easier to turn on
686 ;; Font Lock mode, without the user needing to know for which modes s/he has to
687 ;; turn it on, perhaps the same way hilit19.el/hl319.el does. I've always
688 ;; balked at that way, as I see it as just re-moulding the same problem in
689 ;; another form. That is; some person would still have to keep track of which
690 ;; modes (which may not even be distributed with Emacs) support Font Lock mode.
691 ;; The list would always be out of date. And that person might have to be me.
693 ;; Implementation.
694 ;;
695 ;; In a previous discussion the following hack came to mind. It is a gross
696 ;; hack, but it generally works. We use the convention that major modes start
697 ;; by calling the function `kill-all-local-variables', which in turn runs
698 ;; functions on the hook variable `change-major-mode-hook'. We attach our
699 ;; function `font-lock-change-major-mode' to that hook. Of course, when this
700 ;; hook is run, the major mode is in the process of being changed and we do not
701 ;; know what the final major mode will be. So, `font-lock-change-major-mode'
702 ;; only (a) notes the name of the current buffer, and (b) adds our function
703 ;; `turn-on-font-lock-if-enabled' to the hook variables `find-file-hooks' and
704 ;; `post-command-hook' (for buffers that are not visiting files). By the time
705 ;; the functions on the first of these hooks to be run are run, the new major
706 ;; mode is assumed to be in place. This way we get a Font Lock function run
707 ;; when a major mode is turned on, without knowing major modes or their hooks.
708 ;;
709 ;; Naturally this requires that (a) major modes run `kill-all-local-variables',
710 ;; as they are supposed to do, and (b) the major mode is in place after the
711 ;; file is visited or the command that ran `kill-all-local-variables' has
712 ;; finished, whichever the sooner. Arguably, any major mode that does not
713 ;; follow the convension (a) is broken, and I can't think of any reason why (b)
714 ;; would not be met (except `gnudoit' on non-files). However, it is not clean.
715 ;;
716 ;; Probably the cleanest solution is to have each major mode function run some
717 ;; hook, e.g., `major-mode-hook', but maybe implementing that change is
718 ;; impractical. I am personally against making `setq' a macro or be advised,
719 ;; or have a special function such as `set-major-mode', but maybe someone can
720 ;; come up with another solution?
722 ;; User interface.
723 ;;
724 ;; Although Global Font Lock mode is a pseudo-mode, I think that the user
725 ;; interface should conform to the usual Emacs convention for modes, i.e., a
726 ;; command to toggle the feature (`global-font-lock-mode') with a variable for
727 ;; finer control of the mode's behaviour (`font-lock-global-modes').
728 ;;
729 ;; The feature should not be enabled by loading font-lock.el, since other
730 ;; mechanisms for turning on Font Lock mode, such as M-x font-lock-mode RET or
731 ;; (add-hook 'c-mode-hook 'turn-on-font-lock), would cause Font Lock mode to be
732 ;; turned on everywhere. That would not be intuitive or informative because
733 ;; loading a file tells you nothing about the feature or how to control it. It
734 ;; would also be contrary to the Principle of Least Surprise. sm.
739 ;;;###autoload
741 "*Modes for which Font Lock mode is automagically turned on.
742 Global Font Lock mode is controlled by the `global-font-lock-mode' command.
743 If nil, means no modes have Font Lock mode automatically turned on.
744 If t, all modes that support Font Lock mode have it automatically turned on.
745 If a list, it should be a list of `major-mode' symbol names for which Font Lock
746 mode should be automatically turned on. The sense of the list is negated if it
747 begins with `not'. For example:
748 (c-mode c++-mode)
751 ;;;###autoload
753 "Toggle Global Font Lock mode.
754 With prefix ARG, turn Global Font Lock mode on if and only if ARG is positive.
755 Displays a message saying whether the mode is on or off if MESSAGE is non-nil.
756 Returns the new status of Global Font Lock mode (non-nil means on).
758 When Global Font Lock mode is enabled, Font Lock mode is automagically
759 turned on in a buffer if its major mode is one of `font-lock-global-modes'."
763 global-font-lock-mode)))
774 ;; Turn off Font Lock mode if it's on.
777 ;; Gross hack warning: Delicate readers should avert eyes now.
778 ;; Something is running `kill-all-local-variables', which generally means the
779 ;; major mode is being changed. Run `turn-on-font-lock-if-enabled' after the
780 ;; file is visited or the current command has finished.
786 ;; Gross hack warning: Delicate readers should avert eyes now.
787 ;; Turn on Font Lock mode if it's supported by the major mode and enabled by
788 ;; the user.
806 ;;; End of Global Font Lock mode.
807 \f
808 ;;; Font Lock Support mode.
810 ;; This is the code used to interface font-lock.el with any of its add-on
811 ;; packages, and provide the user interface. Packages that have their own
812 ;; local buffer fontification functions (see below) may have to call
813 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
814 ;; themselves.
816 ;;;###autoload
818 "*Support mode for Font Lock mode.
819 Support modes speed up Font Lock mode by being choosy about when fontification
820 occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode') and
821 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
822 If nil, means support for Font Lock mode is never performed.
823 If a symbol, use that support mode.
824 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
825 where MAJOR-MODE is a symbol or t (meaning the default). For example:
826 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
827 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
828 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
860 ;;; End of Font Lock Support mode.
861 \f
862 ;;; Fontification functions.
864 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
865 ;; code to fontify a region, the function runs the function whose name is the
866 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
867 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
868 ;; which does contain the code to fontify a region. However, the value of the
869 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
870 ;; do anything. The indirection of the fontification functions gives major
871 ;; modes the capability of modifying the way font-lock.el fontifies. Major
872 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
873 ;; via the variable `font-lock-defaults'.
874 ;;
875 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
876 ;; font-lock.el uses its own function for buffer fontification. This function
877 ;; makes fontification be on a message-by-message basis and so visiting an
878 ;; RMAIL file is much faster. A clever implementation of the function might
879 ;; fontify the headers differently than the message body. (It should, and
880 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
881 ;; you?) This hints at a more interesting use...
882 ;;
883 ;; Languages that contain text normally contained in different major modes
884 ;; could define their own fontification functions that treat text differently
885 ;; depending on its context. For example, Perl mode could arrange that here
886 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
887 ;; rules one way and C code another. Neat!
888 ;;
889 ;; A further reason to use the fontification indirection feature is when the
890 ;; default syntactual fontification, or the default fontification in general,
891 ;; is not flexible enough for a particular major mode. For example, perhaps
892 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' and
893 ;; `font-lock-comment-start-regexp' to cope with. You need to write your own
894 ;; version of that function, e.g., `hairy-fontify-syntactically-region', and
895 ;; make your own version of `hairy-fontify-region' call it before calling
896 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
897 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
898 ;; would call your region fontification function instead of its own. For
899 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
900 ;; directives correctly and cleanly. (It is the same problem as fontifying
901 ;; multi-line strings and comments; regexps are not appropriate for the job.)
903 ;;;###autoload
905 "Fontify the current buffer the way `font-lock-mode' would."
922 font-lock-verbose)))
925 ;; Make sure we have the right `font-lock-keywords' etc.
928 ;; Make sure we fontify etc. in the whole buffer.
937 ;; We don't restore the old fontification, so it's best to unfontify.
939 ;; Make sure we undo `font-lock-keywords' etc.
946 ;; Make sure we unfontify etc. in the whole buffer.
958 ;; Use the fontification syntax table, if any.
961 ;; Now do the fontification.
966 ;; Clean up.
969 ;; The following must be rethought, since keywords can override fontification.
970 ; ;; Now scan for keywords, but not if we are inside a comment now.
971 ; (or (and (not font-lock-keywords-only)
972 ; (let ((state (parse-partial-sexp beg end nil nil
973 ; font-lock-cache-state)))
974 ; (or (nth 4 state) (nth 7 state))))
975 ; (font-lock-fontify-keywords-region beg end))
981 ;; Called when any modification is made to buffer text.
985 ;; Rescan between start of lines enclosing the region.
991 "Fontify some lines the way `font-lock-fontify-buffer' would.
992 The lines could be a function or paragraph, or a specified number of lines.
993 If ARG is given, fontify that many lines before and after point, or 16 lines if
994 no ARG is given and `font-lock-mark-block-function' is nil.
995 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
996 delimit the region to fontify."
999 ;; Make sure we have the right `font-lock-keywords' etc.
1015 ;;; End of Fontification functions.
1016 \f
1017 ;;; Syntactic fontification functions.
1019 ;; These record the parse state at a particular position, always the start of a
1020 ;; line. Used to make `font-lock-fontify-syntactically-region' faster.
1021 ;; Previously, `font-lock-cache-position' was just a buffer position. However,
1022 ;; under certain situations, this occasionally resulted in mis-fontification.
1023 ;; I think the "situations" were deletion with Lazy Lock mode's deferral. sm.
1028 "Put proper face on each string and comment between START and END.
1029 START should be at the beginning of a line."
1034 ;;
1035 ;; Find the state at the `beginning-of-line' before `start'.
1037 ;; Use the cache for the state of `start'.
1039 ;; Find the state of `start'.
1041 ;; Use the state at the previous cache position, if any, or
1042 ;; otherwise calculate from `point-min'.
1046 font-lock-cache-state)))
1047 ;; Call the function to move outside any syntactic block.
1050 ;; Cache the state and position of `start'.
1053 ;;
1054 ;; If the region starts inside a string, show the extent of it.
1061 font-lock-comment-face
1062 font-lock-string-face)))
1063 ;;
1064 ;; Find each interesting place between here and `end'.
1076 font-lock-comment-face
1077 font-lock-string-face))
1078 ;;
1079 ;; Make sure `prev' is non-nil after the loop
1080 ;; only if it was set on the very last iteration.
1083 ;;; End of Syntactic fontification functions.
1084 \f
1085 ;;; Additional text property functions.
1087 ;; The following text property functions should be builtins. This means they
1088 ;; should be written in C and put with all the other text property functions.
1089 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1090 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1091 ;; in Lisp below and commented out. sm.
1094 "Prepend to one property of the text from START to END.
1095 Arguments PROP and VALUE specify the property and value to prepend to the value
1096 already in place. The resulting property values are always lists.
1097 Optional argument OBJECT is the string or buffer containing the text."
1104 object)
1108 "Append to one property of the text from START to END.
1109 Arguments PROP and VALUE specify the property and value to append to the value
1110 already in place. The resulting property values are always lists.
1111 Optional argument OBJECT is the string or buffer containing the text."
1118 object)
1122 "Fill in one property of the text from START to END.
1123 Arguments PROP and VALUE specify the property and value to put where none are
1124 already in place. Therefore existing property values are not overwritten.
1125 Optional argument OBJECT is the string or buffer containing the text."
1132 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1133 ;; is to `add-text-properties', etc.
1134 ;(defun remove-text-property (start end property &optional object)
1135 ; "Remove a property from text from START to END.
1136 ;Argument PROPERTY is the property to remove.
1137 ;Optional argument OBJECT is the string or buffer containing the text.
1138 ;Return t if the property was actually removed, nil otherwise."
1139 ; (remove-text-properties start end (list property) object))
1141 ;; For consistency: maybe this should be called `remove-single-property' like
1142 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1143 ;(defun remove-single-text-property (start end prop value &optional object)
1144 ; "Remove a specific property value from text from START to END.
1145 ;Arguments PROP and VALUE specify the property and value to remove. The
1146 ;resulting property values are not equal to VALUE nor lists containing VALUE.
1147 ;Optional argument OBJECT is the string or buffer containing the text."
1148 ; (let ((start (text-property-not-all start end prop nil object)) next prev)
1149 ; (while start
1150 ; (setq next (next-single-property-change start prop object end)
1151 ; prev (get-text-property start prop object))
1152 ; (cond ((and (symbolp prev) (eq value prev))
1153 ; (remove-text-property start next prop object))
1154 ; ((and (listp prev) (memq value prev))
1155 ; (let ((new (delq value prev)))
1156 ; (cond ((null new)
1157 ; (remove-text-property start next prop object))
1158 ; ((= (length new) 1)
1159 ; (put-text-property start next prop (car new) object))
1160 ; (t
1161 ; (put-text-property start next prop new object))))))
1162 ; (setq start (text-property-not-all next end prop nil object)))))
1164 ;;; End of Additional text property functions.
1165 \f
1166 ;;; Regexp fontification functions.
1169 "Apply HIGHLIGHT following a match.
1170 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1175 ;; No match but we might not signal an error.
1179 ;; Cannot override existing fontification.
1183 ;; Override existing fontification.
1186 ;; Prepend to existing fontification.
1189 ;; Append to existing fontification.
1192 ;; Keep existing fontification.
1196 "Fontify according to KEYWORDS until LIMIT.
1197 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1198 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1200 ;; Evaluate PRE-MATCH-FORM.
1202 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1207 ;; Find an occurrence of `matcher' before `limit'.
1211 ;; Apply each highlight to this instance of `matcher'.
1216 ;; Evaluate POST-MATCH-FORM.
1220 "Fontify according to `font-lock-keywords' between START and END.
1221 START should be at the beginning of a line."
1224 font-lock-keywords
1227 keyword matcher highlights)
1228 ;;
1229 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1233 ;;
1234 ;; Find an occurrence of `matcher' from `start' to `end'.
1240 ;; Apply each highlight to this instance of `matcher', which may be
1241 ;; specific highlights or more keywords anchored to `matcher'.
1250 ;;; End of Regexp fontification functions.
1251 \f
1252 ;; Various functions.
1255 ;; Compile `font-lock-keywords' into the form (t KEYWORD ...) where KEYWORD
1256 ;; is the (MATCHER HIGHLIGHT ...) shown in the variable's doc string.
1260 keywords
1269 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1280 keyword)))
1283 ;; Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1284 ;; Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t.
1287 alist))
1290 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1291 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
1293 keywords)
1304 "Set fontification defaults appropriately for this mode.
1305 Sets various variables using `font-lock-defaults' (or, if nil, using
1306 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1307 ;; Set face defaults.
1309 ;; Set fontification defaults.
1311 ;; Set iff not previously set.
1322 ;; Regexp fontification?
1325 ;; Local fontification?
1329 ;; Syntactic fontification?
1332 ;; Case fold during regexp fontification?
1335 ;; Syntax table for regexp and syntactic fontification?
1341 ;; The character to modify may be a single CHAR or a STRING.
1348 font-lock-syntax-table)
1351 ;; Syntax function for syntactic fontification?
1355 ;; Variable alist?
1362 "Unset fontification defaults. See `font-lock-set-defaults'."
1364 font-lock-keywords nil
1365 font-lock-keywords-only nil
1366 font-lock-keywords-case-fold-search nil
1367 font-lock-syntax-table nil
1368 font-lock-beginning-of-syntax-function nil)
1375 \f
1376 ;;; Colour etc. support.
1378 ;; This section of code is crying out for revision. Come on down, custom.el?
1380 ;; To begin with, `display-type' and `background-mode' are `frame-parameters'
1381 ;; so we don't have to calculate them here anymore. But all the face stuff
1382 ;; should be frame-local (and thus display-local) anyway. Because we're not
1383 ;; sure what support Emacs is going to have for general frame-local face
1384 ;; attributes, we leave this section of code as it is. For now. sm.
1387 "A symbol indicating the display Emacs is running under.
1388 The symbol should be one of `color', `grayscale' or `mono'.
1389 If Emacs guesses this display attribute wrongly, either set this variable in
1390 your `~/.emacs' or set the resource `Emacs.displayType' in your `~/.Xdefaults'.
1394 "A symbol indicating the Emacs background brightness.
1395 The symbol should be one of `light' or `dark'.
1396 If Emacs guesses this frame attribute wrongly, either set this variable in
1397 your `~/.emacs' or set the resource `Emacs.backgroundMode' in your
1398 `~/.Xdefaults'.
1402 "A list of default attributes to use for face attributes.
1403 Each element of the list should be of the form
1405 (FACE FOREGROUND BACKGROUND BOLD-P ITALIC-P UNDERLINE-P)
1407 where FACE could be one of the face symbols `font-lock-comment-face',
1408 `font-lock-string-face', `font-lock-keyword-face', `font-lock-builtin-face',
1409 `font-lock-type-face', `font-lock-function-name-face',
1410 `font-lock-variable-name-face', `font-lock-reference-face' and
1411 `font-lock-warning-face', or any other face symbols and attributes may be
1412 specified here and used in `font-lock-keywords'.
1414 Subsequent element items should be the attributes for the corresponding
1415 Font Lock mode faces. Attributes FOREGROUND and BACKGROUND should be strings
1416 \(default if nil), while BOLD-P, ITALIC-P, and UNDERLINE-P should specify the
1417 corresponding face attributes (yes if non-nil). For example:
1422 in your ~/.emacs makes a garish bold-italic warning face and red comment face.
1424 Emacs uses default attributes based on display type and background brightness.
1425 See variables `font-lock-display-type' and `font-lock-background-mode'.
1427 Resources can be used to over-ride these face attributes. For example, the
1428 resource `Emacs.font-lock-comment-face.attributeUnderline' can be used to
1432 "Make faces from `font-lock-face-attributes'.
1433 A default list is used if this is nil.
1434 If optional OVERRIDE is non-nil, faces that already exist are reset.
1435 See `font-lock-make-face' and `list-faces-display'."
1436 ;; We don't need to `setq' any of these variables, but the user can see what
1437 ;; is being used if we do.
1452 'light
1462 ;; Emacs 19.25's font-lock defaults:
1463 ;;'((font-lock-comment-face nil nil nil t nil)
1464 ;; (font-lock-string-face nil nil nil nil t)
1465 ;; (font-lock-keyword-face nil nil t nil nil)
1466 ;; (font-lock-function-name-face nil nil t t nil)
1467 ;; (font-lock-type-face nil nil nil t nil))
1473 'font-lock-function-name-face
1476 t nil nil)
1481 'font-lock-warning-face
1484 t nil nil)))
1486 grayshade greyshade))
1499 t nil nil)
1509 t nil nil)))
1534 ;; Now make the faces if we have to.
1539 ;; We can stomp all over it anyway. Get outta my face!
1542 ;; The variable exists and is already bound to a face.
1543 nil)
1545 ;; We already have a face so we bind the variable to it.
1548 ;; No variable or no face.
1550 font-lock-face-attributes))
1553 "Make a face from FACE-ATTRIBUTES.
1554 FACE-ATTRIBUTES should be like an element `font-lock-face-attributes', so that
1555 the face name is the first item in the list. A variable with the same name as
1556 the face is also set; its value is the face name."
1567 ;; Set attributes not set from X resources (and therefore `make-face').
1586 ;;; End of Colour etc. support.
1587 \f
1588 ;;; Menu support.
1590 ;; This section of code is commented out because Emacs does not have real menu
1591 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1592 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1593 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1594 ;; the entry for "Text Properties" something like:
1595 ;;
1596 ;; (define-key menu-bar-edit-menu [font-lock]
1597 ;; '("Syntax Highlighting" . font-lock-menu))
1598 ;;
1599 ;; and remove a single ";" from the beginning of each line in the rest of this
1600 ;; section. Probably the mechanism for telling the menu code what are menu
1601 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1602 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1604 ;;;;###autoload
1605 ;(progn
1606 ; ;; Make the Font Lock menu.
1607 ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1608 ; ;; Add the menu items in reverse order.
1609 ; (define-key font-lock-menu [fontify-less]
1610 ; '("Less In Current Buffer" . font-lock-fontify-less))
1611 ; (define-key font-lock-menu [fontify-more]
1612 ; '("More In Current Buffer" . font-lock-fontify-more))
1613 ; (define-key font-lock-menu [font-lock-sep]
1614 ; '("--"))
1615 ; (define-key font-lock-menu [font-lock-mode]
1616 ; '("In Current Buffer" . font-lock-mode))
1617 ; (define-key font-lock-menu [global-font-lock-mode]
1618 ; '("In All Buffers" . global-font-lock-mode)))
1619 ;
1620 ;;;;###autoload
1621 ;(progn
1622 ; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1623 ; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1624 ; (put 'global-font-lock-mode 'menu-toggle t)
1625 ; (put 'font-lock-mode 'menu-toggle t)
1626 ; (put 'font-lock-fontify-more 'menu-enable '(identity))
1627 ; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1628 ;
1629 ;;; Put the appropriate symbol property values on now. See above.
1630 ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode))
1631 ;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1632 ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1633 ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1634 ;
1635 ;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1636 ;
1637 ;(defun font-lock-fontify-level (level)
1638 ; (let ((font-lock-maximum-decoration level))
1639 ; (when font-lock-mode
1640 ; (font-lock-mode))
1641 ; (font-lock-mode)
1642 ; (when font-lock-verbose
1643 ; (message "Fontifying %s... level %d" (buffer-name) level))))
1644 ;
1645 ;(defun font-lock-fontify-less ()
1646 ; "Fontify the current buffer with less decoration.
1647 ;See `font-lock-maximum-decoration'."
1648 ; (interactive)
1649 ; ;; Check in case we get called interactively.
1650 ; (if (nth 1 font-lock-fontify-level)
1651 ; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1652 ; (error "No less decoration")))
1653 ;
1654 ;(defun font-lock-fontify-more ()
1655 ; "Fontify the current buffer with more decoration.
1656 ;See `font-lock-maximum-decoration'."
1657 ; (interactive)
1658 ; ;; Check in case we get called interactively.
1659 ; (if (nth 2 font-lock-fontify-level)
1660 ; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1661 ; (error "No more decoration")))
1662 ;
1663 ;;; This should be called by `font-lock-set-defaults'.
1664 ;(defun font-lock-set-menu ()
1665 ; ;; Activate less/more fontification entries if there are multiple levels for
1666 ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
1667 ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
1668 ; (let ((keywords (or (nth 0 font-lock-defaults)
1669 ; (nth 1 (assq major-mode font-lock-defaults-alist))))
1670 ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1671 ; (make-local-variable 'font-lock-fontify-level)
1672 ; (if (or (symbolp keywords) (= (length keywords) 1))
1673 ; (font-lock-unset-menu)
1674 ; (cond ((eq level t)
1675 ; (setq level (1- (length keywords))))
1676 ; ((or (null level) (zerop level))
1677 ; ;; The default level is usually, but not necessarily, level 1.
1678 ; (setq level (- (length keywords)
1679 ; (length (member (eval (car keywords))
1680 ; (mapcar 'eval (cdr keywords))))))))
1681 ; (setq font-lock-fontify-level (list level (> level 1)
1682 ; (< level (1- (length keywords))))))))
1683 ;
1684 ;;; This should be called by `font-lock-unset-defaults'.
1685 ;(defun font-lock-unset-menu ()
1686 ; ;; Deactivate less/more fontification entries.
1687 ; (setq font-lock-fontify-level nil))
1689 ;;; End of Menu support.
1690 \f
1691 ;;; Various regexp information shared by several modes.
1692 ;;; Information specific to a single mode should go in its load library.
1694 ;; Font Lock support for C, C++, Objective-C and Java modes will one day be in
1695 ;; some cc-font.el (and required by cc-mode.el). However, the below function
1696 ;; should stay in font-lock.el, since it is used by other libraries. sm.
1699 "Match, and move over, any declaration/definition item after point.
1700 Matches after point, but ignores leading whitespace and `*' characters.
1701 Does not move further than LIMIT.
1703 The expected syntax of a declaration/definition item is `word', possibly ending
1704 with optional whitespace and a `('. Everything following the item (but
1705 belonging to it) is expected to by skip-able by `scan-sexps', and items are
1706 expected to be separated with a `,' and to be terminated with a `;'.
1708 Thus the regexp matches after point: word (
1709 ^^^^ ^
1710 Where the match subexpressions are: 1 2
1712 The item is delimited by (match-beginning 1) and (match-end 1).
1713 If (match-beginning 2) is non-nil, the item is followed by a `('.
1715 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
1720 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
1723 ;; Move over any item value, etc., to the next item.
1730 "Return the depth of KEYWORD regexp.
1731 This means the number of parenthesized expressions."
1735 count))
1741 ;;
1742 ;; Anything not a variable or type declaration is fontified as a function.
1743 ;; It would be cleaner to allow preceding whitespace, but it would also be
1744 ;; about five times slower.
1746 ;; Variable declarations.
1748 ;; Structure declarations.
1750 ;; Everything else is a function declaration.
1753 ;; Any whitespace and declared object.
1760 nil t))
1761 ;;
1762 ;; Emacs Lisp autoload cookies.
1766 ))
1773 ;;
1774 ;; Control structures. Emacs Lisp forms.
1776 ; '("cond" "if" "while" "let\\*?" "prog[nv12*]?" "inline" "catch" "throw"
1777 ; "save-restriction" "save-excursion" "save-window-excursion"
1778 ; "save-selected-window" "save-match-data" "save-current-buffer"
1779 ; "unwind-protect" "condition-case" "track-mouse" "dont-compile"
1780 ; "eval-after-load" "eval-and-compile" "eval-when" "eval-when-compile"
1781 ; "with-output-to-temp-buffer" "with-timeout" "with-current-buffer"
1782 ; "with-temp-buffer" "with-temp-file")
1795 ;;
1796 ;; Control structures. Common Lisp forms.
1798 ; '(make-regexp
1799 ; '("when" "unless" "case" "ecase" "typecase" "etypecase"
1800 ; "loop" "do\\*?" "dotimes" "dolist"
1801 ; "proclaim" "declaim" "declare"
1802 ; "lexical-let\\*?" "flet" "labels" "return" "return-from"))
1809 ;;
1810 ;; Feature symbols as references.
1813 ;;
1814 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1816 ;;
1817 ;; Words inside `' tend to be symbol names.
1819 ;;
1820 ;; CLisp `:' keywords as builtins.
1822 ;;
1823 ;; ELisp and CLisp `&' keywords as types.
1825 )))
1836 ;;
1837 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1838 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1840 ;; Function names.
1842 ;; Macro names, as variable names. A bit dubious, this.
1844 ;; Class names.
1845 "-class"
1847 ;; Any whitespace and declared object.
1854 nil t))
1855 ;;
1856 ;; Control structures.
1857 ;(make-regexp '("begin" "call-with-current-continuation" "call/cc"
1858 ; "call-with-input-file" "call-with-output-file" "case" "cond"
1859 ; "do" "else" "for-each" "if" "lambda"
1860 ; "let\\*?" "let-syntax" "letrec" "letrec-syntax"
1861 ; ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1862 ; "and" "or" "delay"
1863 ; ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
1864 ; ;;"quasiquote" "quote" "unquote" "unquote-splicing"
1865 ; "map" "syntax" "syntax-rules"))
1874 ;;
1875 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
1877 ;;
1878 ;; Scheme `:' keywords as references.
1880 ))
1885 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
1886 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
1887 ; 2 font-lock-function-name-face)
1888 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
1889 ; 2 font-lock-reference-face)
1890 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1891 ; ;; not be able to display those fonts.
1892 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
1893 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
1894 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
1895 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
1896 ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
1903 ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1904 ;; not be able to display those fonts.
1905 ;; LaTeX2e: \emph{This is emphasized}.
1907 ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
1910 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables.
1914 \f
1915 ;;; User choices.
1917 ;; These provide a means to fontify types not defined by the language. Those
1918 ;; types might be the user's own or they might be generally accepted and used.
1919 ;; Generally excepted types are used to provide default variable values.
1922 "*List of extra types to fontify in C mode.
1923 Each list item should be a regexp without word-delimiters.
1928 "*List of extra types to fontify in C++ mode.
1929 Each list item should be a regexp without word-delimiters.
1934 "*List of extra types to fontify in Objective-C mode.
1935 Each list item should be a regexp without word-delimiters.
1940 "*List of extra types to fontify in Java mode.
1941 Each list item should be a regexp without word-delimiters.
1944 \f
1945 ;;; C.
1947 ;; [Murmur murmur murmur] Maestro, drum-roll please... [Murmur murmur murmur.]
1948 ;; Ahem. [Murmur murmur murmur] Lay-dees an Gennel-men. [Murmur murmur shhh!]
1949 ;; I am most proud and humbly honoured today [murmur murmur cough] to present
1950 ;; to you good people, the winner of the Second Millennium Award for The Most
1951 ;; Hairy Language Syntax. [Ahhh!] All rise please. [Shuffle shuffle
1952 ;; shuffle.] And a round of applause please. For... The C Language! [Roar.]
1953 ;;
1954 ;; Thank you... You are too kind... It is with a feeling of great privilege
1955 ;; and indeed emotion [sob] that I accept this award. It has been a long hard
1956 ;; road. But we know our destiny. And our future. For we must not rest.
1957 ;; There are more tokens to overload, more shoehorn, more methodologies. But
1958 ;; more is a plus! [Ha ha ha.] And more means plus! [Ho ho ho.] The future
1959 ;; is C++! [Ohhh!] The Third Millennium Award... Will be ours! [Roar.]
1965 "Medium level highlighting for C mode.
1969 "Gaudy level highlighting for C mode.
1973 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while")
1976 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
1977 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
1978 ; "void" "volatile" "const")
1985 c-font-lock-extra-types)
1988 )
1991 ;;
1992 ;; These are all anchored at the beginning of line for speed.
1993 ;; Note that `c++-font-lock-keywords-1' depends on `c-font-lock-keywords-1'.
1994 ;;
1995 ;; Fontify function name definitions (GNU style; without type on line).
1997 ;;
1998 ;; Fontify error directives.
2000 ;;
2001 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2004 ;;
2005 ;; Fontify function macro names.
2007 ;;
2008 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2012 ;;
2013 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2016 ))
2021 ;;
2022 ;; Simple regexps for speed.
2023 ;;
2024 ;; Fontify all type specifiers.
2027 ;;
2028 ;; Fontify all builtin keywords (except case, default and goto; see below).
2030 ;;
2031 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2034 ;; Anders Lindgren <andersl@csd.uu.se> points out that it is quicker to use
2035 ;; MATCH-ANCHORED to effectively anchor the regexp on the left.
2039 )))
2043 ;;
2044 ;; More complicated regexps for more complete highlighting for types.
2045 ;; We still have to fontify type specifiers individually, as C is so hairy.
2047 ;;
2048 ;; Fontify all storage classes and type specifiers, plus their items.
2052 ;; Fontify each declaration item.
2054 ;; Start with point after all type specifiers.
2058 ;; Finish with point after first type specifier.
2060 ;; Fontify as a variable or function name.
2062 font-lock-function-name-face
2063 font-lock-variable-name-face)))))
2064 ;;
2065 ;; Fontify structures, or typedef names, plus their items.
2070 font-lock-function-name-face
2071 font-lock-variable-name-face))))
2072 ;;
2073 ;; Fontify anything at beginning of line as a declaration or definition.
2079 font-lock-function-name-face
2080 font-lock-variable-name-face))))
2081 )))
2082 )
2085 "Default expressions to highlight in C mode.
2087 \f
2088 ;;; C++.
2094 "Medium level highlighting for C++ mode.
2098 "Gaudy level highlighting for C++ mode.
2102 ;; Regexp matches after point: word<word>::word (
2103 ;; ^^^^ ^^^^ ^^^^ ^
2104 ;; Where the match subexpressions are: 1 3 5 6
2105 ;;
2106 ;; Item is delimited by (match-beginning 1) and (match-end 1).
2107 ;; If (match-beginning 3) is non-nil, that part of the item incloses a `<>'.
2108 ;; If (match-beginning 5) is non-nil, that part of the item follows a `::'.
2109 ;; If (match-beginning 6) is non-nil, the item is followed by a `('.
2118 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2121 ;; Move over any item value, etc., to the next item.
2128 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
2129 ; "asm" "catch" "delete" "new" "operator" "sizeof" "this" "throw" "try"
2130 ; ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new.
2131 ; "static_cast" "dynamic_cast" "const_cast" "reinterpret_cast")
2140 ;; Taken from Stroustrup, minus keywords otherwise fontified.
2148 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2149 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2150 ; "void" "volatile" "const" "inline" "friend" "bool"
2151 ; "virtual" "complex" "template"
2152 ; ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new.
2153 ; "namespace" "using")
2170 )
2173 ;;
2174 ;; The list `c-font-lock-keywords-1' less that for function names.
2177 ;;
2178 ;; Class names etc.
2183 font-lock-type-face
2187 ;;
2188 ;; Fontify function name definitions, possibly incorporating class names.
2191 font-lock-type-face
2192 font-lock-function-name-face))
2195 )))
2200 ;;
2201 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2205 ;;
2206 ;; Fontify operator overloading.
2210 ;;
2211 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2217 ;;
2218 ;; Fontify other builtin keywords.
2220 ;;
2221 ;; Eric Hopper <hopper@omnifarious.mn.org> says `true' and `false' are new.
2223 )))
2227 ;;
2228 ;; More complicated regexps for more complete highlighting for types.
2230 ;;
2231 ;; Fontify all storage classes and type specifiers, plus their items.
2235 ;; Fontify each declaration item.
2237 ;; Start with point after all type specifiers.
2241 ;; Finish with point after first type specifier.
2243 ;; Fontify as a variable or function name.
2245 font-lock-type-face)
2250 font-lock-function-name-face
2252 ;;
2253 ;; Fontify structures, or typedef names, plus their items.
2258 font-lock-function-name-face
2259 font-lock-variable-name-face))))
2260 ;;
2261 ;; Fontify anything at beginning of line as a declaration or definition.
2267 font-lock-type-face)
2272 font-lock-function-name-face
2274 )))
2275 )
2278 "Default expressions to highlight in C++ mode.
2280 \f
2281 ;;; Objective-C.
2287 "Medium level highlighting for Objective-C mode.
2291 "Gaudy level highlighting for Objective-C mode.
2294 ;; Regexps written with help from Stephen Peters <speters@us.oracle.com> and
2295 ;; Jacques Duthen Prestataire <duthen@cegelec-red.fr>.
2297 ; '("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
2298 ; "sizeof" "self" "super")
2304 ; '("auto" "extern" "register" "static" "typedef" "struct" "union"
2305 ; "enum" "signed" "unsigned" "short" "long" "int" "char"
2306 ; "float" "double" "void" "volatile" "const"
2307 ; "id" "oneway" "in" "out" "inout" "bycopy" "byref")
2314 objc-font-lock-extra-types)
2317 )
2320 ;;
2321 ;; The list `c-font-lock-keywords-1' less that for function names.
2324 ;;
2325 ;; Fontify compiler directives.
2330 ;;
2331 ;; Fontify method names and arguments. Oh Lordy!
2332 ;; First, on the same line as the function declaration.
2338 nil nil
2342 ;; Second, on lines following the function declaration.
2348 )))
2353 ;;
2354 ;; Simple regexps for speed.
2355 ;;
2356 ;; Fontify all type specifiers.
2360 ;;
2361 ;; Fontify all builtin keywords (except case, default and goto; see below).
2363 ;;
2364 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2367 ;; Fontify tags iff sole statement on line, otherwise we detect selectors.
2371 ;;
2372 ;; Fontify null object pointers.
2374 )))
2378 ;;
2379 ;; More complicated regexps for more complete highlighting for types.
2380 ;; We still have to fontify type specifiers individually, as C is so hairy.
2382 ;;
2383 ;; Fontify all storage classes and type specifiers, plus their items.
2387 ;; Fontify each declaration item.
2389 ;; Start with point after all type specifiers.
2393 ;; Finish with point after first type specifier.
2395 ;; Fontify as a variable or function name.
2397 font-lock-function-name-face
2398 font-lock-variable-name-face)))))
2399 ;;
2400 ;; Fontify structures, or typedef names, plus their items.
2405 font-lock-function-name-face
2406 font-lock-variable-name-face))))
2407 ;;
2408 ;; Fontify anything at beginning of line as a declaration or definition.
2414 font-lock-function-name-face
2415 font-lock-variable-name-face))))
2416 )))
2417 )
2420 "Default expressions to highlight in Objective-C mode.
2422 \f
2423 ;;; Java.
2429 "Medium level highlighting for Java mode.
2433 "Gaudy level highlighting for Java mode.
2436 ;; Regexps written with help from Fred White <fwhite@bbn.com> and
2437 ;; Anders Lindgren <andersl@csd.uu.se>.
2440 ; '("catch" "do" "else" "super" "this" "finally" "for" "if"
2441 ;; ;; Anders Lindgren <andersl@csd.uu.se> says these have gone.
2442 ;; "cast" "byvalue" "future" "generic" "operator" "var"
2443 ;; "inner" "outer" "rest"
2444 ; "interface" "return" "switch" "throw" "try" "while")
2449 ;;
2450 ;; These are immediately followed by an object name.
2456 ;;
2457 ;; These are eventually followed by an object name.
2459 ; '("abstract" "const" "final" "synchronized" "transient" "static"
2460 ;; ;; Anders Lindgren <andersl@csd.uu.se> says this has gone.
2461 ;; "threadsafe"
2462 ; "volatile" "public" "private" "protected" "native")
2466 ;;
2467 ;; Random types immediately followed by an object name.
2472 )
2475 ;;
2476 ;; Fontify class names.
2479 ;;
2480 ;; Fontify package names in import directives.
2483 ))
2488 ;;
2489 ;; Fontify all builtin type specifiers.
2492 ;;
2493 ;; Fontify all builtin keywords (except below).
2495 ;;
2496 ;; Fontify keywords and targets, and case default/goto tags.
2502 ;;
2503 ;; Fontify keywords and types; the first can be followed by a type list.
2512 ;;
2513 ;; Fontify all constants.
2515 ;;
2516 ;; Javadoc tags within comments.
2522 )))
2526 ;;
2527 ;; More complicated regexps for more complete highlighting for types.
2528 ;; We still have to fontify type specifiers individually, as Java is hairy.
2530 ;;
2531 ;; Fontify random types in casts.
2535 ;; Fontify the type name.
2537 ;;
2538 ;; Fontify random types immediately followed by an item or items.
2543 ;; Fontify the type name.
2549 ;; Fontify each declaration item.
2551 ;; Start and finish with point after the type specifier.
2556 ;; Fontify as a variable or function name.
2558 font-lock-function-name-face
2559 font-lock-variable-name-face)))))
2560 ;;
2561 ;; Fontify those that are immediately followed by an item or items.
2564 ;; Fontify each declaration item.
2566 ;; Start and finish with point after the type specifier.
2568 ;; Fontify as a variable or function name.
2570 font-lock-function-name-face
2571 font-lock-variable-name-face))))
2572 ;;
2573 ;; Fontify those that are eventually followed by an item or items.
2578 ;; Fontify each declaration item.
2580 ;; Start with point after all type specifiers.
2582 ;; Finish with point after first type specifier.
2584 ;; Fontify as a variable or function name.
2586 font-lock-function-name-face
2587 font-lock-variable-name-face))))
2588 )))
2589 )
2592 "Default expressions to highlight in Java mode.
2594 \f
2595 ;; Install ourselves:
2600 ;; Provide ourselves:
2604 ;;; font-lock.el ends here