1 ;;; font-lock.el --- Electric font lock mode
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
5 ;; Author: jwz, then rms, then sm <simon@gnu.ai.mit.edu>
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)
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.
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.
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.
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.
39 ;; To turn Font Lock mode on automatically, add this to your ~/.emacs file:
41 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock)
43 ;; Or if you want to turn Font Lock mode on in many modes:
45 ;; (global-font-lock-mode t)
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'.
53 ;; Constructing patterns:
55 ;; See the documentation for the variable `font-lock-keywords'.
57 ;; Nasty regexps of the form "bar\\(\\|lo\\)\\|f\\(oo\\|u\\(\\|bar\\)\\)\\|lo"
58 ;; are made thusly: (make-regexp '("foo" "fu" "fubar" "bar" "barlo" "lo")) for
59 ;; efficiency. See /pub/gnu/emacs/elisp-archive/functions/make-regexp.el.Z on
60 ;; archive.cis.ohio-state.edu for this and other functions.
62 ;; Adding patterns for modes that already support Font Lock:
64 ;; Font Lock mode uses the buffer local variable `font-lock-keywords' for the
65 ;; highlighting patterns. This variable is set by Font Lock mode from (a) the
66 ;; buffer local variable `font-lock-defaults', if non-nil, or (b) the global
67 ;; variable `font-lock-defaults-alist', if the major mode has an entry.
68 ;; Font Lock mode is set up via (a) where a mode's patterns are distributed
69 ;; with the mode's package library, (b) where a mode's patterns are distributed
70 ;; with font-lock.el itself. An example of (a) is Pascal mode, an example of
71 ;; (b) is C/C++ modes. (Normally, the mechanism is (a); (b) is used where it
72 ;; is not clear which package library should contain the pattern definitions.)
74 ;; If, for a particular mode, mechanism (a) is used, you need to add your
75 ;; patterns after that package library has loaded, e.g.:
77 ;; (eval-after-load "pascal" '(add-to-list 'pascal-font-lock-keywords ...))
79 ;; (Note that only one pattern can be added with `add-to-list'. For multiple
80 ;; patterns, use one `eval-after-load' form with one `setq' and `append' form,
81 ;; or multiple `eval-after-load' forms each with one `add-to-list' form.)
82 ;; If mechanism (b) is used, you need to add your patterns after font-lock.el
83 ;; itself has loaded, e.g.:
85 ;; (eval-after-load "font-lock" '(add-to-list 'c-font-lock-keywords ...))
87 ;; Which variable you should add to depends on what level of fontification you
88 ;; choose and what level is supported. If you choose the maximum level, by
89 ;; setting the variable `font-lock-maximum-decoration', you change a different
90 ;; variable. Maximum level patterns for C are `c-font-lock-keywords-3', so:
92 ;; (setq font-lock-maximum-decoration t)
93 ;; (eval-after-load "font-lock"
94 ;; '(add-to-list 'c-font-lock-keywords-3
95 ;; '("\\<FILE\\>" . font-lock-type-face)))
97 ;; To see which variable to set, see the buffer's value of `font-lock-defaults'
98 ;; or the mode's entry in the global value of `font-lock-defaults-alist'.
100 ;; Adding patterns for modes that do not support Font Lock:
102 ;; If you add patterns for a new mode, say foo.el's `foo-mode', say in which
103 ;; you don't want syntactic fontification to occur, you can make Font Lock mode
104 ;; use your regexps when turning on Font Lock by adding to `foo-mode-hook':
106 ;; (add-hook 'foo-mode-hook
107 ;; '(lambda () (make-local-variable 'font-lock-defaults)
108 ;; (setq font-lock-defaults '(foo-font-lock-keywords t))))
110 ;; What is fontification for? You might say, "It's to make my code look nice."
111 ;; I think it should be for adding information in the form of cues. These cues
112 ;; should provide you with enough information to both (a) distinguish between
113 ;; different items, and (b) identify the item meanings, without having to read
114 ;; the items and think about it. Therefore, fontification allows you to think
115 ;; less about, say, the structure of code, and more about, say, why the code
116 ;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
118 ;; So, here are my opinions/advice/guidelines:
120 ;; - Highlight conceptual objects, such as function and variable names, and
121 ;; different objects types differently, i.e., (a) and (b) above, highlight
122 ;; function names differently to variable names.
123 ;; - Keep the faces distinct from each other as far as possible.
125 ;; - Use the same face for the same conceptual object, across all modes.
126 ;; i.e., (b) above, all modes that have items that can be thought of as, say,
127 ;; keywords, should be highlighted with the same face, etc.
128 ;; - Make the face attributes fit the concept as far as possible.
129 ;; i.e., function names might be a bold colour such as blue, comments might
130 ;; be a bright colour such as red, character strings might be brown, because,
131 ;; err, strings are brown (that was not the reason, please believe me).
132 ;; - Don't use a non-nil OVERRIDE unless you have a good reason.
133 ;; Only use OVERRIDE for special things that are easy to define, such as the
134 ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
135 ;; Don't use it to, say, highlight keywords in commented out code or strings.
140 (defvar font-lock-verbose (* 0 1024)
141 "*If non-nil, means show status messages for buffer fontification.
142 If a number, only buffers greater than this size have fontification messages.")
145 (defvar font-lock-maximum-decoration nil
146 "*Maximum decoration level for fontification.
147 If nil, use the default decoration (typically the minimum available).
148 If t, use the maximum decoration available.
149 If a number, use that level of decoration (or if not available the maximum).
150 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
151 where MAJOR-MODE is a symbol or t (meaning the default). For example:
152 ((c-mode . t) (c++-mode . 2) (t . 1))
153 means use the maximum decoration available for buffers in C mode, level 2
154 decoration for buffers in C++ mode, and level 1 decoration otherwise.")
157 (defvar font-lock-maximum-size (* 250 1024)
158 "*Maximum size of a buffer for buffer fontification.
159 Only buffers less than this can be fontified when Font Lock mode is turned on.
160 If nil, means size is irrelevant.
161 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
162 where MAJOR-MODE is a symbol or t (meaning the default). For example:
163 ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576))
164 means that the maximum size is 250K for buffers in C or C++ modes, one megabyte
165 for buffers in Rmail mode, and size is irrelevant otherwise.")
167 ;; Fontification variables:
169 (defvar font-lock-comment-face 'font-lock-comment-face
170 "Face to use for comments.")
172 (defvar font-lock-string-face 'font-lock-string-face
173 "Face to use for strings.")
175 (defvar font-lock-keyword-face 'font-lock-keyword-face
176 "Face to use for keywords.")
178 (defvar font-lock-function-name-face 'font-lock-function-name-face
179 "Face to use for function names.")
181 (defvar font-lock-variable-name-face 'font-lock-variable-name-face
182 "Face to use for variable names.")
184 (defvar font-lock-type-face 'font-lock-type-face
185 "Face to use for type names.")
187 (defvar font-lock-reference-face 'font-lock-reference-face
188 "Face to use for reference names.")
190 (defvar font-lock-keywords nil
191 "*A list of the keywords to highlight.
192 Each element should be of the form:
197 (MATCHER . HIGHLIGHT)
198 (MATCHER HIGHLIGHT ...)
201 where HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
203 FORM is an expression, whose value should be a keyword element, evaluated when
204 the keyword is (first) used in a buffer. This feature can be used to provide a
205 keyword that can only be generated when Font Lock mode is actually turned on.
207 For highlighting single items, typically only MATCH-HIGHLIGHT is required.
208 However, if an item or (typically) items are to be highlighted following the
209 instance of another item (the anchor) then MATCH-ANCHORED may be required.
211 MATCH-HIGHLIGHT should be of the form:
213 (MATCH FACENAME OVERRIDE LAXMATCH)
215 Where MATCHER can be either the regexp to search for, or the function name to
216 call to make the search (called with one argument, the limit of the search).
217 MATCH is the subexpression of MATCHER to be highlighted. FACENAME is an
218 expression whose value is the face name to use. FACENAME's default attributes
219 may be defined in `font-lock-face-attributes'.
221 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification may
222 be overwritten. If `keep', only parts not already fontified are highlighted.
223 If `prepend' or `append', existing fontification is merged with the new, in
224 which the new or existing fontification, respectively, takes precedence.
225 If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER.
227 For example, an element of the form highlights (if not already highlighted):
229 \"\\\\\\=<foo\\\\\\=>\" Discrete occurrences of \"foo\" in the value of the
230 variable `font-lock-keyword-face'.
231 (\"fu\\\\(bar\\\\)\" . 1) Substring \"bar\" within all occurrences of \"fubar\" in
232 the value of `font-lock-keyword-face'.
233 (\"fubar\" . fubar-face) Occurrences of \"fubar\" in the value of `fubar-face'.
234 (\"foo\\\\|bar\" 0 foo-bar-face t)
235 Occurrences of either \"foo\" or \"bar\" in the value
236 of `foo-bar-face', even if already highlighted.
238 MATCH-ANCHORED should be of the form:
240 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
242 Where MATCHER is as for MATCH-HIGHLIGHT with one exception. The limit of the
243 search is currently guaranteed to be (no greater than) the end of the line.
244 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
245 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
246 used to initialise before, and cleanup after, MATCHER is used. Typically,
247 PRE-MATCH-FORM is used to move to some position relative to the original
248 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
249 be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
251 For example, an element of the form highlights (if not already highlighted):
253 (\"\\\\\\=<anchor\\\\\\=>\" (0 anchor-face) (\"\\\\\\=<item\\\\\\=>\" nil nil (0 item-face)))
255 Discrete occurrences of \"anchor\" in the value of `anchor-face', and subsequent
256 discrete occurrences of \"item\" (on the same line) in the value of `item-face'.
257 (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil. Therefore \"item\" is
258 initially searched for starting from the end of the match of \"anchor\", and
259 searching for subsequent instance of \"anchor\" resumes from where searching
260 for \"item\" concluded.)
262 Note that the MATCH-ANCHORED feature is experimental; in the future, we may
263 replace it with other ways of providing this functionality.
265 These regular expressions should not match text which spans lines. While
266 \\[font-lock-fontify-buffer] handles multi-line patterns correctly, updating
267 when you edit the buffer does not, since it considers text one line at a time.
269 Be very careful composing regexps for this list;
270 the wrong pattern can dramatically slow things down!")
271 (make-variable-buffer-local 'font-lock-keywords)
273 (defvar font-lock-defaults nil
274 "If set by a major mode, should be the defaults for Font Lock mode.
275 The value should be like the `cdr' of an item in `font-lock-defaults-alist'.")
277 (defvar font-lock-defaults-alist
278 (let (;; For C and Lisp modes we use `beginning-of-defun', rather than nil,
279 ;; for SYNTAX-BEGIN. Thus the calculation of the cache is usually
280 ;; faster but not infallible, so we risk mis-fontification. --sm.
282 '((c-font-lock-keywords c-font-lock-keywords-1
283 c-font-lock-keywords-2 c-font-lock-keywords-3)
284 nil nil ((?_ . "w")) beginning-of-defun
285 (font-lock-comment-start-regexp . "/[*/]")
286 (font-lock-mark-block-function . mark-defun)))
288 '((c++-font-lock-keywords c++-font-lock-keywords-1
289 c++-font-lock-keywords-2 c++-font-lock-keywords-3)
290 nil nil ((?_ . "w") (?~ . "w")) beginning-of-defun
291 (font-lock-comment-start-regexp . "/[*/]")
292 (font-lock-mark-block-function . mark-defun)))
294 '((lisp-font-lock-keywords
295 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
296 nil nil (("+-*/.<>=!?$%_&~^:" . "w")) beginning-of-defun
297 (font-lock-comment-start-regexp . ";")
298 (font-lock-mark-block-function . mark-defun)))
299 (scheme-mode-defaults
300 '(scheme-font-lock-keywords
301 nil t (("+-*/.<>=!?$%_&~^:" . "w")) beginning-of-defun
302 (font-lock-comment-start-regexp . ";")
303 (font-lock-mark-block-function . mark-defun)))
304 ;; For TeX modes we could use `backward-paragraph' for the same reason.
305 ;; But we don't, because paragraph breaks are arguably likely enough to
306 ;; occur within a genuine syntactic block to make it too risky.
307 ;; However, we do specify a MARK-BLOCK function as that cannot result
308 ;; in a mis-fontification even if it might not fontify enough. --sm.
310 '(tex-font-lock-keywords nil nil ((?$ . "\"")) nil
311 (font-lock-comment-start-regexp . "%")
312 (font-lock-mark-block-function . mark-paragraph)))
315 (cons 'c++-c-mode c-mode-defaults)
316 (cons 'c++-mode c++-mode-defaults)
317 (cons 'c-mode c-mode-defaults)
318 (cons 'elec-c-mode c-mode-defaults)
319 (cons 'emacs-lisp-mode lisp-mode-defaults)
320 (cons 'inferior-scheme-mode scheme-mode-defaults)
321 (cons 'latex-mode tex-mode-defaults)
322 (cons 'lisp-mode lisp-mode-defaults)
323 (cons 'lisp-interaction-mode lisp-mode-defaults)
324 (cons 'plain-tex-mode tex-mode-defaults)
325 (cons 'scheme-mode scheme-mode-defaults)
326 (cons 'scheme-interaction-mode scheme-mode-defaults)
327 (cons 'slitex-mode tex-mode-defaults)
328 (cons 'tex-mode tex-mode-defaults)))
329 "Alist of default major mode and Font Lock defaults.
330 Each item should be a list of the form:
332 (MAJOR-MODE . (KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN
335 where MAJOR-MODE is a symbol. KEYWORDS may be a symbol (a variable or function
336 whose value is the keywords to use for fontification) or a list of symbols.
337 If KEYWORDS-ONLY is non-nil, syntactic fontification (strings and comments) is
338 not performed. If CASE-FOLD is non-nil, the case of the keywords is ignored
339 when fontifying. If SYNTAX-ALIST is non-nil, it should be a list of cons pairs
340 of the form (CHAR-OR-STRING . STRING) used to set the local Font Lock syntax
341 table, for keyword and syntactic fontification (see `modify-syntax-entry').
343 If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
344 backwards outside any enclosing syntactic block, for syntactic fontification.
345 Typical values are `beginning-of-line' (i.e., the start of the line is known to
346 be outside a syntactic block), or `beginning-of-defun' for programming modes or
347 `backward-paragraph' for textual modes (i.e., the mode-dependent function is
348 known to move outside a syntactic block). If nil, the beginning of the buffer
349 is used as a position outside of a syntactic block, in the worst case.
351 These item elements are used by Font Lock mode to set the variables
352 `font-lock-keywords', `font-lock-keywords-only',
353 `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
354 `font-lock-beginning-of-syntax-function', respectively.
356 Further item elements are alists of the form (VARIABLE . VALUE) and are in no
357 particular order. Each VARIABLE is made buffer-local before set to VALUE.
359 Currently, appropriate variables include `font-lock-mark-block-function'.
360 If this is non-nil, it should be a function with no args used to mark any
361 enclosing block of text, for fontification via \\[font-lock-fontify-block].
362 Typical values are `mark-defun' for programming modes or `mark-paragraph' for
363 textual modes (i.e., the mode-dependent function is known to put point and mark
364 around a text block relevant to that mode).
366 Other variables include those for buffer-specialised fontification functions,
367 `font-lock-fontify-buffer-function', `font-lock-unfontify-buffer-function',
368 `font-lock-fontify-region-function', `font-lock-unfontify-region-function',
369 `font-lock-comment-start-regexp', `font-lock-inhibit-thing-lock' and
370 `font-lock-maximum-size'.")
372 (defvar font-lock-keywords-only nil
373 "*Non-nil means Font Lock should not fontify comments or strings.
374 This is normally set via `font-lock-defaults'.")
376 (defvar font-lock-keywords-case-fold-search nil
377 "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive.
378 This is normally set via `font-lock-defaults'.")
380 (defvar font-lock-syntax-table nil
381 "Non-nil means use this syntax table for fontifying.
382 If this is nil, the major mode's syntax table is used.
383 This is normally set via `font-lock-defaults'.")
385 ;; If this is nil, we only use the beginning of the buffer if we can't use
386 ;; `font-lock-cache-position' and `font-lock-cache-state'.
387 (defvar font-lock-beginning-of-syntax-function nil
388 "*Non-nil means use this function to move back outside of a syntactic block.
389 When called with no args it should leave point at the beginning of any
390 enclosing syntactic block.
391 If this is nil, the beginning of the buffer is used (in the worst case).
392 This is normally set via `font-lock-defaults'.")
394 (defvar font-lock-mark-block-function nil
395 "*Non-nil means use this function to mark a block of text.
396 When called with no args it should leave point at the beginning of any
397 enclosing textual block and mark at the end.
398 This is normally set via `font-lock-defaults'.")
400 (defvar font-lock-comment-start-regexp nil
401 "*Regexp to match the start of a comment.
402 This need not discriminate between genuine comments and quoted comment
403 characters or comment characters within strings.
404 If nil, `comment-start-skip' is used instead; see that variable for more info.
405 This is normally set via `font-lock-defaults'.")
407 (defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer
408 "Function to use for fontifying the buffer.
409 This is normally set via `font-lock-defaults'.")
411 (defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer
412 "Function to use for unfontifying the buffer.
413 This is used when turning off Font Lock mode.
414 This is normally set via `font-lock-defaults'.")
416 (defvar font-lock-fontify-region-function 'font-lock-default-fontify-region
417 "Function to use for fontifying a region.
418 It should take two args, the beginning and end of the region, and an optional
419 third arg VERBOSE. If non-nil, the function should print status messages.
420 This is normally set via `font-lock-defaults'.")
422 (defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region
423 "Function to use for unfontifying a region.
424 It should take two args, the beginning and end of the region.
425 This is normally set via `font-lock-defaults'.")
427 (defvar font-lock-inhibit-thing-lock nil
428 "List of Font Lock mode related modes that should not be turned on.
429 Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'.
430 This is normally set via `font-lock-defaults'.")
432 (defvar font-lock-mode nil) ; For the modeline.
433 (defvar font-lock-fontified nil) ; Whether we have fontified the buffer.
436 (defvar font-lock-mode-hook nil
437 "Function or functions to run on entry to Font Lock mode.")
442 ;; We don't do this at the top-level as we only use non-autoloaded macros.
446 (defun font-lock-mode (&optional arg)
447 "Toggle Font Lock mode.
448 With arg, turn Font Lock mode on if and only if arg is positive.
450 When Font Lock mode is enabled, text is fontified as you type it:
452 - Comments are displayed in `font-lock-comment-face';
453 - Strings are displayed in `font-lock-string-face';
454 - Certain other expressions are displayed in other faces according to the
455 value of the variable `font-lock-keywords'.
457 You can enable Font Lock mode in any major mode automatically by turning on in
458 the major mode's hook. For example, put in your ~/.emacs:
460 (add-hook 'c-mode-hook 'turn-on-font-lock)
462 Alternatively, you can use Global Font Lock mode to automagically turn on Font
463 Lock mode in buffers whose major mode supports it and whose major mode is one
464 of `font-lock-global-modes'. For example, put in your ~/.emacs:
466 (global-font-lock-mode t)
468 There are a number of support modes that may be used to speed up Font Lock mode
469 in various ways, specified via the variable `font-lock-support-mode'. Where
470 major modes support different levels of fontification, you can use the variable
471 `font-lock-maximum-decoration' to specify which level you generally prefer.
472 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
473 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
475 For example, to specify that Font Lock mode use use Lazy Lock mode as a support
476 mode and use maximum levels of fontification, put in your ~/.emacs:
478 (setq font-lock-support-mode 'lazy-lock-mode)
479 (setq font-lock-maximum-decoration t)
481 To fontify a buffer, without turning on Font Lock mode and regardless of buffer
482 size, you can use \\[font-lock-fontify-buffer].
484 To fontify a block (the function or paragraph containing point, or a number of
485 lines around point), perhaps because modification on the current line caused
486 syntactic change on other lines, you can use \\[font-lock-fontify-block].
488 The default Font Lock mode faces and their attributes are defined in the
489 variable `font-lock-face-attributes', and Font Lock mode default settings in
490 the variable `font-lock-defaults-alist'. You can set your own default settings
491 for some mode, by setting a buffer local value for `font-lock-defaults', via
494 ;; Don't turn on Font Lock mode if we don't have a display (we're running a
495 ;; batch job) or if the buffer is invisible (the name starts with a space).
496 (let ((on-p (and (not noninteractive)
497 (not (eq (aref (buffer-name) 0) ?\ ))
499 (> (prefix-numeric-value arg) 0)
500 (not font-lock-mode)))))
501 (set (make-local-variable 'font-lock-mode) on-p)
502 ;; Turn on Font Lock mode.
504 (font-lock-set-defaults)
505 (unless (eq font-lock-fontify-region-function 'ignore)
506 (make-local-hook 'after-change-functions)
507 (add-hook 'after-change-functions 'font-lock-after-change-function nil t))
508 (font-lock-turn-on-thing-lock)
509 (run-hooks 'font-lock-mode-hook)
510 ;; Fontify the buffer if we have to.
511 (let ((max-size (font-lock-value-in-major-mode font-lock-maximum-size)))
512 (cond (font-lock-fontified
514 ((or (null max-size) (> max-size (buffer-size)))
515 (font-lock-fontify-buffer))
517 (message "Fontifying %s...buffer too big" (buffer-name))))))
518 ;; Turn off Font Lock mode.
520 (remove-hook 'after-change-functions 'font-lock-after-change-function t)
521 (font-lock-unfontify-buffer)
522 (font-lock-turn-off-thing-lock)
523 (font-lock-unset-defaults))
524 (force-mode-line-update)))
527 (defun turn-on-font-lock ()
528 "Turn on Font Lock mode conditionally.
529 Turn on only if the terminal can display it."
533 ;; Global Font Lock mode.
535 ;; A few people have hassled in the past for a way to make it easier to turn on
536 ;; Font Lock mode, without the user needing to know for which modes s/he has to
537 ;; turn it on, perhaps the same way hilit19.el/hl319.el does. I've always
538 ;; balked at that way, as I see it as just re-moulding the same problem in
539 ;; another form. That is; some person would still have to keep track of which
540 ;; modes (which may not even be distributed with Emacs) support Font Lock mode.
541 ;; The list would always be out of date. And that person might have to be me.
545 ;; In a previous discussion the following hack came to mind. It is a gross
546 ;; hack, but it generally works. We use the convention that major modes start
547 ;; by calling the function `kill-all-local-variables', which in turn runs
548 ;; functions on the hook variable `change-major-mode-hook'. We attach our
549 ;; function `font-lock-change-major-mode' to that hook. Of course, when this
550 ;; hook is run, the major mode is in the process of being changed and we do not
551 ;; know what the final major mode will be. So, `font-lock-change-major-mode'
552 ;; only (a) notes the name of the current buffer, and (b) adds our function
553 ;; `turn-on-font-lock-if-enabled' to the hook variables `find-file-hooks' and
554 ;; `post-command-hook' (for buffers that are not visiting files). By the time
555 ;; the functions on the first of these hooks to be run are run, the new major
556 ;; mode is assumed to be in place. This way we get a Font Lock function run
557 ;; when a major mode is turned on, without knowing major modes or their hooks.
559 ;; Naturally this requires that (a) major modes run `kill-all-local-variables',
560 ;; as they are supposed to do, and (b) the major mode is in place after the
561 ;; file is visited or the command that ran `kill-all-local-variables' has
562 ;; finished, whichever the sooner. Arguably, any major mode that does not
563 ;; follow the convension (a) is broken, and I can't think of any reason why (b)
564 ;; would not be met (except `gnudoit' on non-files). However, it is not clean.
566 ;; Probably the cleanest solution is to have each major mode function run some
567 ;; hook, e.g., `major-mode-hook', but maybe implementing that change is
568 ;; impractical. I am personally against making `setq' a macro or be advised,
569 ;; or have a special function such as `set-major-mode', but maybe someone can
570 ;; come up with another solution?
574 ;; Although Global Font Lock mode is a pseudo-mode, I think that the user
575 ;; interface should conform to the usual Emacs convention for modes, i.e., a
576 ;; command to toggle the feature (`global-font-lock-mode') with a variable for
577 ;; finer control of the mode's behaviour (`font-lock-global-modes').
579 ;; I don't think it is better that the feature be enabled via a variable, since
580 ;; it does not conform to the usual convention. I don't think the feature
581 ;; should be enabled by loading font-lock.el, since other mechanisms such as
582 ;; M-x font-lock-mode RET or (add-hook 'c-mode-hook 'turn-on-font-lock) would
583 ;; cause Font Lock mode to be turned on everywhere, and it is not intuitive or
584 ;; informative because loading a file tells you nothing about the feature or
585 ;; how to control it. It would be contrary to the Principle of Least Surprise.
587 (defvar font-lock-buffers nil) ; For remembering buffers.
588 (defvar global-font-lock-mode nil)
591 (defvar font-lock-global-modes t
592 "*Modes for which Font Lock mode is automagically turned on.
593 Global Font Lock mode is controlled by the `global-font-lock-mode' command.
594 If nil, means no modes have Font Lock mode automatically turned on.
595 If t, all modes that support Font Lock mode have it automatically turned on.
596 If a list, it should be a list of `major-mode' symbol names for which Font Lock
597 mode should be automatically turned on. The sense of the list is negated if it
598 begins with `not'. For example:
600 means that Font Lock mode is turned on for buffers in C and C++ modes only.")
603 (defun global-font-lock-mode (&optional arg message)
604 "Toggle Global Font Lock mode.
605 With prefix ARG, turn Global Font Lock mode on if and only if ARG is positive.
606 Displays a message saying whether the mode is on or off if MESSAGE is non-nil.
607 Returns the new status of Global Font Lock mode (non-nil means on).
609 When Global Font Lock mode is enabled, Font Lock mode is automagically
610 turned on in a buffer if its major mode is one of `font-lock-global-modes'."
613 (<= (prefix-numeric-value arg) 0)
614 global-font-lock-mode)))
616 (remove-hook 'find-file-hooks 'turn-on-font-lock-if-enabled)
617 (add-hook 'find-file-hooks 'turn-on-font-lock-if-enabled)
618 (add-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
619 (setq font-lock-buffers (buffer-list)))
621 (message "Global Font Lock mode is now %s." (if off-p "OFF" "ON")))
622 (setq global-font-lock-mode (not off-p))))
624 (defun font-lock-change-major-mode ()
625 ;; Turn off Font Lock mode if it's on.
627 (font-lock-mode nil))
628 ;; Gross hack warning: Delicate readers should avert eyes now.
629 ;; Something is running `kill-all-local-variables', which generally means the
630 ;; major mode is being changed. Run `turn-on-font-lock-if-enabled' after the
631 ;; file is visited or the current command has finished.
632 (when global-font-lock-mode
633 (add-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
634 (add-to-list 'font-lock-buffers (current-buffer))))
636 (defun turn-on-font-lock-if-enabled ()
637 ;; Gross hack warning: Delicate readers should avert eyes now.
638 ;; Turn on Font Lock mode if it's supported by the major mode and enabled by
640 (remove-hook 'post-command-hook 'turn-on-font-lock-if-enabled)
641 (while font-lock-buffers
642 (if (buffer-live-p (car font-lock-buffers))
644 (set-buffer (car font-lock-buffers))
645 (if (and (or font-lock-defaults
646 (assq major-mode font-lock-defaults-alist))
647 (or (eq font-lock-global-modes t)
648 (if (eq (car-safe font-lock-global-modes) 'not)
649 (not (memq major-mode (cdr font-lock-global-modes)))
650 (memq major-mode font-lock-global-modes))))
652 (turn-on-font-lock)))))
653 (setq font-lock-buffers (cdr font-lock-buffers))))
655 (add-hook 'change-major-mode-hook 'font-lock-change-major-mode)
657 ;; End of Global Font Lock mode.
659 ;; Font Lock Support mode.
661 ;; This is the code used to interface font-lock.el with any of its add-on
662 ;; packages, and provide the user interface. Packages that have their own
663 ;; local buffer fontification functions (see below) may have to call
664 ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer'
668 (defvar font-lock-support-mode nil
669 "*Support mode for Font Lock mode.
670 Support modes speed up Font Lock mode by being choosy about when fontification
671 occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode') and
672 Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info.
673 If nil, means support for Font Lock mode is never performed.
674 If a symbol, use that support mode.
675 If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE),
676 where MAJOR-MODE is a symbol or t (meaning the default). For example:
677 ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode))
678 means that Fast Lock mode is used to support Font Lock mode for buffers in C or
679 C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise.
681 The value of this variable is used when Font Lock mode is turned on.")
683 (defun font-lock-turn-on-thing-lock ()
684 (let ((thing-mode (font-lock-value-in-major-mode font-lock-support-mode)))
685 (cond ((eq thing-mode 'fast-lock-mode)
687 ((eq thing-mode 'lazy-lock-mode)
688 (lazy-lock-mode t)))))
690 (defvar fast-lock-mode nil)
691 (defvar lazy-lock-mode nil)
693 (defun font-lock-turn-off-thing-lock ()
694 (cond (fast-lock-mode
695 (fast-lock-mode nil))
697 (lazy-lock-mode nil))))
699 (defun font-lock-after-fontify-buffer ()
700 (cond (fast-lock-mode
701 (fast-lock-after-fontify-buffer))
703 (lazy-lock-after-fontify-buffer))))
705 (defun font-lock-after-unfontify-buffer ()
706 (cond (fast-lock-mode
707 (fast-lock-after-unfontify-buffer))
709 (lazy-lock-after-unfontify-buffer))))
711 ;; End of Font Lock Support mode.
713 ;; Fontification functions.
716 (defun font-lock-fontify-buffer ()
717 "Fontify the current buffer the way `font-lock-mode' would."
719 (let ((font-lock-verbose (or font-lock-verbose (interactive-p))))
720 (funcall font-lock-fontify-buffer-function)))
722 (defun font-lock-unfontify-buffer ()
723 (funcall font-lock-unfontify-buffer-function))
725 (defun font-lock-fontify-region (beg end &optional loudly)
726 (funcall font-lock-fontify-region-function beg end loudly))
728 (defun font-lock-unfontify-region (beg end)
729 (funcall font-lock-unfontify-region-function beg end))
731 (defun font-lock-default-fontify-buffer ()
732 (let ((verbose (if (numberp font-lock-verbose)
733 (> (buffer-size) font-lock-verbose)
735 (if verbose (message "Fontifying %s..." (buffer-name)))
736 ;; Make sure we have the right `font-lock-keywords' etc.
737 (if (not font-lock-mode) (font-lock-set-defaults))
738 ;; Make sure we fontify etc. in the whole buffer.
744 (font-lock-fontify-region (point-min) (point-max) verbose)
745 (font-lock-after-fontify-buffer)
746 (setq font-lock-fontified t)))
747 ;; We don't restore the old fontification, so it's best to unfontify.
748 (quit (font-lock-unfontify-buffer))))
749 (if verbose (message "Fontifying %s...%s" (buffer-name)
750 (if font-lock-fontified "done" "aborted")))))
752 (defun font-lock-default-unfontify-buffer ()
755 (font-lock-unfontify-region (point-min) (point-max))
756 (font-lock-after-unfontify-buffer)
757 (setq font-lock-fontified nil)))
759 ;; We use this wrapper. However, `font-lock-fontify-region' used to be the
760 ;; name used for `font-lock-fontify-syntactically-region', so a change isn't
761 ;; back-compatible. But you shouldn't be calling these directly, should you?
762 (defun font-lock-default-fontify-region (beg end loudly)
763 (let ((modified (buffer-modified-p))
764 (buffer-undo-list t) (inhibit-read-only t)
765 (old-syntax-table (syntax-table))
766 before-change-functions after-change-functions
767 buffer-file-name buffer-file-truename)
771 ;; Use the fontification syntax table, if any.
772 (if font-lock-syntax-table (set-syntax-table font-lock-syntax-table))
773 ;; Now do the fontification.
774 (if font-lock-keywords-only
775 (font-lock-unfontify-region beg end)
776 (font-lock-fontify-syntactically-region beg end loudly))
777 (font-lock-fontify-keywords-region beg end loudly))
779 (set-syntax-table old-syntax-table)
780 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil)))))
782 ;; The following must be rethought, since keywords can override fontification.
783 ; ;; Now scan for keywords, but not if we are inside a comment now.
784 ; (or (and (not font-lock-keywords-only)
785 ; (let ((state (parse-partial-sexp beg end nil nil
786 ; font-lock-cache-state)))
787 ; (or (nth 4 state) (nth 7 state))))
788 ; (font-lock-fontify-keywords-region beg end))
790 (defun font-lock-default-unfontify-region (beg end)
791 (let ((modified (buffer-modified-p))
792 (buffer-undo-list t) (inhibit-read-only t)
793 before-change-functions after-change-functions
794 buffer-file-name buffer-file-truename)
795 (remove-text-properties beg end '(face nil))
796 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil))))
798 ;; Called when any modification is made to buffer text.
799 (defun font-lock-after-change-function (beg end old-len)
802 ;; Rescan between start of line from `beg' and start of line after `end'.
803 (font-lock-fontify-region
804 (progn (goto-char beg) (beginning-of-line) (point))
805 (progn (goto-char end) (forward-line 1) (point))))))
807 (defun font-lock-fontify-block (&optional arg)
808 "Fontify some lines the way `font-lock-fontify-buffer' would.
809 The lines could be a function or paragraph, or a specified number of lines.
810 If ARG is given, fontify that many lines before and after point, or 16 lines if
811 no ARG is given and `font-lock-mark-block-function' is nil.
812 If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to
813 delimit the region to fontify."
815 (let (font-lock-beginning-of-syntax-function deactivate-mark)
816 ;; Make sure we have the right `font-lock-keywords' etc.
817 (if (not font-lock-mode) (font-lock-set-defaults))
820 (condition-case error-data
821 (if (or arg (not font-lock-mark-block-function))
822 (let ((lines (if arg (prefix-numeric-value arg) 16)))
823 (font-lock-fontify-region
824 (save-excursion (forward-line (- lines)) (point))
825 (save-excursion (forward-line lines) (point))))
826 (funcall font-lock-mark-block-function)
827 (font-lock-fontify-region (point) (mark)))
828 ((error quit) (message "Fontifying block...%s" error-data)))))))
830 (define-key facemenu-keymap "\M-g" 'font-lock-fontify-block)
832 ;; Syntactic fontification functions.
834 ;; These record the parse state at a particular position, always the start of a
835 ;; line. Used to make `font-lock-fontify-syntactically-region' faster.
836 (defvar font-lock-cache-position nil)
837 (defvar font-lock-cache-state nil)
838 (make-variable-buffer-local 'font-lock-cache-position)
839 (make-variable-buffer-local 'font-lock-cache-state)
841 (defun font-lock-fontify-syntactically-region (start end &optional loudly)
842 "Put proper face on each string and comment between START and END.
843 START should be at the beginning of a line."
844 (let ((synstart (cond (font-lock-comment-start-regexp
845 (concat "\\s\"\\|" font-lock-comment-start-regexp))
847 (concat "\\s\"\\|" comment-start-skip))
850 (comstart (cond (font-lock-comment-start-regexp
851 font-lock-comment-start-regexp)
853 (concat "\\s<\\|" comment-start-skip))
856 state prev prevstate)
857 (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
860 ;; Find the state at the `beginning-of-line' before `start'.
861 (if (eq start font-lock-cache-position)
862 ;; Use the cache for the state of `start'.
863 (setq state font-lock-cache-state)
864 ;; Find the state of `start'.
865 (if (null font-lock-beginning-of-syntax-function)
866 ;; Use the state at the previous cache position, if any, or
867 ;; otherwise calculate from `point-min'.
868 (if (or (null font-lock-cache-position)
869 (< start font-lock-cache-position))
870 (setq state (parse-partial-sexp (point-min) start))
871 (setq state (parse-partial-sexp font-lock-cache-position start
872 nil nil font-lock-cache-state)))
873 ;; Call the function to move outside any syntactic block.
874 (funcall font-lock-beginning-of-syntax-function)
875 (setq state (parse-partial-sexp (point) start)))
876 ;; Cache the state and position of `start'.
877 (setq font-lock-cache-state state
878 font-lock-cache-position start))
880 ;; If the region starts inside a string, show the extent of it.
883 (while (and (re-search-forward "\\s\"" end 'move)
884 (nth 3 (parse-partial-sexp beg (point) nil nil state))))
885 (put-text-property beg (point) 'face font-lock-string-face)
886 (setq state (parse-partial-sexp beg (point) nil nil state))))
888 ;; Likewise for a comment.
889 (if (or (nth 4 state) (nth 7 state))
892 (narrow-to-region (point-min) end)
895 (re-search-backward comstart (point-min) 'move)
897 ;; forward-comment skips all whitespace,
898 ;; so go back to the real end of the comment.
899 (skip-chars-backward " \t"))
900 (error (goto-char end))))
901 (put-text-property beg (point) 'face font-lock-comment-face)
902 (setq state (parse-partial-sexp beg (point) nil nil state))))
904 ;; Find each interesting place between here and `end'.
905 (while (and (< (point) end)
906 (setq prev (point) prevstate state)
907 (re-search-forward synstart end t)
909 ;; Clear out the fonts of what we skip over.
910 (remove-text-properties prev (point) '(face nil))
911 ;; Verify the state at that place
912 ;; so we don't get fooled by \" or \;.
913 (setq state (parse-partial-sexp prev (point)
915 (let ((here (point)))
916 (if (or (nth 4 state) (nth 7 state))
918 ;; We found a real comment start.
919 (let ((beg (or (match-end 1) (match-beginning 0))))
922 (narrow-to-region (point-min) end)
926 ;; forward-comment skips all whitespace,
927 ;; so go back to the real end of the comment.
928 (skip-chars-backward " \t"))
929 (error (goto-char end))))
930 (put-text-property beg (point) 'face font-lock-comment-face)
931 (setq state (parse-partial-sexp here (point) nil nil state)))
934 ;; We found a real string start.
935 (let ((beg (or (match-end 1) (match-beginning 0))))
936 (while (and (re-search-forward "\\s\"" end 'move)
937 (nth 3 (parse-partial-sexp here (point)
939 (put-text-property beg (point) 'face font-lock-string-face)
940 (setq state (parse-partial-sexp here (point)
943 ;; Make sure `prev' is non-nil after the loop
944 ;; only if it was set on the very last iteration.
948 (and prev (remove-text-properties prev end '(face nil)))))
950 ;;; Additional text property functions.
952 ;; The following three text property functions are not generally available (and
953 ;; it's not certain that they should be) so they are inlined for speed.
954 ;; The case for `fillin-text-property' is simple; it may or not be generally
955 ;; useful. (Since it is used here, it is useful in at least one place.;-)
956 ;; However, the case for `append-text-property' and `prepend-text-property' is
957 ;; more complicated. Should they remove duplicate property values or not? If
958 ;; so, should the first or last duplicate item remain? Or the one that was
959 ;; added? In our implementation, the first duplicate remains.
961 (defsubst font-lock-fillin-text-property (start end prop value &optional object)
962 "Fill in one property of the text from START to END.
963 Arguments PROP and VALUE specify the property and value to put where none are
964 already in place. Therefore existing property values are not overwritten.
965 Optional argument OBJECT is the string or buffer containing the text."
966 (let ((start (text-property-any start end prop nil object)) next)
968 (setq next (next-single-property-change start prop object end))
969 (put-text-property start next prop value object)
970 (setq start (text-property-any next end prop nil object)))))
972 ;; This function (from simon's unique.el) is rewritten and inlined for speed.
973 ;(defun unique (list function)
974 ; "Uniquify LIST, deleting elements using FUNCTION.
975 ;Return the list with subsequent duplicate items removed by side effects.
976 ;FUNCTION is called with an element of LIST and a list of elements from LIST,
977 ;and should return the list of elements with occurrences of the element removed,
978 ;i.e., a function such as `delete' or `delq'.
979 ;This function will work even if LIST is unsorted. See also `uniq'."
982 ; (setq list (setcdr list (funcall function (car list) (cdr list))))))
985 (defsubst font-lock-unique (list)
986 "Uniquify LIST, deleting elements using `delq'.
987 Return the list with subsequent duplicate items removed by side effects."
990 (setq list (setcdr list (delq (car list) (cdr list))))))
993 ;; A generalisation of `facemenu-add-face' for any property, but without the
994 ;; removal of inactive faces via `facemenu-discard-redundant-faces' and special
995 ;; treatment of `default'. Uses `unique' to remove duplicate property values.
996 (defsubst font-lock-prepend-text-property (start end prop value &optional object)
997 "Prepend to one property of the text from START to END.
998 Arguments PROP and VALUE specify the property and value to prepend to the value
999 already in place. The resulting property values are always lists, and unique.
1000 Optional argument OBJECT is the string or buffer containing the text."
1001 (let ((val (if (listp value) value (list value))) next prev)
1002 (while (/= start end)
1003 (setq next (next-single-property-change start prop object end)
1004 prev (get-text-property start prop object))
1007 (font-lock-unique (append val (if (listp prev) prev (list prev))))
1009 (setq start next))))
1011 (defsubst font-lock-append-text-property (start end prop value &optional object)
1012 "Append to one property of the text from START to END.
1013 Arguments PROP and VALUE specify the property and value to append to the value
1014 already in place. The resulting property values are always lists, and unique.
1015 Optional argument OBJECT is the string or buffer containing the text."
1016 (let ((val (if (listp value) value (list value))) next prev)
1017 (while (/= start end)
1018 (setq next (next-single-property-change start prop object end)
1019 prev (get-text-property start prop object))
1022 (font-lock-unique (append (if (listp prev) prev (list prev)) val))
1024 (setq start next))))
1026 ;;; Regexp fontification functions.
1028 (defsubst font-lock-apply-highlight (highlight)
1029 "Apply HIGHLIGHT following a match.
1030 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1031 (let* ((match (nth 0 highlight))
1032 (start (match-beginning match)) (end (match-end match))
1033 (override (nth 2 highlight)))
1035 ;; No match but we might not signal an error.
1036 (or (nth 3 highlight)
1037 (error "No match %d in highlight %S" match highlight)))
1039 ;; Cannot override existing fontification.
1040 (or (text-property-not-all start end 'face nil)
1041 (put-text-property start end 'face (eval (nth 1 highlight)))))
1043 ;; Override existing fontification.
1044 (put-text-property start end 'face (eval (nth 1 highlight))))
1045 ((eq override 'keep)
1046 ;; Keep existing fontification.
1047 (font-lock-fillin-text-property start end 'face
1048 (eval (nth 1 highlight))))
1049 ((eq override 'prepend)
1050 ;; Prepend to existing fontification.
1051 (font-lock-prepend-text-property start end 'face
1052 (eval (nth 1 highlight))))
1053 ((eq override 'append)
1054 ;; Append to existing fontification.
1055 (font-lock-append-text-property start end 'face
1056 (eval (nth 1 highlight)))))))
1058 (defsubst font-lock-fontify-anchored-keywords (keywords limit)
1059 "Fontify according to KEYWORDS until LIMIT.
1060 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords'."
1061 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights)
1062 ;; Until we come up with a cleaner solution, we make LIMIT the end of line.
1063 (save-excursion (end-of-line) (setq limit (min limit (point))))
1064 ;; Evaluate PRE-MATCH-FORM.
1065 (eval (nth 1 keywords))
1067 ;; Find an occurrence of `matcher' before `limit'.
1068 (while (if (stringp matcher)
1069 (re-search-forward matcher limit t)
1070 (funcall matcher limit))
1071 ;; Apply each highlight to this instance of `matcher'.
1072 (setq highlights lowdarks)
1074 (font-lock-apply-highlight (car highlights))
1075 (setq highlights (cdr highlights)))))
1076 ;; Evaluate POST-MATCH-FORM.
1077 (eval (nth 2 keywords))))
1079 (defun font-lock-fontify-keywords-region (start end &optional loudly)
1080 "Fontify according to `font-lock-keywords' between START and END.
1081 START should be at the beginning of a line."
1082 (let ((case-fold-search font-lock-keywords-case-fold-search)
1083 (keywords (cdr (if (eq (car-safe font-lock-keywords) t)
1085 (font-lock-compile-keywords))))
1086 (bufname (buffer-name)) (count 0)
1087 keyword matcher highlights)
1089 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1091 (if loudly (message "Fontifying %s... (regexps..%s)" bufname
1092 (make-string (setq count (1+ count)) ?.)))
1094 ;; Find an occurrence of `matcher' from `start' to `end'.
1095 (setq keyword (car keywords) matcher (car keyword))
1097 (while (if (stringp matcher)
1098 (re-search-forward matcher end t)
1099 (funcall matcher end))
1100 ;; Apply each highlight to this instance of `matcher', which may be
1101 ;; specific highlights or more keywords anchored to `matcher'.
1102 (setq highlights (cdr keyword))
1104 (if (numberp (car (car highlights)))
1105 (font-lock-apply-highlight (car highlights))
1106 (font-lock-fontify-anchored-keywords (car highlights) end))
1107 (setq highlights (cdr highlights))))
1108 (setq keywords (cdr keywords)))))
1110 ;; Various functions.
1112 (defun font-lock-compile-keywords (&optional keywords)
1113 ;; Compile `font-lock-keywords' into the form (t KEYWORD ...) where KEYWORD
1114 ;; is the (MATCHER HIGHLIGHT ...) shown in the variable's doc string.
1115 (let ((keywords (or keywords font-lock-keywords)))
1116 (setq font-lock-keywords
1117 (if (eq (car-safe keywords) t)
1119 (cons t (mapcar 'font-lock-compile-keyword keywords))))))
1121 (defun font-lock-compile-keyword (keyword)
1122 (cond ((nlistp keyword) ; Just MATCHER
1123 (list keyword '(0 font-lock-keyword-face)))
1124 ((eq (car keyword) 'eval) ; Specified (eval . FORM)
1125 (font-lock-compile-keyword (eval (cdr keyword))))
1126 ((numberp (cdr keyword)) ; Specified (MATCHER . MATCH)
1127 (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
1128 ((symbolp (cdr keyword)) ; Specified (MATCHER . FACENAME)
1129 (list (car keyword) (list 0 (cdr keyword))))
1130 ((nlistp (nth 1 keyword)) ; Specified (MATCHER . HIGHLIGHT)
1131 (list (car keyword) (cdr keyword)))
1132 (t ; Hopefully (MATCHER HIGHLIGHT ...)
1135 (defun font-lock-value-in-major-mode (alist)
1136 ;; Return value in ALIST for `major-mode', or ALIST if it is not an alist.
1137 ;; Alist structure is ((MAJOR-MODE . VALUE)) where MAJOR-MODE may be t.
1139 (cdr (or (assq major-mode alist) (assq t alist)))
1142 (defun font-lock-choose-keywords (keywords level)
1143 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1144 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
1145 (cond ((symbolp keywords)
1148 (or (nth level keywords) (car (reverse keywords))))
1150 (car (reverse keywords)))
1154 (defun font-lock-set-defaults ()
1155 "Set fontification defaults appropriately for this mode.
1156 Sets various variables using `font-lock-defaults' (or, if nil, using
1157 `font-lock-defaults-alist') and `font-lock-maximum-decoration'."
1158 ;; Set face defaults.
1159 (font-lock-make-faces)
1160 ;; Set fontification defaults.
1161 (make-local-variable 'font-lock-fontified)
1162 (if (member font-lock-keywords '(nil (t)))
1163 (let* ((defaults (or font-lock-defaults
1164 (cdr (assq major-mode font-lock-defaults-alist))))
1166 (font-lock-choose-keywords (nth 0 defaults)
1167 (font-lock-value-in-major-mode font-lock-maximum-decoration))))
1168 ;; Regexp fontification?
1169 (setq font-lock-keywords (if (fboundp keywords)
1172 ;; Syntactic fontification?
1173 (if (nth 1 defaults)
1174 (set (make-local-variable 'font-lock-keywords-only) t))
1175 ;; Case fold during regexp fontification?
1176 (if (nth 2 defaults)
1177 (set (make-local-variable 'font-lock-keywords-case-fold-search) t))
1178 ;; Syntax table for regexp and syntactic fontification?
1179 (if (nth 3 defaults)
1180 (let ((slist (nth 3 defaults)))
1181 (set (make-local-variable 'font-lock-syntax-table)
1182 (copy-syntax-table (syntax-table)))
1184 ;; The character to modify may be a single CHAR or a STRING.
1185 (let ((chars (if (numberp (car (car slist)))
1186 (list (car (car slist)))
1187 (mapcar 'identity (car (car slist)))))
1188 (syntax (cdr (car slist))))
1190 (modify-syntax-entry (car chars) syntax
1191 font-lock-syntax-table)
1192 (setq chars (cdr chars)))
1193 (setq slist (cdr slist))))))
1194 ;; Syntax function for syntactic fontification?
1195 (if (nth 4 defaults)
1196 (set (make-local-variable 'font-lock-beginning-of-syntax-function)
1199 (let ((alist (nthcdr 5 defaults)))
1201 (set (make-local-variable (car (car alist))) (cdr (car alist)))
1202 (setq alist (cdr alist)))))))
1204 (defun font-lock-unset-defaults ()
1205 "Unset fontification defaults. See `font-lock-set-defaults'."
1206 (setq font-lock-keywords nil
1207 font-lock-keywords-only nil
1208 font-lock-keywords-case-fold-search nil
1209 font-lock-syntax-table nil
1210 font-lock-beginning-of-syntax-function nil)
1211 (let* ((defaults (or font-lock-defaults
1212 (cdr (assq major-mode font-lock-defaults-alist))))
1213 (alist (nthcdr 5 defaults)))
1215 (set (car (car alist)) (default-value (car (car alist))))
1216 (setq alist (cdr alist)))))
1218 ;; Colour etc. support.
1220 ;; This section of code is crying out for revision.
1222 ;; To begin with, `display-type' and `background-mode' are `frame-parameters'
1223 ;; so we don't have to calculate them here anymore. But all the face stuff
1224 ;; should be frame-local (and thus display-local) anyway. Because we're not
1225 ;; sure what support Emacs is going to have for general frame-local face
1226 ;; attributes, we leave this section of code as it is. For now. --sm.
1228 (defvar font-lock-display-type nil
1229 "A symbol indicating the display Emacs is running under.
1230 The symbol should be one of `color', `grayscale' or `mono'.
1231 If Emacs guesses this display attribute wrongly, either set this variable in
1232 your `~/.emacs' or set the resource `Emacs.displayType' in your `~/.Xdefaults'.
1233 See also `font-lock-background-mode' and `font-lock-face-attributes'.")
1235 (defvar font-lock-background-mode nil
1236 "A symbol indicating the Emacs background brightness.
1237 The symbol should be one of `light' or `dark'.
1238 If Emacs guesses this frame attribute wrongly, either set this variable in
1239 your `~/.emacs' or set the resource `Emacs.backgroundMode' in your
1241 See also `font-lock-display-type' and `font-lock-face-attributes'.")
1243 (defvar font-lock-face-attributes nil
1244 "A list of default attributes to use for face attributes.
1245 Each element of the list should be of the form
1247 (FACE FOREGROUND BACKGROUND BOLD-P ITALIC-P UNDERLINE-P)
1249 where FACE should be one of the face symbols `font-lock-comment-face',
1250 `font-lock-string-face', `font-lock-keyword-face', `font-lock-type-face',
1251 `font-lock-function-name-face', `font-lock-variable-name-face', and
1252 `font-lock-reference-face'. A form for each of these face symbols should be
1253 provided in the list, but other face symbols and attributes may be given and
1254 used in highlighting. See `font-lock-keywords'.
1256 Subsequent element items should be the attributes for the corresponding
1257 Font Lock mode faces. Attributes FOREGROUND and BACKGROUND should be strings
1258 \(default if nil), while BOLD-P, ITALIC-P, and UNDERLINE-P should specify the
1259 corresponding face attributes (yes if non-nil).
1261 Emacs uses default attributes based on display type and background brightness.
1262 See variables `font-lock-display-type' and `font-lock-background-mode'.
1264 Resources can be used to over-ride these face attributes. For example, the
1265 resource `Emacs.font-lock-comment-face.attributeUnderline' can be used to
1266 specify the UNDERLINE-P attribute for face `font-lock-comment-face'.")
1268 (defun font-lock-make-faces (&optional override)
1269 "Make faces from `font-lock-face-attributes'.
1270 A default list is used if this is nil.
1271 If optional OVERRIDE is non-nil, faces that already exist are reset.
1272 See `font-lock-make-face' and `list-faces-display'."
1273 ;; We don't need to `setq' any of these variables, but the user can see what
1274 ;; is being used if we do.
1275 (if (null font-lock-display-type)
1276 (setq font-lock-display-type
1277 (let ((display-resource (x-get-resource ".displayType"
1279 (cond (display-resource (intern (downcase display-resource)))
1280 ((x-display-color-p) 'color)
1281 ((x-display-grayscale-p) 'grayscale)
1283 (if (null font-lock-background-mode)
1284 (setq font-lock-background-mode
1285 (let ((bg-resource (x-get-resource ".backgroundMode"
1287 (params (frame-parameters)))
1288 (cond (bg-resource (intern (downcase bg-resource)))
1289 ((eq system-type 'ms-dos)
1290 (if (string-match "light"
1291 (cdr (assq 'background-color params)))
1294 ((< (apply '+ (x-color-values
1295 (cdr (assq 'background-color params))))
1296 (* (apply '+ (x-color-values "white")) .6))
1299 (if (null font-lock-face-attributes)
1300 (setq font-lock-face-attributes
1301 (let ((light-bg (eq font-lock-background-mode 'light)))
1302 (cond ((memq font-lock-display-type '(mono monochrome))
1303 ;; Emacs 19.25's font-lock defaults:
1304 ;;'((font-lock-comment-face nil nil nil t nil)
1305 ;; (font-lock-string-face nil nil nil nil t)
1306 ;; (font-lock-keyword-face nil nil t nil nil)
1307 ;; (font-lock-function-name-face nil nil t t nil)
1308 ;; (font-lock-type-face nil nil nil t nil))
1309 (list '(font-lock-comment-face nil nil t t nil)
1310 '(font-lock-string-face nil nil nil t nil)
1311 '(font-lock-keyword-face nil nil t nil nil)
1313 'font-lock-function-name-face
1314 (cdr (assq 'background-color (frame-parameters)))
1315 (cdr (assq 'foreground-color (frame-parameters)))
1317 '(font-lock-variable-name-face nil nil t t nil)
1318 '(font-lock-type-face nil nil t nil t)
1319 '(font-lock-reference-face nil nil t nil t)))
1320 ((memq font-lock-display-type '(grayscale greyscale
1321 grayshade greyshade))
1323 (list 'font-lock-comment-face
1324 nil (if light-bg "Gray80" "DimGray") t t nil)
1325 (list 'font-lock-string-face
1326 nil (if light-bg "Gray50" "LightGray") nil t nil)
1327 (list 'font-lock-keyword-face
1328 nil (if light-bg "Gray90" "DimGray") t nil nil)
1329 (list 'font-lock-function-name-face
1330 (cdr (assq 'background-color (frame-parameters)))
1331 (cdr (assq 'foreground-color (frame-parameters)))
1333 (list 'font-lock-variable-name-face
1334 nil (if light-bg "Gray90" "DimGray") t t nil)
1335 (list 'font-lock-type-face
1336 nil (if light-bg "Gray80" "DimGray") t nil t)
1337 (list 'font-lock-reference-face
1338 nil (if light-bg "LightGray" "Gray50") t nil t)))
1339 (light-bg ; light colour background
1340 '((font-lock-comment-face "Firebrick")
1341 (font-lock-string-face "RosyBrown")
1342 (font-lock-keyword-face "Purple")
1343 (font-lock-function-name-face "Blue")
1344 (font-lock-variable-name-face "DarkGoldenrod")
1345 (font-lock-type-face "DarkOliveGreen")
1346 (font-lock-reference-face "CadetBlue")))
1347 (t ; dark colour background
1348 '((font-lock-comment-face "OrangeRed")
1349 (font-lock-string-face "LightSalmon")
1350 (font-lock-keyword-face "LightSteelBlue")
1351 (font-lock-function-name-face "LightSkyBlue")
1352 (font-lock-variable-name-face "LightGoldenrod")
1353 (font-lock-type-face "PaleGreen")
1354 (font-lock-reference-face "Aquamarine")))))))
1355 ;; Now make the faces if we have to.
1357 (lambda (face-attributes)
1358 (let ((face (nth 0 face-attributes)))
1360 ;; We can stomp all over it anyway. Get outta my face!
1361 (font-lock-make-face face-attributes))
1362 ((and (boundp face) (facep (symbol-value face)))
1363 ;; The variable exists and is already bound to a face.
1366 ;; We already have a face so we bind the variable to it.
1369 ;; No variable or no face.
1370 (font-lock-make-face face-attributes))))))
1371 font-lock-face-attributes))
1373 (defun font-lock-make-face (face-attributes)
1374 "Make a face from FACE-ATTRIBUTES.
1375 FACE-ATTRIBUTES should be like an element `font-lock-face-attributes', so that
1376 the face name is the first item in the list. A variable with the same name as
1377 the face is also set; its value is the face name."
1378 (let* ((face (nth 0 face-attributes))
1379 (face-name (symbol-name face))
1380 (set-p (function (lambda (face-name resource)
1381 (x-get-resource (concat face-name ".attribute" resource)
1382 (concat "Face.Attribute" resource)))))
1383 (on-p (function (lambda (face-name resource)
1384 (let ((set (funcall set-p face-name resource)))
1385 (and set (member (downcase set) '("on" "true"))))))))
1387 (add-to-list 'facemenu-unlisted-faces face)
1388 ;; Set attributes not set from X resources (and therefore `make-face').
1389 (or (funcall set-p face-name "Foreground")
1391 (set-face-foreground face (nth 1 face-attributes))
1393 (or (funcall set-p face-name "Background")
1395 (set-face-background face (nth 2 face-attributes))
1397 (if (funcall set-p face-name "Bold")
1398 (and (funcall on-p face-name "Bold") (make-face-bold face nil t))
1399 (and (nth 3 face-attributes) (make-face-bold face nil t)))
1400 (if (funcall set-p face-name "Italic")
1401 (and (funcall on-p face-name "Italic") (make-face-italic face nil t))
1402 (and (nth 4 face-attributes) (make-face-italic face nil t)))
1403 (or (funcall set-p face-name "Underline")
1404 (set-face-underline-p face (nth 5 face-attributes)))
1407 ;;; Various regexp information shared by several modes.
1408 ;;; Information specific to a single mode should go in its load library.
1410 (defconst lisp-font-lock-keywords-1
1412 ;; Anything not a variable or type declaration is fontified as a function.
1413 ;; It would be cleaner to allow preceding whitespace, but it would also be
1414 ;; about five times slower.
1415 (list (concat "^(\\(def\\("
1416 ;; Variable declarations.
1417 "\\(const\\(\\|ant\\)\\|ine-key\\(\\|-after\\)\\|var\\)\\|"
1418 ;; Structure declarations.
1419 "\\(class\\|struct\\|type\\)\\|"
1420 ;; Everything else is a function declaration.
1421 "\\([^ \t\n\(\)]+\\)"
1423 ;; Any whitespace and declared object.
1426 '(1 font-lock-keyword-face)
1427 '(8 (cond ((match-beginning 3) font-lock-variable-name-face)
1428 ((match-beginning 6) font-lock-type-face)
1429 (t font-lock-function-name-face))
1432 "Subdued level highlighting for Lisp modes.")
1434 (defconst lisp-font-lock-keywords-2
1435 (append lisp-font-lock-keywords-1
1438 ;; Control structures. ELisp and CLisp combined.
1440 ; '("cond" "if" "while" "let\\*?" "prog[nv12*]?" "inline" "catch" "throw"
1441 ; "save-restriction" "save-excursion" "save-window-excursion"
1442 ; "save-selected-window" "save-match-data" "unwind-protect"
1443 ; "condition-case" "track-mouse"
1444 ; "eval-after-load" "eval-and-compile" "eval-when-compile"
1445 ; "when" "unless" "do" "flet" "labels" "return" "return-from"
1446 ; "with-output-to-temp-buffer" "with-timeout"))
1450 "c\\(atch\\|ond\\(\\|ition-case\\)\\)\\|do\\|"
1451 "eval-\\(a\\(fter-load\\|nd-compile\\)\\|when-compile\\)\\|flet\\|"
1452 "i\\(f\\|nline\\)\\|l\\(abels\\|et\\*?\\)\\|prog[nv12*]?\\|"
1453 "return\\(\\|-from\\)\\|save-\\(excursion\\|match-data\\|restriction\\|"
1454 "selected-window\\|window-excursion\\)\\|t\\(hrow\\|rack-mouse\\)\\|"
1455 "un\\(less\\|wind-protect\\)\\|"
1456 "w\\(h\\(en\\|ile\\)\\|ith-\\(output-to-temp-buffer\\|timeout\\)\\)"
1459 ;; Feature symbols as references.
1460 '("(\\(featurep\\|provide\\|require\\)\\>[ \t']*\\(\\sw+\\)?"
1461 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1463 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1464 '("\\\\\\\\\\[\\(\\sw+\\)]" 1 font-lock-reference-face prepend)
1466 ;; Words inside `' tend to be symbol names.
1467 '("`\\(\\sw\\sw+\\)'" 1 font-lock-reference-face prepend)
1469 ;; CLisp `:' keywords as references.
1470 '("\\<:\\sw+\\>" 0 font-lock-reference-face prepend)
1472 ;; ELisp and CLisp `&' keywords as types.
1473 '("\\<\\&\\sw+\\>" . font-lock-type-face)
1475 "Gaudy level highlighting for Lisp modes.")
1477 (defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
1478 "Default expressions to highlight in Lisp modes.")
1481 (defvar scheme-font-lock-keywords
1485 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1486 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1487 (list (concat "(\\(define\\("
1489 "\\(\\|-\\(generic\\(\\|-procedure\\)\\|method\\)\\)\\|"
1490 ;; Macro names, as variable names. A bit dubious, this.
1495 ;; Any whitespace and declared object.
1498 '(1 font-lock-keyword-face)
1499 '(8 (cond ((match-beginning 3) font-lock-function-name-face)
1500 ((match-beginning 6) font-lock-variable-name-face)
1501 (t font-lock-type-face))
1504 ;; Control structures.
1505 ;(make-regexp '("begin" "call-with-current-continuation" "call/cc"
1506 ; "call-with-input-file" "call-with-output-file" "case" "cond"
1507 ; "do" "else" "for-each" "if" "lambda"
1508 ; "let\\*?" "let-syntax" "letrec" "letrec-syntax"
1509 ; ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1510 ; "and" "or" "delay"
1511 ; ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
1512 ; ;;"quasiquote" "quote" "unquote" "unquote-splicing"
1513 ; "map" "syntax" "syntax-rules"))
1516 "and\\|begin\\|c\\(a\\(ll\\(-with-\\(current-continuation\\|"
1517 "input-file\\|output-file\\)\\|/cc\\)\\|se\\)\\|ond\\)\\|"
1518 "d\\(elay\\|o\\)\\|else\\|for-each\\|if\\|"
1519 "l\\(ambda\\|et\\(-syntax\\|\\*?\\|rec\\(\\|-syntax\\)\\)\\)\\|"
1520 "map\\|or\\|syntax\\(\\|-rules\\)"
1523 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
1524 '("\\<<\\sw+>\\>" . font-lock-type-face)
1526 ;; Scheme `:' keywords as references.
1527 '("\\<:\\sw+\\>" . font-lock-reference-face)
1529 "Default expressions to highlight in Scheme modes.")
1532 (defconst c-font-lock-keywords-1 nil
1533 "Subdued level highlighting for C modes.")
1535 (defconst c-font-lock-keywords-2 nil
1536 "Medium level highlighting for C modes.")
1538 (defconst c-font-lock-keywords-3 nil
1539 "Gaudy level highlighting for C modes.")
1541 (defconst c++-font-lock-keywords-1 nil
1542 "Subdued level highlighting for C++ modes.")
1544 (defconst c++-font-lock-keywords-2 nil
1545 "Medium level highlighting for C++ modes.")
1547 (defconst c++-font-lock-keywords-3 nil
1548 "Gaudy level highlighting for C++ modes.")
1550 (defun font-lock-match-c++-style-declaration-item-and-skip-to-next (limit)
1551 ;; Match, and move over, any declaration/definition item after point.
1552 ;; The expect syntax of an item is "word" or "word::word", possibly ending
1553 ;; with optional whitespace and a "(". Everything following the item (but
1554 ;; belonging to it) is expected to by skip-able by `forward-sexp', and items
1555 ;; are expected to be separated with a ",".
1557 ;; The regexp matches: word::word (
1559 ;; Match subexps are: 1 3 4
1561 ;; So, the item is delimited by (match-beginning 1) and (match-end 1).
1562 ;; If (match-beginning 3) is non-nil, that part of the item follows a ":".
1563 ;; If (match-beginning 4) is non-nil, the item is followed by a "(".
1564 (if (looking-at "[ \t*&]*\\(\\sw+\\)\\(::\\(\\sw+\\)\\)?[ \t]*\\((\\)?")
1568 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
1569 (narrow-to-region (point-min) limit)
1570 (goto-char (match-end 1))
1571 ;; Move over any item value, etc., to the next item.
1572 (while (not (looking-at "[ \t]*\\(\\(,\\)\\|;\\|$\\)"))
1573 (goto-char (or (scan-sexps (point) 1) (point-max))))
1574 (goto-char (match-end 2)))
1578 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while")
1579 "break\\|continue\\|do\\|else\\|for\\|if\\|return\\|switch\\|while")
1581 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
1582 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
1583 ; "void" "volatile" "const")
1584 (concat "auto\\|c\\(har\\|onst\\)\\|double\\|e\\(num\\|xtern\\)\\|"
1585 "float\\|int\\|long\\|register\\|"
1586 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|typedef\\|"
1587 "un\\(ion\\|signed\\)\\|vo\\(id\\|latile\\)")) ; 6 ()s deep.
1589 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
1590 ; "asm" "catch" "delete" "new" "operator" "sizeof" "this" "throw" "try"
1591 ; "protected" "private" "public")
1592 (concat "asm\\|break\\|c\\(atch\\|ontinue\\)\\|d\\(elete\\|o\\)\\|"
1593 "else\\|for\\|if\\|new\\|"
1594 "p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|return\\|"
1595 "s\\(izeof\\|witch\\)\\|t\\(h\\(is\\|row\\)\\|ry\\)\\|while"))
1597 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
1598 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
1599 ; "void" "volatile" "const" "class" "inline" "friend" "bool"
1600 ; "virtual" "complex" "template")
1601 (concat "auto\\|bool\\|c\\(har\\|lass\\|o\\(mplex\\|nst\\)\\)\\|"
1602 "double\\|e\\(num\\|xtern\\)\\|f\\(loat\\|riend\\)\\|"
1603 "in\\(line\\|t\\)\\|long\\|register\\|"
1604 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|"
1605 "t\\(emplate\\|ypedef\\)\\|un\\(ion\\|signed\\)\\|"
1606 "v\\(irtual\\|o\\(id\\|latile\\)\\)")) ; 11 ()s deep.
1608 (setq c-font-lock-keywords-1
1611 ;; These are all anchored at the beginning of line for speed.
1613 ;; Fontify function name definitions (GNU style; without type on line).
1614 (list (concat "^\\(\\sw+\\)[ \t]*(") 1 'font-lock-function-name-face)
1616 ;; Fontify filenames in #include <...> preprocessor directives as strings.
1617 '("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
1619 ;; Fontify function macro names.
1620 '("^#[ \t]*define[ \t]+\\(\\sw+\\)(" 1 font-lock-function-name-face)
1622 ;; Fontify symbol names in #elif or #if ... defined preprocessor directives.
1623 '("^#[ \t]*\\(elif\\|if\\)\\>"
1624 ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
1625 (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t)))
1627 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
1628 '("^#[ \t]*\\(\\sw+\\)\\>[ \t]*\\(\\sw+\\)?"
1629 (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t))
1632 (setq c-font-lock-keywords-2
1633 (append c-font-lock-keywords-1
1636 ;; Simple regexps for speed.
1638 ;; Fontify all type specifiers.
1639 (cons (concat "\\<\\(" c-type-types "\\)\\>") 'font-lock-type-face)
1641 ;; Fontify all builtin keywords (except case, default and goto; see below).
1642 (cons (concat "\\<\\(" c-keywords "\\)\\>") 'font-lock-keyword-face)
1644 ;; Fontify case/goto keywords and targets, and case default/goto tags.
1645 '("\\<\\(case\\|goto\\)\\>[ \t]*\\(\\sw+\\)?"
1646 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1647 '("^[ \t]*\\(\\sw+\\)[ \t]*:" 1 font-lock-reference-face)
1650 (setq c-font-lock-keywords-3
1651 (append c-font-lock-keywords-2
1653 ;; More complicated regexps for more complete highlighting for types.
1654 ;; We still have to fontify type specifiers individually, as C is so hairy.
1657 ;; Fontify all storage classes and type specifiers, plus their items.
1658 (list (concat "\\<\\(" c-type-types "\\)\\>"
1659 "\\([ \t*&]+\\sw+\\>\\)*")
1660 ;; Fontify each declaration item.
1661 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
1662 ;; Start with point after all type specifiers.
1663 (goto-char (or (match-beginning 8) (match-end 1)))
1664 ;; Finish with point after first type specifier.
1665 (goto-char (match-end 1))
1666 ;; Fontify as a variable or function name.
1667 (1 (if (match-beginning 4)
1668 font-lock-function-name-face
1669 font-lock-variable-name-face))))
1671 ;; Fontify structures, or typedef names, plus their items.
1672 '("\\(}\\)[ \t*]*\\sw"
1673 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1674 (goto-char (match-end 1)) nil
1675 (1 (if (match-beginning 4)
1676 font-lock-function-name-face
1677 font-lock-variable-name-face))))
1679 ;; Fontify anything at beginning of line as a declaration or definition.
1680 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
1681 (1 font-lock-type-face)
1682 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1683 (goto-char (or (match-beginning 2) (match-end 1))) nil
1684 (1 (if (match-beginning 4)
1685 font-lock-function-name-face
1686 font-lock-variable-name-face))))
1689 (setq c++-font-lock-keywords-1
1692 ;; The list `c-font-lock-keywords-1' less that for function names.
1693 (cdr c-font-lock-keywords-1)
1695 ;; Fontify function name definitions, possibly incorporating class name.
1697 '("^\\(\\sw+\\)\\(::\\(\\sw+\\)\\)?[ \t]*("
1698 (1 (if (match-beginning 2)
1700 font-lock-function-name-face))
1701 (3 font-lock-function-name-face nil t))
1704 (setq c++-font-lock-keywords-2
1705 (append c++-font-lock-keywords-1
1708 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
1709 (cons (concat "\\<\\(" c++-type-types "\\)\\>") 'font-lock-type-face)
1711 ;; Fontify operator function name overloading.
1712 '("\\<\\(operator\\)\\>[ \t]*\\([[(><!=+-][])><=+-]?\\)?"
1713 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
1715 ;; Fontify case/goto keywords and targets, and case default/goto tags.
1716 '("\\<\\(case\\|goto\\)\\>[ \t]*\\(\\sw+\\)?"
1717 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1718 '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-reference-face)
1720 ;; Fontify other builtin keywords.
1721 (cons (concat "\\<\\(" c++-keywords "\\)\\>") 'font-lock-keyword-face)
1724 (setq c++-font-lock-keywords-3
1725 (append c++-font-lock-keywords-2
1727 ;; More complicated regexps for more complete highlighting for types.
1730 ;; Fontify all storage classes and type specifiers, plus their items.
1731 (list (concat "\\<\\(" c++-type-types "\\)\\>"
1732 "\\([ \t*&]+\\sw+\\>\\)*")
1733 ;; Fontify each declaration item.
1734 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
1735 ;; Start with point after all type specifiers.
1736 (goto-char (or (match-beginning 13) (match-end 1)))
1737 ;; Finish with point after first type specifier.
1738 (goto-char (match-end 1))
1739 ;; Fontify as a variable or function name.
1740 (1 (cond ((match-beginning 2) font-lock-type-face)
1741 ((match-beginning 4) font-lock-function-name-face)
1742 (t font-lock-variable-name-face)))
1743 (3 (if (match-beginning 4)
1744 font-lock-function-name-face
1745 font-lock-variable-name-face) nil t)))
1747 ;; Fontify structures, or typedef names, plus their items.
1748 '("\\(}\\)[ \t*]*\\sw"
1749 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1750 (goto-char (match-end 1)) nil
1751 (1 (if (match-beginning 4)
1752 font-lock-function-name-face
1753 font-lock-variable-name-face))))
1755 ;; Fontify anything at beginning of line as a declaration or definition.
1756 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
1757 (1 font-lock-type-face)
1758 (font-lock-match-c++-style-declaration-item-and-skip-to-next
1759 (goto-char (or (match-beginning 2) (match-end 1))) nil
1760 (1 (cond ((match-beginning 2) font-lock-type-face)
1761 ((match-beginning 4) font-lock-function-name-face)
1762 (t font-lock-variable-name-face)))
1763 (3 (if (match-beginning 4)
1764 font-lock-function-name-face
1765 font-lock-variable-name-face) nil t)))
1769 (defvar c-font-lock-keywords c-font-lock-keywords-1
1770 "Default expressions to highlight in C mode.")
1772 (defvar c++-font-lock-keywords c++-font-lock-keywords-1
1773 "Default expressions to highlight in C++ mode.")
1776 (defvar tex-font-lock-keywords
1777 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
1778 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
1779 ; 2 font-lock-function-name-face)
1780 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
1781 ; 2 font-lock-reference-face)
1782 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1783 ; ;; not be able to display those fonts.
1784 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
1785 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
1786 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
1787 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
1788 ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
1789 '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
1790 2 font-lock-function-name-face)
1791 ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
1792 2 font-lock-reference-face)
1793 ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
1794 "\\\\\\([a-zA-Z@]+\\|.\\)"
1795 ;; It seems a bit dubious to use `bold' and `italic' faces since we might
1796 ;; not be able to display those fonts.
1797 ;; LaTeX2e: \emph{This is emphasized}.
1798 ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
1799 ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
1800 ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
1801 3 (if (match-beginning 2) 'bold 'italic) keep)
1802 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables.
1803 ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
1804 3 (if (match-beginning 2) 'bold 'italic) keep))
1805 "Default expressions to highlight in TeX modes.")
1807 ;; Install ourselves:
1809 (unless (assq 'font-lock-mode minor-mode-alist)
1810 (setq minor-mode-alist (cons '(font-lock-mode " Font") minor-mode-alist)))
1812 ;; Provide ourselves:
1814 (provide 'font-lock)
1816 ;;; font-lock.el ends here