1 ;;; font-lock.el --- decorating source files with fonts/colors based on syntax
3 ;; Copyright (C) 1992-1995, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995 Amdahl Corporation.
5 ;; Copyright (C) 1996 Ben Wing.
7 ;; Author: Jamie Zawinski <jwz@jwz.org>, for the LISPM Preservation Society.
8 ;; Minimally merged with FSF 19.34 by Barry Warsaw <bwarsaw@python.org>
9 ;; Then (partially) synched with FSF 19.30, leading to:
11 ;; Next Author: Simon Marshall <simon@gnu.ai.mit.edu>
12 ;; Latest XEmacs Author: Ben Wing
13 ;; Maintainer: XEmacs Development Team
14 ;; Keywords: languages, faces
16 ;; This file is part of XEmacs.
18 ;; XEmacs is free software; you can redistribute it and/or modify it
19 ;; under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation; either version 2, or (at your option)
23 ;; XEmacs is distributed in the hope that it will be useful, but
24 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
26 ;; General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with XEmacs; see the file COPYING. If not, write to the
30 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
31 ;; Boston, MA 02111-1307, USA.
33 ;;; Synched up with: FSF 19.30 except for the code to initialize the faces.
37 ;; Font-lock-mode is a minor mode that causes your comments to be
38 ;; displayed in one face, strings in another, reserved words in another,
39 ;; documentation strings in another, and so on.
41 ;; Comments will be displayed in `font-lock-comment-face'.
42 ;; Strings will be displayed in `font-lock-string-face'.
43 ;; Doc strings will be displayed in `font-lock-doc-string-face'.
44 ;; Function and variable names (in their defining forms) will be
45 ;; displayed in `font-lock-function-name-face'.
46 ;; Reserved words will be displayed in `font-lock-keyword-face'.
48 ;; Don't let the name fool you: you can highlight things using different
49 ;; colors or background stipples instead of fonts, though that is not the
50 ;; default. See the variables `font-lock-use-colors' and
51 ;; `font-lock-use-fonts' for broad control over this, or see the
52 ;; documentation on faces and how to change their attributes for
53 ;; fine-grained control.
55 ;; To make the text you type be fontified, use M-x font-lock-mode. When
56 ;; this minor mode is on, the fonts of the current line will be updated
57 ;; with every insertion or deletion.
59 ;; By default, font-lock will automatically put newly loaded files
60 ;; into font-lock-mode if it knows about the file's mode. See the
61 ;; variables `font-lock-auto-fontify', `font-lock-mode-enable-list',
62 ;; and `font-lock-mode-disable-list' for control over this.
64 ;; The `font-lock-keywords' variable defines other patterns to highlight.
65 ;; The default font-lock-mode-hook sets it to the value of the variables
66 ;; lisp-font-lock-keywords, c-font-lock-keywords, etc, as appropriate.
67 ;; The easiest way to change the highlighting patterns is to change the
68 ;; values of c-font-lock-keywords and related variables. See the doc
69 ;; string of the variable `font-lock-keywords' for the appropriate syntax.
71 ;; The default value for `lisp-font-lock-keywords' is the value of the variable
72 ;; `lisp-font-lock-keywords-1'. You may like `lisp-font-lock-keywords-2'
73 ;; better; it highlights many more words, but is slower and makes your buffers
74 ;; be very visually noisy.
76 ;; The same is true of `c-font-lock-keywords-1' and `c-font-lock-keywords-2';
77 ;; the former is subdued, the latter is loud.
79 ;; You can make font-lock default to the gaudier variety of keyword
80 ;; highlighting by setting the variable `font-lock-maximum-decoration'
81 ;; before loading font-lock, or by calling the functions
82 ;; `font-lock-use-default-maximal-decoration' or
83 ;; `font-lock-use-default-minimal-decoration'.
85 ;; On a Sparc10, the initial fontification takes about 6 seconds for a typical
86 ;; 140k file of C code, using the default configuration. The actual speed
87 ;; depends heavily on the type of code in the file, and how many non-syntactic
88 ;; patterns match; for example, Xlib.h takes 23 seconds for 101k, because many
89 ;; patterns match in it. You can speed this up substantially by removing some
90 ;; of the patterns that are highlighted by default. Fontifying lisp code is
91 ;; significantly faster, because lisp has a more regular syntax than C, so the
92 ;; regular expressions don't have to be as complicated.
94 ;; It's called font-lock-mode here because on the Lispms it was called
95 ;; "Electric Font Lock Mode." It was called that because there was an older
96 ;; mode called "Electric Caps Lock Mode" which had the function of causing all
97 ;; of your source code to be in upper case except for strings and comments,
98 ;; without you having to blip the caps lock key by hand all the time (thus the
99 ;; "electric", as in `electric-c-brace'.)
101 ;; See also the related packages `fast-lock' and `lazy-lock'. Both
102 ;; attempt to speed up the initial fontification. `fast-lock' saves
103 ;; the fontification info when you exit Emacs and reloads it next time
104 ;; you load the file, so that the file doesn't have to be fontified
105 ;; again. `lazy-lock' does "lazy" fontification -- i.e. it only
106 ;; fontifies the text as it becomes visible rather than fontifying
107 ;; the whole file when it's first loaded in.
109 ;; Further comments from the FSF:
111 ;; Nasty regexps of the form "bar\\(\\|lo\\)\\|f\\(oo\\|u\\(\\|bar\\)\\)\\|lo"
112 ;; are made thusly: (regexp-opt '("foo" "fu" "fubar" "bar" "barlo" "lo")) for
115 ;; What is fontification for? You might say, "It's to make my code look nice."
116 ;; I think it should be for adding information in the form of cues. These cues
117 ;; should provide you with enough information to both (a) distinguish between
118 ;; different items, and (b) identify the item meanings, without having to read
119 ;; the items and think about it. Therefore, fontification allows you to think
120 ;; less about, say, the structure of code, and more about, say, why the code
121 ;; doesn't work. Or maybe it allows you to think less and drift off to sleep.
123 ;; So, here are my opinions/advice/guidelines:
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 ;; - Keep the faces distinct from each other as far as possible.
130 ;; - Make the face attributes fit the concept as far as possible.
131 ;; i.e., function names might be a bold color such as blue, comments might
132 ;; be a bright color such as red, character strings might be brown, because,
133 ;; err, strings are brown (that was not the reason, please believe me).
134 ;; - Don't use a non-nil OVERRIDE unless you have a good reason.
135 ;; Only use OVERRIDE for special things that are easy to define, such as the
136 ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode.
137 ;; Don't use it to, say, highlight keywords in commented out code or strings.
143 (require 'fontl-hooks)
145 ;;;;;;;;;;;;;;;;;;;;;; user variables ;;;;;;;;;;;;;;;;;;;;;;
147 (defgroup font-lock nil
148 "Decorate source files with fonts/colors based on syntax.
149 Font-lock-mode is a minor mode that causes your comments to be
150 displayed in one face, strings in another, reserved words in another,
151 documentation strings in another, and so on.
153 Comments will be displayed in `font-lock-comment-face'.
154 Strings will be displayed in `font-lock-string-face'.
155 Doc strings will be displayed in `font-lock-doc-string-face'.
156 Function and variable names (in their defining forms) will be displayed
157 in `font-lock-function-name-face'.
158 Reserved words will be displayed in `font-lock-keyword-face'.
159 Preprocessor conditionals will be displayed in `font-lock-preprocessor-face'."
162 (defgroup font-lock-faces nil
163 "Faces used by the font-lock package."
168 (defcustom font-lock-verbose t
169 "*If non-nil, means show status messages when fontifying.
170 See also `font-lock-message-threshold'."
174 (defcustom font-lock-message-threshold 6000
175 "*Minimum size of region being fontified for status messages to appear.
177 The size is measured in characters. This affects `font-lock-fontify-region'
178 but not `font-lock-fontify-buffer'. (In other words, when you first visit
179 a file and it gets fontified, you will see status messages no matter what
180 size the file is. However, if you do something else like paste a
181 chunk of text or revert a buffer, you will see status messages only if the
182 changed region is large enough.)
184 Note that setting `font-lock-verbose' to nil disables the status
190 (defcustom font-lock-auto-fontify t
191 "*Whether font-lock should automatically fontify files as they're loaded.
192 This will only happen if font-lock has fontifying keywords for the major
193 mode of the file. You can get finer-grained control over auto-fontification
194 by using this variable in combination with `font-lock-mode-enable-list' or
195 `font-lock-mode-disable-list'."
200 (defcustom font-lock-mode-enable-list nil
201 "*List of modes to auto-fontify, if `font-lock-auto-fontify' is nil."
202 :type '(repeat (symbol :tag "Mode"))
206 (defcustom font-lock-mode-disable-list nil
207 "*List of modes not to auto-fontify, if `font-lock-auto-fontify' is t."
208 :type '(repeat (symbol :tag "Mode"))
212 (defcustom font-lock-use-colors '(color)
213 "*Specification for when Font Lock will set up color defaults.
214 Normally this should be '(color), meaning that Font Lock will set up
215 color defaults that are only used on color displays. Set this to nil
216 if you don't want Font Lock to set up color defaults at all. This
219 -- a list of valid tags, meaning that the color defaults will be used
220 when all of the tags apply. (e.g. '(color x))
221 -- a list whose first element is 'or and whose remaining elements are
222 lists of valid tags, meaning that the defaults will be used when
223 any of the tag lists apply.
224 -- nil, meaning that the defaults should not be set up at all.
226 \(If you specify face values in your init file, they will override any
227 that Font Lock specifies, regardless of whether you specify the face
228 values before or after loading Font Lock.)
230 See also `font-lock-use-fonts'. If you want more control over the faces
231 used for fontification, see the documentation of `font-lock-mode' for
238 (defcustom font-lock-use-fonts '(or (mono) (grayscale))
239 "*Specification for when Font Lock will set up non-color defaults.
241 Normally this should be '(or (mono) (grayscale)), meaning that Font
242 Lock will set up non-color defaults that are only used on either mono
243 or grayscale displays. Set this to nil if you don't want Font Lock to
244 set up non-color defaults at all. This should be one of
246 -- a list of valid tags, meaning that the non-color defaults will be used
247 when all of the tags apply. (e.g. '(grayscale x))
248 -- a list whose first element is 'or and whose remaining elements are
249 lists of valid tags, meaning that the defaults will be used when
250 any of the tag lists apply.
251 -- nil, meaning that the defaults should not be set up at all.
253 \(If you specify face values in your init file, they will override any
254 that Font Lock specifies, regardless of whether you specify the face
255 values before or after loading Font Lock.)
257 See also `font-lock-use-colors'. If you want more control over the faces
258 used for fontification, see the documentation of `font-lock-mode' for
264 (defcustom font-lock-maximum-decoration t
265 "*If non-nil, the maximum decoration level for fontifying.
266 If nil, use the minimum decoration (equivalent to level 0).
267 If t, use the maximum decoration available.
268 If a number, use that level of decoration (or if not available the maximum).
269 If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL),
270 where MAJOR-MODE is a symbol or t (meaning the default). For example:
271 ((c++-mode . 2) (c-mode . t) (t . 1))
272 means use level 2 decoration for buffers in `c++-mode', the maximum decoration
273 available for buffers in `c-mode', and level 1 decoration otherwise."
274 :type '(choice (const :tag "default" nil)
275 (const :tag "maximum" t)
276 (integer :tag "level" 1)
277 (repeat :menu-tag "mode specific" :tag "mode specific"
279 (cons :tag "Instance"
282 (symbol :tag "name"))
283 (radio :tag "Decoration"
284 (const :tag "default" nil)
285 (const :tag "maximum" t)
286 (integer :tag "level" 1)))))
290 (define-obsolete-variable-alias 'font-lock-use-maximal-decoration
291 'font-lock-maximum-decoration)
294 (defcustom font-lock-maximum-size (* 250 1024)
295 "*If non-nil, the maximum size for buffers for fontifying.
296 Only buffers less than this can be fontified when Font Lock mode is turned on.
297 If nil, means size is irrelevant.
298 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
299 where MAJOR-MODE is a symbol or t (meaning the default). For example:
300 ((c++-mode . 256000) (c-mode . 256000) (rmail-mode . 1048576))
301 means that the maximum size is 250K for buffers in `c++-mode' or `c-mode', one
302 megabyte for buffers in `rmail-mode', and size is irrelevant otherwise."
303 :type '(choice (const :tag "none" nil)
304 (integer :tag "size")
305 (repeat :menu-tag "mode specific" :tag "mode specific"
307 (cons :tag "Instance"
310 (symbol :tag "name"))
312 (const :tag "none" nil)
313 (integer :tag "size")))))
317 ;; Fontification variables:
320 (defvar font-lock-keywords nil
321 "A list of the keywords to highlight.
322 Each element should be of the form:
327 (MATCHER . HIGHLIGHT)
328 (MATCHER HIGHLIGHT ...)
331 where HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
333 FORM is an expression, whose value should be a keyword element,
334 evaluated when the keyword is (first) used in a buffer. This feature
335 can be used to provide a keyword that can only be generated when Font
336 Lock mode is actually turned on.
338 For highlighting single items, typically only MATCH-HIGHLIGHT is required.
339 However, if an item or (typically) items is to be highlighted following the
340 instance of another item (the anchor) then MATCH-ANCHORED may be required.
342 MATCH-HIGHLIGHT should be of the form:
344 (MATCH FACENAME OVERRIDE LAXMATCH)
346 Where MATCHER can be either the regexp to search for, a variable
347 containing the regexp to search for, or the function to call to make
348 the search (called with one argument, the limit of the search). MATCH
349 is the subexpression of MATCHER to be highlighted. FACENAME is either
350 a symbol naming a face, or an expression whose value is the face name
351 to use. If you want FACENAME to be a symbol that evaluates to a face,
352 use a form like \"(progn sym)\".
354 OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification may
355 be overwritten. If `keep', only parts not already fontified are highlighted.
356 If `prepend' or `append', existing fontification is merged with the new, in
357 which the new or existing fontification, respectively, takes precedence.
358 If LAXMATCH is non-nil, no error is signalled if there is no MATCH in MATCHER.
360 For example, an element of the form highlights (if not already highlighted):
362 \"\\\\\\=<foo\\\\\\=>\" Discrete occurrences of \"foo\" in the value of the
363 variable `font-lock-keyword-face'.
364 (\"fu\\\\(bar\\\\)\" . 1) Substring \"bar\" within all occurrences of \"fubar\" in
365 the value of `font-lock-keyword-face'.
366 (\"fubar\" . fubar-face) Occurrences of \"fubar\" in the value of `fubar-face'.
367 (\"foo\\\\|bar\" 0 foo-bar-face t)
368 Occurrences of either \"foo\" or \"bar\" in the value
369 of `foo-bar-face', even if already highlighted.
371 MATCH-ANCHORED should be of the form:
373 (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
375 Where MATCHER is as for MATCH-HIGHLIGHT with one exception; see below.
376 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
377 the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be
378 used to initialize before, and cleanup after, MATCHER is used. Typically,
379 PRE-MATCH-FORM is used to move to some position relative to the original
380 MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might
381 be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
383 For example, an element of the form highlights (if not already highlighted):
385 (\"\\\\\\=<anchor\\\\\\=>\" (0 anchor-face) (\"\\\\\\=<item\\\\\\=>\" nil nil (0 item-face)))
387 Discrete occurrences of \"anchor\" in the value of `anchor-face', and subsequent
388 discrete occurrences of \"item\" (on the same line) in the value of `item-face'.
389 (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil. Therefore \"item\" is
390 initially searched for starting from the end of the match of \"anchor\", and
391 searching for subsequent instance of \"anchor\" resumes from where searching
392 for \"item\" concluded.)
394 The above-mentioned exception is as follows. The limit of the MATCHER search
395 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
396 However, if PRE-MATCH-FORM returns a position greater than the position after
397 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
398 It is generally a bad idea to return a position greater than the end of the
399 line, i.e., cause the MATCHER search to span lines.
401 Note that the MATCH-ANCHORED feature is experimental; in the future, we may
402 replace it with other ways of providing this functionality.
404 These regular expressions should not match text which spans lines. While
405 \\[font-lock-fontify-buffer] handles multi-line patterns correctly, updating
406 when you edit the buffer does not, since it considers text one line at a time.
408 Be very careful composing regexps for this list;
409 the wrong pattern can dramatically slow things down!")
411 (make-variable-buffer-local 'font-lock-keywords)
413 (defvar font-lock-defaults nil
414 "The defaults font Font Lock mode for the current buffer.
415 Normally, do not set this directly. If you are writing a major mode,
416 put a property of `font-lock-defaults' on the major-mode symbol with
421 \(KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN)
423 KEYWORDS may be a symbol (a variable or function whose value is the keywords
424 to use for fontification) or a list of symbols. If KEYWORDS-ONLY is non-nil,
425 syntactic fontification (strings and comments) is not performed. If CASE-FOLD
426 is non-nil, the case of the keywords is ignored when fontifying. If
427 SYNTAX-ALIST is non-nil, it should be a list of cons pairs of the form (CHAR
428 . STRING) used to set the local Font Lock syntax table, for keyword and
429 syntactic fontification (see `modify-syntax-entry').
431 If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
432 backwards outside any enclosing syntactic block, for syntactic fontification.
433 Typical values are `beginning-of-line' (i.e., the start of the line is known to
434 be outside a syntactic block), or `beginning-of-defun' for programming modes or
435 `backward-paragraph' for textual modes (i.e., the mode-dependent function is
436 known to move outside a syntactic block). If nil, the beginning of the buffer
437 is used as a position outside of a syntactic block, in the worst case.
439 These item elements are used by Font Lock mode to set the variables
440 `font-lock-keywords', `font-lock-keywords-only',
441 `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
442 `font-lock-beginning-of-syntax-function', respectively.
444 Alternatively, if the value is a symbol, it should name a major mode,
445 and the defaults for that mode will apply.")
446 (make-variable-buffer-local 'font-lock-defaults)
448 ;; FSF uses `font-lock-defaults-alist' and expects the major mode to
449 ;; set a value for `font-lock-defaults', but I don't like either of
450 ;; these -- requiring the mode to set `font-lock-defaults' makes it
451 ;; impossible to have defaults for a minor mode, and using an alist is
452 ;; generally a bad idea for information that really should be
453 ;; decentralized. (Who knows what strange modes might want
456 (defvar font-lock-keywords-only nil
457 "Non-nil means Font Lock should not do syntactic fontification.
458 This is normally set via `font-lock-defaults'.
460 This should be nil for all ``language'' modes, but other modes, like
461 dired, do not have anything useful in the syntax tables (no comment
462 or string delimiters, etc) and so there is no need to use them and
463 this variable should have a value of t.
465 You should not set this variable directly; its value is computed
466 from `font-lock-defaults', or (if that does not specify anything)
467 by examining the syntax table to see whether it appears to contain
469 (make-variable-buffer-local 'font-lock-keywords-only)
471 (defvar font-lock-keywords-case-fold-search nil
472 "Whether the strings in `font-lock-keywords' should be case-folded.
473 This variable is automatically buffer-local, as the correct value depends
474 on the language in use.")
475 (make-variable-buffer-local 'font-lock-keywords-case-fold-search)
477 (defvar font-lock-after-fontify-buffer-hook nil
478 "Function or functions to run after completion of font-lock-fontify-buffer.")
480 (defvar font-lock-syntax-table nil
481 "Non-nil means use this syntax table for fontifying.
482 If this is nil, the major mode's syntax table is used.
483 This is normally set via `font-lock-defaults'.")
484 (make-variable-buffer-local 'font-lock-syntax-table)
486 ;; These are used in the FSF version in syntactic font-locking.
487 ;; We do this all in C.
488 ;;; These record the parse state at a particular position, always the
489 ;;; start of a line. Used to make
490 ;;; `font-lock-fontify-syntactically-region' faster.
491 ;(defvar font-lock-cache-position nil)
492 ;(defvar font-lock-cache-state nil)
493 ;(make-variable-buffer-local 'font-lock-cache-position)
494 ;(make-variable-buffer-local 'font-lock-cache-state)
496 ;; If this is nil, we only use the beginning of the buffer if we can't use
497 ;; `font-lock-cache-position' and `font-lock-cache-state'.
498 (defvar font-lock-beginning-of-syntax-function nil
499 "Non-nil means use this function to move back outside of a syntactic block.
500 If this is nil, the beginning of the buffer is used (in the worst case).
501 This is normally set via `font-lock-defaults'.")
502 (make-variable-buffer-local 'font-lock-beginning-of-syntax-function)
504 (defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer
505 "Function to use for fontifying the buffer.
506 This is normally set via `font-lock-defaults'.")
508 (defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer
509 "Function to use for unfontifying the buffer.
510 This is used when turning off Font Lock mode.
511 This is normally set via `font-lock-defaults'.")
513 (defvar font-lock-fontify-region-function 'font-lock-default-fontify-region
514 "Function to use for fontifying a region.
515 It should take two args, the beginning and end of the region, and an optional
516 third arg VERBOSE. If non-nil, the function should print status messages.
517 This is normally set via `font-lock-defaults'.")
519 (defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region
520 "Function to use for unfontifying a region.
521 It should take two args, the beginning and end of the region.
522 This is normally set via `font-lock-defaults'.")
524 (defvar font-lock-inhibit-thing-lock nil
525 "List of Font Lock mode related modes that should not be turned on.
526 Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'.
527 This is normally set via `font-lock-defaults'.")
530 (defcustom font-lock-mode nil ;; customized for the option menu. dverna
531 "Non nil means `font-lock-mode' is on"
534 :initialize 'custom-initialize-default
536 :set #'(lambda (var val) (font-lock-mode (or val 0)))
539 (defvar font-lock-fontified nil) ; whether we have hacked this buffer
540 (put 'font-lock-fontified 'permanent-local t)
543 (defvar font-lock-mode-hook nil
544 "Function or functions to run on entry to font-lock-mode.")
546 ; whether font-lock-set-defaults has already been run.
547 (defvar font-lock-defaults-computed nil)
548 (make-variable-buffer-local 'font-lock-defaults-computed)
551 ;;; Initialization of faces.
553 ;; #### barf gag retch. Horrid FSF lossage that we need to
554 ;; keep around for compatibility with font-lock-keywords that
555 ;; forget to properly quote their faces.
556 (defvar font-lock-comment-face 'font-lock-comment-face
557 "Don't even think of using this.")
558 (defvar font-lock-doc-string-face 'font-lock-doc-string-face
559 "Don't even think of using this.")
560 (defvar font-lock-string-face 'font-lock-string-face
561 "Don't even think of using this.")
562 (defvar font-lock-keyword-face 'font-lock-keyword-face
563 "Don't even think of using this.")
564 (defvar font-lock-function-name-face 'font-lock-function-name-face
565 "Don't even think of using this.")
566 (defvar font-lock-variable-name-face 'font-lock-variable-name-face
567 "Don't even think of using this.")
568 (defvar font-lock-type-face 'font-lock-type-face
569 "Don't even think of using this.")
570 (defvar font-lock-reference-face 'font-lock-reference-face
571 "Don't even think of using this.")
572 (defvar font-lock-preprocessor-face 'font-lock-preprocessor-face
573 "Don't even think of using this.")
575 (defconst font-lock-face-list
576 '(font-lock-comment-face
577 font-lock-string-face
578 font-lock-doc-string-face
579 font-lock-keyword-face
580 font-lock-function-name-face
581 font-lock-variable-name-face
583 font-lock-reference-face
584 font-lock-preprocessor-face
585 font-lock-warning-face))
587 ;; #### There should be an emulation for the old font-lock-use-*
590 (defface font-lock-comment-face
591 '((((class color) (background dark)) (:foreground "gray80"))
592 (((class color) (background light)) (:foreground "blue4"))
593 (((class grayscale) (background light))
594 (:foreground "DimGray" :bold t :italic t))
595 (((class grayscale) (background dark))
596 (:foreground "LightGray" :bold t :italic t))
598 "Font Lock mode face used to highlight comments."
599 :group 'font-lock-faces)
601 (defface font-lock-string-face
602 '((((class color) (background dark)) (:foreground "tan"))
603 (((class color) (background light)) (:foreground "green4"))
604 (((class grayscale) (background light)) (:foreground "DimGray" :italic t))
605 (((class grayscale) (background dark)) (:foreground "LightGray" :italic t))
607 "Font Lock mode face used to highlight strings."
608 :group 'font-lock-faces)
610 (defface font-lock-doc-string-face
611 '((((class color) (background dark)) (:foreground "light coral"))
612 (((class color) (background light)) (:foreground "green4"))
614 "Font Lock mode face used to highlight documentation strings."
615 :group 'font-lock-faces)
617 (defface font-lock-keyword-face
618 '((((class color) (background dark)) (:foreground "cyan"))
619 (((class color) (background light)) (:foreground "red4"))
620 (((class grayscale) (background light)) (:foreground "LightGray" :bold t))
621 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
623 "Font Lock mode face used to highlight keywords."
624 :group 'font-lock-faces)
626 (defface font-lock-function-name-face
627 '((((class color) (background dark)) (:foreground "aquamarine"))
628 (((class color) (background light)) (:foreground "brown4"))
629 (t (:bold t :underline t)))
630 "Font Lock mode face used to highlight function names."
631 :group 'font-lock-faces)
633 (defface font-lock-variable-name-face
634 '((((class color) (background dark)) (:foreground "cyan3"))
635 (((class color) (background light)) (:foreground "magenta4"))
636 (((class grayscale) (background light))
637 (:foreground "Gray90" :bold t :italic t))
638 (((class grayscale) (background dark))
639 (:foreground "DimGray" :bold t :italic t))
641 "Font Lock mode face used to highlight variable names."
642 :group 'font-lock-faces)
644 (defface font-lock-type-face
645 '((((class color) (background dark)) (:foreground "wheat"))
646 (((class color) (background light)) (:foreground "steelblue"))
647 (((class grayscale) (background light)) (:foreground "Gray90" :bold t))
648 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
650 "Font Lock mode face used to highlight types."
651 :group 'font-lock-faces)
653 (defface font-lock-reference-face
654 '((((class color) (background dark)) (:foreground "cadetblue2"))
655 (((class color) (background light)) (:foreground "red3"))
656 (((class grayscale) (background light))
657 (:foreground "LightGray" :bold t :underline t))
658 (((class grayscale) (background dark))
659 (:foreground "Gray50" :bold t :underline t)))
660 "Font Lock mode face used to highlight references."
661 :group 'font-lock-faces)
663 ;; #### FSF has font-lock-builtin-face.
665 (defface font-lock-preprocessor-face
666 '((((class color) (background dark)) (:foreground "steelblue1"))
667 (((class color) (background light)) (:foreground "blue3"))
669 "Font Lock Mode face used to highlight preprocessor conditionals."
670 :group 'font-lock-faces)
672 ;; #### Currently unused
673 (defface font-lock-warning-face
674 '((((class color) (background light)) (:foreground "Red" :bold t))
675 (((class color) (background dark)) (:foreground "Pink" :bold t))
676 (t (:inverse-video t :bold t)))
677 "Font Lock mode face used to highlight warnings."
678 :group 'font-lock-faces)
680 (defun font-lock-recompute-variables ()
681 ;; Is this a Draconian thing to do?
682 (mapc #'(lambda (buffer)
683 (with-current-buffer buffer
685 (font-lock-set-defaults t)))
688 ;; Backwards-compatible crud.
690 (defun font-lock-reset-all-faces ()
691 (dolist (face font-lock-face-list)
692 (face-spec-set face (get face 'face-defface-spec))))
694 (defun font-lock-use-default-fonts ()
695 "Reset the font-lock faces to a default set of fonts."
698 (font-lock-reset-all-faces))
700 (defun font-lock-use-default-colors ()
701 "Reset the font-lock faces to a default set of colors."
704 (font-lock-reset-all-faces))
706 (defun font-lock-use-default-minimal-decoration ()
707 "Reset the font-lock patterns to a fast, minimal set of decorations."
708 (and font-lock-maximum-decoration
709 (setq font-lock-maximum-decoration nil)
710 (font-lock-recompute-variables)))
712 (defun font-lock-use-default-maximal-decoration ()
713 "Reset the font-lock patterns to a larger set of decorations."
714 (and (not (eq t font-lock-maximum-decoration))
715 (setq font-lock-maximum-decoration t)
716 (font-lock-recompute-variables)))
719 ;;;;;;;;;;;;;;;;;;;;;; actual code ;;;;;;;;;;;;;;;;;;;;;;
721 ;;; To fontify the whole buffer by language syntax, we go through it a
722 ;;; character at a time, creating extents on the boundary of each syntactic
723 ;;; unit (that is, one extent for each block comment, one for each line
724 ;;; comment, one for each string, etc.) This is done with the C function
725 ;;; syntactically-sectionize. It's in C for speed (the speed of lisp function
726 ;;; calls was a real bottleneck for this task since it involves examining each
727 ;;; character in turn.)
729 ;;; Then we make a second pass, to fontify the buffer based on other patterns
730 ;;; specified by regexp. When we find a match for a region of text, we need
731 ;;; to change the fonts on those characters. This is done with the
732 ;;; put-text-property function, which knows how to efficiently share extents.
733 ;;; Conceptually, we are attaching some particular face to each of the
734 ;;; characters in a range, but the implementation of this involves creating
735 ;;; extents, or resizing existing ones.
737 ;;; Each time a modification happens to a line, we re-fontify the entire line.
738 ;;; We do this by first removing the extents (text properties) on the line,
739 ;;; and then doing the syntactic and keyword passes again on that line. (More
740 ;;; generally, each modified region is extended to include the preceding and
741 ;;; following BOL or EOL.)
743 ;;; This means that, as the user types, we repeatedly go back to the beginning
744 ;;; of the line, doing more work the longer the line gets. This doesn't cost
745 ;;; much in practice, and if we don't, then we incorrectly fontify things when,
746 ;;; for example, inserting spaces into `intfoo () {}'.
750 ;; The user level functions
753 (defun font-lock-mode (&optional arg)
754 "Toggle Font Lock Mode.
755 With arg, turn font-lock mode on if and only if arg is positive.
757 When Font Lock mode is enabled, text is fontified as you type it:
759 - Comments are displayed in `font-lock-comment-face';
760 - Strings are displayed in `font-lock-string-face';
761 - Documentation strings (in Lisp-like languages) are displayed in
762 `font-lock-doc-string-face';
763 - Language keywords (\"reserved words\") are displayed in
764 `font-lock-keyword-face';
765 - Function names in their defining form are displayed in
766 `font-lock-function-name-face';
767 - Variable names in their defining form are displayed in
768 `font-lock-variable-name-face';
769 - Type names are displayed in `font-lock-type-face';
770 - References appearing in help files and the like are displayed
771 in `font-lock-reference-face';
772 - Preprocessor declarations are displayed in
773 `font-lock-preprocessor-face';
777 - Certain other expressions are displayed in other faces according
778 to the value of the variable `font-lock-keywords'.
780 Where modes support different levels of fontification, you can use the variable
781 `font-lock-maximum-decoration' to specify which level you generally prefer.
782 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
783 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
784 To fontify a buffer without turning on Font Lock mode, and regardless of buffer
785 size, you can use \\[font-lock-fontify-buffer].
787 See the variable `font-lock-keywords' for customization."
789 (let ((on-p (if arg (> (prefix-numeric-value arg) 0) (not font-lock-mode)))
790 (maximum-size (if (not (consp font-lock-maximum-size))
791 font-lock-maximum-size
792 (cdr (or (assq major-mode font-lock-maximum-size)
793 (assq t font-lock-maximum-size))))))
794 ;; Font-lock mode will refuse to turn itself on if in batch mode, or if
795 ;; the current buffer is "invisible". The latter is because packages
796 ;; sometimes put their temporary buffers into some particular major mode
797 ;; to get syntax tables and variables and whatnot, but we don't want the
798 ;; fact that the user has font-lock-mode on a mode hook to slow these
800 (if (or noninteractive (eq (aref (buffer-name) 0) ?\ ))
802 (if (equal (buffer-name) " *Compiler Input*") ; hack for bytecomp...
805 (make-local-hook 'after-change-functions)
806 (add-hook 'after-change-functions
807 'font-lock-after-change-function nil t)
808 (add-hook 'pre-idle-hook 'font-lock-pre-idle-hook))
810 (remove-hook 'after-change-functions
811 'font-lock-after-change-function t)
812 (setq font-lock-defaults-computed nil
813 font-lock-keywords nil)
814 ;; We have no business doing this here, since
815 ;; pre-idle-hook is global. Other buffers may
816 ;; still be in font-lock mode. -dkindred@cs.cmu.edu
817 ;; (remove-hook 'pre-idle-hook 'font-lock-pre-idle-hook)
819 (set (make-local-variable 'font-lock-mode) on-p)
821 (font-lock-set-defaults-1)
822 (make-local-hook 'before-revert-hook)
823 (make-local-hook 'after-revert-hook)
824 ;; If buffer is reverted, must clean up the state.
825 (add-hook 'before-revert-hook 'font-lock-revert-setup nil t)
826 (add-hook 'after-revert-hook 'font-lock-revert-cleanup nil t)
827 (run-hooks 'font-lock-mode-hook)
828 (cond (font-lock-fontified
830 ((or (null maximum-size) (<= (buffer-size) maximum-size))
831 (font-lock-fontify-buffer))
833 (lmessage 'command "Fontifying %s... buffer too big."
836 (setq font-lock-fontified nil)
837 (remove-hook 'before-revert-hook 'font-lock-revert-setup t)
838 (remove-hook 'after-revert-hook 'font-lock-revert-cleanup t)
839 (font-lock-unfontify-region (point-min) (point-max))
840 (font-lock-thing-lock-cleanup))
842 (remove-hook 'before-revert-hook 'font-lock-revert-setup t)
843 (remove-hook 'after-revert-hook 'font-lock-revert-cleanup t)
844 (font-lock-thing-lock-cleanup)))
847 ;; For init-file hooks
849 (defun turn-on-font-lock ()
850 "Unconditionally turn on Font Lock mode."
854 (defun turn-off-font-lock ()
855 "Unconditionally turn off Font Lock mode."
860 ;; support for add-keywords, global-font-lock-mode and
861 ;; font-lock-support-mode (unified support for various *-lock modes).
864 ;; Fontification functions.
866 ;; We first define some defsubsts to encapsulate the way we add
867 ;; faces to a region of text. I am planning on modifying the
868 ;; text-property mechanism so that multiple independent classes
869 ;; of text properties can exist. That way, for example, ediff's
870 ;; face text properties don't interfere with font lock's face
871 ;; text properties. Due to the XEmacs implementation of text
872 ;; properties in terms of extents, doing this is fairly trivial:
873 ;; instead of using the `text-prop' property, you just use a
874 ;; specified property.
876 (defsubst font-lock-set-face (start end face)
877 ;; Set the face on the characters in the range.
878 (put-nonduplicable-text-property start end 'face face)
879 (put-nonduplicable-text-property start end 'font-lock t))
881 (defsubst font-lock-remove-face (start end)
882 ;; Remove any syntax highlighting on the characters in the range.
883 (put-nonduplicable-text-property start end 'face nil)
884 (put-nonduplicable-text-property start end 'font-lock nil))
886 (defsubst font-lock-any-faces-p (start end)
887 ;; Return non-nil if we've put any syntax highlighting on
888 ;; the characters in the range.
890 ;; used to look for 'text-prop property, but this has problems if
891 ;; you put any other text properties in the vicinity. Simon
892 ;; Marshall suggested looking for the 'face property (this is what
893 ;; FSF Emacs does) but that's equally bogus. Only reliable way is
894 ;; for font-lock to specially mark its extents.
896 ;; FSF's (equivalent) definition of this defsubst would be
897 ;; (text-property-not-all start end 'font-lock nil)
899 ;; Perhaps our `map-extents' is faster than our definition
900 ;; of `text-property-not-all'. #### If so, `text-property-not-all'
901 ;; should be fixed ...
903 (map-extents 'extent-property (current-buffer) start (1- end) 'font-lock))
906 ;; Fontification functions.
908 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
909 ;; code to fontify a region, the function runs the function whose name is the
910 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
911 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
912 ;; which does contain the code to fontify a region. However, the value of the
913 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
914 ;; do anything. The indirection of the fontification functions gives major
915 ;; modes the capability of modifying the way font-lock.el fontifies. Major
916 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
917 ;; via the variable `font-lock-defaults'.
919 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
920 ;; font-lock.el uses its own function for buffer fontification. This function
921 ;; makes fontification be on a message-by-message basis and so visiting an
922 ;; RMAIL file is much faster. A clever implementation of the function might
923 ;; fontify the headers differently than the message body. (It should, and
924 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
925 ;; you?) This hints at a more interesting use...
927 ;; Languages that contain text normally contained in different major modes
928 ;; could define their own fontification functions that treat text differently
929 ;; depending on its context. For example, Perl mode could arrange that here
930 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
931 ;; rules one way and C code another. Neat!
933 ;; A further reason to use the fontification indirection feature is when the
934 ;; default syntactual fontification, or the default fontification in general,
935 ;; is not flexible enough for a particular major mode. For example, perhaps
936 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
937 ;; cope with. You need to write your own version of that function, e.g.,
938 ;; `hairy-fontify-syntactically-region', and make your own version of
939 ;; `hairy-fontify-region' call that function before calling
940 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
941 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
942 ;; would call your region fontification function instead of its own. For
943 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
944 ;; directives correctly and cleanly. (It is the same problem as fontifying
945 ;; multi-line strings and comments; regexps are not appropriate for the job.)
948 (defun font-lock-fontify-buffer ()
949 "Fontify the current buffer the way `font-lock-mode' would.
950 See `font-lock-mode' for details.
952 This can take a while for large buffers."
954 (let ((font-lock-verbose (or font-lock-verbose (interactive-p))))
955 (funcall font-lock-fontify-buffer-function)))
957 (defun font-lock-unfontify-buffer ()
958 (funcall font-lock-unfontify-buffer-function))
960 (defun font-lock-fontify-region (beg end &optional loudly)
961 (funcall font-lock-fontify-region-function beg end loudly))
963 (defun font-lock-unfontify-region (beg end &optional loudly)
964 (funcall font-lock-unfontify-region-function beg end loudly))
966 ;; #### In these functions, the FSF is careful to do
969 ;; before anything else. Should we copy?
970 (defun font-lock-default-fontify-buffer ()
972 (let ((was-on font-lock-mode)
973 (font-lock-verbose (or font-lock-verbose (interactive-p)))
974 (font-lock-message-threshold 0)
976 ;; Turn it on to run hooks and get the right font-lock-keywords.
977 (or was-on (font-lock-mode 1))
978 (font-lock-unfontify-region (point-min) (point-max) t)
979 ;; (buffer-syntactic-context-flush-cache)
981 ;; If a ^G is typed during fontification, abort the fontification, but
982 ;; return normally (do not signal.) This is to make it easy to abort
983 ;; fontification if it's taking a long time, without also causing the
984 ;; buffer not to pop up. If a real abort is desired, the user can ^G
987 ;; Possibly this should happen down in font-lock-fontify-region instead
988 ;; of here, but since that happens from the after-change-hook (meaning
989 ;; much more frequently) I'm afraid of the bad consequences of stealing
990 ;; the interrupt character at inopportune times.
994 (font-lock-fontify-region (point-min) (point-max)))
998 (or was-on ; turn it off if it was off.
999 (let ((font-lock-fontified nil)) ; kludge to prevent defontification
1000 (font-lock-mode 0)))
1001 (set (make-local-variable 'font-lock-fontified) t)
1002 (when (and aborted font-lock-verbose)
1003 (lmessage 'command "Fontifying %s... aborted." (buffer-name))))
1004 (run-hooks 'font-lock-after-fontify-buffer-hook))
1006 (defun font-lock-default-unfontify-buffer ()
1007 (font-lock-unfontify-region (point-min) (point-max))
1008 (set (make-local-variable 'font-lock-fontified) nil))
1010 ;; This used to be `font-lock-fontify-region', and before that,
1011 ;; `font-lock-fontify-region' used to be the name used for what is now
1012 ;; `font-lock-fontify-syntactically-region'.
1013 (defun font-lock-default-fontify-region (beg end &optional loudly)
1014 (let ((modified (buffer-modified-p))
1015 (buffer-undo-list t) (inhibit-read-only t)
1016 (old-syntax-table (syntax-table))
1017 buffer-file-name buffer-file-truename)
1020 ;; Use the fontification syntax table, if any.
1021 (if font-lock-syntax-table (set-syntax-table font-lock-syntax-table))
1022 ;; Now do the fontification.
1023 (if font-lock-keywords-only
1024 (font-lock-unfontify-region beg end)
1025 (font-lock-fontify-syntactically-region beg end loudly))
1026 (font-lock-fontify-keywords-region beg end loudly))
1028 (set-syntax-table old-syntax-table)
1029 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil)))))
1031 ;; The following must be rethought, since keywords can override fontification.
1032 ; ;; Now scan for keywords, but not if we are inside a comment now.
1033 ; (or (and (not font-lock-keywords-only)
1034 ; (let ((state (parse-partial-sexp beg end nil nil
1035 ; font-lock-cache-state)))
1036 ; (or (nth 4 state) (nth 7 state))))
1037 ; (font-lock-fontify-keywords-region beg end))
1039 (defun font-lock-default-unfontify-region (beg end &optional maybe-loudly)
1040 (when (and maybe-loudly font-lock-verbose
1041 (>= (- end beg) font-lock-message-threshold))
1042 (lmessage 'progress "Fontifying %s..." (buffer-name)))
1043 (let ((modified (buffer-modified-p))
1044 (buffer-undo-list t) (inhibit-read-only t)
1045 buffer-file-name buffer-file-truename)
1046 (font-lock-remove-face beg end)
1047 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil))))
1049 ;; Following is the original FSF version (similar to our original
1050 ;; version, before all the crap I added below).
1052 ;; Probably that crap should either be fixed up so it works better,
1055 ;; I think that lazy-lock v2 tries to do something similar.
1056 ;; Those efforts should be merged.
1058 ;; Called when any modification is made to buffer text.
1059 ;(defun font-lock-after-change-function (beg end old-len)
1062 ; ;; Rescan between start of line from `beg' and start of line after `end'.
1063 ; (font-lock-fontify-region
1064 ; (progn (goto-char beg) (beginning-of-line) (point))
1065 ; (progn (goto-char end) (forward-line 1) (point))))))
1067 (defvar font-lock-old-extent nil)
1068 (defvar font-lock-old-len 0)
1070 (defun font-lock-fontify-glumped-region ()
1071 ;; even if something goes wrong in the fontification, mark the glumped
1072 ;; region as fontified; otherwise, the same error might get signaled
1073 ;; after every command.
1075 ;; buffer/extent may be deleted.
1076 (if (and (extent-live-p font-lock-old-extent)
1077 (buffer-live-p (extent-object font-lock-old-extent)))
1079 (set-buffer (extent-object font-lock-old-extent))
1080 (font-lock-after-change-function-1
1081 (extent-start-position font-lock-old-extent)
1082 (extent-end-position font-lock-old-extent)
1083 font-lock-old-len)))
1084 (detach-extent font-lock-old-extent)
1085 (setq font-lock-old-extent nil)))
1087 (defun font-lock-pre-idle-hook ()
1089 (if font-lock-old-extent
1090 (font-lock-fontify-glumped-region))
1091 (error (warn "Error caught in `font-lock-pre-idle-hook'"))))
1093 (defvar font-lock-always-fontify-immediately nil
1094 "Set this to non-nil to disable font-lock deferral.")
1096 ;;; called when any modification is made to buffer text. This function
1097 ;;; attempts to glump adjacent changes together so that excessive
1098 ;;; fontification is avoided. This function could easily be adapted
1099 ;;; to other after-change-functions.
1101 (defun font-lock-after-change-function (beg end old-len)
1102 (let ((obeg (and font-lock-old-extent
1103 (extent-start-position font-lock-old-extent)))
1104 (oend (and font-lock-old-extent
1105 (extent-end-position font-lock-old-extent)))
1106 (bc-end (+ beg old-len)))
1108 ;; If this change can't be merged into the glumped one,
1109 ;; we need to fontify the glumped one right now.
1110 (if (and font-lock-old-extent
1111 (or (not (eq (current-buffer)
1112 (extent-object font-lock-old-extent)))
1115 (font-lock-fontify-glumped-region))
1117 (if font-lock-old-extent
1118 ;; Update glumped region.
1120 ;; Any characters in the before-change region that are
1121 ;; outside the glumped region go into the glumped
1122 ;; before-change region.
1124 (setq font-lock-old-len (+ font-lock-old-len (- bc-end oend))))
1126 (setq font-lock-old-len (+ font-lock-old-len (- obeg beg))))
1127 ;; New glumped region is the union of the glumped region
1128 ;; and the new region.
1129 (set-extent-endpoints font-lock-old-extent
1133 ;; No glumped region, so create one.
1134 (setq font-lock-old-extent (make-extent beg end))
1135 (set-extent-property font-lock-old-extent 'detachable nil)
1136 (set-extent-property font-lock-old-extent 'end-open nil)
1137 (setq font-lock-old-len old-len))
1139 (if font-lock-always-fontify-immediately
1140 (font-lock-fontify-glumped-region))))
1142 (defun font-lock-after-change-function-1 (beg end old-len)
1143 (if (null font-lock-mode)
1147 ;; if we don't widen, then fill-paragraph (and any command that
1148 ;; operates on a narrowed region) confuses things, because the C
1149 ;; code will fail to realize that we're inside a comment.
1152 (let ((zmacs-region-stays zmacs-region-stays)) ; protect from change!
1154 ;; Maybe flush the internal cache used by syntactically-sectionize.
1155 ;; (It'd be nice if this was more automatic.) Any deletions mean
1156 ;; the cache is invalid, and insertions at beginning or end of line
1157 ;; mean that the bol cache might be invalid.
1158 ;; (if (or (> old-len 0) (bobp) (= (preceding-char) ?\n))
1159 ;; (buffer-syntactic-context-flush-cache))
1161 ;; Always recompute the whole line.
1168 ;; Rescan between start of line from `beg' and start of line after
1170 (font-lock-fontify-region beg end)))))))
1173 ;; Syntactic fontification functions.
1175 ;; Note: Here is the FSF version. Our version is much faster because
1176 ;; of the C support we provide. This may be useful for reference,
1177 ;; however, and perhaps there is something useful here that should
1178 ;; be merged into our version.
1180 ;(defun font-lock-fontify-syntactically-region (start end &optional loudly)
1181 ; "Put proper face on each string and comment between START and END.
1182 ;START should be at the beginning of a line."
1183 ; (let ((synstart (if comment-start-skip
1184 ; (concat "\\s\"\\|" comment-start-skip)
1186 ; (comstart (if comment-start-skip
1187 ; (concat "\\s<\\|" comment-start-skip)
1189 ; state prev prevstate)
1190 ; (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
1195 ; ;; Find the state at the `beginning-of-line' before `start'.
1196 ; (if (eq start font-lock-cache-position)
1197 ; ;; Use the cache for the state of `start'.
1198 ; (setq state font-lock-cache-state)
1199 ; ;; Find the state of `start'.
1200 ; (if (null font-lock-beginning-of-syntax-function)
1201 ; ;; Use the state at the previous cache position, if any, or
1202 ; ;; otherwise calculate from `point-min'.
1203 ; (if (or (null font-lock-cache-position)
1204 ; (< start font-lock-cache-position))
1205 ; (setq state (parse-partial-sexp (point-min) start))
1206 ; (setq state (parse-partial-sexp font-lock-cache-position start
1207 ; nil nil font-lock-cache-state)))
1208 ; ;; Call the function to move outside any syntactic block.
1209 ; (funcall font-lock-beginning-of-syntax-function)
1210 ; (setq state (parse-partial-sexp (point) start)))
1211 ; ;; Cache the state and position of `start'.
1212 ; (setq font-lock-cache-state state
1213 ; font-lock-cache-position start))
1215 ; ;; If the region starts inside a string, show the extent of it.
1217 ; (let ((beg (point)))
1218 ; (while (and (re-search-forward "\\s\"" end 'move)
1219 ; (nth 3 (parse-partial-sexp beg (point)
1221 ; (put-text-property beg (point) 'face font-lock-string-face)
1222 ; (setq state (parse-partial-sexp beg (point) nil nil state))))
1224 ; ;; Likewise for a comment.
1225 ; (if (or (nth 4 state) (nth 7 state))
1226 ; (let ((beg (point)))
1228 ; (narrow-to-region (point-min) end)
1229 ; (condition-case nil
1231 ; (re-search-backward comstart (point-min) 'move)
1232 ; (forward-comment 1)
1233 ; ;; forward-comment skips all whitespace,
1234 ; ;; so go back to the real end of the comment.
1235 ; (skip-chars-backward " \t"))
1236 ; (error (goto-char end))))
1237 ; (put-text-property beg (point) 'face font-lock-comment-face)
1238 ; (setq state (parse-partial-sexp beg (point) nil nil state))))
1240 ; ;; Find each interesting place between here and `end'.
1241 ; (while (and (< (point) end)
1242 ; (setq prev (point) prevstate state)
1243 ; (re-search-forward synstart end t)
1245 ; ;; Clear out the fonts of what we skip over.
1246 ; (remove-text-properties prev (point) '(face nil))
1247 ; ;; Verify the state at that place
1248 ; ;; so we don't get fooled by \" or \;.
1249 ; (setq state (parse-partial-sexp prev (point)
1251 ; (let ((here (point)))
1252 ; (if (or (nth 4 state) (nth 7 state))
1254 ; ;; We found a real comment start.
1255 ; (let ((beg (match-beginning 0)))
1258 ; (narrow-to-region (point-min) end)
1259 ; (condition-case nil
1261 ; (forward-comment 1)
1262 ; ;; forward-comment skips all whitespace,
1263 ; ;; so go back to the real end of the comment.
1264 ; (skip-chars-backward " \t"))
1265 ; (error (goto-char end))))
1266 ; (put-text-property beg (point) 'face
1267 ; font-lock-comment-face)
1268 ; (setq state (parse-partial-sexp here (point) nil nil state)))
1271 ; ;; We found a real string start.
1272 ; (let ((beg (match-beginning 0)))
1273 ; (while (and (re-search-forward "\\s\"" end 'move)
1274 ; (nth 3 (parse-partial-sexp here (point)
1276 ; (put-text-property beg (point) 'face font-lock-string-face)
1277 ; (setq state (parse-partial-sexp here (point)
1278 ; nil nil state))))))
1280 ; ;; Make sure `prev' is non-nil after the loop
1281 ; ;; only if it was set on the very last iteration.
1285 ; (and prev (remove-text-properties prev end '(face nil)))))
1287 (defun font-lock-fontify-syntactically-region (start end &optional loudly)
1288 "Put proper face on each string and comment between START and END.
1289 START should be at the beginning of a line."
1290 (if font-lock-keywords-only
1292 (when (and font-lock-verbose
1293 (>= (- end start) font-lock-message-threshold))
1294 (lmessage 'progress "Fontifying %s... (syntactically...)"
1296 (font-lock-unfontify-region start end loudly)
1298 (if (> end (point-max)) (setq end (point-max)))
1299 (syntactically-sectionize
1300 #'(lambda (s e context depth)
1302 (cond ((eq context 'string)
1303 ;;#### Should only do this is Lisp-like modes!
1306 ;; really we should only use this if
1307 ;; in position 3 depth 1, but that's
1308 ;; too expensive to compute.
1309 'font-lock-doc-string-face
1310 'font-lock-string-face)))
1311 ((or (eq context 'comment)
1312 (eq context 'block-comment))
1313 (setq face 'font-lock-comment-face)
1314 ; ;; Don't fontify whitespace at the beginning of lines;
1315 ; ;; otherwise comment blocks may not line up with code.
1316 ; ;; (This is sometimes a good idea, sometimes not; in any
1317 ; ;; event it should be in C for speed --jwz)
1320 ; (while (prog1 (search-forward "\n" (1- e) 'move)
1321 ; (setq face 'font-lock-comment-face)
1323 ; (skip-chars-forward " \t\n")
1326 (font-lock-set-face s e face)))
1330 ;;; Additional text property functions.
1332 ;; The following three text property functions are not generally available (and
1333 ;; it's not certain that they should be) so they are inlined for speed.
1334 ;; The case for `fillin-text-property' is simple; it may or not be generally
1335 ;; useful. (Since it is used here, it is useful in at least one place.;-)
1336 ;; However, the case for `append-text-property' and `prepend-text-property' is
1337 ;; more complicated. Should they remove duplicate property values or not? If
1338 ;; so, should the first or last duplicate item remain? Or the one that was
1339 ;; added? In our implementation, the first duplicate remains.
1341 ;; XEmacs: modified all these functions to use
1342 ;; `put-nonduplicable-text-property' instead of `put-text-property', and
1343 ;; the first one to take both SETPROP and MARKPROP, in accordance with the
1344 ;; changed definitions of `font-lock-any-faces-p' and `font-lock-set-face'.
1346 (defsubst font-lock-fillin-text-property (start end setprop markprop value &optional object)
1347 "Fill in one property of the text from START to END.
1348 Arguments PROP and VALUE specify the property and value to put where none are
1349 already in place. Therefore existing property values are not overwritten.
1350 Optional argument OBJECT is the string or buffer containing the text."
1351 (let ((start (text-property-any start end markprop nil object)) next)
1353 (setq next (next-single-property-change start markprop object end))
1354 (put-nonduplicable-text-property start next setprop value object)
1355 (put-nonduplicable-text-property start next markprop value object)
1356 (setq start (text-property-any next end markprop nil object)))))
1358 ;; This function (from simon's unique.el) is rewritten and inlined for speed.
1359 ;(defun unique (list function)
1360 ; "Uniquify LIST, deleting elements using FUNCTION.
1361 ;Return the list with subsequent duplicate items removed by side effects.
1362 ;FUNCTION is called with an element of LIST and a list of elements from LIST,
1363 ;and should return the list of elements with occurrences of the element removed,
1364 ;i.e., a function such as `delete' or `delq'.
1365 ;This function will work even if LIST is unsorted. See also `uniq'."
1366 ; (let ((list list))
1368 ; (setq list (setcdr list (funcall function (car list) (cdr list))))))
1371 (defsubst font-lock-unique (list)
1372 "Uniquify LIST, deleting elements using `delq'.
1373 Return the list with subsequent duplicate items removed by side effects."
1376 (setq list (setcdr list (delq (car list) (cdr list))))))
1379 ;; A generalisation of `facemenu-add-face' for any property, but without the
1380 ;; removal of inactive faces via `facemenu-discard-redundant-faces' and special
1381 ;; treatment of `default'. Uses `unique' to remove duplicate property values.
1382 (defsubst font-lock-prepend-text-property (start end prop value &optional object)
1383 "Prepend to one property of the text from START to END.
1384 Arguments PROP and VALUE specify the property and value to prepend to the value
1385 already in place. The resulting property values are always lists, and unique.
1386 Optional argument OBJECT is the string or buffer containing the text."
1387 (let ((val (if (listp value) value (list value))) next prev)
1388 (while (/= start end)
1389 (setq next (next-single-property-change start prop object end)
1390 prev (get-text-property start prop object))
1393 (font-lock-unique (append val (if (listp prev) prev (list prev))))
1395 (setq start next))))
1397 (defsubst font-lock-append-text-property (start end prop value &optional object)
1398 "Append to one property of the text from START to END.
1399 Arguments PROP and VALUE specify the property and value to append to the value
1400 already in place. The resulting property values are always lists, and unique.
1401 Optional argument OBJECT is the string or buffer containing the text."
1402 (let ((val (if (listp value) value (list value))) next prev)
1403 (while (/= start end)
1404 (setq next (next-single-property-change start prop object end)
1405 prev (get-text-property start prop object))
1408 (font-lock-unique (append (if (listp prev) prev (list prev)) val))
1410 (setq start next))))
1412 ;;; Regexp fontification functions.
1414 (defsubst font-lock-apply-highlight (highlight)
1415 "Apply HIGHLIGHT following a match.
1416 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1417 (let* ((match (nth 0 highlight))
1418 (start (match-beginning match)) (end (match-end match))
1419 (override (nth 2 highlight)))
1420 (let ((newface (nth 1 highlight)))
1421 (or (symbolp newface)
1422 (setq newface (eval newface)))
1424 ;; No match but we might not signal an error.
1425 (or (nth 3 highlight)
1426 (error "No match %d in highlight %S" match highlight)))
1429 ;; Cannot override existing fontification.
1430 (or (font-lock-any-faces-p start end)
1431 (font-lock-set-face start end newface)))
1433 ;; Override existing fontification.
1434 (font-lock-set-face start end newface))
1435 ((eq override 'keep)
1436 ;; Keep existing fontification.
1437 (font-lock-fillin-text-property start end 'face 'font-lock
1439 ((eq override 'prepend)
1440 ;; Prepend to existing fontification.
1441 (font-lock-prepend-text-property start end 'face newface))
1442 ((eq override 'append)
1443 ;; Append to existing fontification.
1444 (font-lock-append-text-property start end 'face newface))))))
1446 (defsubst font-lock-fontify-anchored-keywords (keywords limit)
1447 "Fontify according to KEYWORDS until LIMIT.
1448 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1449 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1450 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
1451 ;; Evaluate PRE-MATCH-FORM.
1452 (pre-match-value (eval (nth 1 keywords))))
1453 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1454 (if (and (numberp pre-match-value) (> pre-match-value (point)))
1455 (setq limit pre-match-value)
1456 (save-excursion (end-of-line) (setq limit (point))))
1458 ;; Find an occurrence of `matcher' before `limit'.
1459 (while (if (stringp matcher)
1460 (re-search-forward matcher limit t)
1461 (funcall matcher limit))
1462 ;; Apply each highlight to this instance of `matcher'.
1463 (setq highlights lowdarks)
1465 (font-lock-apply-highlight (car highlights))
1466 (setq highlights (cdr highlights)))))
1467 ;; Evaluate POST-MATCH-FORM.
1468 (eval (nth 2 keywords))))
1470 (defun font-lock-fontify-keywords-region (start end &optional loudvar)
1471 "Fontify according to `font-lock-keywords' between START and END.
1472 START should be at the beginning of a line."
1473 (let ((loudly (and font-lock-verbose
1474 (>= (- end start) font-lock-message-threshold))))
1475 (let ((case-fold-search font-lock-keywords-case-fold-search)
1476 (keywords (cdr (if (eq (car-safe font-lock-keywords) t)
1478 (font-lock-compile-keywords))))
1479 (bufname (buffer-name)) (count 0)
1480 keyword matcher highlights)
1482 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1484 (when loudly (lmessage 'progress "Fontifying %s... (regexps..%s)"
1486 (make-string (setq count (1+ count)) ?.)))
1488 ;; Find an occurrence of `matcher' from `start' to `end'.
1489 (setq keyword (car keywords) matcher (car keyword))
1491 (while (and (< (point) end)
1492 (if (stringp matcher)
1493 (re-search-forward matcher end t)
1494 (funcall matcher end)))
1495 ;; Apply each highlight to this instance of `matcher', which may be
1496 ;; specific highlights or more keywords anchored to `matcher'.
1497 (setq highlights (cdr keyword))
1499 (if (numberp (car (car highlights)))
1500 (let ((end (match-end (car (car highlights)))))
1501 (font-lock-apply-highlight (car highlights))
1502 ;; restart search just after the end of the
1503 ;; keyword so keywords can share bracketing
1505 (and end (goto-char end)))
1506 (font-lock-fontify-anchored-keywords (car highlights) end))
1507 (setq highlights (cdr highlights))))
1508 (setq keywords (cdr keywords))))
1509 (if loudly (lmessage 'progress "Fontifying %s... done." (buffer-name)))))
1512 ;; Various functions.
1514 ;; Turn off other related packages if they're on. I prefer a hook. --sm.
1515 ;; These explicit calls are easier to understand
1516 ;; because people know what they will do.
1517 ;; A hook is a mystery because it might do anything whatever. --rms.
1518 (defun font-lock-thing-lock-cleanup ()
1519 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
1520 (fast-lock-mode -1))
1521 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
1522 (lazy-lock-mode -1))
1523 ((and (boundp 'lazy-shot-mode) lazy-shot-mode)
1524 (lazy-shot-mode -1))))
1526 ;; Do something special for these packages after fontifying. I prefer a hook.
1527 (defun font-lock-after-fontify-buffer ()
1528 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
1529 (fast-lock-after-fontify-buffer))
1530 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
1531 (lazy-lock-after-fontify-buffer))))
1533 ;; If the buffer is about to be reverted, it won't be fontified afterward.
1534 (defun font-lock-revert-setup ()
1535 (setq font-lock-fontified nil))
1537 ;; If the buffer has just been reverted, normally that turns off
1538 ;; Font Lock mode. So turn the mode back on if necessary.
1539 ;; sb 1999-03-03 -- The above comment no longer appears to be operative as
1540 ;; the first call to normal-mode *will* restore the font-lock state and
1541 ;; this call forces a second font-locking to occur when reverting a buffer,
1542 ;; which is wasteful at best.
1543 ;(defalias 'font-lock-revert-cleanup 'turn-on-font-lock)
1544 (defun font-lock-revert-cleanup ())
1547 ;; Various functions.
1549 (defun font-lock-compile-keywords (&optional keywords)
1550 ;; Compile `font-lock-keywords' into the form (t KEYWORD ...) where KEYWORD
1551 ;; is the (MATCHER HIGHLIGHT ...) shown in the variable's doc string.
1552 (let ((keywords (or keywords font-lock-keywords)))
1553 (setq font-lock-keywords
1554 (if (eq (car-safe keywords) t)
1556 (cons t (mapcar 'font-lock-compile-keyword keywords))))))
1558 (defun font-lock-compile-keyword (keyword)
1559 (cond ((nlistp keyword) ; Just MATCHER
1560 (list keyword '(0 font-lock-keyword-face)))
1561 ((eq (car keyword) 'eval) ; Specified (eval . FORM)
1562 (font-lock-compile-keyword (eval (cdr keyword))))
1563 ((numberp (cdr keyword)) ; Specified (MATCHER . MATCH)
1564 (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
1565 ((symbolp (cdr keyword)) ; Specified (MATCHER . FACENAME)
1566 (list (car keyword) (list 0 (cdr keyword))))
1567 ((nlistp (nth 1 keyword)) ; Specified (MATCHER . HIGHLIGHT)
1568 (list (car keyword) (cdr keyword)))
1569 (t ; Hopefully (MATCHER HIGHLIGHT ...)
1572 (defun font-lock-choose-keywords (keywords level)
1573 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1574 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
1575 (let ((level (if (not (consp level))
1577 (cdr (or (assq major-mode level) (assq t level))))))
1578 (cond ((symbolp keywords)
1581 (or (nth level keywords) (car (reverse keywords))))
1583 (car (reverse keywords)))
1588 ;;; Determining which set of font-lock keywords to use.
1590 (defun font-lock-find-font-lock-defaults (modesym)
1591 ;; Get the defaults based on the major mode.
1593 ;; I want a do-while loop!
1595 (setq raw-defaults (get modesym 'font-lock-defaults))
1596 (and raw-defaults (symbolp raw-defaults)
1597 (setq modesym raw-defaults)))
1601 (defun font-lock-examine-syntax-table ()
1602 ; Computes the value of font-lock-keywords-only for this buffer.
1603 (if (eq (syntax-table) (standard-syntax-table))
1604 ;; Assume that modes which haven't bothered to install their own
1605 ;; syntax table don't do anything syntactically interesting.
1606 ;; Really, the standard-syntax-table shouldn't have comments and
1607 ;; strings in it, but changing that now might break things.
1609 ;; else map over the syntax table looking for strings or comments.
1612 (if (fboundp 'map-syntax-table)
1615 #'(lambda (key value)
1616 (memq (char-syntax-from-code value)
1617 '(?\" ?\< ?\> ?\$)))
1620 (let ((i (1- (length (syntax-table)))))
1622 (if (memq (char-syntax i) '(?\" ?\< ?\> ?\$))
1623 (setq got-one t i 0))
1625 (set (make-local-variable 'font-lock-keywords-only) (not got-one)))))
1627 ;; font-lock-set-defaults is in fontl-hooks.el.
1630 (defun font-lock-set-defaults-1 (&optional explicit-defaults)
1631 ;; does everything that font-lock-set-defaults does except
1632 ;; enable font-lock-mode. This is called by `font-lock-mode'.
1633 ;; Note that the return value is used!
1635 (if (and font-lock-defaults-computed (not explicit-defaults))
1639 (or font-lock-keywords
1640 (let* ((defaults (or (and (not (eq t explicit-defaults))
1642 ;; in case modes decide to set
1643 ;; `font-lock-defaults' themselves,
1646 (font-lock-find-font-lock-defaults major-mode)))
1647 (keywords (font-lock-choose-keywords
1648 (nth 0 defaults) font-lock-maximum-decoration)))
1651 (setq font-lock-keywords (if (fboundp keywords)
1654 (or font-lock-keywords
1656 ;; try to look for a variable `foo-mode-font-lock-keywords',
1658 (let ((major (symbol-name major-mode))
1660 (if (stringp n) (setq n (intern-soft n)))
1665 (setq font-lock-keywords
1667 (or (funcall try (get major-mode 'font-lock-keywords))
1668 (funcall try (concat major "-font-lock-keywords"))
1669 (funcall try (and (string-match "-mode\\'" major)
1672 (match-beginning 0))
1673 "-font-lock-keywords")))
1674 'font-lock-keywords)))))
1677 (if (>= (length defaults) 3)
1678 (setq font-lock-keywords-case-fold-search (nth 2 defaults))
1680 ;; look for a property 'font-lock-keywords-case-fold-search on
1681 ;; the major-mode symbol.
1682 (let* ((nonexist (make-symbol ""))
1683 (value (get major-mode 'font-lock-keywords-case-fold-search
1685 (if (not (eq nonexist value))
1686 (setq font-lock-keywords-case-fold-search value))))
1689 (if (>= (length defaults) 2)
1690 (setq font-lock-keywords-only (nth 1 defaults))
1692 ;; cleverly examine the syntax table.
1693 (font-lock-examine-syntax-table))
1696 (if (nth 3 defaults)
1697 (let ((slist (nth 3 defaults)))
1698 (setq font-lock-syntax-table
1699 (copy-syntax-table (syntax-table)))
1701 (modify-syntax-entry (car (car slist)) (cdr (car slist))
1702 font-lock-syntax-table)
1703 (setq slist (cdr slist)))))
1707 (setq font-lock-beginning-of-syntax-function
1711 ;; defaults not specified at all, so use `beginning-of-defun'.
1712 (setq font-lock-beginning-of-syntax-function
1713 'beginning-of-defun)))))
1715 (setq font-lock-defaults-computed t)))
1718 ;;;;;;;;;;;;;;;;;;;;;; keywords ;;;;;;;;;;;;;;;;;;;;;;
1720 ;;; Various major-mode interfaces.
1721 ;;; Probably these should go in with the source of the respective major modes.
1723 ;; The defaults and keywords listed here should perhaps be moved into
1724 ;; mode-specific files.
1726 ;; For C and Lisp modes we use `beginning-of-defun', rather than nil,
1727 ;; for SYNTAX-BEGIN. Thus the calculation of the cache is usually
1728 ;; faster but not infallible, so we risk mis-fontification. --sm.
1730 (put 'c-mode 'font-lock-defaults
1731 '((c-font-lock-keywords
1732 c-font-lock-keywords-1 c-font-lock-keywords-2 c-font-lock-keywords-3)
1733 nil nil ((?_ . "w")) beginning-of-defun))
1734 (put 'c++-c-mode 'font-lock-defaults 'c-mode)
1735 (put 'elec-c-mode 'font-lock-defaults 'c-mode)
1737 (put 'c++-mode 'font-lock-defaults
1738 '((c++-font-lock-keywords
1739 c++-font-lock-keywords-1 c++-font-lock-keywords-2
1740 c++-font-lock-keywords-3)
1741 nil nil ((?_ . "w") (?~ . "w")) beginning-of-defun))
1743 (put 'java-mode 'font-lock-defaults
1744 '((java-font-lock-keywords
1745 java-font-lock-keywords-1 java-font-lock-keywords-2
1746 java-font-lock-keywords-3)
1747 nil nil ((?_ . "w")) beginning-of-defun
1748 (font-lock-mark-block-function . mark-defun)))
1750 (put 'lisp-mode 'font-lock-defaults
1751 '((lisp-font-lock-keywords
1752 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
1754 ((?: . "w") (?- . "w") (?* . "w") (?+ . "w") (?. . "w") (?< . "w")
1755 (?> . "w") (?= . "w") (?! . "w") (?? . "w") (?$ . "w") (?% . "w")
1756 (?_ . "w") (?& . "w") (?~ . "w") (?^ . "w") (?/ . "w"))
1757 beginning-of-defun))
1758 (put 'emacs-lisp-mode 'font-lock-defaults 'lisp-mode)
1759 (put 'lisp-interaction-mode 'font-lock-defaults 'lisp-mode)
1761 (put 'scheme-mode 'font-lock-defaults
1762 '(scheme-font-lock-keywords
1764 ((?: . "w") (?- . "w") (?* . "w") (?+ . "w") (?. . "w") (?< . "w")
1765 (?> . "w") (?= . "w") (?! . "w") (?? . "w") (?$ . "w") (?% . "w")
1766 (?_ . "w") (?& . "w") (?~ . "w") (?^ . "w") (?/ . "w"))
1767 beginning-of-defun))
1768 (put 'inferior-scheme-mode 'font-lock-defaults 'scheme-mode)
1769 (put 'scheme-interaction-mode 'font-lock-defaults 'scheme-mode)
1771 (put 'tex-mode 'font-lock-defaults
1772 ;; For TeX modes we could use `backward-paragraph' for the same reason.
1773 '(tex-font-lock-keywords nil nil ((?$ . "\""))))
1774 ;; the nine billion names of TeX mode...
1775 (put 'bibtex-mode 'font-lock-defaults 'tex-mode)
1776 (put 'plain-tex-mode 'font-lock-defaults 'tex-mode)
1777 (put 'slitex-tex-mode 'font-lock-defaults 'tex-mode)
1778 (put 'SliTeX-mode 'font-lock-defaults 'tex-mode)
1779 (put 'slitex-mode 'font-lock-defaults 'tex-mode)
1780 (put 'latex-tex-mode 'font-lock-defaults 'tex-mode)
1781 (put 'LaTex-tex-mode 'font-lock-defaults 'tex-mode)
1782 (put 'latex-mode 'font-lock-defaults 'tex-mode)
1783 (put 'LaTeX-mode 'font-lock-defaults 'tex-mode)
1784 (put 'japanese-LaTeX-mode 'font-lock-defaults 'tex-mode)
1785 (put 'japanese-SliTeX-mode 'font-lock-defaults 'tex-mode)
1786 (put 'FoilTeX-mode 'font-lock-defaults 'tex-mode)
1787 (put 'LATeX-MoDe 'font-lock-defaults 'tex-mode)
1788 (put 'lATEx-mODe 'font-lock-defaults 'tex-mode)
1789 ;; ok, this is getting a bit silly ...
1790 (put 'eDOm-xETAl 'font-lock-defaults 'tex-mode)
1792 ;;; Various regexp information shared by several modes.
1793 ;;; Information specific to a single mode should go in its load library.
1795 (defconst lisp-font-lock-keywords-1
1797 ;; Anything not a variable or type declaration is fontified as a function.
1798 ;; It would be cleaner to allow preceding whitespace, but it would also be
1799 ;; about five times slower.
1800 (list (concat "^(\\(def\\("
1801 ;; Variable declarations.
1802 "\\(const\\(\\|ant\\)\\|ine-key\\(\\|-after\\)\\|var\\|custom\\)\\|"
1803 ;; Structure declarations.
1804 "\\(class\\|struct\\|type\\)\\|"
1805 ;; Everything else is a function declaration.
1806 "\\([^ \t\n\(\)]+\\)"
1808 ;; Any whitespace and declared object.
1810 "\\([^ \t\n\)]+\\)?")
1811 '(1 font-lock-keyword-face)
1812 '(8 (cond ((match-beginning 3) 'font-lock-variable-name-face)
1813 ((match-beginning 6) 'font-lock-type-face)
1814 (t 'font-lock-function-name-face))
1817 "Subdued level highlighting Lisp modes.")
1819 (defconst lisp-font-lock-keywords-2
1820 (append lisp-font-lock-keywords-1
1823 ;; Control structures. ELisp and CLisp combined.
1826 ;; '("cond" "if" "while" "let" "let*" "prog" "progn" "prog1"
1827 ;; "prog2" "progv" "catch" "throw" "save-restriction"
1828 ;; "save-excursion" "save-window-excursion"
1829 ;; "save-current-buffer" "with-current-buffer"
1830 ;; "with-temp-file" "with-temp-buffer" "with-output-to-string"
1831 ;; "with-string-as-buffer-contents"
1832 ;; "save-selected-window" "save-match-data" "unwind-protect"
1833 ;; "condition-case" "track-mouse" "autoload"
1834 ;; "eval-after-load" "eval-and-compile" "eval-when-compile"
1835 ;; "when" "unless" "do" "dolist" "dotimes" "flet" "labels"
1836 ;; "lambda" "return" "return-from"))
1840 "autoload\\|c\\(atch\\|ond\\(ition-case\\)?\\)\\|do\\(list\\|"
1841 "times\\)?\\|eval-\\(a\\(fter-load\\|nd-compile\\)\\|when-compile\\)\\|"
1842 "flet\\|if\\|l\\(a\\(bels\\|mbda\\)\\|et\\*?\\)\\|"
1843 "prog[nv12\\*]?\\|return\\(-from\\)?\\|save-\\(current-buffer\\|"
1844 "excursion\\|match-data\\|restriction\\|selected-window\\|"
1845 "window-excursion\\)\\|t\\(hrow\\|rack-mouse\\)\\|un\\(less\\|"
1846 "wind-protect\\)\\|w\\(h\\(en\\|ile\\)\\|ith-\\(current-buffer\\|"
1847 "output-to-string\\|string-as-buffer-contents\\|temp-\\(buffer\\|"
1851 ;; Feature symbols as references.
1852 '("(\\(featurep\\|provide\\|require\\)\\>[ \t']*\\(\\sw+\\)?"
1853 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1855 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1856 '("\\\\\\\\\\[\\(\\sw+\\)]" 1 font-lock-reference-face prepend)
1858 ;; Words inside `' tend to be symbol names.
1859 '("`\\(\\sw\\sw+\\)'" 1 font-lock-reference-face prepend)
1861 ;; CLisp `:' keywords as references.
1862 '("\\<:\\sw+\\>" 0 font-lock-reference-face prepend)
1864 ;; ELisp and CLisp `&' keywords as types.
1865 '("\\<\\&\\(optional\\|rest\\|whole\\)\\>" . font-lock-type-face)
1867 "Gaudy level highlighting for Lisp modes.")
1869 (defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
1870 "Default expressions to highlight in Lisp modes.")
1872 ;; The previous version, before replacing it with the FSF version.
1873 ;(defconst lisp-font-lock-keywords-1 (purecopy
1875 ; ;; highlight defining forms. This doesn't work too nicely for
1876 ; ;; (defun (setf foo) ...) but it does work for (defvar foo) which
1877 ; ;; is more important.
1878 ; ("^(def[-a-z]+\\s +\\([^ \t\n\)]+\\)" 1 font-lock-function-name-face)
1880 ; ;; highlight CL keywords (three clauses seems faster than one)
1881 ; ("\\s :\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1882 ; ("(:\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1883 ; ("':\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1885 ; ;; this is highlights things like (def* (setf foo) (bar baz)), but may
1886 ; ;; be slower (I haven't really thought about it)
1887 ;; ("^(def[-a-z]+\\s +\\(\\s(\\S)*\\s)\\|\\S(\\S *\\)"
1888 ;; 1 font-lock-function-name-face)
1890 ; "For consideration as a value of `lisp-font-lock-keywords'.
1891 ;This does fairly subdued highlighting.")
1893 ;(defconst lisp-font-lock-keywords-2 (purecopy
1894 ; (append lisp-font-lock-keywords-1
1896 ; ;; Highlight control structures
1897 ; ("(\\(cond\\|if\\|when\\|unless\\|[ec]?\\(type\\)?case\\)[ \t\n]" . 1)
1898 ; ("(\\(while\\|do\\|let\\*?\\|flet\\|labels\\|prog[nv12*]?\\)[ \t\n]" . 1)
1899 ; ("(\\(do\\*\\|dotimes\\|dolist\\|loop\\)[ \t\n]" . 1)
1900 ; ("(\\(catch\\|\\throw\\|block\\|return\\|return-from\\)[ \t\n]" . 1)
1901 ; ("(\\(save-restriction\\|save-window-restriction\\)[ \t\n]" . 1)
1902 ; ("(\\(save-excursion\\|unwind-protect\\|condition-case\\)[ \t\n]" . 1)
1904 ; ;; highlight function names in emacs-lisp docstrings (in the syntax
1905 ; ;; that substitute-command-keys understands.)
1906 ; ("\\\\\\\\\\[\\([^]\\\n]+\\)]" 1 font-lock-keyword-face t)
1908 ; ;; highlight words inside `' which tend to be function names
1909 ; ("`\\([-a-zA-Z0-9_][-a-zA-Z0-9_][-a-zA-Z0-9_.]+\\)'"
1910 ; 1 font-lock-keyword-face t)
1912 ; "For consideration as a value of `lisp-font-lock-keywords'.
1914 ;This does a lot more highlighting.")
1916 (defvar scheme-font-lock-keywords
1920 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1921 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1922 (list (concat "(\\(define\\("
1924 "\\(\\|-\\(generic\\(\\|-procedure\\)\\|method\\)\\)\\|"
1925 ;; Macro names, as variable names. A bit dubious, this.
1930 ;; Any whitespace and declared object.
1933 '(1 font-lock-keyword-face)
1934 '(8 (cond ((match-beginning 3) 'font-lock-function-name-face)
1935 ((match-beginning 6) 'font-lock-variable-name-face)
1936 (t 'font-lock-type-face))
1939 ;; Control structures.
1940 ;(regexp-opt '("begin" "call-with-current-continuation" "call/cc"
1941 ; "call-with-input-file" "call-with-output-file" "case" "cond"
1942 ; "do" "else" "for-each" "if" "lambda"
1943 ; "let\\*?" "let-syntax" "letrec" "letrec-syntax"
1944 ; ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1945 ; "and" "or" "delay"
1946 ; ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
1947 ; ;;"quasiquote" "quote" "unquote" "unquote-splicing"
1948 ; "map" "syntax" "syntax-rules"))
1951 "and\\|begin\\|c\\(a\\(ll\\(-with-\\(current-continuation\\|"
1952 "input-file\\|output-file\\)\\|/cc\\)\\|se\\)\\|ond\\)\\|"
1953 "d\\(elay\\|o\\)\\|else\\|for-each\\|if\\|"
1954 "l\\(ambda\\|et\\(-syntax\\|\\*?\\|rec\\(\\|-syntax\\)\\)\\)\\|"
1955 "map\\|or\\|syntax\\(\\|-rules\\)"
1958 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
1959 '("\\<<\\sw+>\\>" . font-lock-type-face)
1961 ;; Scheme `:' keywords as references.
1962 '("\\<:\\sw+\\>" . font-lock-reference-face)
1964 "Default expressions to highlight in Scheme modes.")
1966 ;; The previous version, before replacing it with the FSF version.
1967 ;(defconst scheme-font-lock-keywords (purecopy
1968 ; '(("(define[ \t]+(?\\([^ \t\n\)]+\\)" 1 font-lock-function-name-face)
1969 ; ("(\\(cond\\|lambda\\|begin\\|if\\|else\\|case\\|do\\)[ \t\n]" . 1)
1970 ; ("(\\(\\|letrec\\|let\\*?\\|set!\\|and\\|or\\)[ \t\n]" . 1)
1971 ; ("(\\(quote\\|unquote\\|quasiquote\\|unquote-splicing\\)[ \t\n]" . 1)
1972 ; ("(\\(syntax\\|syntax-rules\\|define-syntax\\|let-syntax\\|letrec-syntax\\)[ \t\n]" . 1)))
1973 ; "Expressions to highlight in Scheme buffers.")
1975 (defconst c-font-lock-keywords-1 nil
1976 "Subdued level highlighting for C modes.")
1978 (defconst c-font-lock-keywords-2 nil
1979 "Medium level highlighting for C modes.")
1981 (defconst c-font-lock-keywords-3 nil
1982 "Gaudy level highlighting for C modes.")
1984 (defconst c++-font-lock-keywords-1 nil
1985 "Subdued level highlighting for C++ modes.")
1987 (defconst c++-font-lock-keywords-2 nil
1988 "Medium level highlighting for C++ modes.")
1990 (defconst c++-font-lock-keywords-3 nil
1991 "Gaudy level highlighting for C++ modes.")
1993 (defun font-lock-match-c++-style-declaration-item-and-skip-to-next (limit)
1994 ;; Match, and move over, any declaration/definition item after point.
1995 ;; The expect syntax of an item is "word" or "word::word", possibly ending
1996 ;; with optional whitespace and a "(". Everything following the item (but
1997 ;; belonging to it) is expected to by skip-able by `forward-sexp', and items
1998 ;; are expected to be separated with a "," or ";".
1999 (if (looking-at "[ \t*&]*\\(\\(?:\\sw\\|\\s_\\)+\\)\\(::\\(\\(?:\\sw\\|\\s_\\)+\\)\\)?[ \t]*\\((\\)?")
2003 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2004 (narrow-to-region (point-min) limit)
2005 (goto-char (match-end 1))
2006 ;; Move over any item value, etc., to the next item.
2007 (while (not (looking-at "[ \t]*\\([,;]\\|$\\)"))
2008 (goto-char (or (scan-sexps (point) 1) (point-max))))
2009 (goto-char (match-end 0)))
2013 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while")
2014 "break\\|continue\\|do\\|else\\|for\\|if\\|return\\|switch\\|while")
2016 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2017 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2018 ; "void" "volatile" "const")
2019 (concat "auto\\|c\\(har\\|onst\\)\\|double\\|e\\(num\\|xtern\\)\\|"
2020 "float\\|int\\|long\\|register\\|"
2021 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|typedef\\|"
2022 "un\\(ion\\|signed\\)\\|vo\\(id\\|latile\\)")) ; 6 ()s deep.
2024 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
2025 ; "asm" "catch" "delete" "new" "operator" "sizeof" "this" "throw" "try"
2026 ; "protected" "private" "public")
2027 (concat "asm\\|break\\|c\\(atch\\|ontinue\\)\\|d\\(elete\\|o\\)\\|"
2028 "else\\|for\\|if\\|new\\|"
2029 "p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|return\\|"
2030 "s\\(izeof\\|witch\\)\\|t\\(h\\(is\\|row\\)\\|ry\\)\\|while"))
2032 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2033 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2034 ; "void" "volatile" "const" "class" "inline" "friend" "bool"
2035 ; "virtual" "complex" "template")
2036 (concat "auto\\|bool\\|c\\(har\\|lass\\|o\\(mplex\\|nst\\)\\)\\|"
2037 "double\\|e\\(num\\|xtern\\)\\|f\\(loat\\|riend\\)\\|"
2038 "in\\(line\\|t\\)\\|long\\|register\\|"
2039 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|"
2040 "t\\(emplate\\|ypedef\\)\\|un\\(ion\\|signed\\)\\|"
2041 "v\\(irtual\\|o\\(id\\|latile\\)\\)")) ; 11 ()s deep.
2042 (ctoken "\\(\\sw\\|\\s_\\|[:~*&]\\)+")
2044 (setq c-font-lock-keywords-1
2047 ;; These are all anchored at the beginning of line for speed.
2049 ;; Fontify function name definitions (GNU style; without type on line).
2051 ;; In FSF this has the simpler definition of "\\sw+" for ctoken.
2052 ;; I'm not sure if ours is more correct.
2053 ;; This is a subset of the next rule, and is slower when present. --dmoore
2054 ;; (list (concat "^\\(" ctoken "\\)[ \t]*(") 1 'font-lock-function-name-face)
2056 ;; fontify the names of functions being defined.
2057 ;; FSF doesn't have this but I think it should be fast for us because
2058 ;; our regexp routines are more intelligent than FSF's about handling
2059 ;; anchored-at-newline. (When I added this hack in regex.c, it halved
2060 ;; the time to do the regexp phase of font-lock for a C file!) Not
2061 ;; including this discriminates against those who don't follow the
2062 ;; GNU coding style. --ben
2063 ;; x?x?x?y?z should always be: (x(xx?)?)?y?z --dmoore
2066 "\\(" ctoken "[ \t]+\\)" ; type specs; there can be no
2068 "\\(" ctoken "[ \t]+\\)" ; more than 3 tokens, right?
2069 "\\(" ctoken "[ \t]+\\)"
2071 "\\([*&]+[ \t]*\\)?" ; pointer
2072 "\\(" ctoken "\\)[ \t]*(") ; name
2073 10 'font-lock-function-name-face)
2075 ;; This is faster but not by much. I don't see why not.
2076 ;(list (concat "^\\(" ctoken "\\)[ \t]*(") 1 'font-lock-function-name-face)
2078 ;; Added next two; they're both jolly-good fastmatch candidates so
2079 ;; should be fast. --ben
2081 ;; Fontify structure names (in structure definition form).
2082 (list (concat "^\\(typedef[ \t]+struct\\|struct\\|static[ \t]+struct\\)"
2083 "[ \t]+\\(" ctoken "\\)[ \t]*\\(\{\\|$\\)")
2084 2 'font-lock-function-name-face)
2086 ;; Fontify case clauses. This is fast because its anchored on the left.
2087 '("case[ \t]+\\(\\(\\sw\\|\\s_\\)+\\)[ \t]+:". 1)
2089 '("\\<\\(default\\):". 1)
2090 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2091 '("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
2093 ;; Fontify function macro names.
2094 '("^#[ \t]*define[ \t]+\\(\\(\\sw+\\)(\\)" 2 font-lock-function-name-face)
2096 ;; Fontify symbol names in #if ... defined preprocessor directives.
2098 ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
2099 (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t)))
2101 ;; Fontify symbol names in #elif ... defined preprocessor directives.
2103 ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
2104 (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t)))
2106 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2107 '("^\\(#[ \t]*[a-z]+\\)\\>[ \t]*\\(\\sw+\\)?"
2108 (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t))
2111 (setq c-font-lock-keywords-2
2112 (append c-font-lock-keywords-1
2115 ;; Simple regexps for speed.
2117 ;; Fontify all type specifiers.
2118 (cons (concat "\\<\\(" c-type-types "\\)\\>") 'font-lock-type-face)
2120 ;; Fontify all builtin keywords (except case, default and goto; see below).
2121 (cons (concat "\\<\\(" c-keywords "\\)\\>") 'font-lock-keyword-face)
2123 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2124 '("\\<\\(case\\|goto\\)\\>[ \t]*\\([^ \t\n:;]+\\)?"
2125 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2126 '("^[ \t]*\\(\\sw+\\)[ \t]*:" 1 font-lock-reference-face)
2129 (setq c-font-lock-keywords-3
2130 (append c-font-lock-keywords-2
2132 ;; More complicated regexps for more complete highlighting for types.
2133 ;; We still have to fontify type specifiers individually, as C is so hairy.
2136 ;; Fontify all storage classes and type specifiers, plus their items.
2137 (list (concat "\\<\\(" c-type-types "\\)\\>"
2138 "\\([ \t*&]+\\sw+\\>\\)*")
2139 ;; Fontify each declaration item.
2140 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
2141 ;; Start with point after all type specifiers.
2142 (goto-char (or (match-beginning 8) (match-end 1)))
2143 ;; Finish with point after first type specifier.
2144 (goto-char (match-end 1))
2145 ;; Fontify as a variable or function name.
2146 (1 (if (match-beginning 4)
2147 font-lock-function-name-face
2148 font-lock-variable-name-face))))
2150 ;; Fontify structures, or typedef names, plus their items.
2151 '("\\(}\\)[ \t*]*\\sw"
2152 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2153 (goto-char (match-end 1)) nil
2154 (1 (if (match-beginning 4)
2155 font-lock-function-name-face
2156 font-lock-variable-name-face))))
2158 ;; Fontify anything at beginning of line as a declaration or definition.
2159 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
2160 (1 font-lock-type-face)
2161 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2162 (goto-char (or (match-beginning 2) (match-end 1))) nil
2163 (1 (if (match-beginning 4)
2164 font-lock-function-name-face
2165 font-lock-variable-name-face))))
2168 (setq c++-font-lock-keywords-1
2171 ;; The list `c-font-lock-keywords-1' less that for function names.
2172 ;; the simple function form regexp has been removed. --dmoore
2173 ;;(cdr c-font-lock-keywords-1)
2174 c-font-lock-keywords-1
2176 ;; Fontify function name definitions, possibly incorporating class name.
2178 '("^\\(\\sw+\\)\\(::\\(\\sw+\\)\\)?[ \t]*("
2179 (1 (if (match-beginning 2)
2181 font-lock-function-name-face))
2182 (3 (if (match-beginning 2) font-lock-function-name-face) nil t))
2185 (setq c++-font-lock-keywords-2
2186 (append c++-font-lock-keywords-1
2189 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2190 (cons (concat "\\<\\(" c++-type-types "\\)\\>") 'font-lock-type-face)
2192 ;; Fontify operator function name overloading.
2193 '("\\<\\(operator\\)\\>[ \t]*\\([][)(><!=+-][][)(><!=+-]?\\)?"
2194 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
2196 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2197 '("\\<\\(case\\|goto\\)\\>[ \t]*\\([^ \t\n:;]+\\)?"
2198 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2199 '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-reference-face)
2201 ;; Fontify other builtin keywords.
2202 (cons (concat "\\<\\(" c++-keywords "\\)\\>") 'font-lock-keyword-face)
2205 (setq c++-font-lock-keywords-3
2206 (append c++-font-lock-keywords-2
2208 ;; More complicated regexps for more complete highlighting for types.
2211 ;; Fontify all storage classes and type specifiers, plus their items.
2212 (list (concat "\\<\\(" c++-type-types "\\)\\>"
2213 "\\([ \t*&]+\\sw+\\>\\)*")
2214 ;; Fontify each declaration item.
2215 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
2216 ;; Start with point after all type specifiers.
2217 (goto-char (or (match-beginning 13) (match-end 1)))
2218 ;; Finish with point after first type specifier.
2219 (goto-char (match-end 1))
2220 ;; Fontify as a variable or function name.
2221 (1 (cond ((match-beginning 2) 'font-lock-type-face)
2222 ((match-beginning 4) 'font-lock-function-name-face)
2223 (t 'font-lock-variable-name-face)))
2224 (3 (if (match-beginning 4)
2225 'font-lock-function-name-face
2226 'font-lock-variable-name-face) nil t)))
2228 ;; Fontify structures, or typedef names, plus their items.
2229 '("\\(}\\)[ \t*]*\\sw"
2230 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2231 (goto-char (match-end 1)) nil
2232 (1 (if (match-beginning 4)
2233 font-lock-function-name-face
2234 font-lock-variable-name-face))))
2236 ;; Fontify anything at beginning of line as a declaration or definition.
2237 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
2238 (1 font-lock-type-face)
2239 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2240 (goto-char (or (match-beginning 2) (match-end 1))) nil
2241 (1 (cond ((match-beginning 2) 'font-lock-type-face)
2242 ((match-beginning 4) 'font-lock-function-name-face)
2243 (t 'font-lock-variable-name-face)))
2244 (3 (if (match-beginning 4)
2245 'font-lock-function-name-face
2246 'font-lock-variable-name-face) nil t)))
2250 (defvar c-font-lock-keywords c-font-lock-keywords-1
2251 "Default expressions to highlight in C mode.")
2253 (defvar c++-font-lock-keywords c++-font-lock-keywords-1
2254 "Default expressions to highlight in C++ mode.")
2258 ;; Java support has been written by XEmacs people, and it's apparently
2259 ;; totally divergent from the FSF. I don't know if it's better or
2260 ;; worse, so I'm leaving it in until someone convinces me the FSF
2261 ;; version is better. --hniksic
2263 (defconst java-font-lock-keywords-1 nil
2264 "For consideration as a value of `java-font-lock-keywords'.
2265 This does fairly subdued highlighting.")
2267 (defconst java-font-lock-keywords-2 nil
2268 "For consideration as a value of `java-font-lock-keywords'.
2269 This adds highlighting of types and identifier names.")
2271 (defconst java-font-lock-keywords-3 nil
2272 "For consideration as a value of `java-font-lock-keywords'.
2273 This adds highlighting of Java documentation tags, such as @see.")
2275 (defvar java-font-lock-type-regexp
2276 (concat "\\<\\(boolean\\|byte\\|char\\|double\\|float\\|int"
2277 "\\|long\\|short\\|void\\)\\>")
2278 "Regexp which should match a primitive type.")
2280 (let ((capital-letter "A-Z\300-\326\330-\337")
2281 (letter "a-zA-Z_$\300-\326\330-\366\370-\377")
2283 (defvar java-font-lock-identifier-regexp
2284 (concat "\\<\\([" letter "][" letter digit "]*\\)\\>")
2285 "Regexp which should match all Java identifiers.")
2287 (defvar java-font-lock-class-name-regexp
2288 (concat "\\<\\([" capital-letter "][" letter digit "]*\\)\\>")
2289 "Regexp which should match a class or an interface name.
2290 The name is assumed to begin with a capital letter.")
2294 (let ((java-modifier-regexp
2295 (concat "\\<\\(abstract\\|const\\|final\\|native\\|"
2296 "private\\|protected\\|public\\|"
2297 "static\\|synchronized\\|transient\\|volatile\\)\\>")))
2299 ;; Basic font-lock support:
2300 (setq java-font-lock-keywords-1
2306 "break\\|byvalue\\|"
2307 "case\\|cast\\|catch\\|class\\|continue\\|"
2308 "do\\|else\\|extends\\|"
2309 "finally\\|for\\|future\\|"
2311 "if\\|implements\\|import\\|"
2312 "instanceof\\|interface\\|"
2313 "new\\|package\\|return\\|switch\\|"
2314 "throws?\\|try\\|while\\)\\>")
2315 1 'font-lock-keyword-face)
2318 (list java-modifier-regexp 1 font-lock-type-face)
2320 ;; Special constants:
2321 '("\\<\\(this\\|super\\)\\>" (1 font-lock-reference-face))
2322 '("\\<\\(false\\|null\\|true\\)\\>" (1 font-lock-keyword-face))
2325 (list (concat "\\<class\\>\\s *" java-font-lock-identifier-regexp)
2326 1 'font-lock-function-name-face)
2328 ;; Package declarations:
2329 (list (concat "\\<\\(package\\|import\\)\\>\\s *"
2330 java-font-lock-identifier-regexp)
2331 '(2 font-lock-reference-face)
2333 "\\=\\.\\(" java-font-lock-identifier-regexp "\\)")
2334 nil nil '(1 (if (equal (char-after (match-end 0)) ?.)
2335 'font-lock-reference-face
2336 'font-lock-type-face))))
2340 "^\\s *\\(" java-modifier-regexp "\\s +\\)*"
2341 java-font-lock-class-name-regexp "\\s *\(")
2343 '(condition-case nil
2345 (goto-char (scan-sexps (- (match-end 0) 1) 1))
2346 (parse-partial-sexp (point) (point-max) nil t)
2347 (and (looking-at "\\($\\|\\<throws\\>\\|{\\)")
2348 'font-lock-function-name-face))
2349 (error 'font-lock-function-name-face))))
2352 (list (concat "\\(" java-font-lock-type-regexp "\\|"
2353 java-font-lock-class-name-regexp "\\)"
2354 "\\s *\\(\\[\\s *\\]\\s *\\)*"
2355 java-font-lock-identifier-regexp "\\s *\(")
2357 'font-lock-function-name-face)
2362 (concat "^\\s *" java-font-lock-identifier-regexp "\\s *:")
2363 '(beginning-of-line) '(end-of-line)
2364 '(1 font-lock-reference-face)))
2366 ;; `break' and continue' destination labels:
2367 (list (concat "\\<\\(break\\|continue\\)\\>\\s *"
2368 java-font-lock-identifier-regexp)
2369 2 'font-lock-reference-face)
2372 ;; In Java, any constant expression is allowed.
2373 '("\\<case\\>\\s *\\(.*\\):" 1 font-lock-reference-face)))
2375 ;; Types and declared variable names:
2376 (setq java-font-lock-keywords-2
2379 java-font-lock-keywords-1
2381 ;; Keywords followed by a type:
2382 (list (concat "\\<\\(extends\\|instanceof\\|new\\)\\>\\s *"
2383 java-font-lock-identifier-regexp)
2384 '(2 (if (equal (char-after (match-end 0)) ?.)
2385 'font-lock-reference-face 'font-lock-type-face))
2386 (list (concat "\\=\\." java-font-lock-identifier-regexp)
2387 '(goto-char (match-end 0)) nil
2388 '(1 (if (equal (char-after (match-end 0)) ?.)
2389 'font-lock-reference-face 'font-lock-type-face))))
2391 ;; Keywords followed by a type list:
2392 (list (concat "\\<\\(implements\\|throws\\)\\>\\ s*"
2393 java-font-lock-identifier-regexp)
2394 '(2 (if (equal (char-after (match-end 0)) ?.)
2395 font-lock-reference-face font-lock-type-face))
2396 (list (concat "\\=\\(\\.\\|\\s *\\(,\\)\\s *\\)"
2397 java-font-lock-identifier-regexp)
2398 '(goto-char (match-end 0)) nil
2399 '(3 (if (equal (char-after (match-end 0)) ?.)
2400 font-lock-reference-face font-lock-type-face))))
2402 ;; primitive types, can't be confused with anything else.
2403 (list java-font-lock-type-regexp
2404 '(1 font-lock-type-face)
2405 '(font-lock-match-java-declarations
2406 (goto-char (match-end 0))
2407 (goto-char (match-end 0))
2408 (0 font-lock-variable-name-face)))
2410 ;; Declarations, class types and capitalized variables:
2412 ;; Declarations are easy to recognize. Capitalized words
2413 ;; followed by a closing parenthesis are treated as casts if they
2414 ;; also are followed by an expression. Expressions beginning with
2415 ;; a unary numerical operator, e.g. +, can't be cast to an object
2418 ;; The path of a fully qualified type, e.g. java.lang.Foo, is
2419 ;; fontified in the reference face.
2421 ;; An access to a static field, e.g. System.out.println, is
2422 ;; not fontified since it can't be distinguished from the
2423 ;; usage of a capitalized variable, e.g. Foo.out.println.
2425 (list (concat java-font-lock-class-name-regexp
2426 "\\s *\\(\\[\\s *\\]\\s *\\)*"
2427 "\\(\\<\\|$\\|)\\s *\\([\(\"]\\|\\<\\)\\)")
2428 '(1 (save-match-data
2431 (match-beginning 3))
2432 (if (not (looking-at "\\<instanceof\\>"))
2433 'font-lock-type-face))))
2434 (list (concat "\\=" java-font-lock-identifier-regexp "\\.")
2436 (goto-char (match-beginning 0))
2437 (while (or (= (preceding-char) ?.)
2438 (= (char-syntax (preceding-char)) ?w))
2440 '(goto-char (match-end 0))
2441 '(1 font-lock-reference-face)
2442 '(0 nil)) ; Workaround for bug in XEmacs.
2443 '(font-lock-match-java-declarations
2444 (goto-char (match-end 1))
2445 (goto-char (match-end 0))
2446 (1 font-lock-variable-name-face))))))
2448 ;; Modifier keywords and Java doc tags
2449 (setq java-font-lock-keywords-3
2454 ;; These must come first or the Modifiers from keywords-1 will
2455 ;; catch them. We don't want to use override fontification here
2456 ;; because then these terms will be fontified within comments.
2457 ("\\<private\\>" 0 font-lock-string-face)
2458 ("\\<protected\\>" 0 font-lock-preprocessor-face)
2459 ("\\<public\\>" 0 font-lock-reference-face))
2460 java-font-lock-keywords-2
2465 '("@\\(author\\|exception\\|throws\\|deprecated\\|param\\|return\\|see\\|since\\|version\\)\\s "
2466 0 font-lock-keyword-face t)
2468 ;; Doc tag - Parameter identifiers
2469 (list (concat "@param\\s +" java-font-lock-identifier-regexp)
2470 1 'font-lock-variable-name-face t)
2472 ;; Doc tag - Exception types
2473 (list (concat "@exception\\s +"
2474 java-font-lock-identifier-regexp)
2475 '(1 (if (equal (char-after (match-end 0)) ?.)
2476 font-lock-reference-face font-lock-type-face) t)
2477 (list (concat "\\=\\." java-font-lock-identifier-regexp)
2478 '(goto-char (match-end 0)) nil
2479 '(1 (if (equal (char-after (match-end 0)) ?.)
2480 'font-lock-reference-face 'font-lock-type-face) t)))
2482 ;; Doc tag - Exception types
2483 (list (concat "@exception\\s +"
2484 java-font-lock-identifier-regexp)
2485 '(1 (if (equal (char-after (match-end 0)) ?.)
2486 font-lock-reference-face font-lock-type-face) t)
2487 (list (concat "\\=\\." java-font-lock-identifier-regexp)
2488 '(goto-char (match-end 0)) nil
2489 '(1 (if (equal (char-after (match-end 0)) ?.)
2490 'font-lock-reference-face 'font-lock-type-face) t)))
2492 ;; Doc tag - Cross-references, usually to methods
2493 '("@see\\s +\\(\\S *[^][ \t\n\r\f(){},.;:]\\)"
2494 1 font-lock-function-name-face t)
2497 '("{@link\\s +\\([^}]*\\)}"
2498 0 font-lock-keyword-face t)
2500 '("{@link\\s +\\(\\S +\\s +\\S +\\)}"
2501 1 font-lock-function-name-face t)
2506 (defvar java-font-lock-keywords java-font-lock-keywords-1
2507 "Additional expressions to highlight in Java mode.")
2509 ;; Match and move over any declaration/definition item after
2510 ;; point. Does not match items which look like a type declaration
2511 ;; (primitive types and class names, i.e. capitalized words.)
2512 ;; Should the variable name be followed by a comma, we reposition
2513 ;; the cursor to fontify more identifiers.
2514 (defun font-lock-match-java-declarations (limit)
2515 "Match and skip over variable definitions."
2516 (if (looking-at "\\s *\\(\\[\\s *\\]\\s *\\)*")
2517 (goto-char (match-end 0)))
2519 (looking-at java-font-lock-identifier-regexp)
2521 (not (string-match java-font-lock-type-regexp
2522 (buffer-substring (match-beginning 1)
2526 (goto-char (match-beginning 1))
2528 (concat java-font-lock-class-name-regexp
2529 "\\s *\\(\\[\\s *\\]\\s *\\)*\\<")))))
2533 (narrow-to-region (point-min) limit)
2534 (goto-char (match-end 0))
2535 ;; Note: Both `scan-sexps' and the second goto-char can
2536 ;; generate an error which is caught by the
2537 ;; `condition-case' expression.
2538 (while (not (looking-at "\\s *\\(\\(,\\)\\|;\\|$\\)"))
2539 (goto-char (or (scan-sexps (point) 1) (point-max))))
2540 (goto-char (match-end 2))) ; non-nil
2544 (defvar tex-font-lock-keywords
2545 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
2546 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2547 ; 2 font-lock-function-name-face)
2548 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2549 ; 2 font-lock-reference-face)
2550 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2551 ; ;; not be able to display those fonts.
2552 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
2553 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
2554 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
2555 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
2556 ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
2557 '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2558 2 font-lock-function-name-face)
2559 ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2560 2 font-lock-reference-face)
2561 ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
2562 "\\\\\\([a-zA-Z@]+\\|.\\)"
2563 ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2564 ;; not be able to display those fonts.
2565 ;; LaTeX2e: \emph{This is emphasized}.
2566 ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
2567 ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
2568 ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
2569 3 (if (match-beginning 2) 'bold 'italic) keep)
2570 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables.
2571 ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
2572 3 (if (match-beginning 2) 'bold 'italic) keep))
2573 "Default expressions to highlight in TeX modes.")
2575 (defconst ksh-font-lock-keywords (purecopy
2577 '("\\(^\\|[^\$\\\]\\)#.*" . font-lock-comment-face)
2578 '("\\<\\(if\\|then\\|else\\|elif\\|fi\\|case\\|esac\\|for\\|do\\|done\\|foreach\\|in\\|end\\|select\\|while\\|repeat\\|time\\|function\\|until\\|exec\\|command\\|coproc\\|noglob\\|nohup\\|nocorrect\\|source\\|autoload\\|alias\\|unalias\\|export\\|set\\|echo\\|eval\\|cd\\|log\\|compctl\\)\\>" . font-lock-keyword-face)
2579 '("\\<\\[\\[.*\\]\\]\\>" . font-lock-type-face)
2580 '("\$\(.*\)" . font-lock-type-face)
2582 "Additional expressions to highlight in ksh-mode.")
2584 (defconst sh-font-lock-keywords (purecopy
2586 '("\\(^\\|[^\$\\\]\\)#.*" . font-lock-comment-face)
2587 '("\\<\\(if\\|then\\|else\\|elif\\|fi\\|case\\|esac\\|for\\|do\\|done\\|in\\|while\\|exec\\|export\\|set\\|echo\\|eval\\|cd\\)\\>" . font-lock-keyword-face)
2588 '("\\[.*\\]" . font-lock-type-face)
2589 '("`.*`" . font-lock-type-face)
2591 "Additional expressions to highlight in sh-mode.")
2594 ;; Install ourselves:
2596 (add-hook 'find-file-hooks 'font-lock-set-defaults t)
2599 (add-minor-mode 'font-lock-mode " Font")
2601 ;; Provide ourselves:
2603 (provide 'font-lock)
2605 ;;; font-lock.el ends here