| blob | 380d41261ae7d7c0d64dcfa9b50bc963fe9219b9 |
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. FACENAME is an
278 expression whose value is the face name to use. FACENAME's default attributes
279 may be defined in `font-lock-face-attributes'.
281 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification may
282 be overwritten. If `keep', only parts not already fontified are highlighted.
283 If `prepend' or `append', existing fontification is merged with the new, in
284 which the new or existing fontification, respectively, takes precedence.
285 If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER.
287 For example, an element of the form highlights (if not already highlighted):
290 variable `font-lock-keyword-face'.
292 the value of `font-lock-keyword-face'.
296 of `foo-bar-face', even if already highlighted.
298 MATCH-ANCHORED should be of the form:
300 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
302 Where MATCHER is as for MATCH-HIGHLIGHT with one exception; see below.
303 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
304 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
305 used to initialise before, and cleanup after, MATCHER is used. Typically,
306 PRE-MATCH-FORM is used to move to some position relative to the original
307 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
308 be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
310 For example, an element of the form highlights (if not already highlighted):
321 The above-mentioned exception is as follows. The limit of the MATCHER search
322 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
323 However, if PRE-MATCH-FORM returns a position greater than the position after
324 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
325 It is generally a bad idea to return a position greater than the end of the
326 line, i.e., cause the MATCHER search to span lines.
328 Note that the MATCH-ANCHORED feature is experimental; in the future, we may
329 replace it with other ways of providing this functionality.
331 These regular expressions should not match text which spans lines. While
333 when you edit the buffer does not, since it considers text one line at a time.
335 Be very careful composing regexps for this list;
339 ;; This variable is used by mode packages that support Font Lock mode by
340 ;; defining their own keywords to use for `font-lock-keywords'. (The mode
341 ;; command should make it buffer-local and set it to provide the set up.)
343 "If set by a major mode, should be the defaults for Font Lock mode.
346 ;; This variable is used where font-lock.el itself supplies the keywords.
349 ;; Thus the calculation of the cache is usually faster but not
350 ;; infallible, so we risk mis-fontification. sm.
353 c-font-lock-keywords-2 c-font-lock-keywords-3)
365 objc-font-lock-keywords-2 objc-font-lock-keywords-3)
371 java-font-lock-keywords-2 java-font-lock-keywords-3)
377 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
386 ;; For TeX modes we could use `backward-paragraph' for the same reason.
387 ;; But we don't, because paragraph breaks are arguably likely enough to
388 ;; occur within a genuine syntactic block to make it too risky.
389 ;; However, we do specify a MARK-BLOCK function as that cannot result
390 ;; in a mis-fontification even if it might not fontify enough. --sm.
395 )
411 "Alist of default major mode and Font Lock defaults.
412 Each item should be a list of the form:
414 (MAJOR-MODE . (KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN
415 ...))
417 where MAJOR-MODE is a symbol. KEYWORDS may be a symbol (a variable or function
418 whose value is the keywords to use for fontification) or a list of symbols.
419 If KEYWORDS-ONLY is non-nil, syntactic fontification (strings and comments) is
420 not performed. If CASE-FOLD is non-nil, the case of the keywords is ignored
421 when fontifying. If SYNTAX-ALIST is non-nil, it should be a list of cons pairs
422 of the form (CHAR-OR-STRING . STRING) used to set the local Font Lock syntax
423 table, for keyword and syntactic fontification (see `modify-syntax-entry').
425 If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
426 backwards outside any enclosing syntactic block, for syntactic fontification.
427 Typical values are `beginning-of-line' (i.e., the start of the line is known to
428 be outside a syntactic block), or `beginning-of-defun' for programming modes or
429 `backward-paragraph' for textual modes (i.e., the mode-dependent function is
430 known to move outside a syntactic block). If nil, the beginning of the buffer
431 is used as a position outside of a syntactic block, in the worst case.
433 These item elements are used by Font Lock mode to set the variables
434 `font-lock-keywords', `font-lock-keywords-only',
435 `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
436 `font-lock-beginning-of-syntax-function', respectively.
438 Further item elements are alists of the form (VARIABLE . VALUE) and are in no
439 particular order. Each VARIABLE is made buffer-local before set to VALUE.
441 Currently, appropriate variables include `font-lock-mark-block-function'.
442 If this is non-nil, it should be a function with no args used to mark any
444 Typical values are `mark-defun' for programming modes or `mark-paragraph' for
445 textual modes (i.e., the mode-dependent function is known to put point and mark
446 around a text block relevant to that mode).
448 Other variables include those for buffer-specialised fontification functions,
449 `font-lock-fontify-buffer-function', `font-lock-unfontify-buffer-function',
450 `font-lock-fontify-region-function', `font-lock-unfontify-region-function',
451 `font-lock-comment-start-regexp', `font-lock-inhibit-thing-lock' and
455 "*Alist of `font-lock-keywords' local to a `major-mode'.
459 "*Non-nil means Font Lock should not fontify comments or strings.
463 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
467 "Non-nil means use this syntax table for fontifying.
468 If this is nil, the major mode's syntax table is used.
471 ;; If this is nil, we only use the beginning of the buffer if we can't use
472 ;; `font-lock-cache-position' and `font-lock-cache-state'.
474 "*Non-nil means use this function to move back outside of a syntactic block.
475 When called with no args it should leave point at the beginning of any
476 enclosing syntactic block.
477 If this is nil, the beginning of the buffer is used (in the worst case).
481 "*Non-nil means use this function to mark a block of text.
482 When called with no args it should leave point at the beginning of any
483 enclosing textual block and mark at the end.
487 "*Regexp to match the start of a comment.
488 This need not discriminate between genuine comments and quoted comment
489 characters or comment characters within strings.
490 If nil, `comment-start-skip' is used instead; see that variable for more info.
494 "Function to use for fontifying the buffer.
498 "Function to use for unfontifying the buffer.
499 This is used when turning off Font Lock mode.
503 "Function to use for fontifying a region.
504 It should take two args, the beginning and end of the region, and an optional
505 third arg VERBOSE. If non-nil, the function should print status messages.
509 "Function to use for unfontifying a region.
510 It should take two args, the beginning and end of the region.
514 "List of Font Lock mode related modes that should not be turned on.
515 Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'.
521 ;;;###autoload
524 \f
525 ;; Font Lock mode.
528 ;;
529 ;; We don't do this at the top-level as we only use non-autoloaded macros.
531 ;;
532 ;; Borrowed from lazy-lock.el.
533 ;; We use this to preserve or protect things when modifying text properties.
535 "Bind variables according to VARLIST and eval BODY restoring buffer state."
539 before-change-functions after-change-functions
540 deactivate-mark buffer-file-name buffer-file-truename))))
546 ;;;###autoload
548 "Toggle Font Lock mode.
549 With arg, turn Font Lock mode on if and only if arg is positive.
551 When Font Lock mode is enabled, text is fontified as you type it:
553 - Comments are displayed in `font-lock-comment-face';
554 - Strings are displayed in `font-lock-string-face';
555 - Certain other expressions are displayed in other faces according to the
556 value of the variable `font-lock-keywords'.
558 You can enable Font Lock mode in any major mode automatically by turning on in
559 the major mode's hook. For example, put in your ~/.emacs:
561 (add-hook 'c-mode-hook 'turn-on-font-lock)
563 Alternatively, you can use Global Font Lock mode to automagically turn on Font
564 Lock mode in buffers whose major mode supports it and whose major mode is one
565 of `font-lock-global-modes'. For example, put in your ~/.emacs:
567 (global-font-lock-mode t)
569 There are a number of support modes that may be used to speed up Font Lock mode
570 in various ways, specified via the variable `font-lock-support-mode'. Where
571 major modes support different levels of fontification, you can use the variable
572 `font-lock-maximum-decoration' to specify which level you generally prefer.
573 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
574 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
576 For example, to specify that Font Lock mode use use Lazy Lock mode as a support
577 mode and use maximum levels of fontification, put in your ~/.emacs:
579 (setq font-lock-support-mode 'lazy-lock-mode)
580 (setq font-lock-maximum-decoration t)
582 To add your own highlighting for some major mode, and modify the highlighting
583 selected automatically via the variable `font-lock-maximum-decoration', you can
584 use `font-lock-add-keywords'.
586 To fontify a buffer, without turning on Font Lock mode and regardless of buffer
589 To fontify a block (the function or paragraph containing point, or a number of
590 lines around point), perhaps because modification on the current line caused
593 The default Font Lock mode faces and their attributes are defined in the
594 variable `font-lock-face-attributes', and Font Lock mode default settings in
595 the variable `font-lock-defaults-alist'. You can set your own default settings
596 for some mode, by setting a buffer local value for `font-lock-defaults', via
597 its mode hook."
599 ;; Don't turn on Font Lock mode if we don't have a display (we're running a
600 ;; batch job) or if the buffer is invisible (the name starts with a space).
607 ;; Turn on Font Lock mode.
614 ;; Fontify the buffer if we have to.
617 nil)
622 ;; Turn off Font Lock mode.
630 ;;;###autoload
632 "Turn on Font Lock mode conditionally.
633 Turn on only if the terminal can display it."
637 ;;;###autoload
639 "Add highlighting KEYWORDS for MAJOR-MODE.
640 MAJOR-MODE should be a symbol, the major mode command name, such as `c-mode'
641 or nil. If nil, highlighting keywords are added for the current buffer.
642 KEYWORDS should be a list; see the variable `font-lock-keywords'.
643 By default they are added at the beginning of the current highlighting list.
644 If optional argument APPEND is `set', they are used to replace the current
645 highlighting list. If APPEND has any other value, e.g., t, they are added at
646 the end of the current highlighting list.
648 For example:
650 (font-lock-add-keywords 'c-mode
654 adds two fontification patterns for C mode, to fontify `FIXME:' words, even in
655 comments, and to fontify `and', `or' and `not' words as keywords."
657 ;; If MAJOR-MODE is non-nil, add the KEYWORDS and APPEND spec to
658 ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
664 ;; Otherwise if Font Lock mode is on, set or add the keywords now.
669 font-lock-keywords)))
673 \f
674 ;; Global Font Lock mode.
675 ;;
676 ;; A few people have hassled in the past for a way to make it easier to turn on
677 ;; Font Lock mode, without the user needing to know for which modes s/he has to
678 ;; turn it on, perhaps the same way hilit19.el/hl319.el does. I've always
679 ;; balked at that way, as I see it as just re-moulding the same problem in
680 ;; another form. That is; some person would still have to keep track of which
681 ;; modes (which may not even be distributed with Emacs) support Font Lock mode.
682 ;; The list would always be out of date. And that person might have to be me.
684 ;; Implementation.
685 ;;
686 ;; In a previous discussion the following hack came to mind. It is a gross
687 ;; hack, but it generally works. We use the convention that major modes start
688 ;; by calling the function `kill-all-local-variables', which in turn runs
689 ;; functions on the hook variable `change-major-mode-hook'. We attach our
690 ;; function `font-lock-change-major-mode' to that hook. Of course, when this
691 ;; hook is run, the major mode is in the process of being changed and we do not
692 ;; know what the final major mode will be. So, `font-lock-change-major-mode'
693 ;; only (a) notes the name of the current buffer, and (b) adds our function
694 ;; `turn-on-font-lock-if-enabled' to the hook variables `find-file-hooks' and
695 ;; `post-command-hook' (for buffers that are not visiting files). By the time
696 ;; the functions on the first of these hooks to be run are run, the new major
697 ;; mode is assumed to be in place. This way we get a Font Lock function run
698 ;; when a major mode is turned on, without knowing major modes or their hooks.
699 ;;
700 ;; Naturally this requires that (a) major modes run `kill-all-local-variables',
701 ;; as they are supposed to do, and (b) the major mode is in place after the
702 ;; file is visited or the command that ran `kill-all-local-variables' has
703 ;; finished, whichever the sooner. Arguably, any major mode that does not
704 ;; follow the convension (a) is broken, and I can't think of any reason why (b)
705 ;; would not be met (except `gnudoit' on non-files). However, it is not clean.
706 ;;
707 ;; Probably the cleanest solution is to have each major mode function run some
708 ;; hook, e.g., `major-mode-hook', but maybe implementing that change is
709 ;; impractical. I am personally against making `setq' a macro or be advised,
710 ;; or have a special function such as `set-major-mode', but maybe someone can
711 ;; come up with another solution?
713 ;; User interface.
714 ;;
715 ;; Although Global Font Lock mode is a pseudo-mode, I think that the user
716 ;; interface should conform to the usual Emacs convention for modes, i.e., a
717 ;; command to toggle the feature (`global-font-lock-mode') with a variable for
718 ;; finer control of the mode's behaviour (`font-lock-global-modes').
719 ;;
720 ;; The feature should not be enabled by loading font-lock.el, since other
721 ;; mechanisms for turning on Font Lock mode, such as M-x font-lock-mode RET or
722 ;; (add-hook 'c-mode-hook 'turn-on-font-lock), would cause Font Lock mode to be
723 ;; turned on everywhere. That would not be intuitive or informative because
724 ;; loading a file tells you nothing about the feature or how to control it. It
725 ;; would also be contrary to the Principle of Least Surprise. sm.
730 ;;;###autoload
732 "*Modes for which Font Lock mode is automagically turned on.
733 Global Font Lock mode is controlled by the `global-font-lock-mode' command.
734 If nil, means no modes have Font Lock mode automatically turned on.
735 If t, all modes that support Font Lock mode have it automatically turned on.
736 If a list, it should be a list of `major-mode' symbol names for which Font Lock
737 mode should be automatically turned on. The sense of the list is negated if it
738 begins with `not'. For example:
739 (c-mode c++-mode)
742 ;;;###autoload
744 "Toggle Global Font Lock mode.
745 With prefix ARG, turn Global Font Lock mode on if and only if ARG is positive.
746 Displays a message saying whether the mode is on or off if MESSAGE is non-nil.
747 Returns the new status of Global Font Lock mode (non-nil means on).
749 When Global Font Lock mode is enabled, Font Lock mode is automagically
750 turned on in a buffer if its major mode is one of `font-lock-global-modes'."
754 global-font-lock-mode)))
765 ;; Turn off Font Lock mode if it's on.
768 ;; Gross hack warning: Delicate readers should avert eyes now.
769 ;; Something is running `kill-all-local-variables', which generally means the
770 ;; major mode is being changed. Run `turn-on-font-lock-if-enabled' after the
771 ;; file is visited or the current command has finished.
777 ;; Gross hack warning: Delicate readers should avert eyes now.
778 ;; Turn on Font Lock mode if it's supported by the major mode and enabled by
779 ;; the user.
797 ;; End of Global Font Lock mode.
798 \f
799 ;; Font Lock Support mode.
800 ;;
801 ;; This is the code used to interface font-lock.el with any of its add-on
802 ;; packages, and provide the user interface. Packages that have their own
803 ;; local buffer fontification functions (see below) may have to call
804 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
805 ;; themselves.
807 ;;;###autoload
809 "*Support mode for Font Lock mode.
810 Support modes speed up Font Lock mode by being choosy about when fontification
811 occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode') and
812 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
813 If nil, means support for Font Lock mode is never performed.
814 If a symbol, use that support mode.
815 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
816 where MAJOR-MODE is a symbol or t (meaning the default). For example:
817 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
818 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
819 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
851 ;; End of Font Lock Support mode.
852 \f
853 ;; Fontification functions.
855 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
856 ;; code to fontify a region, the function runs the function whose name is the
857 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
858 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
859 ;; which does contain the code to fontify a region. However, the value of the
860 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
861 ;; do anything. The indirection of the fontification functions gives major
862 ;; modes the capability of modifying the way font-lock.el fontifies. Major
863 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
864 ;; via the variable `font-lock-defaults'.
865 ;;
866 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
867 ;; font-lock.el uses its own function for buffer fontification. This function
868 ;; makes fontification be on a message-by-message basis and so visiting an
869 ;; RMAIL file is much faster. A clever implementation of the function might
870 ;; fontify the headers differently than the message body. (It should, and
871 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
872 ;; you?) This hints at a more interesting use...
873 ;;
874 ;; Languages that contain text normally contained in different major modes
875 ;; could define their own fontification functions that treat text differently
876 ;; depending on its context. For example, Perl mode could arrange that here
877 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
878 ;; rules one way and C code another. Neat!
879 ;;
880 ;; A further reason to use the fontification indirection feature is when the
881 ;; default syntactual fontification, or the default fontification in general,
882 ;; is not flexible enough for a particular major mode. For example, perhaps
883 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' and
884 ;; `font-lock-comment-start-regexp' to cope with. You need to write your own
885 ;; version of that function, e.g., `hairy-fontify-syntactically-region', and
886 ;; make your own version of `hairy-fontify-region' call it before calling
887 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
888 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
889 ;; would call your region fontification function instead of its own. For
890 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
891 ;; directives correctly and cleanly. (It is the same problem as fontifying
892 ;; multi-line strings and comments; regexps are not appropriate for the job.)
894 ;;;###autoload
896 "Fontify the current buffer the way `font-lock-mode' would."
913 font-lock-verbose)))
916 ;; Make sure we have the right `font-lock-keywords' etc.
919 ;; Make sure we fontify etc. in the whole buffer.
928 ;; We don't restore the old fontification, so it's best to unfontify.
930 ;; Make sure we undo `font-lock-keywords' etc.
937 ;; Make sure we unfontify etc. in the whole buffer.
949 ;; Use the fontification syntax table, if any.
952 ;; Now do the fontification.
957 ;; Clean up.
960 ;; The following must be rethought, since keywords can override fontification.
961 ; ;; Now scan for keywords, but not if we are inside a comment now.
962 ; (or (and (not font-lock-keywords-only)
963 ; (let ((state (parse-partial-sexp beg end nil nil
964 ; font-lock-cache-state)))
965 ; (or (nth 4 state) (nth 7 state))))
966 ; (font-lock-fontify-keywords-region beg end))
972 ;; Called when any modification is made to buffer text.
976 ;; Rescan between start of lines enclosing the region.
982 "Fontify some lines the way `font-lock-fontify-buffer' would.
983 The lines could be a function or paragraph, or a specified number of lines.
984 If ARG is given, fontify that many lines before and after point, or 16 lines if
985 no ARG is given and `font-lock-mark-block-function' is nil.
986 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
987 delimit the region to fontify."
990 ;; Make sure we have the right `font-lock-keywords' etc.
1005 \f
1006 ;; Syntactic fontification functions.
1008 ;; These record the parse state at a particular position, always the start of a
1009 ;; line. Used to make `font-lock-fontify-syntactically-region' faster.
1010 ;; Previously, `font-lock-cache-position' was just a buffer position. However,
1011 ;; under certain situations, this occasionally resulted in mis-fontification.
1012 ;; I think the "situations" were deletion with Lazy Lock mode's deferral. sm.
1017 "Put proper face on each string and comment between START and END.
1018 START should be at the beginning of a line."
1026 state prev here beg)
1029 ;;
1030 ;; Find the state at the `beginning-of-line' before `start'.
1032 ;; Use the cache for the state of `start'.
1034 ;; Find the state of `start'.
1036 ;; Use the state at the previous cache position, if any, or
1037 ;; otherwise calculate from `point-min'.
1041 font-lock-cache-state)))
1042 ;; Call the function to move outside any syntactic block.
1045 ;; Cache the state and position of `start'.
1048 ;;
1049 ;; If the region starts inside a string, show the extent of it.
1053 ;; Verify the state so we don't get fooled by quoting.
1057 ;;
1058 ;; Likewise for a comment.
1061 font-lock-comment-start-regexp)
1071 ;; Go back to the real start of the comment.
1074 ;; If there is more than one comment type, then the previous
1075 ;; comment start might not be the real comment start.
1076 ;; For example, in C++ code, `here' might be on a line following
1077 ;; a // comment that is actually within a /* */ comment.
1082 ;; Go back to the real end of the comment.
1087 ;;
1088 ;; Find each interesting place between here and `end'.
1094 ;;
1095 ;; Found a real string start.
1105 ;;
1106 ;; Found a real comment start.
1117 \f
1118 ;;; Additional text property functions.
1120 ;; The following text property functions should be builtins. This means they
1121 ;; should be written in C and put with all the other text property functions.
1122 ;; In the meantime, those that are used by font-lock.el are defined in Lisp
1123 ;; below and given a `font-lock-' prefix. Those that are not used are defined
1124 ;; in Lisp below and commented out. sm.
1127 "Prepend to one property of the text from START to END.
1128 Arguments PROP and VALUE specify the property and value to prepend to the value
1129 already in place. The resulting property values are always lists.
1130 Optional argument OBJECT is the string or buffer containing the text."
1137 object)
1141 "Append to one property of the text from START to END.
1142 Arguments PROP and VALUE specify the property and value to append to the value
1143 already in place. The resulting property values are always lists.
1144 Optional argument OBJECT is the string or buffer containing the text."
1151 object)
1155 "Fill in one property of the text from START to END.
1156 Arguments PROP and VALUE specify the property and value to put where none are
1157 already in place. Therefore existing property values are not overwritten.
1158 Optional argument OBJECT is the string or buffer containing the text."
1165 ;; For completeness: this is to `remove-text-properties' as `put-text-property'
1166 ;; is to `add-text-properties', etc.
1167 ;(defun remove-text-property (start end property &optional object)
1168 ; "Remove a property from text from START to END.
1169 ;Argument PROPERTY is the property to remove.
1170 ;Optional argument OBJECT is the string or buffer containing the text.
1171 ;Return t if the property was actually removed, nil otherwise."
1172 ; (remove-text-properties start end (list property) object))
1174 ;; For consistency: maybe this should be called `remove-single-property' like
1175 ;; `next-single-property-change' (not `next-single-text-property-change'), etc.
1176 ;(defun remove-single-text-property (start end prop value &optional object)
1177 ; "Remove a specific property value from text from START to END.
1178 ;Arguments PROP and VALUE specify the property and value to remove. The
1179 ;resulting property values are not equal to VALUE nor lists containing VALUE.
1180 ;Optional argument OBJECT is the string or buffer containing the text."
1181 ; (let ((start (text-property-not-all start end prop nil object)) next prev)
1182 ; (while start
1183 ; (setq next (next-single-property-change start prop object end)
1184 ; prev (get-text-property start prop object))
1185 ; (cond ((and (symbolp prev) (eq value prev))
1186 ; (remove-text-property start next prop object))
1187 ; ((and (listp prev) (memq value prev))
1188 ; (let ((new (delq value prev)))
1189 ; (cond ((null new)
1190 ; (remove-text-property start next prop object))
1191 ; ((= (length new) 1)
1192 ; (put-text-property start next prop (car new) object))
1193 ; (t
1194 ; (put-text-property start next prop new object))))))
1195 ; (setq start (text-property-not-all next end prop nil object)))))
1196 \f
1197 ;;; Regexp fontification functions.
1200 "Apply HIGHLIGHT following a match.
1201 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1206 ;; No match but we might not signal an error.
1210 ;; Cannot override existing fontification.
1214 ;; Override existing fontification.
1217 ;; Prepend to existing fontification.
1220 ;; Append to existing fontification.
1223 ;; Keep existing fontification.
1227 "Fontify according to KEYWORDS until LIMIT.
1228 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1229 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1231 ;; Evaluate PRE-MATCH-FORM.
1233 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1238 ;; Find an occurrence of `matcher' before `limit'.
1242 ;; Apply each highlight to this instance of `matcher'.
1247 ;; Evaluate POST-MATCH-FORM.
1251 "Fontify according to `font-lock-keywords' between START and END.
1252 START should be at the beginning of a line."
1255 font-lock-keywords
1258 keyword matcher highlights)
1259 ;;
1260 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1264 ;;
1265 ;; Find an occurrence of `matcher' from `start' to `end'.
1271 ;; Apply each highlight to this instance of `matcher', which may be
1272 ;; specific highlights or more keywords anchored to `matcher'.
1280 \f
1281 ;; Various functions.
1284 ;; Compile `font-lock-keywords' into the form (t KEYWORD ...) where KEYWORD
1285 ;; is the (MATCHER HIGHLIGHT ...) shown in the variable's doc string.
1289 keywords
1298 ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote.
1309 keyword)))
1312 ;; Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1313 ;; Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t.
1316 alist))
1319 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1320 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
1322 keywords)
1333 "Set fontification defaults appropriately for this mode.
1334 Sets various variables using `font-lock-defaults' (or, if nil, using
1335 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1336 ;; Set face defaults.
1338 ;; Set fontification defaults.
1340 ;; Set iff not previously set.
1351 ;; Regexp fontification?
1355 ;; Local fontification?
1359 ;; Syntactic fontification?
1362 ;; Case fold during regexp fontification?
1365 ;; Syntax table for regexp and syntactic fontification?
1371 ;; The character to modify may be a single CHAR or a STRING.
1378 font-lock-syntax-table)
1381 ;; Syntax function for syntactic fontification?
1385 ;; Variable alist?
1392 "Unset fontification defaults. See `font-lock-set-defaults'."
1394 font-lock-keywords nil
1395 font-lock-keywords-only nil
1396 font-lock-keywords-case-fold-search nil
1397 font-lock-syntax-table nil
1398 font-lock-beginning-of-syntax-function nil)
1405 \f
1406 ;; Colour etc. support.
1408 ;; This section of code is crying out for revision. Come on down, custom.el?
1410 ;; To begin with, `display-type' and `background-mode' are `frame-parameters'
1411 ;; so we don't have to calculate them here anymore. But all the face stuff
1412 ;; should be frame-local (and thus display-local) anyway. Because we're not
1413 ;; sure what support Emacs is going to have for general frame-local face
1414 ;; attributes, we leave this section of code as it is. For now. sm.
1417 "A symbol indicating the display Emacs is running under.
1418 The symbol should be one of `color', `grayscale' or `mono'.
1419 If Emacs guesses this display attribute wrongly, either set this variable in
1420 your `~/.emacs' or set the resource `Emacs.displayType' in your `~/.Xdefaults'.
1424 "A symbol indicating the Emacs background brightness.
1425 The symbol should be one of `light' or `dark'.
1426 If Emacs guesses this frame attribute wrongly, either set this variable in
1427 your `~/.emacs' or set the resource `Emacs.backgroundMode' in your
1428 `~/.Xdefaults'.
1432 "A list of default attributes to use for face attributes.
1433 Each element of the list should be of the form
1435 (FACE FOREGROUND BACKGROUND BOLD-P ITALIC-P UNDERLINE-P)
1437 where FACE could be one of the face symbols `font-lock-comment-face',
1438 `font-lock-string-face', `font-lock-keyword-face', `font-lock-builtin-face',
1439 `font-lock-type-face', `font-lock-function-name-face',
1440 `font-lock-variable-name-face', `font-lock-reference-face' and
1441 `font-lock-warning-face', or any other face symbols and attributes may be
1442 specified here and used in `font-lock-keywords'.
1444 Subsequent element items should be the attributes for the corresponding
1445 Font Lock mode faces. Attributes FOREGROUND and BACKGROUND should be strings
1446 \(default if nil), while BOLD-P, ITALIC-P, and UNDERLINE-P should specify the
1447 corresponding face attributes (yes if non-nil). For example:
1452 in your ~/.emacs makes a garish bold-italic warning face and red comment face.
1454 Emacs uses default attributes based on display type and background brightness.
1455 See variables `font-lock-display-type' and `font-lock-background-mode'.
1457 Resources can be used to over-ride these face attributes. For example, the
1458 resource `Emacs.font-lock-comment-face.attributeUnderline' can be used to
1462 "Make faces from `font-lock-face-attributes'.
1463 A default list is used if this is nil.
1464 If optional OVERRIDE is non-nil, faces that already exist are reset.
1465 See `font-lock-make-face' and `list-faces-display'."
1466 ;; We don't need to `setq' any of these variables, but the user can see what
1467 ;; is being used if we do.
1482 'light
1492 ;; Emacs 19.25's font-lock defaults:
1493 ;;'((font-lock-comment-face nil nil nil t nil)
1494 ;; (font-lock-string-face nil nil nil nil t)
1495 ;; (font-lock-keyword-face nil nil t nil nil)
1496 ;; (font-lock-function-name-face nil nil t t nil)
1497 ;; (font-lock-type-face nil nil nil t nil))
1503 'font-lock-function-name-face
1506 t nil nil)
1511 'font-lock-warning-face
1514 t nil nil)))
1516 grayshade greyshade))
1529 t nil nil)
1539 t nil nil)))
1564 ;; Now make the faces if we have to.
1569 ;; We can stomp all over it anyway. Get outta my face!
1572 ;; The variable exists and is already bound to a face.
1573 nil)
1575 ;; We already have a face so we bind the variable to it.
1578 ;; No variable or no face.
1580 font-lock-face-attributes))
1583 "Make a face from FACE-ATTRIBUTES.
1584 FACE-ATTRIBUTES should be like an element `font-lock-face-attributes', so that
1585 the face name is the first item in the list. A variable with the same name as
1586 the face is also set; its value is the face name."
1597 ;; Set attributes not set from X resources (and therefore `make-face').
1615 \f
1616 ;;; Menu support.
1618 ;; This section of code is commented out because Emacs does not have real menu
1619 ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of
1620 ;; the menu entry text, but with Xt it looks both ugly and embarrassingly
1621 ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after
1622 ;; the entry for "Text Properties" something like:
1623 ;;
1624 ;; (define-key menu-bar-edit-menu [font-lock]
1625 ;; '("Syntax Highlighting" . font-lock-menu))
1626 ;;
1627 ;; and remove a single ";" from the beginning of each line in the rest of this
1628 ;; section. Probably the mechanism for telling the menu code what are menu
1629 ;; buttons and when they are on or off needs tweaking. I have assumed that the
1630 ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm.
1632 ;;;;###autoload
1633 ;(progn
1634 ; ;; Make the Font Lock menu.
1635 ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
1636 ; ;; Add the menu items in reverse order.
1637 ; (define-key font-lock-menu [fontify-less]
1638 ; '("Less In Current Buffer" . font-lock-fontify-less))
1639 ; (define-key font-lock-menu [fontify-more]
1640 ; '("More In Current Buffer" . font-lock-fontify-more))
1641 ; (define-key font-lock-menu [font-lock-sep]
1642 ; '("--"))
1643 ; (define-key font-lock-menu [font-lock-mode]
1644 ; '("In Current Buffer" . font-lock-mode))
1645 ; (define-key font-lock-menu [global-font-lock-mode]
1646 ; '("In All Buffers" . global-font-lock-mode)))
1647 ;
1648 ;;;;###autoload
1649 ;(progn
1650 ; ;; We put the appropriate `menu-enable' etc. symbol property values on when
1651 ; ;; font-lock.el is loaded, so we don't need to autoload the three variables.
1652 ; (put 'global-font-lock-mode 'menu-toggle t)
1653 ; (put 'font-lock-mode 'menu-toggle t)
1654 ; (put 'font-lock-fontify-more 'menu-enable '(identity))
1655 ; (put 'font-lock-fontify-less 'menu-enable '(identity)))
1656 ;
1657 ;;; Put the appropriate symbol property values on now. See above.
1658 ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode))
1659 ;(put 'font-lock-mode 'menu-selected 'font-lock-mode)
1660 ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level))
1661 ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level))
1662 ;
1663 ;(defvar font-lock-fontify-level nil) ; For less/more fontification.
1664 ;
1665 ;(defun font-lock-fontify-level (level)
1666 ; (let ((font-lock-maximum-decoration level))
1667 ; (when font-lock-mode
1668 ; (font-lock-mode))
1669 ; (font-lock-mode)
1670 ; (when font-lock-verbose
1671 ; (message "Fontifying %s... level %d" (buffer-name) level))))
1672 ;
1673 ;(defun font-lock-fontify-less ()
1674 ; "Fontify the current buffer with less decoration.
1675 ;See `font-lock-maximum-decoration'."
1676 ; (interactive)
1677 ; ;; Check in case we get called interactively.
1678 ; (if (nth 1 font-lock-fontify-level)
1679 ; (font-lock-fontify-level (1- (car font-lock-fontify-level)))
1680 ; (error "No less decoration")))
1681 ;
1682 ;(defun font-lock-fontify-more ()
1683 ; "Fontify the current buffer with more decoration.
1684 ;See `font-lock-maximum-decoration'."
1685 ; (interactive)
1686 ; ;; Check in case we get called interactively.
1687 ; (if (nth 2 font-lock-fontify-level)
1688 ; (font-lock-fontify-level (1+ (car font-lock-fontify-level)))
1689 ; (error "No more decoration")))
1690 ;
1691 ;;; This should be called by `font-lock-set-defaults'.
1692 ;(defun font-lock-set-menu ()
1693 ; ;; Activate less/more fontification entries if there are multiple levels for
1694 ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form
1695 ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation.
1696 ; (let ((keywords (or (nth 0 font-lock-defaults)
1697 ; (nth 1 (assq major-mode font-lock-defaults-alist))))
1698 ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration)))
1699 ; (make-local-variable 'font-lock-fontify-level)
1700 ; (if (or (symbolp keywords) (= (length keywords) 1))
1701 ; (font-lock-unset-menu)
1702 ; (cond ((eq level t)
1703 ; (setq level (1- (length keywords))))
1704 ; ((or (null level) (zerop level))
1705 ; ;; The default level is usually, but not necessarily, level 1.
1706 ; (setq level (- (length keywords)
1707 ; (length (member (eval (car keywords))
1708 ; (mapcar 'eval (cdr keywords))))))))
1709 ; (setq font-lock-fontify-level (list level (> level 1)
1710 ; (< level (1- (length keywords))))))))
1711 ;
1712 ;;; This should be called by `font-lock-unset-defaults'.
1713 ;(defun font-lock-unset-menu ()
1714 ; ;; Deactivate less/more fontification entries.
1715 ; (setq font-lock-fontify-level nil))
1716 \f
1717 ;;; Various regexp information shared by several modes.
1718 ;;; Information specific to a single mode should go in its load library.
1720 ;; Font Lock support for C, C++, Objective-C and Java modes will one day be in
1721 ;; some cc-font.el (and required by cc-mode.el). However, the below function
1722 ;; should stay in font-lock.el, since it is used by other libraries. sm.
1725 "Match, and move over, any declaration/definition item after point.
1726 Matches after point, but ignores leading whitespace and `*' characters.
1727 Does not move further than LIMIT.
1729 The expected syntax of a declaration/definition item is `word', possibly ending
1730 with optional whitespace and a `('. Everything following the item (but
1731 belonging to it) is expected to by skip-able by `scan-sexps', and items are
1732 expected to be separated with a `,' and to be terminated with a `;'.
1734 Thus the regexp matches after point: word (
1735 ^^^^ ^
1736 Where the match subexpressions are: 1 2
1738 The item is delimited by (match-beginning 1) and (match-end 1).
1739 If (match-beginning 2) is non-nil, the item is followed by a `('.
1741 This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item."
1746 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
1749 ;; Move over any item value, etc., to the next item.
1759 ;; Anything not a variable or type declaration is fontified as a function.
1760 ;; It would be cleaner to allow preceding whitespace, but it would also be
1761 ;; about five times slower.
1763 ;; Variable declarations.
1765 ;; Structure declarations.
1767 ;; Everything else is a function declaration.
1770 ;; Any whitespace and declared object.
1777 nil t))
1778 ))
1785 ;;
1786 ;; Control structures. Common ELisp and CLisp forms combined.
1787 ; (make-regexp
1788 ; '("cond" "if" "while" "let\\*?" "prog[nv12*]?" "inline" "catch" "throw"
1789 ; "save-restriction" "save-excursion" "save-window-excursion"
1790 ; "save-selected-window" "save-match-data" "save-current-buffer"
1791 ; "unwind-protect" "condition-case" "track-mouse" "dont-compile"
1792 ; "eval-after-load" "eval-and-compile" "eval-when-compile"
1793 ; "when" "unless" "do" "flet" "labels" "return" "return-from"
1794 ; "with-output-to-temp-buffer" "with-timeout" "with-current-buffer"
1795 ; "with-temp-buffer" "with-temp-file"))
1811 ;;
1812 ;; Feature symbols as references.
1815 ;;
1816 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1818 ;;
1819 ;; Words inside `' tend to be symbol names.
1821 ;;
1822 ;; CLisp `:' keywords as builtins.
1824 ;;
1825 ;; ELisp and CLisp `&' keywords as types.
1827 )))
1838 ;;
1839 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1840 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1842 ;; Function names.
1844 ;; Macro names, as variable names. A bit dubious, this.
1846 ;; Class names.
1847 "-class"
1849 ;; Any whitespace and declared object.
1856 nil t))
1857 ;;
1858 ;; Control structures.
1859 ;(make-regexp '("begin" "call-with-current-continuation" "call/cc"
1860 ; "call-with-input-file" "call-with-output-file" "case" "cond"
1861 ; "do" "else" "for-each" "if" "lambda"
1862 ; "let\\*?" "let-syntax" "letrec" "letrec-syntax"
1863 ; ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1864 ; "and" "or" "delay"
1865 ; ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
1866 ; ;;"quasiquote" "quote" "unquote" "unquote-splicing"
1867 ; "map" "syntax" "syntax-rules"))
1876 ;;
1877 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
1879 ;;
1880 ;; Scheme `:' keywords as references.
1882 ))
1887 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
1888 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
1889 ; 2 font-lock-function-name-face)
1890 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
1891 ; 2 font-lock-reference-face)
1892 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1893 ; ;; not be able to display those fonts.
1894 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
1895 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
1896 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
1897 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
1898 ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
1905 ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1906 ;; not be able to display those fonts.
1907 ;; LaTeX2e: \emph{This is emphasized}.
1909 ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
1912 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables.
1916 \f
1917 ;;; User choices.
1919 ;; These provide a means to fontify types not defined by the language. Those
1920 ;; types might be the user's own or they might be generally accepted and used.
1921 ;; Generally excepted types are used to provide default variable values.
1924 "*List of extra types to fontify in C mode.
1925 Each list item should be a regexp without word-delimiters or parentheses.
1930 "*List of extra types to fontify in C++ mode.
1931 Each list item should be a regexp without word-delimiters or parentheses.
1936 "*List of extra types to fontify in Objective-C mode.
1937 Each list item should be a regexp without word-delimiters or parentheses.
1942 "*List of extra types to fontify in Java mode.
1943 Each list item should be a regexp without word-delimiters or parentheses.
1946 \f
1947 ;;; C.
1949 ;; [Murmur murmur murmur] Maestro, drum-roll please... [Murmur murmur murmur.]
1950 ;; Ahem. [Murmur murmur murmur] Lay-dees an Gennel-men. [Murmur murmur shhh!]
1951 ;; I am most proud and humbly honoured today [murmur murmur cough] to present
1952 ;; to you good people, the winner of the Second Millennium Award for The Most
1953 ;; Hairy Language Syntax. [Ahhh!] All rise please. [Shuffle shuffle
1954 ;; shuffle.] And a round of applause please. For... The C Language! [Roar.]
1955 ;;
1956 ;; Thank you... You are too kind... It is with a feeling of great privilege
1957 ;; and indeed emotion [sob] that I accept this award. It has been a long hard
1958 ;; road. But we know our destiny. And our future. For we must not rest.
1959 ;; There are more tokens to overload, more shoehorn, more methodologies. But
1960 ;; more is a plus! [Ha ha ha.] And more means plus! [Ho ho ho.] The future
1961 ;; is C++! [Ohhh!] The Third Millennium Award... Will be ours! [Roar.]
1967 "Medium level highlighting for C mode.
1971 "Gaudy level highlighting for C mode.
1975 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while")
1978 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
1979 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
1980 ; "void" "volatile" "const")
1987 c-font-lock-extra-types)
1989 )
1992 ;;
1993 ;; These are all anchored at the beginning of line for speed.
1994 ;; Note that `c++-font-lock-keywords-1' depends on `c-font-lock-keywords-1'.
1995 ;;
1996 ;; Fontify function name definitions (GNU style; without type on line).
1998 ;;
1999 ;; Fontify error directives.
2001 ;;
2002 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2005 ;;
2006 ;; Fontify function macro names.
2008 ;;
2009 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
2013 ;;
2014 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2017 ))
2022 ;;
2023 ;; Simple regexps for speed.
2024 ;;
2025 ;; Fontify all type specifiers.
2028 ;;
2029 ;; Fontify all builtin keywords (except case, default and goto; see below).
2031 ;;
2032 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2035 ;; Anders Lindgren <andersl@csd.uu.se> points out that it is quicker to use
2036 ;; MATCH-ANCHORED to effectively anchor the regexp on the left.
2040 )))
2044 ;;
2045 ;; More complicated regexps for more complete highlighting for types.
2046 ;; We still have to fontify type specifiers individually, as C is so hairy.
2048 ;;
2049 ;; Fontify all storage classes and type specifiers, plus their items.
2053 ;; Fontify each declaration item.
2055 ;; Start with point after all type specifiers.
2057 ;; Finish with point after first type specifier.
2059 ;; Fontify as a variable or function name.
2061 font-lock-function-name-face
2062 font-lock-variable-name-face)))))
2063 ;;
2064 ;; Fontify structures, or typedef names, plus their items.
2069 font-lock-function-name-face
2070 font-lock-variable-name-face))))
2071 ;;
2072 ;; Fontify anything at beginning of line as a declaration or definition.
2078 font-lock-function-name-face
2079 font-lock-variable-name-face))))
2080 )))
2081 )
2084 "Default expressions to highlight in C mode.
2086 \f
2087 ;;; C++.
2093 "Medium level highlighting for C++ mode.
2097 "Gaudy level highlighting for C++ mode.
2101 ;; Regexp matches after point: word<word>::word (
2102 ;; ^^^^ ^^^^ ^^^^ ^
2103 ;; Where the match subexpressions are: 1 3 5 6
2104 ;;
2105 ;; Item is delimited by (match-beginning 1) and (match-end 1).
2106 ;; If (match-beginning 3) is non-nil, that part of the item incloses a `<>'.
2107 ;; If (match-beginning 5) is non-nil, that part of the item follows a `::'.
2108 ;; If (match-beginning 6) is non-nil, the item is followed by a `('.
2117 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2120 ;; Move over any item value, etc., to the next item.
2127 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
2128 ; "asm" "catch" "delete" "new" "operator" "sizeof" "this" "throw" "try"
2129 ; ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new.
2130 ; "static_cast" "dynamic_cast" "const_cast" "reinterpret_cast")
2139 ;; Taken from Stroustrup, minus keywords otherwise fontified.
2147 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2148 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2149 ; "void" "volatile" "const" "inline" "friend" "bool"
2150 ; "virtual" "complex" "template"
2151 ; ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new.
2152 ; "namespace" "using")
2166 )
2169 ;;
2170 ;; The list `c-font-lock-keywords-1' less that for function names.
2173 ;;
2174 ;; Class names etc.
2179 font-lock-type-face
2183 ;;
2184 ;; Fontify function name definitions, possibly incorporating class names.
2187 font-lock-type-face
2188 font-lock-function-name-face))
2191 )))
2196 ;;
2197 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2201 ;;
2202 ;; Fontify operator overloading.
2206 ;;
2207 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2213 ;;
2214 ;; Fontify other builtin keywords.
2216 ;;
2217 ;; Eric Hopper <hopper@omnifarious.mn.org> says `true' and `false' are new.
2219 )))
2223 ;;
2224 ;; More complicated regexps for more complete highlighting for types.
2226 ;;
2227 ;; Fontify all storage classes and type specifiers, plus their items.
2231 ;; Fontify each declaration item.
2233 ;; Start with point after all type specifiers.
2235 ;; Finish with point after first type specifier.
2237 ;; Fontify as a variable or function name.
2239 font-lock-type-face)
2244 font-lock-function-name-face
2246 ;;
2247 ;; Fontify structures, or typedef names, plus their items.
2252 font-lock-function-name-face
2253 font-lock-variable-name-face))))
2254 ;;
2255 ;; Fontify anything at beginning of line as a declaration or definition.
2261 font-lock-type-face)
2266 font-lock-function-name-face
2268 )))
2269 )
2272 "Default expressions to highlight in C++ mode.
2274 \f
2275 ;;; Objective-C.
2281 "Medium level highlighting for Objective-C mode.
2285 "Gaudy level highlighting for Objective-C mode.
2288 ;; Regexps written with help from Stephen Peters <speters@us.oracle.com> and
2289 ;; Jacques Duthen Prestataire <duthen@cegelec-red.fr>.
2291 ; (make-regexp
2292 ; '("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
2293 ; "sizeof" "self" "super"))
2299 ; '("auto" "extern" "register" "static" "typedef" "struct" "union"
2300 ; "enum" "signed" "unsigned" "short" "long" "int" "char"
2301 ; "float" "double" "void" "volatile" "const"
2302 ; "id" "oneway" "in" "out" "inout" "bycopy" "byref")
2309 objc-font-lock-extra-types)
2311 )
2314 ;;
2315 ;; The list `c-font-lock-keywords-1' less that for function names.
2318 ;;
2319 ;; Fontify compiler directives.
2324 ;;
2325 ;; Fontify method names and arguments. Oh Lordy!
2326 ;; First, on the same line as the function declaration.
2332 nil nil
2336 ;; Second, on lines following the function declaration.
2342 )))
2347 ;;
2348 ;; Simple regexps for speed.
2349 ;;
2350 ;; Fontify all type specifiers.
2354 ;;
2355 ;; Fontify all builtin keywords (except case, default and goto; see below).
2357 ;;
2358 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2361 ;; Fontify tags iff sole statement on line, otherwise we detect selectors.
2365 ;;
2366 ;; Fontify null object pointers.
2368 )))
2372 ;;
2373 ;; More complicated regexps for more complete highlighting for types.
2374 ;; We still have to fontify type specifiers individually, as C is so hairy.
2376 ;;
2377 ;; Fontify all storage classes and type specifiers, plus their items.
2381 ;; Fontify each declaration item.
2383 ;; Start with point after all type specifiers.
2385 ;; Finish with point after first type specifier.
2387 ;; Fontify as a variable or function name.
2389 font-lock-function-name-face
2390 font-lock-variable-name-face)))))
2391 ;;
2392 ;; Fontify structures, or typedef names, plus their items.
2397 font-lock-function-name-face
2398 font-lock-variable-name-face))))
2399 ;;
2400 ;; Fontify anything at beginning of line as a declaration or definition.
2406 font-lock-function-name-face
2407 font-lock-variable-name-face))))
2408 )))
2409 )
2412 "Default expressions to highlight in Objective-C mode.
2414 \f
2415 ;;; Java.
2421 "Medium level highlighting for Java mode.
2425 "Gaudy level highlighting for Java mode.
2428 ;; Regexps written with help from Fred White <fwhite@bbn.com> and
2429 ;; Anders Lindgren <andersl@csd.uu.se>.
2432 ; (make-regexp
2433 ; '("catch" "do" "else" "super" "this" "finally" "for" "if"
2434 ;; ;; Anders Lindgren <andersl@csd.uu.se> says these have gone.
2435 ;; "cast" "byvalue" "future" "generic" "operator" "var"
2436 ;; "inner" "outer" "rest"
2437 ; "interface" "return" "switch" "throw" "try" "while")
2442 ;;
2443 ;; These are immediately followed by an object name.
2448 ;;
2449 ;; These are eventually followed by an object name.
2451 ; (make-regexp
2452 ; '("abstract" "const" "final" "synchronized" "transient" "static"
2453 ;; ;; Anders Lindgren <andersl@csd.uu.se> says this has gone.
2454 ;; "threadsafe"
2455 ; "volatile" "public" "private" "protected" "native")
2459 ;;
2460 ;; Random types immediately followed by an object name.
2464 )
2467 ;;
2468 ;; Fontify class names.
2471 ;;
2472 ;; Fontify package names in import directives.
2475 ))
2480 ;;
2481 ;; Fontify all builtin type specifiers.
2484 ;;
2485 ;; Fontify all builtin keywords (except below).
2487 ;;
2488 ;; Fontify keywords and targets, and case default/goto tags.
2494 ;;
2495 ;; Fontify keywords and types; the first can be followed by a type list.
2504 ;;
2505 ;; Fontify all constants.
2507 ;;
2508 ;; Javadoc tags within comments.
2514 )))
2518 ;;
2519 ;; More complicated regexps for more complete highlighting for types.
2520 ;; We still have to fontify type specifiers individually, as Java is hairy.
2522 ;;
2523 ;; Fontify random types in casts.
2527 ;; Fontify the type name.
2529 ;;
2530 ;; Fontify random types immediately followed by an item or items.
2535 ;; Fontify the type name.
2541 ;; Fontify each declaration item.
2543 ;; Start and finish with point after the type specifier.
2545 ;; Fontify as a variable or function name.
2547 font-lock-function-name-face
2548 font-lock-variable-name-face)))))
2549 ;;
2550 ;; Fontify those that are immediately followed by an item or items.
2553 ;; Fontify each declaration item.
2555 ;; Start and finish with point after the type specifier.
2557 ;; Fontify as a variable or function name.
2559 font-lock-function-name-face
2560 font-lock-variable-name-face))))
2561 ;;
2562 ;; Fontify those that are eventually followed by an item or items.
2567 ;; Fontify each declaration item.
2569 ;; Start with point after all type specifiers.
2571 ;; Finish with point after first type specifier.
2573 ;; Fontify as a variable or function name.
2575 font-lock-function-name-face
2576 font-lock-variable-name-face))))
2577 )))
2578 )
2581 "Default expressions to highlight in Java mode.
2583 \f
2584 ;; Install ourselves:
2589 ;; Provide ourselves:
2593 ;;; font-lock.el ends here