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, you will see status messages only if the changed region is
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 defining the keywords for `font-lock-mode' to highlight.
323 FONT-LOCK-KEYWORDS := List of FONT-LOCK-FORM's.
325 FONT-LOCK-FORM :== MATCHER
327 | (MATCHER . FACE-FORM)
328 | (MATCHER . HIGHLIGHT)
329 | (MATCHER HIGHLIGHT ...)
332 MATCHER :== A string containing a regexp.
333 | A variable containing a regexp to search for.
334 | A function to call to make the search.
335 It is called with one arg, the limit of the search,
336 and should leave MATCH results in the XEmacs global
339 MATCH :== An integer match subexpression number from MATCHER.
341 FACE-FORM :== The symbol naming a defined face.
342 | Expression whos value is the face name to use. If you
343 want FACE-FORM to be a symbol that evaluates to a face,
344 use a form like \"(progn sym)\".
346 HIGHLIGHT :== MATCH-HIGHLIGHT
349 FORM :== Expression returning a FONT-LOCK-FORM, evaluated when
350 the FONT-LOCK-FORM is first used in a buffer. This
351 feature can be used to provide a FONT-LOCK-FORM that
352 can only be generated when Font Lock mode is actually
355 MATCH-HIGHLIGHT :== (MATCH FACE-FORM OVERRIDE LAXMATCH)
357 OVERRIDE :== t - overwrite existing fontification
358 | 'keep - only parts not already fontified are
360 | 'prepend - merge faces, this fontification has
361 precedence over existing
362 | 'append - merge faces, existing fontification has
366 LAXMATCH :== If non-nil, no error is signalled if there is no MATCH
369 MATCH-ANCHORED :== (ANCHOR-MATCHER PRE-MATCH-FORM \\
370 POST-MATCH-FORM MATCH-HIGHLIGHT ...)
372 ANCHOR-MATCHER :== Like a MATCHER, except that the limit of the search
373 defaults to the end of the line after PRE-MATCH-FORM
374 is evaluated. However, if PRE-MATCH-FORM returns a
375 position greater than the end of the line, that
376 position is used as the limit of the search. It is
377 generally a bad idea to return a position greater than
378 the end of the line, i.e., cause the ANCHOR-MATCHER
379 search to span lines.
381 PRE-MATCH-FORM :== Evaluated before the ANCHOR-MATCHER is used, therefore
382 can be used to initialize before, ANCHOR-MATCHER is
383 used. Typically, PRE-MATCH-FORM is used to move to
384 some position relative to the original MATCHER, before
385 starting with the ANCHOR-MATCHER.
387 POST-MATCH-FORM :== Like PRE-MATCH-FORM, but used to clean up after the
388 ANCHOR-MATCHER. It might be used to move, before
389 resuming with MATCH-ANCHORED's parent's MATCHER.
391 For example, an element of the first form highlights (if not already highlighted):
393 \"\\\\<foo\\\\>\" Discrete occurrences of \"foo\" in the value
394 of the variable `font-lock-keyword-face'.
396 (\"fu\\\\(bar\\\\)\" . 1) Substring \"bar\" within all occurrences of
397 \"fubar\" in the value of
398 `font-lock-keyword-face'.
400 (\"fubar\" . fubar-face) Occurrences of \"fubar\" in the value of
403 (\"foo\\\\|bar\" 0 foo-bar-face t) Occurrences of either \"foo\" or \"bar\" in the
404 value of `foo-bar-face', even if already
407 (fubar-match 1 fubar-face) The first subexpression within all
408 occurrences of whatever the function
409 `fubar-match' finds and matches in the value
412 (\"\\\\<anchor\\\\>\" (0 anchor-face) (\"\\\\<item\\\\>\" nil nil (0 item-face)))
413 -------------- --------------- ------------ --- --- -------------
415 MATCHER | ANCHOR-MATCHER | +------+ MATCH-HIGHLIGHT
416 MATCH-HIGHLIGHT PRE-MATCH-FORM |
419 Discrete occurrences of \"anchor\" in the value of `anchor-face', and
420 subsequent discrete occurrences of \"item\" (on the same line) in the value
421 of `item-face'. (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil.
422 Therefore \"item\" is initially searched for starting from the end of the
423 match of \"anchor\", and searching for subsequent instance of \"anchor\"
424 resumes from where searching for \"item\" concluded.)
426 For highlighting single items, typically only MATCH-HIGHLIGHT is required.
427 However, if an item or (typically) several items are to be highlighted
428 following the instance of another item (the anchor) then MATCH-ANCHORED may be
431 These regular expressions should not match text which spans lines. While
432 \\[font-lock-fontify-buffer] handles multi-line patterns correctly, updating when you
433 edit the buffer does not, since it considers text one line at a time.
435 Be very careful composing regexps for this list; the wrong pattern can
436 dramatically slow things down!
439 (make-variable-buffer-local 'font-lock-keywords)
441 (defvar font-lock-defaults nil
442 "The defaults font Font Lock mode for the current buffer.
443 Normally, do not set this directly. If you are writing a major mode,
444 put a property of `font-lock-defaults' on the major-mode symbol with
449 \(KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN)
451 KEYWORDS may be a symbol (a variable or function whose value is the keywords
452 to use for fontification) or a list of symbols. If KEYWORDS-ONLY is non-nil,
453 syntactic fontification (strings and comments) is not performed. If CASE-FOLD
454 is non-nil, the case of the keywords is ignored when fontifying. If
455 SYNTAX-ALIST is non-nil, it should be a list of cons pairs of the form (CHAR
456 . STRING) used to set the local Font Lock syntax table, for keyword and
457 syntactic fontification (see `modify-syntax-entry').
459 If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
460 backwards outside any enclosing syntactic block, for syntactic fontification.
461 Typical values are `beginning-of-line' (i.e., the start of the line is known to
462 be outside a syntactic block), or `beginning-of-defun' for programming modes or
463 `backward-paragraph' for textual modes (i.e., the mode-dependent function is
464 known to move outside a syntactic block). If nil, the beginning of the buffer
465 is used as a position outside of a syntactic block, in the worst case.
467 These item elements are used by Font Lock mode to set the variables
468 `font-lock-keywords', `font-lock-keywords-only',
469 `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
470 `font-lock-beginning-of-syntax-function', respectively.
472 Alternatively, if the value is a symbol, it should name a major mode,
473 and the defaults for that mode will apply.")
474 (make-variable-buffer-local 'font-lock-defaults)
476 ;; FSF uses `font-lock-defaults-alist' and expects the major mode to
477 ;; set a value for `font-lock-defaults', but I don't like either of
478 ;; these -- requiring the mode to set `font-lock-defaults' makes it
479 ;; impossible to have defaults for a minor mode, and using an alist is
480 ;; generally a bad idea for information that really should be
481 ;; decentralized. (Who knows what strange modes might want
484 (defvar font-lock-keywords-only nil
485 "Non-nil means Font Lock should not do syntactic fontification.
486 This is normally set via `font-lock-defaults'.
488 This should be nil for all ``language'' modes, but other modes, like
489 dired, do not have anything useful in the syntax tables (no comment
490 or string delimiters, etc) and so there is no need to use them and
491 this variable should have a value of t.
493 You should not set this variable directly; its value is computed
494 from `font-lock-defaults', or (if that does not specify anything)
495 by examining the syntax table to see whether it appears to contain
497 (make-variable-buffer-local 'font-lock-keywords-only)
499 (defvar font-lock-keywords-case-fold-search nil
500 "Whether the strings in `font-lock-keywords' should be case-folded.
501 This variable is automatically buffer-local, as the correct value depends
502 on the language in use.")
503 (make-variable-buffer-local 'font-lock-keywords-case-fold-search)
505 (defvar font-lock-after-fontify-buffer-hook nil
506 "Function or functions to run after completion of font-lock-fontify-buffer.")
508 (defvar font-lock-syntax-table nil
509 "Non-nil means use this syntax table for fontifying.
510 If this is nil, the major mode's syntax table is used.
511 This is normally set via `font-lock-defaults'.")
512 (make-variable-buffer-local 'font-lock-syntax-table)
514 ;; These are used in the FSF version in syntactic font-locking.
515 ;; We do this all in C.
516 ;;; These record the parse state at a particular position, always the
517 ;;; start of a line. Used to make
518 ;;; `font-lock-fontify-syntactically-region' faster.
519 ;(defvar font-lock-cache-position nil)
520 ;(defvar font-lock-cache-state nil)
521 ;(make-variable-buffer-local 'font-lock-cache-position)
522 ;(make-variable-buffer-local 'font-lock-cache-state)
524 ;; If this is nil, we only use the beginning of the buffer if we can't use
525 ;; `font-lock-cache-position' and `font-lock-cache-state'.
526 (defvar font-lock-beginning-of-syntax-function nil
527 "Non-nil means use this function to move back outside of a syntactic block.
528 If this is nil, the beginning of the buffer is used (in the worst case).
529 This is normally set via `font-lock-defaults'.")
530 (make-variable-buffer-local 'font-lock-beginning-of-syntax-function)
532 (defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer
533 "Function to use for fontifying the buffer.
534 This is normally set via `font-lock-defaults'.")
536 (defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer
537 "Function to use for unfontifying the buffer.
538 This is used when turning off Font Lock mode.
539 This is normally set via `font-lock-defaults'.")
541 (defvar font-lock-fontify-region-function 'font-lock-default-fontify-region
542 "Function to use for fontifying a region.
543 It should take two args, the beginning and end of the region, and an optional
544 third arg VERBOSE. If non-nil, the function should print status messages.
545 This is normally set via `font-lock-defaults'.")
547 (defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region
548 "Function to use for unfontifying a region.
549 It should take two args, the beginning and end of the region.
550 This is normally set via `font-lock-defaults'.")
552 (defvar font-lock-inhibit-thing-lock nil
553 "List of Font Lock mode related modes that should not be turned on.
554 Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'.
555 This is normally set via `font-lock-defaults'.")
558 (defcustom font-lock-mode nil ;; customized for the option menu. dverna
559 "Non nil means `font-lock-mode' is on"
562 :initialize 'custom-initialize-default
564 :set #'(lambda (var val) (font-lock-mode (or val 0)))
567 (defvar font-lock-fontified nil) ; whether we have hacked this buffer
568 (put 'font-lock-fontified 'permanent-local t)
571 (defvar font-lock-mode-hook nil
572 "Function or functions to run on entry to font-lock-mode.")
574 ; whether font-lock-set-defaults has already been run.
575 (defvar font-lock-defaults-computed nil)
576 (make-variable-buffer-local 'font-lock-defaults-computed)
579 ;;; Initialization of faces.
581 ;; #### barf gag retch. Horrid FSF lossage that we need to
582 ;; keep around for compatibility with font-lock-keywords that
583 ;; forget to properly quote their faces.
584 (defvar font-lock-comment-face 'font-lock-comment-face
585 "Don't even think of using this.")
586 (defvar font-lock-doc-string-face 'font-lock-doc-string-face
587 "Don't even think of using this.")
588 (defvar font-lock-string-face 'font-lock-string-face
589 "Don't even think of using this.")
590 (defvar font-lock-keyword-face 'font-lock-keyword-face
591 "Don't even think of using this.")
592 (defvar font-lock-function-name-face 'font-lock-function-name-face
593 "Don't even think of using this.")
594 (defvar font-lock-variable-name-face 'font-lock-variable-name-face
595 "Don't even think of using this.")
596 (defvar font-lock-type-face 'font-lock-type-face
597 "Don't even think of using this.")
598 (defvar font-lock-reference-face 'font-lock-reference-face
599 "Don't even think of using this.")
600 (defvar font-lock-preprocessor-face 'font-lock-preprocessor-face
601 "Don't even think of using this.")
603 (defconst font-lock-face-list
604 '(font-lock-comment-face
605 font-lock-string-face
606 font-lock-doc-string-face
607 font-lock-keyword-face
608 font-lock-function-name-face
609 font-lock-variable-name-face
611 font-lock-reference-face
612 font-lock-preprocessor-face
613 font-lock-warning-face))
615 (defface font-lock-comment-face
616 '((((class color) (background dark)) (:foreground "gray80"))
617 ;; blue4 is hardly different from black on windows.
618 (((class color) (background light) (type mswindows)) (:foreground "blue"))
619 (((class color) (background light)) (:foreground "blue4"))
620 (((class grayscale) (background light))
621 (:foreground "DimGray" :bold t :italic t))
622 (((class grayscale) (background dark))
623 (:foreground "LightGray" :bold t :italic t))
625 "Font Lock mode face used to highlight comments."
626 :group 'font-lock-faces)
628 (defface font-lock-string-face
629 '((((class color) (background dark)) (:foreground "tan"))
630 (((class color) (background light)) (:foreground "green4"))
631 (((class grayscale) (background light)) (:foreground "DimGray" :italic t))
632 (((class grayscale) (background dark)) (:foreground "LightGray" :italic t))
634 "Font Lock mode face used to highlight strings."
635 :group 'font-lock-faces)
637 (defface font-lock-doc-string-face
638 '((((class color) (background dark)) (:foreground "light coral"))
639 (((class color) (background light)) (:foreground "green4"))
641 "Font Lock mode face used to highlight documentation strings.
642 This is currently supported only in Lisp-like modes, which are those
643 with \"lisp\" or \"scheme\" in their name. You can explicitly make
644 a mode Lisp-like by putting a non-nil `font-lock-lisp-like' property
645 on the major mode's symbol."
646 :group 'font-lock-faces)
648 (defface font-lock-keyword-face
649 '((((class color) (background dark)) (:foreground "cyan"))
650 ;; red4 is hardly different from black on windows.
651 (((class color) (background light) (type mswindows)) (:foreground "red"))
652 (((class color) (background light)) (:foreground "red4"))
653 (((class grayscale) (background light)) (:foreground "LightGray" :bold t))
654 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
656 "Font Lock mode face used to highlight keywords."
657 :group 'font-lock-faces)
659 (defface font-lock-function-name-face
660 '((((class color) (background dark)) (:foreground "aquamarine"))
661 ;; brown4 is hardly different from black on windows.
662 ;; I changed it to red because IMO it's pointless and ugly to
663 ;; use a million slightly different colors for niggly syntactic
664 ;; differences. --ben
665 (((class color) (background light) (type mswindows)) (:foreground "red"))
666 (((class color) (background light)) (:foreground "brown4"))
667 (t (:bold t :underline t)))
668 "Font Lock mode face used to highlight function names."
669 :group 'font-lock-faces)
671 (defface font-lock-variable-name-face
672 '((((class color) (background dark)) (:foreground "cyan3"))
673 (((class color) (background light)) (:foreground "magenta4"))
674 (((class grayscale) (background light))
675 (:foreground "Gray90" :bold t :italic t))
676 (((class grayscale) (background dark))
677 (:foreground "DimGray" :bold t :italic t))
679 "Font Lock mode face used to highlight variable names."
680 :group 'font-lock-faces)
682 (defface font-lock-type-face
683 '((((class color) (background dark)) (:foreground "wheat"))
684 (((class color) (background light)) (:foreground "steelblue"))
685 (((class grayscale) (background light)) (:foreground "Gray90" :bold t))
686 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
688 "Font Lock mode face used to highlight types."
689 :group 'font-lock-faces)
691 (defface font-lock-reference-face
692 '((((class color) (background dark)) (:foreground "cadetblue2"))
693 (((class color) (background light)) (:foreground "red3"))
694 (((class grayscale) (background light))
695 (:foreground "LightGray" :bold t :underline t))
696 (((class grayscale) (background dark))
697 (:foreground "Gray50" :bold t :underline t)))
698 "Font Lock mode face used to highlight references."
699 :group 'font-lock-faces)
701 ;; #### FSF has font-lock-builtin-face.
703 (defface font-lock-preprocessor-face
704 '((((class color) (background dark)) (:foreground "steelblue1"))
705 (((class color) (background light)) (:foreground "blue3"))
707 "Font Lock Mode face used to highlight preprocessor conditionals."
708 :group 'font-lock-faces)
710 ;; #### Currently unused
711 (defface font-lock-warning-face
712 '((((class color) (background light)) (:foreground "Red" :bold t))
713 (((class color) (background dark)) (:foreground "Pink" :bold t))
714 (t (:inverse-video t :bold t)))
715 "Font Lock mode face used to highlight warnings."
716 :group 'font-lock-faces)
718 (defun font-lock-recompute-variables ()
719 ;; Is this a Draconian thing to do?
720 (mapc #'(lambda (buffer)
721 (with-current-buffer buffer
723 (font-lock-set-defaults t)))
726 ;; Backwards-compatible crud.
728 (defun font-lock-reset-all-faces ()
729 (dolist (face font-lock-face-list)
730 (face-spec-set face (get face 'face-defface-spec))))
732 (defun font-lock-use-default-fonts ()
733 "Reset the font-lock faces to a default set of fonts."
736 (font-lock-reset-all-faces))
738 (defun font-lock-use-default-colors ()
739 "Reset the font-lock faces to a default set of colors."
742 (font-lock-reset-all-faces))
744 (defun font-lock-use-default-minimal-decoration ()
745 "Reset the font-lock patterns to a fast, minimal set of decorations."
746 (and font-lock-maximum-decoration
747 (setq font-lock-maximum-decoration nil)
748 (font-lock-recompute-variables)))
750 (defun font-lock-use-default-maximal-decoration ()
751 "Reset the font-lock patterns to a larger set of decorations."
752 (and (not (eq t font-lock-maximum-decoration))
753 (setq font-lock-maximum-decoration t)
754 (font-lock-recompute-variables)))
757 ;;;;;;;;;;;;;;;;;;;;;; actual code ;;;;;;;;;;;;;;;;;;;;;;
759 ;;; To fontify the whole buffer by language syntax, we go through it a
760 ;;; character at a time, creating extents on the boundary of each syntactic
761 ;;; unit (that is, one extent for each block comment, one for each line
762 ;;; comment, one for each string, etc.) This is done with the C function
763 ;;; syntactically-sectionize. It's in C for speed (the speed of lisp function
764 ;;; calls was a real bottleneck for this task since it involves examining each
765 ;;; character in turn.)
767 ;;; Then we make a second pass, to fontify the buffer based on other patterns
768 ;;; specified by regexp. When we find a match for a region of text, we need
769 ;;; to change the fonts on those characters. This is done with the
770 ;;; put-text-property function, which knows how to efficiently share extents.
771 ;;; Conceptually, we are attaching some particular face to each of the
772 ;;; characters in a range, but the implementation of this involves creating
773 ;;; extents, or resizing existing ones.
775 ;;; Each time a modification happens to a line, we re-fontify the entire line.
776 ;;; We do this by first removing the extents (text properties) on the line,
777 ;;; and then doing the syntactic and keyword passes again on that line. (More
778 ;;; generally, each modified region is extended to include the preceding and
779 ;;; following BOL or EOL.)
781 ;;; This means that, as the user types, we repeatedly go back to the beginning
782 ;;; of the line, doing more work the longer the line gets. This doesn't cost
783 ;;; much in practice, and if we don't, then we incorrectly fontify things when,
784 ;;; for example, inserting spaces into `intfoo () {}'.
788 ;; The user level functions
791 (defun font-lock-mode (&optional arg)
792 "Toggle Font Lock Mode.
793 With arg, turn font-lock mode on if and only if arg is positive.
795 When Font Lock mode is enabled, text is fontified as you type it:
797 - Comments are displayed in `font-lock-comment-face';
798 - Strings are displayed in `font-lock-string-face';
799 - Documentation strings (in Lisp-like languages) are displayed in
800 `font-lock-doc-string-face';
801 - Language keywords (\"reserved words\") are displayed in
802 `font-lock-keyword-face';
803 - Function names in their defining form are displayed in
804 `font-lock-function-name-face';
805 - Variable names in their defining form are displayed in
806 `font-lock-variable-name-face';
807 - Type names are displayed in `font-lock-type-face';
808 - References appearing in help files and the like are displayed
809 in `font-lock-reference-face';
810 - Preprocessor declarations are displayed in
811 `font-lock-preprocessor-face';
815 - Certain other expressions are displayed in other faces according
816 to the value of the variable `font-lock-keywords'.
818 Where modes support different levels of fontification, you can use the variable
819 `font-lock-maximum-decoration' to specify which level you generally prefer.
820 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
821 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
822 To fontify a buffer without turning on Font Lock mode, and regardless of buffer
823 size, you can use \\[font-lock-fontify-buffer].
825 See the variable `font-lock-keywords' for customization."
827 (let ((on-p (if arg (> (prefix-numeric-value arg) 0) (not font-lock-mode)))
828 (maximum-size (if (not (consp font-lock-maximum-size))
829 font-lock-maximum-size
830 (cdr (or (assq major-mode font-lock-maximum-size)
831 (assq t font-lock-maximum-size))))))
832 ;; Font-lock mode will refuse to turn itself on if in batch mode, or if
833 ;; the current buffer is "invisible". The latter is because packages
834 ;; sometimes put their temporary buffers into some particular major mode
835 ;; to get syntax tables and variables and whatnot, but we don't want the
836 ;; fact that the user has font-lock-mode on a mode hook to slow these
838 (if (or noninteractive (eq (aref (buffer-name) 0) ?\ ))
840 (if (equal (buffer-name) " *Compiler Input*") ; hack for bytecomp...
843 (make-local-hook 'after-change-functions)
844 (add-hook 'after-change-functions
845 'font-lock-after-change-function nil t)
846 (add-hook 'pre-idle-hook 'font-lock-pre-idle-hook))
848 (remove-hook 'after-change-functions
849 'font-lock-after-change-function t)
850 (setq font-lock-defaults-computed nil
851 font-lock-keywords nil)
852 ;; We have no business doing this here, since
853 ;; pre-idle-hook is global. Other buffers may
854 ;; still be in font-lock mode. -dkindred@cs.cmu.edu
855 ;; (remove-hook 'pre-idle-hook 'font-lock-pre-idle-hook)
857 (set (make-local-variable 'font-lock-mode) on-p)
859 (font-lock-set-defaults-1)
860 (run-hooks 'font-lock-mode-hook)
861 (cond (font-lock-fontified
863 ((or (null maximum-size) (<= (buffer-size) maximum-size))
864 (font-lock-fontify-buffer))
866 (lprogress-display 'font-lock
867 "Fontifying %s... buffer too big." 'abort
870 (setq font-lock-fontified nil)
871 (font-lock-unfontify-region (point-min) (point-max))
872 (font-lock-thing-lock-cleanup))
874 (font-lock-thing-lock-cleanup)))
877 ;; For init-file hooks
879 (defun turn-on-font-lock ()
880 "Unconditionally turn on Font Lock mode."
884 (defun turn-off-font-lock ()
885 "Unconditionally turn off Font Lock mode."
890 ;; support for add-keywords, global-font-lock-mode and
891 ;; font-lock-support-mode (unified support for various *-lock modes).
894 ;; Fontification functions.
896 ;; We first define some defsubsts to encapsulate the way we add
897 ;; faces to a region of text. I am planning on modifying the
898 ;; text-property mechanism so that multiple independent classes
899 ;; of text properties can exist. That way, for example, ediff's
900 ;; face text properties don't interfere with font lock's face
901 ;; text properties. Due to the XEmacs implementation of text
902 ;; properties in terms of extents, doing this is fairly trivial:
903 ;; instead of using the `text-prop' property, you just use a
904 ;; specified property.
906 (defsubst font-lock-set-face (start end face)
907 ;; Set the face on the characters in the range.
908 (put-nonduplicable-text-property start end 'face face)
909 (put-nonduplicable-text-property start end 'font-lock t))
911 (defsubst font-lock-remove-face (start end)
912 ;; Remove any syntax highlighting on the characters in the range.
913 (put-nonduplicable-text-property start end 'face nil)
914 (put-nonduplicable-text-property start end 'font-lock nil))
916 (defsubst font-lock-any-faces-p (start end)
917 ;; Return non-nil if we've put any syntax highlighting on
918 ;; the characters in the range.
920 ;; used to look for 'text-prop property, but this has problems if
921 ;; you put any other text properties in the vicinity. Simon
922 ;; Marshall suggested looking for the 'face property (this is what
923 ;; FSF Emacs does) but that's equally bogus. Only reliable way is
924 ;; for font-lock to specially mark its extents.
926 ;; FSF's (equivalent) definition of this defsubst would be
927 ;; (text-property-not-all start end 'font-lock nil)
929 ;; Perhaps our `map-extents' is faster than our definition
930 ;; of `text-property-not-all'. #### If so, `text-property-not-all'
931 ;; should be fixed ...
933 (map-extents 'extent-property (current-buffer) start (1- end) 'font-lock))
936 ;; Fontification functions.
938 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
939 ;; code to fontify a region, the function runs the function whose name is the
940 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
941 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
942 ;; which does contain the code to fontify a region. However, the value of the
943 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
944 ;; do anything. The indirection of the fontification functions gives major
945 ;; modes the capability of modifying the way font-lock.el fontifies. Major
946 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
947 ;; via the variable `font-lock-defaults'.
949 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
950 ;; font-lock.el uses its own function for buffer fontification. This function
951 ;; makes fontification be on a message-by-message basis and so visiting an
952 ;; RMAIL file is much faster. A clever implementation of the function might
953 ;; fontify the headers differently than the message body. (It should, and
954 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
955 ;; you?) This hints at a more interesting use...
957 ;; Languages that contain text normally contained in different major modes
958 ;; could define their own fontification functions that treat text differently
959 ;; depending on its context. For example, Perl mode could arrange that here
960 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
961 ;; rules one way and C code another. Neat!
963 ;; A further reason to use the fontification indirection feature is when the
964 ;; default syntactual fontification, or the default fontification in general,
965 ;; is not flexible enough for a particular major mode. For example, perhaps
966 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
967 ;; cope with. You need to write your own version of that function, e.g.,
968 ;; `hairy-fontify-syntactically-region', and make your own version of
969 ;; `hairy-fontify-region' call that function before calling
970 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
971 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
972 ;; would call your region fontification function instead of its own. For
973 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
974 ;; directives correctly and cleanly. (It is the same problem as fontifying
975 ;; multi-line strings and comments; regexps are not appropriate for the job.)
978 (defun font-lock-fontify-buffer ()
979 "Fontify the current buffer the way `font-lock-mode' would.
980 See `font-lock-mode' for details.
982 This can take a while for large buffers."
984 (let ((font-lock-verbose (or font-lock-verbose (interactive-p))))
985 (funcall font-lock-fontify-buffer-function)))
987 (defun font-lock-unfontify-buffer ()
988 (funcall font-lock-unfontify-buffer-function))
990 (defun font-lock-fontify-region (beg end &optional loudly)
991 (funcall font-lock-fontify-region-function beg end loudly))
993 (defun font-lock-unfontify-region (beg end &optional loudly)
994 (funcall font-lock-unfontify-region-function beg end loudly))
996 (defun font-lock-default-fontify-buffer ()
998 ;; if we don't widen, then the C code will fail to
999 ;; realize that we're inside a comment.
1002 (let ((was-on font-lock-mode)
1003 (font-lock-verbose (or font-lock-verbose (interactive-p)))
1004 (font-lock-message-threshold 0)
1006 ;; Turn it on to run hooks and get the right font-lock-keywords.
1007 (or was-on (font-lock-mode 1))
1008 (font-lock-unfontify-region (point-min) (point-max) t)
1009 ;; (buffer-syntactic-context-flush-cache)
1011 ;; If a ^G is typed during fontification, abort the fontification, but
1012 ;; return normally (do not signal.) This is to make it easy to abort
1013 ;; fontification if it's taking a long time, without also causing the
1014 ;; buffer not to pop up. If a real abort is desired, the user can ^G
1017 ;; Possibly this should happen down in font-lock-fontify-region instead
1018 ;; of here, but since that happens from the after-change-hook (meaning
1019 ;; much more frequently) I'm afraid of the bad consequences of stealing
1020 ;; the interrupt character at inopportune times.
1024 (font-lock-fontify-region (point-min) (point-max)))
1028 (or was-on ; turn it off if it was off.
1029 (let ((font-lock-fontified nil)) ; kludge to prevent defontification
1030 (font-lock-mode 0)))
1031 (set (make-local-variable 'font-lock-fontified) t)
1032 (when (and aborted font-lock-verbose)
1033 (lprogress-display 'font-lock "Fontifying %s... aborted."
1034 'abort (buffer-name))))
1035 (run-hooks 'font-lock-after-fontify-buffer-hook)))
1037 (defun font-lock-default-unfontify-buffer ()
1038 (font-lock-unfontify-region (point-min) (point-max))
1039 (set (make-local-variable 'font-lock-fontified) nil))
1041 ;; This used to be `font-lock-fontify-region', and before that,
1042 ;; `font-lock-fontify-region' used to be the name used for what is now
1043 ;; `font-lock-fontify-syntactically-region'.
1044 (defun font-lock-default-fontify-region (beg end &optional loudly)
1045 (let ((modified (buffer-modified-p))
1046 (buffer-undo-list t) (inhibit-read-only t)
1047 (old-syntax-table (syntax-table))
1048 buffer-file-name buffer-file-truename)
1051 ;; Use the fontification syntax table, if any.
1052 (if font-lock-syntax-table (set-syntax-table font-lock-syntax-table))
1053 ;; Now do the fontification.
1054 (if font-lock-keywords-only
1055 (font-lock-unfontify-region beg end)
1056 (font-lock-fontify-syntactically-region beg end loudly))
1057 (font-lock-fontify-keywords-region beg end loudly))
1059 (set-syntax-table old-syntax-table)
1060 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil)))))
1062 ;; The following must be rethought, since keywords can override fontification.
1063 ; ;; Now scan for keywords, but not if we are inside a comment now.
1064 ; (or (and (not font-lock-keywords-only)
1065 ; (let ((state (parse-partial-sexp beg end nil nil
1066 ; font-lock-cache-state)))
1067 ; (or (nth 4 state) (nth 7 state))))
1068 ; (font-lock-fontify-keywords-region beg end))
1070 (defun font-lock-default-unfontify-region (beg end &optional maybe-loudly)
1071 (when (and maybe-loudly font-lock-verbose
1072 (>= (- end beg) font-lock-message-threshold))
1073 (lprogress-display 'font-lock "Fontifying %s..." 0 (buffer-name)))
1074 (let ((modified (buffer-modified-p))
1075 (buffer-undo-list t) (inhibit-read-only t)
1076 buffer-file-name buffer-file-truename)
1077 (font-lock-remove-face beg end)
1078 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil))))
1080 ;; Following is the original FSF version (similar to our original
1081 ;; version, before the deferred stuff was added).
1083 ;; I think that lazy-lock v2 tries to do something similar.
1084 ;; Those efforts should be merged.
1086 ;; Called when any modification is made to buffer text.
1087 ;(defun font-lock-after-change-function (beg end old-len)
1090 ; ;; Rescan between start of line from `beg' and start of line after `end'.
1091 ; (font-lock-fontify-region
1092 ; (progn (goto-char beg) (beginning-of-line) (point))
1093 ; (progn (goto-char end) (forward-line 1) (point))))))
1095 (defvar font-lock-always-fontify-immediately nil
1096 "Set this to non-nil to disable font-lock deferral.
1097 Otherwise, changes to existing text will not be processed until the
1098 next redisplay cycle, avoiding excessive fontification when many
1099 buffer modifications are performed or a buffer is reverted.")
1101 (defvar font-lock-pending-extent-table (make-hash-table :weakness 'key))
1102 (defvar font-lock-range-table (make-range-table))
1104 (defun font-lock-pre-idle-hook ()
1105 (condition-case font-lock-error
1106 (if (> (hash-table-count font-lock-pending-extent-table) 0)
1107 (font-lock-fontify-pending-extents))
1108 (error (warn "Error caught in `font-lock-pre-idle-hook': %s"
1111 ;;; called when any modification is made to buffer text. This function
1112 ;;; remembers the changed ranges until the next redisplay, at which point
1113 ;;; the extents are merged and pruned, and the resulting ranges fontified.
1114 ;;; This function could easily be adapted to other after-change-functions.
1116 (defun font-lock-after-change-function (beg end old-len)
1117 (when font-lock-mode
1118 (let ((ex (make-extent beg end)))
1119 (set-extent-property ex 'detachable nil)
1120 (set-extent-property ex 'end-open nil)
1121 (let ((exs (gethash (current-buffer) font-lock-pending-extent-table)))
1123 (puthash (current-buffer) exs font-lock-pending-extent-table)))
1124 (if font-lock-always-fontify-immediately
1125 (font-lock-fontify-pending-extents))))
1127 (defun font-lock-fontify-pending-extents ()
1128 ;; ah, the beauty of mapping functions.
1129 ;; this function is actually shorter than the old version, which handled
1130 ;; only one buffer and one contiguous region!
1133 #'(lambda (buffer exs)
1134 ;; remove first, to avoid infinite reprocessing if error
1135 (remhash buffer font-lock-pending-extent-table)
1136 (when (buffer-live-p buffer)
1137 (clear-range-table font-lock-range-table)
1138 (with-current-buffer buffer
1141 ;; if we don't widen, then the C code will fail to
1142 ;; realize that we're inside a comment.
1144 (let ((zmacs-region-stays
1145 zmacs-region-stays)) ; protect from change!
1149 (when (and (extent-live-p ex)
1150 (not (extent-detached-p ex)))
1151 ;; first expand the ranges to full lines, because
1152 ;; that is what will be fontified; then use a
1153 ;; range table to merge the ranges.
1154 (let* ((beg (extent-start-position ex))
1155 (end (extent-end-position ex))
1156 (beg (progn (goto-char beg)
1159 (end (progn (goto-char end)
1163 (put-range-table beg end t
1164 font-lock-range-table))))
1167 #'(lambda (beg end val)
1168 ;; Maybe flush the internal cache used by
1169 ;; syntactically-sectionize. (It'd be nice if this
1170 ;; was more automatic.) Any deletions mean the
1171 ;; cache is invalid, and insertions at beginning or
1172 ;; end of line mean that the bol cache might be
1174 ;; #### This code has been commented out for some time
1175 ;; now and is bit-rotting. Someone should look into
1177 ;; (if (or change-was-deletion (bobp)
1178 ;; (= (preceding-char) ?\n))
1179 ;; (buffer-syntactic-context-flush-cache))
1180 (if (and (= beg (point-min))
1181 (= end (point-max)))
1182 (font-lock-fontify-buffer)
1183 (font-lock-fontify-region beg end)))
1184 font-lock-range-table)))))))
1185 font-lock-pending-extent-table)))
1187 ;; Syntactic fontification functions.
1189 ;; Note: Here is the FSF version. Our version is much faster because
1190 ;; of the C support we provide. This may be useful for reference,
1191 ;; however, and perhaps there is something useful here that should
1192 ;; be merged into our version.
1194 ;(defun font-lock-fontify-syntactically-region (start end &optional loudly)
1195 ; "Put proper face on each string and comment between START and END.
1196 ;START should be at the beginning of a line."
1197 ; (let ((synstart (if comment-start-skip
1198 ; (concat "\\s\"\\|" comment-start-skip)
1200 ; (comstart (if comment-start-skip
1201 ; (concat "\\s<\\|" comment-start-skip)
1203 ; state prev prevstate)
1204 ; (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
1209 ; ;; Find the state at the `beginning-of-line' before `start'.
1210 ; (if (eq start font-lock-cache-position)
1211 ; ;; Use the cache for the state of `start'.
1212 ; (setq state font-lock-cache-state)
1213 ; ;; Find the state of `start'.
1214 ; (if (null font-lock-beginning-of-syntax-function)
1215 ; ;; Use the state at the previous cache position, if any, or
1216 ; ;; otherwise calculate from `point-min'.
1217 ; (if (or (null font-lock-cache-position)
1218 ; (< start font-lock-cache-position))
1219 ; (setq state (parse-partial-sexp (point-min) start))
1220 ; (setq state (parse-partial-sexp font-lock-cache-position start
1221 ; nil nil font-lock-cache-state)))
1222 ; ;; Call the function to move outside any syntactic block.
1223 ; (funcall font-lock-beginning-of-syntax-function)
1224 ; (setq state (parse-partial-sexp (point) start)))
1225 ; ;; Cache the state and position of `start'.
1226 ; (setq font-lock-cache-state state
1227 ; font-lock-cache-position start))
1229 ; ;; If the region starts inside a string, show the extent of it.
1231 ; (let ((beg (point)))
1232 ; (while (and (re-search-forward "\\s\"" end 'move)
1233 ; (nth 3 (parse-partial-sexp beg (point)
1235 ; (put-text-property beg (point) 'face font-lock-string-face)
1236 ; (setq state (parse-partial-sexp beg (point) nil nil state))))
1238 ; ;; Likewise for a comment.
1239 ; (if (or (nth 4 state) (nth 7 state))
1240 ; (let ((beg (point)))
1242 ; (narrow-to-region (point-min) end)
1243 ; (condition-case nil
1245 ; (re-search-backward comstart (point-min) 'move)
1246 ; (forward-comment 1)
1247 ; ;; forward-comment skips all whitespace,
1248 ; ;; so go back to the real end of the comment.
1249 ; (skip-chars-backward " \t"))
1250 ; (error (goto-char end))))
1251 ; (put-text-property beg (point) 'face font-lock-comment-face)
1252 ; (setq state (parse-partial-sexp beg (point) nil nil state))))
1254 ; ;; Find each interesting place between here and `end'.
1255 ; (while (and (< (point) end)
1256 ; (setq prev (point) prevstate state)
1257 ; (re-search-forward synstart end t)
1259 ; ;; Clear out the fonts of what we skip over.
1260 ; (remove-text-properties prev (point) '(face nil))
1261 ; ;; Verify the state at that place
1262 ; ;; so we don't get fooled by \" or \;.
1263 ; (setq state (parse-partial-sexp prev (point)
1265 ; (let ((here (point)))
1266 ; (if (or (nth 4 state) (nth 7 state))
1268 ; ;; We found a real comment start.
1269 ; (let ((beg (match-beginning 0)))
1272 ; (narrow-to-region (point-min) end)
1273 ; (condition-case nil
1275 ; (forward-comment 1)
1276 ; ;; forward-comment skips all whitespace,
1277 ; ;; so go back to the real end of the comment.
1278 ; (skip-chars-backward " \t"))
1279 ; (error (goto-char end))))
1280 ; (put-text-property beg (point) 'face
1281 ; font-lock-comment-face)
1282 ; (setq state (parse-partial-sexp here (point) nil nil state)))
1285 ; ;; We found a real string start.
1286 ; (let ((beg (match-beginning 0)))
1287 ; (while (and (re-search-forward "\\s\"" end 'move)
1288 ; (nth 3 (parse-partial-sexp here (point)
1290 ; (put-text-property beg (point) 'face font-lock-string-face)
1291 ; (setq state (parse-partial-sexp here (point)
1292 ; nil nil state))))))
1294 ; ;; Make sure `prev' is non-nil after the loop
1295 ; ;; only if it was set on the very last iteration.
1299 ; (and prev (remove-text-properties prev end '(face nil)))))
1301 (defun font-lock-lisp-like (mode)
1302 ;; Note: (or (get mode 'font-lock-lisp-like) (string-match ...)) is
1303 ;; not enough because the property needs to be able to specify a nil
1305 (if (plist-member (symbol-plist mode) 'font-lock-lisp-like)
1306 (get mode 'font-lock-lisp-like)
1307 ;; If the property is not specified, guess. Similar logic exists
1308 ;; in add-log, but I think this encompasses more modes.
1309 (string-match "lisp\\|scheme" (symbol-name mode))))
1311 (defun font-lock-fontify-syntactically-region (start end &optional loudly)
1312 "Put proper face on each string and comment between START and END.
1313 START should be at the beginning of a line."
1314 (if font-lock-keywords-only
1316 (when (and font-lock-verbose
1317 (>= (- end start) font-lock-message-threshold))
1318 (lprogress-display 'font-lock "Fontifying %s... (syntactically)" 5
1320 (font-lock-unfontify-region start end loudly)
1322 (if (> end (point-max)) (setq end (point-max)))
1323 (let ((lisp-like (font-lock-lisp-like major-mode)))
1324 (syntactically-sectionize
1325 #'(lambda (s e context depth)
1327 (cond ((eq context 'string)
1329 ;; #### It would be nice if we handled
1330 ;; Python and other non-Lisp languages with
1331 ;; docstrings correctly.
1332 (if (and lisp-like (= depth 1))
1333 ;; really we should only use this if
1334 ;; in position 3 depth 1, but that's
1335 ;; too expensive to compute.
1336 'font-lock-doc-string-face
1337 'font-lock-string-face)))
1338 ((or (eq context 'comment)
1339 (eq context 'block-comment))
1340 (setq face 'font-lock-comment-face)
1341 ; ;; Don't fontify whitespace at the beginning of lines;
1342 ; ;; otherwise comment blocks may not line up with code.
1343 ; ;; (This is sometimes a good idea, sometimes not; in any
1344 ; ;; event it should be in C for speed --jwz)
1347 ; (while (prog1 (search-forward "\n" (1- e) 'move)
1348 ; (setq face 'font-lock-comment-face)
1350 ; (skip-chars-forward " \t\n")
1353 (font-lock-set-face s e face)))
1357 ;;; Additional text property functions.
1359 ;; The following three text property functions are not generally available (and
1360 ;; it's not certain that they should be) so they are inlined for speed.
1361 ;; The case for `fillin-text-property' is simple; it may or not be generally
1362 ;; useful. (Since it is used here, it is useful in at least one place.;-)
1363 ;; However, the case for `append-text-property' and `prepend-text-property' is
1364 ;; more complicated. Should they remove duplicate property values or not? If
1365 ;; so, should the first or last duplicate item remain? Or the one that was
1366 ;; added? In our implementation, the first duplicate remains.
1368 ;; XEmacs: modified all these functions to use
1369 ;; `put-nonduplicable-text-property' instead of `put-text-property', and
1370 ;; the first one to take both SETPROP and MARKPROP, in accordance with the
1371 ;; changed definitions of `font-lock-any-faces-p' and `font-lock-set-face'.
1373 (defsubst font-lock-fillin-text-property (start end setprop markprop value &optional object)
1374 "Fill in one property of the text from START to END.
1375 Arguments PROP and VALUE specify the property and value to put where none are
1376 already in place. Therefore existing property values are not overwritten.
1377 Optional argument OBJECT is the string or buffer containing the text."
1378 (let ((start (text-property-any start end markprop nil object)) next)
1380 (setq next (next-single-property-change start markprop object end))
1381 (put-nonduplicable-text-property start next setprop value object)
1382 (put-nonduplicable-text-property start next markprop value object)
1383 (setq start (text-property-any next end markprop nil object)))))
1385 ;; This function (from simon's unique.el) is rewritten and inlined for speed.
1386 ;(defun unique (list function)
1387 ; "Uniquify LIST, deleting elements using FUNCTION.
1388 ;Return the list with subsequent duplicate items removed by side effects.
1389 ;FUNCTION is called with an element of LIST and a list of elements from LIST,
1390 ;and should return the list of elements with occurrences of the element removed,
1391 ;i.e., a function such as `delete' or `delq'.
1392 ;This function will work even if LIST is unsorted. See also `uniq'."
1393 ; (let ((list list))
1395 ; (setq list (setcdr list (funcall function (car list) (cdr list))))))
1398 (defsubst font-lock-unique (list)
1399 "Uniquify LIST, deleting elements using `delq'.
1400 Return the list with subsequent duplicate items removed by side effects."
1403 (setq list (setcdr list (delq (car list) (cdr list))))))
1406 ;; A generalisation of `facemenu-add-face' for any property, but without the
1407 ;; removal of inactive faces via `facemenu-discard-redundant-faces' and special
1408 ;; treatment of `default'. Uses `unique' to remove duplicate property values.
1409 (defsubst font-lock-prepend-text-property (start end prop value &optional object)
1410 "Prepend to one property of the text from START to END.
1411 Arguments PROP and VALUE specify the property and value to prepend to the value
1412 already in place. The resulting property values are always lists, and unique.
1413 Optional argument OBJECT is the string or buffer containing the text."
1414 (let ((val (if (listp value) value (list value))) next prev)
1415 (while (/= start end)
1416 (setq next (next-single-property-change start prop object end)
1417 prev (get-text-property start prop object))
1420 (font-lock-unique (append val (if (listp prev) prev (list prev))))
1422 (setq start next))))
1424 (defsubst font-lock-append-text-property (start end prop value &optional object)
1425 "Append to one property of the text from START to END.
1426 Arguments PROP and VALUE specify the property and value to append to the value
1427 already in place. The resulting property values are always lists, and unique.
1428 Optional argument OBJECT is the string or buffer containing the text."
1429 (let ((val (if (listp value) value (list value))) next prev)
1430 (while (/= start end)
1431 (setq next (next-single-property-change start prop object end)
1432 prev (get-text-property start prop object))
1435 (font-lock-unique (append (if (listp prev) prev (list prev)) val))
1437 (setq start next))))
1439 ;;; Regexp fontification functions.
1441 (defsubst font-lock-apply-highlight (highlight)
1442 "Apply HIGHLIGHT following a match.
1443 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1444 (let* ((match (nth 0 highlight))
1445 (start (match-beginning match)) (end (match-end match))
1446 (override (nth 2 highlight)))
1447 (let ((newface (nth 1 highlight)))
1448 (or (symbolp newface)
1449 (setq newface (eval newface)))
1451 ;; No match but we might not signal an error.
1452 (or (nth 3 highlight)
1453 (error "No match %d in highlight %S" match highlight)))
1456 ;; Cannot override existing fontification.
1457 (or (font-lock-any-faces-p start end)
1458 (font-lock-set-face start end newface)))
1460 ;; Override existing fontification.
1461 (font-lock-set-face start end newface))
1462 ((eq override 'keep)
1463 ;; Keep existing fontification.
1464 (font-lock-fillin-text-property start end 'face 'font-lock
1466 ((eq override 'prepend)
1467 ;; Prepend to existing fontification.
1468 (font-lock-prepend-text-property start end 'face newface))
1469 ((eq override 'append)
1470 ;; Append to existing fontification.
1471 (font-lock-append-text-property start end 'face newface))))))
1473 (defsubst font-lock-fontify-anchored-keywords (keywords limit)
1474 "Fontify according to KEYWORDS until LIMIT.
1475 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1476 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1477 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
1478 ;; Evaluate PRE-MATCH-FORM.
1479 (pre-match-value (eval (nth 1 keywords))))
1480 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1481 (if (and (numberp pre-match-value) (> pre-match-value (point)))
1482 (setq limit pre-match-value)
1483 (save-excursion (end-of-line) (setq limit (point))))
1485 ;; Find an occurrence of `matcher' before `limit'.
1486 (while (if (stringp matcher)
1487 (re-search-forward matcher limit t)
1488 (funcall matcher limit))
1489 ;; Apply each highlight to this instance of `matcher'.
1490 (setq highlights lowdarks)
1492 (font-lock-apply-highlight (car highlights))
1493 (setq highlights (cdr highlights)))))
1494 ;; Evaluate POST-MATCH-FORM.
1495 (eval (nth 2 keywords))))
1497 (defun font-lock-fontify-keywords-region (start end &optional loudvar)
1498 "Fontify according to `font-lock-keywords' between START and END.
1499 START should be at the beginning of a line."
1500 (let ((loudly (and font-lock-verbose
1501 (>= (- end start) font-lock-message-threshold))))
1502 (let* ((case-fold-search font-lock-keywords-case-fold-search)
1503 (keywords (cdr (if (eq (car-safe font-lock-keywords) t)
1505 (font-lock-compile-keywords))))
1506 (bufname (buffer-name))
1507 (progress 5) (old-progress 5)
1509 (nkeywords (length keywords))
1510 keyword matcher highlights)
1512 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1513 ;; In order to measure progress accurately we need to know how
1514 ;; many keywords we have and how big the region is. Then progress
1515 ;; is ((pos - start)/ (end - start) * nkeywords
1516 ;; + iteration / nkeywords) * 100
1519 ;; Find an occurrence of `matcher' from `start' to `end'.
1520 (setq keyword (car keywords) matcher (car keyword))
1522 (while (and (< (point) end)
1523 (if (stringp matcher)
1524 (re-search-forward matcher end t)
1525 (funcall matcher end)))
1526 ;; calculate progress
1528 (+ (/ (* (- (point) start) 95) (* (- end start) nkeywords))
1529 (/ (* iter 95) nkeywords) 5))
1530 (when (and loudly (> progress old-progress))
1531 (lprogress-display 'font-lock "Fontifying %s... (regexps)"
1533 (setq old-progress progress)
1534 ;; Apply each highlight to this instance of `matcher', which may be
1535 ;; specific highlights or more keywords anchored to `matcher'.
1536 (setq highlights (cdr keyword))
1538 (if (numberp (car (car highlights)))
1539 (let ((end (match-end (car (car highlights)))))
1540 (font-lock-apply-highlight (car highlights))
1541 ;; restart search just after the end of the
1542 ;; keyword so keywords can share bracketing
1544 (and end (goto-char end)))
1545 (font-lock-fontify-anchored-keywords (car highlights) end))
1546 (setq highlights (cdr highlights))))
1547 (setq iter (1+ iter))
1548 (setq keywords (cdr keywords))))
1549 (if loudly (lprogress-display 'font-lock "Fontifying %s... " 100 (buffer-name)))))
1552 ;; Various functions.
1554 ;; Turn off other related packages if they're on. I prefer a hook. --sm.
1555 ;; These explicit calls are easier to understand
1556 ;; because people know what they will do.
1557 ;; A hook is a mystery because it might do anything whatever. --rms.
1558 (defun font-lock-thing-lock-cleanup ()
1559 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
1560 (fast-lock-mode -1))
1561 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
1562 (lazy-lock-mode -1))
1563 ((and (boundp 'lazy-shot-mode) lazy-shot-mode)
1564 (lazy-shot-mode -1))))
1566 ;; Do something special for these packages after fontifying. I prefer a hook.
1567 (defun font-lock-after-fontify-buffer ()
1568 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
1569 (fast-lock-after-fontify-buffer))
1570 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
1571 (lazy-lock-after-fontify-buffer))))
1574 ;; Various functions.
1576 (defun font-lock-compile-keywords (&optional keywords)
1577 ;; Compile `font-lock-keywords' into the form (t KEYWORD ...) where KEYWORD
1578 ;; is the (MATCHER HIGHLIGHT ...) shown in the variable's doc string.
1579 (let ((keywords (or keywords font-lock-keywords)))
1580 (setq font-lock-keywords
1581 (if (eq (car-safe keywords) t)
1583 (cons t (mapcar 'font-lock-compile-keyword keywords))))))
1585 (defun font-lock-compile-keyword (keyword)
1586 (cond ((nlistp keyword) ; Just MATCHER
1587 (list keyword '(0 font-lock-keyword-face)))
1588 ((eq (car keyword) 'eval) ; Specified (eval . FORM)
1589 (font-lock-compile-keyword (eval (cdr keyword))))
1590 ((numberp (cdr keyword)) ; Specified (MATCHER . MATCH)
1591 (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
1592 ((symbolp (cdr keyword)) ; Specified (MATCHER . FACENAME)
1593 (list (car keyword) (list 0 (cdr keyword))))
1594 ((nlistp (nth 1 keyword)) ; Specified (MATCHER . HIGHLIGHT)
1595 (list (car keyword) (cdr keyword)))
1596 (t ; Hopefully (MATCHER HIGHLIGHT ...)
1599 (defun font-lock-choose-keywords (keywords level)
1600 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1601 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
1602 (let ((level (if (not (consp level))
1604 (cdr (or (assq major-mode level) (assq t level))))))
1605 (cond ((symbolp keywords)
1608 (or (nth level keywords) (car (reverse keywords))))
1610 (car (reverse keywords)))
1615 ;;; Determining which set of font-lock keywords to use.
1617 (defun font-lock-find-font-lock-defaults (modesym)
1618 ;; Get the defaults based on the major mode.
1620 ;; I want a do-while loop!
1622 (setq raw-defaults (get modesym 'font-lock-defaults))
1623 (and raw-defaults (symbolp raw-defaults)
1624 (setq modesym raw-defaults)))
1628 (defun font-lock-examine-syntax-table ()
1629 ; Computes the value of font-lock-keywords-only for this buffer.
1630 (if (eq (syntax-table) (standard-syntax-table))
1631 ;; Assume that modes which haven't bothered to install their own
1632 ;; syntax table don't do anything syntactically interesting.
1633 ;; Really, the standard-syntax-table shouldn't have comments and
1634 ;; strings in it, but changing that now might break things.
1636 ;; else map over the syntax table looking for strings or comments.
1639 (if (fboundp 'map-syntax-table)
1642 #'(lambda (key value)
1643 (memq (char-syntax-from-code value)
1644 '(?\" ?\< ?\> ?\$)))
1647 (let ((i (1- (length (syntax-table)))))
1649 (if (memq (char-syntax i) '(?\" ?\< ?\> ?\$))
1650 (setq got-one t i 0))
1652 (set (make-local-variable 'font-lock-keywords-only) (not got-one)))))
1654 ;; font-lock-set-defaults is in fontl-hooks.el.
1657 (defun font-lock-set-defaults-1 (&optional explicit-defaults)
1658 ;; does everything that font-lock-set-defaults does except
1659 ;; enable font-lock-mode. This is called by `font-lock-mode'.
1660 ;; Note that the return value is used!
1662 (if (and font-lock-defaults-computed (not explicit-defaults))
1666 (or font-lock-keywords
1667 (let* ((defaults (or (and (not (eq t explicit-defaults))
1669 ;; in case modes decide to set
1670 ;; `font-lock-defaults' themselves,
1673 (font-lock-find-font-lock-defaults major-mode)))
1674 (keywords (font-lock-choose-keywords
1675 (nth 0 defaults) font-lock-maximum-decoration)))
1678 (setq font-lock-keywords (if (fboundp keywords)
1681 (or font-lock-keywords
1683 ;; try to look for a variable `foo-mode-font-lock-keywords',
1685 (let ((major (symbol-name major-mode))
1687 (if (stringp n) (setq n (intern-soft n)))
1692 (setq font-lock-keywords
1694 (or (funcall try (get major-mode 'font-lock-keywords))
1695 (funcall try (concat major "-font-lock-keywords"))
1696 (funcall try (and (string-match "-mode\\'" major)
1699 (match-beginning 0))
1700 "-font-lock-keywords")))
1701 'font-lock-keywords)))))
1704 (if (>= (length defaults) 3)
1705 (setq font-lock-keywords-case-fold-search (nth 2 defaults))
1707 ;; look for a property 'font-lock-keywords-case-fold-search on
1708 ;; the major-mode symbol.
1709 (let* ((nonexist (make-symbol ""))
1710 (value (get major-mode 'font-lock-keywords-case-fold-search
1712 (if (not (eq nonexist value))
1713 (setq font-lock-keywords-case-fold-search value))))
1716 (if (>= (length defaults) 2)
1717 (setq font-lock-keywords-only (nth 1 defaults))
1719 ;; cleverly examine the syntax table.
1720 (font-lock-examine-syntax-table))
1723 (if (nth 3 defaults)
1724 (let ((slist (nth 3 defaults)))
1725 (setq font-lock-syntax-table
1726 (copy-syntax-table (syntax-table)))
1728 (modify-syntax-entry (car (car slist)) (cdr (car slist))
1729 font-lock-syntax-table)
1730 (setq slist (cdr slist)))))
1734 (setq font-lock-beginning-of-syntax-function
1738 ;; defaults not specified at all, so use `beginning-of-defun'.
1739 (setq font-lock-beginning-of-syntax-function
1740 'beginning-of-defun)))))
1742 (setq font-lock-defaults-computed t)))
1745 ;;;;;;;;;;;;;;;;;;;;;; keywords ;;;;;;;;;;;;;;;;;;;;;;
1747 ;;; Various major-mode interfaces.
1748 ;;; Probably these should go in with the source of the respective major modes.
1750 ;; The defaults and keywords listed here should perhaps be moved into
1751 ;; mode-specific files.
1753 ;; For C and Lisp modes we use `beginning-of-defun', rather than nil,
1754 ;; for SYNTAX-BEGIN. Thus the calculation of the cache is usually
1755 ;; faster but not infallible, so we risk mis-fontification. --sm.
1757 (put 'c-mode 'font-lock-defaults
1758 '((c-font-lock-keywords
1759 c-font-lock-keywords-1 c-font-lock-keywords-2 c-font-lock-keywords-3)
1760 nil nil ((?_ . "w")) beginning-of-defun))
1761 (put 'c++-c-mode 'font-lock-defaults 'c-mode)
1762 (put 'elec-c-mode 'font-lock-defaults 'c-mode)
1764 (put 'c++-mode 'font-lock-defaults
1765 '((c++-font-lock-keywords
1766 c++-font-lock-keywords-1 c++-font-lock-keywords-2
1767 c++-font-lock-keywords-3)
1768 nil nil ((?_ . "w") (?~ . "w")) beginning-of-defun))
1770 (put 'java-mode 'font-lock-defaults
1771 '((java-font-lock-keywords
1772 java-font-lock-keywords-1 java-font-lock-keywords-2
1773 java-font-lock-keywords-3)
1774 nil nil ((?_ . "w")) beginning-of-defun
1775 (font-lock-mark-block-function . mark-defun)))
1777 (put 'lisp-mode 'font-lock-defaults
1778 '((lisp-font-lock-keywords
1779 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
1781 ((?: . "w") (?- . "w") (?* . "w") (?+ . "w") (?. . "w") (?< . "w")
1782 (?> . "w") (?= . "w") (?! . "w") (?? . "w") (?$ . "w") (?% . "w")
1783 (?_ . "w") (?& . "w") (?~ . "w") (?^ . "w") (?/ . "w"))
1784 beginning-of-defun))
1785 (put 'emacs-lisp-mode 'font-lock-defaults 'lisp-mode)
1786 (put 'lisp-interaction-mode 'font-lock-defaults 'lisp-mode)
1788 (put 'scheme-mode 'font-lock-defaults
1789 '(scheme-font-lock-keywords
1791 ((?: . "w") (?- . "w") (?* . "w") (?+ . "w") (?. . "w") (?< . "w")
1792 (?> . "w") (?= . "w") (?! . "w") (?? . "w") (?$ . "w") (?% . "w")
1793 (?_ . "w") (?& . "w") (?~ . "w") (?^ . "w") (?/ . "w"))
1794 beginning-of-defun))
1795 (put 'inferior-scheme-mode 'font-lock-defaults 'scheme-mode)
1796 (put 'scheme-interaction-mode 'font-lock-defaults 'scheme-mode)
1798 (put 'tex-mode 'font-lock-defaults
1799 ;; For TeX modes we could use `backward-paragraph' for the same reason.
1800 '(tex-font-lock-keywords nil nil ((?$ . "\""))))
1801 ;; the nine billion names of TeX mode...
1802 (put 'bibtex-mode 'font-lock-defaults 'tex-mode)
1803 (put 'plain-tex-mode 'font-lock-defaults 'tex-mode)
1804 (put 'slitex-tex-mode 'font-lock-defaults 'tex-mode)
1805 (put 'SliTeX-mode 'font-lock-defaults 'tex-mode)
1806 (put 'slitex-mode 'font-lock-defaults 'tex-mode)
1807 (put 'latex-tex-mode 'font-lock-defaults 'tex-mode)
1808 (put 'LaTex-tex-mode 'font-lock-defaults 'tex-mode)
1809 (put 'latex-mode 'font-lock-defaults 'tex-mode)
1810 (put 'LaTeX-mode 'font-lock-defaults 'tex-mode)
1811 (put 'japanese-LaTeX-mode 'font-lock-defaults 'tex-mode)
1812 (put 'japanese-SliTeX-mode 'font-lock-defaults 'tex-mode)
1813 (put 'FoilTeX-mode 'font-lock-defaults 'tex-mode)
1814 (put 'LATeX-MoDe 'font-lock-defaults 'tex-mode)
1815 (put 'lATEx-mODe 'font-lock-defaults 'tex-mode)
1816 ;; ok, this is getting a bit silly ...
1817 (put 'eDOm-xETAl 'font-lock-defaults 'tex-mode)
1819 ;;; Various regexp information shared by several modes.
1820 ;;; Information specific to a single mode should go in its load library.
1822 (defconst lisp-font-lock-keywords-1
1824 ;; Anything not a variable or type declaration is fontified as a function.
1825 ;; It would be cleaner to allow preceding whitespace, but it would also be
1826 ;; about five times slower.
1827 (list (concat "^(\\(def\\("
1828 ;; Variable declarations.
1829 "\\(const\\(\\|ant\\)\\|ine-key\\(\\|-after\\)\\|var\\|custom\\)\\|"
1830 ;; Structure declarations.
1831 "\\(class\\|struct\\|type\\)\\|"
1832 ;; Everything else is a function declaration.
1833 "\\([^ \t\n\(\)]+\\)"
1835 ;; Any whitespace and declared object.
1837 "\\([^ \t\n\)]+\\)?")
1838 '(1 font-lock-keyword-face)
1839 '(8 (cond ((match-beginning 3) 'font-lock-variable-name-face)
1840 ((match-beginning 6) 'font-lock-type-face)
1841 (t 'font-lock-function-name-face))
1844 "Subdued level highlighting Lisp modes.")
1846 (defconst lisp-font-lock-keywords-2
1847 (append lisp-font-lock-keywords-1
1850 ;; Control structures. ELisp and CLisp combined.
1853 ;; '("cond" "if" "while" "let" "let*" "prog" "progn" "prog1"
1854 ;; "prog2" "progv" "catch" "throw" "save-restriction"
1855 ;; "save-excursion" "save-window-excursion"
1856 ;; "save-current-buffer" "with-current-buffer"
1857 ;; "with-temp-file" "with-temp-buffer" "with-output-to-string"
1858 ;; "with-string-as-buffer-contents"
1859 ;; "save-selected-window" "save-match-data" "unwind-protect"
1860 ;; "condition-case" "track-mouse" "autoload"
1861 ;; "eval-after-load" "eval-and-compile" "eval-when-compile"
1862 ;; "when" "unless" "do" "dolist" "dotimes" "flet" "labels"
1863 ;; "lambda" "return" "return-from"))
1867 "autoload\\|c\\(atch\\|ond\\(ition-case\\)?\\)\\|do\\(list\\|"
1868 "times\\)?\\|eval-\\(a\\(fter-load\\|nd-compile\\)\\|when-compile\\)\\|"
1869 "flet\\|if\\|l\\(a\\(bels\\|mbda\\)\\|et\\*?\\)\\|"
1870 "prog[nv12\\*]?\\|return\\(-from\\)?\\|save-\\(current-buffer\\|"
1871 "excursion\\|match-data\\|restriction\\|selected-window\\|"
1872 "window-excursion\\)\\|t\\(hrow\\|rack-mouse\\)\\|un\\(less\\|"
1873 "wind-protect\\)\\|w\\(h\\(en\\|ile\\)\\|ith-\\(current-buffer\\|"
1874 "output-to-string\\|string-as-buffer-contents\\|temp-\\(buffer\\|"
1878 ;; Feature symbols as references.
1879 '("(\\(featurep\\|provide\\|require\\)\\>[ \t']*\\(\\sw+\\)?"
1880 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1882 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1883 '("\\\\\\\\\\[\\(\\sw+\\)]" 1 font-lock-reference-face prepend)
1885 ;; Words inside `' tend to be symbol names.
1886 '("`\\(\\sw\\sw+\\)'" 1 font-lock-reference-face prepend)
1888 ;; CLisp `:' keywords as references.
1889 '("\\<:\\sw+\\>" 0 font-lock-reference-face prepend)
1891 ;; ELisp and CLisp `&' keywords as types.
1892 '("\\<\\&\\(optional\\|rest\\|whole\\)\\>" . font-lock-type-face)
1894 "Gaudy level highlighting for Lisp modes.")
1896 (defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
1897 "Default expressions to highlight in Lisp modes.")
1899 ;; The previous version, before replacing it with the FSF version.
1900 ;(defconst lisp-font-lock-keywords-1 (purecopy
1902 ; ;; highlight defining forms. This doesn't work too nicely for
1903 ; ;; (defun (setf foo) ...) but it does work for (defvar foo) which
1904 ; ;; is more important.
1905 ; ("^(def[-a-z]+\\s +\\([^ \t\n\)]+\\)" 1 font-lock-function-name-face)
1907 ; ;; highlight CL keywords (three clauses seems faster than one)
1908 ; ("\\s :\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1909 ; ("(:\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1910 ; ("':\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1912 ; ;; this is highlights things like (def* (setf foo) (bar baz)), but may
1913 ; ;; be slower (I haven't really thought about it)
1914 ;; ("^(def[-a-z]+\\s +\\(\\s(\\S)*\\s)\\|\\S(\\S *\\)"
1915 ;; 1 font-lock-function-name-face)
1917 ; "For consideration as a value of `lisp-font-lock-keywords'.
1918 ;This does fairly subdued highlighting.")
1920 ;(defconst lisp-font-lock-keywords-2 (purecopy
1921 ; (append lisp-font-lock-keywords-1
1923 ; ;; Highlight control structures
1924 ; ("(\\(cond\\|if\\|when\\|unless\\|[ec]?\\(type\\)?case\\)[ \t\n]" . 1)
1925 ; ("(\\(while\\|do\\|let\\*?\\|flet\\|labels\\|prog[nv12*]?\\)[ \t\n]" . 1)
1926 ; ("(\\(do\\*\\|dotimes\\|dolist\\|loop\\)[ \t\n]" . 1)
1927 ; ("(\\(catch\\|\\throw\\|block\\|return\\|return-from\\)[ \t\n]" . 1)
1928 ; ("(\\(save-restriction\\|save-window-restriction\\)[ \t\n]" . 1)
1929 ; ("(\\(save-excursion\\|unwind-protect\\|condition-case\\)[ \t\n]" . 1)
1931 ; ;; highlight function names in emacs-lisp docstrings (in the syntax
1932 ; ;; that substitute-command-keys understands.)
1933 ; ("\\\\\\\\\\[\\([^]\\\n]+\\)]" 1 font-lock-keyword-face t)
1935 ; ;; highlight words inside `' which tend to be function names
1936 ; ("`\\([-a-zA-Z0-9_][-a-zA-Z0-9_][-a-zA-Z0-9_.]+\\)'"
1937 ; 1 font-lock-keyword-face t)
1939 ; "For consideration as a value of `lisp-font-lock-keywords'.
1941 ;This does a lot more highlighting.")
1943 (defvar scheme-font-lock-keywords
1947 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1948 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1949 (list (concat "(\\(define\\("
1951 "\\(\\|-\\(generic\\(\\|-procedure\\)\\|method\\)\\)\\|"
1952 ;; Macro names, as variable names. A bit dubious, this.
1957 ;; Any whitespace and declared object.
1960 '(1 font-lock-keyword-face)
1961 '(8 (cond ((match-beginning 3) 'font-lock-function-name-face)
1962 ((match-beginning 6) 'font-lock-variable-name-face)
1963 (t 'font-lock-type-face))
1966 ;; Control structures.
1967 ;(regexp-opt '("begin" "call-with-current-continuation" "call/cc"
1968 ; "call-with-input-file" "call-with-output-file" "case" "cond"
1969 ; "do" "else" "for-each" "if" "lambda"
1970 ; "let\\*?" "let-syntax" "letrec" "letrec-syntax"
1971 ; ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1972 ; "and" "or" "delay"
1973 ; ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
1974 ; ;;"quasiquote" "quote" "unquote" "unquote-splicing"
1975 ; "map" "syntax" "syntax-rules"))
1978 "and\\|begin\\|c\\(a\\(ll\\(-with-\\(current-continuation\\|"
1979 "input-file\\|output-file\\)\\|/cc\\)\\|se\\)\\|ond\\)\\|"
1980 "d\\(elay\\|o\\)\\|else\\|for-each\\|if\\|"
1981 "l\\(ambda\\|et\\(-syntax\\|\\*?\\|rec\\(\\|-syntax\\)\\)\\)\\|"
1982 "map\\|or\\|syntax\\(\\|-rules\\)"
1985 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
1986 '("\\<<\\sw+>\\>" . font-lock-type-face)
1988 ;; Scheme `:' keywords as references.
1989 '("\\<:\\sw+\\>" . font-lock-reference-face)
1991 "Default expressions to highlight in Scheme modes.")
1993 ;; The previous version, before replacing it with the FSF version.
1994 ;(defconst scheme-font-lock-keywords (purecopy
1995 ; '(("(define[ \t]+(?\\([^ \t\n\)]+\\)" 1 font-lock-function-name-face)
1996 ; ("(\\(cond\\|lambda\\|begin\\|if\\|else\\|case\\|do\\)[ \t\n]" . 1)
1997 ; ("(\\(\\|letrec\\|let\\*?\\|set!\\|and\\|or\\)[ \t\n]" . 1)
1998 ; ("(\\(quote\\|unquote\\|quasiquote\\|unquote-splicing\\)[ \t\n]" . 1)
1999 ; ("(\\(syntax\\|syntax-rules\\|define-syntax\\|let-syntax\\|letrec-syntax\\)[ \t\n]" . 1)))
2000 ; "Expressions to highlight in Scheme buffers.")
2002 (defconst c-font-lock-keywords-1 nil
2003 "Subdued level highlighting for C modes.")
2005 (defconst c-font-lock-keywords-2 nil
2006 "Medium level highlighting for C modes.")
2008 (defconst c-font-lock-keywords-3 nil
2009 "Gaudy level highlighting for C modes.")
2011 (defconst c++-font-lock-keywords-1 nil
2012 "Subdued level highlighting for C++ modes.")
2014 (defconst c++-font-lock-keywords-2 nil
2015 "Medium level highlighting for C++ modes.")
2017 (defconst c++-font-lock-keywords-3 nil
2018 "Gaudy level highlighting for C++ modes.")
2020 (defun font-lock-match-c++-style-declaration-item-and-skip-to-next (limit)
2021 ;; Match, and move over, any declaration/definition item after point.
2022 ;; The expect syntax of an item is "word" or "word::word", possibly ending
2023 ;; with optional whitespace and a "(". Everything following the item (but
2024 ;; belonging to it) is expected to by skip-able by `forward-sexp', and items
2025 ;; are expected to be separated with a "," or ";".
2026 (if (looking-at "[ \t*&]*\\(\\(?:\\sw\\|\\s_\\)+\\)\\(::\\(\\(?:\\sw\\|\\s_\\)+\\)\\)?[ \t]*\\((\\)?")
2030 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2031 (narrow-to-region (point-min) limit)
2032 (goto-char (match-end 1))
2033 ;; Move over any item value, etc., to the next item.
2034 (while (not (looking-at "[ \t]*\\([,;]\\|$\\)"))
2035 (goto-char (or (scan-sexps (point) 1) (point-max))))
2036 (goto-char (match-end 0)))
2040 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while")
2041 "break\\|continue\\|do\\|else\\|for\\|if\\|return\\|switch\\|while")
2043 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2044 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2045 ; "void" "volatile" "const")
2046 (concat "auto\\|c\\(har\\|onst\\)\\|double\\|e\\(num\\|xtern\\)\\|"
2047 "float\\|int\\|long\\|register\\|"
2048 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|typedef\\|"
2049 "un\\(ion\\|signed\\)\\|vo\\(id\\|latile\\)")) ; 6 ()s deep.
2051 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
2052 ; "asm" "catch" "delete" "new" "operator" "sizeof" "this" "throw" "try"
2053 ; "protected" "private" "public")
2054 (concat "asm\\|break\\|c\\(atch\\|ontinue\\)\\|d\\(elete\\|o\\)\\|"
2055 "else\\|for\\|if\\|new\\|"
2056 "p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|return\\|"
2057 "s\\(izeof\\|witch\\)\\|t\\(h\\(is\\|row\\)\\|ry\\)\\|while"))
2059 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2060 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2061 ; "void" "volatile" "const" "class" "inline" "friend" "bool"
2062 ; "virtual" "complex" "template")
2063 (concat "auto\\|bool\\|c\\(har\\|lass\\|o\\(mplex\\|nst\\)\\)\\|"
2064 "double\\|e\\(num\\|xtern\\)\\|f\\(loat\\|riend\\)\\|"
2065 "in\\(line\\|t\\)\\|long\\|register\\|"
2066 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|"
2067 "t\\(emplate\\|ypedef\\)\\|un\\(ion\\|signed\\)\\|"
2068 "v\\(irtual\\|o\\(id\\|latile\\)\\)")) ; 11 ()s deep.
2069 (ctoken "\\(\\sw\\|\\s_\\|[:~*&]\\)+")
2071 (setq c-font-lock-keywords-1
2074 ;; These are all anchored at the beginning of line for speed.
2076 ;; Fontify function name definitions (GNU style; without type on line).
2078 ;; In FSF this has the simpler definition of "\\sw+" for ctoken.
2079 ;; I'm not sure if ours is more correct.
2080 ;; This is a subset of the next rule, and is slower when present. --dmoore
2081 ;; (list (concat "^\\(" ctoken "\\)[ \t]*(") 1 'font-lock-function-name-face)
2083 ;; fontify the names of functions being defined.
2084 ;; FSF doesn't have this but I think it should be fast for us because
2085 ;; our regexp routines are more intelligent than FSF's about handling
2086 ;; anchored-at-newline. (When I added this hack in regex.c, it halved
2087 ;; the time to do the regexp phase of font-lock for a C file!) Not
2088 ;; including this discriminates against those who don't follow the
2089 ;; GNU coding style. --ben
2090 ;; x?x?x?y?z should always be: (x(xx?)?)?y?z --dmoore
2093 "\\(" ctoken "[ \t]+\\)" ; type specs; there can be no
2095 "\\(" ctoken "[ \t]+\\)" ; more than 3 tokens, right?
2096 "\\(" ctoken "[ \t]+\\)"
2098 "\\([*&]+[ \t]*\\)?" ; pointer
2099 "\\(" ctoken "\\)[ \t]*(") ; name
2100 10 'font-lock-function-name-face)
2102 ;; This is faster but not by much. I don't see why not.
2103 ;(list (concat "^\\(" ctoken "\\)[ \t]*(") 1 'font-lock-function-name-face)
2105 ;; Added next two; they're both jolly-good fastmatch candidates so
2106 ;; should be fast. --ben
2108 ;; Fontify structure names (in structure definition form).
2109 (list (concat "^\\(typedef[ \t]+struct\\|struct\\|static[ \t]+struct\\)"
2110 "[ \t]+\\(" ctoken "\\)[ \t]*\\(\{\\|$\\)")
2111 2 'font-lock-function-name-face)
2113 ;; Fontify case clauses. This is fast because its anchored on the left.
2114 '("case[ \t]+\\(\\(\\sw\\|\\s_\\)+\\)[ \t]+:". 1)
2116 '("\\<\\(default\\):". 1)
2117 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2118 '("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
2120 ;; Fontify function macro names.
2121 '("^#[ \t]*define[ \t]+\\(\\(\\sw+\\)(\\)" 2 font-lock-function-name-face)
2123 ;; Fontify symbol names in #if ... defined preprocessor directives.
2125 ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
2126 (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t)))
2128 ;; Fontify symbol names in #elif ... defined preprocessor directives.
2130 ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
2131 (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t)))
2133 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2134 '("^\\(#[ \t]*[a-z]+\\)\\>[ \t]*\\(\\sw+\\)?"
2135 (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t))
2138 (setq c-font-lock-keywords-2
2139 (append c-font-lock-keywords-1
2142 ;; Simple regexps for speed.
2144 ;; Fontify all type specifiers.
2145 (cons (concat "\\<\\(" c-type-types "\\)\\>") 'font-lock-type-face)
2147 ;; Fontify all builtin keywords (except case, default and goto; see below).
2148 (cons (concat "\\<\\(" c-keywords "\\)\\>") 'font-lock-keyword-face)
2150 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2151 '("\\<\\(case\\|goto\\)\\>[ \t]*\\([^ \t\n:;]+\\)?"
2152 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2153 '("^[ \t]*\\(\\sw+\\)[ \t]*:" 1 font-lock-reference-face)
2156 (setq c-font-lock-keywords-3
2157 (append c-font-lock-keywords-2
2159 ;; More complicated regexps for more complete highlighting for types.
2160 ;; We still have to fontify type specifiers individually, as C is so hairy.
2163 ;; Fontify all storage classes and type specifiers, plus their items.
2164 (list (concat "\\<\\(" c-type-types "\\)\\>"
2165 "\\([ \t*&]+\\sw+\\>\\)*")
2166 ;; Fontify each declaration item.
2167 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
2168 ;; Start with point after all type specifiers.
2169 (goto-char (or (match-beginning 8) (match-end 1)))
2170 ;; Finish with point after first type specifier.
2171 (goto-char (match-end 1))
2172 ;; Fontify as a variable or function name.
2173 (1 (if (match-beginning 4)
2174 font-lock-function-name-face
2175 font-lock-variable-name-face))))
2177 ;; Fontify structures, or typedef names, plus their items.
2178 '("\\(}\\)[ \t*]*\\sw"
2179 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2180 (goto-char (match-end 1)) nil
2181 (1 (if (match-beginning 4)
2182 font-lock-function-name-face
2183 font-lock-variable-name-face))))
2185 ;; Fontify anything at beginning of line as a declaration or definition.
2186 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
2187 (1 font-lock-type-face)
2188 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2189 (goto-char (or (match-beginning 2) (match-end 1))) nil
2190 (1 (if (match-beginning 4)
2191 font-lock-function-name-face
2192 font-lock-variable-name-face))))
2195 (setq c++-font-lock-keywords-1
2198 ;; The list `c-font-lock-keywords-1' less that for function names.
2199 ;; the simple function form regexp has been removed. --dmoore
2200 ;;(cdr c-font-lock-keywords-1)
2201 c-font-lock-keywords-1
2203 ;; Fontify function name definitions, possibly incorporating class name.
2205 '("^\\(\\sw+\\)\\(::\\(\\sw+\\)\\)?[ \t]*("
2206 (1 (if (match-beginning 2)
2208 font-lock-function-name-face))
2209 (3 (if (match-beginning 2) font-lock-function-name-face) nil t))
2212 (setq c++-font-lock-keywords-2
2213 (append c++-font-lock-keywords-1
2216 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2217 (cons (concat "\\<\\(" c++-type-types "\\)\\>") 'font-lock-type-face)
2219 ;; Fontify operator function name overloading.
2220 '("\\<\\(operator\\)\\>[ \t]*\\([][)(><!=+-][][)(><!=+-]?\\)?"
2221 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
2223 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2224 '("\\<\\(case\\|goto\\)\\>[ \t]*\\([^ \t\n:;]+\\)?"
2225 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2226 '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-reference-face)
2228 ;; Fontify other builtin keywords.
2229 (cons (concat "\\<\\(" c++-keywords "\\)\\>") 'font-lock-keyword-face)
2232 (setq c++-font-lock-keywords-3
2233 (append c++-font-lock-keywords-2
2235 ;; More complicated regexps for more complete highlighting for types.
2238 ;; Fontify all storage classes and type specifiers, plus their items.
2239 (list (concat "\\<\\(" c++-type-types "\\)\\>"
2240 "\\([ \t*&]+\\sw+\\>\\)*")
2241 ;; Fontify each declaration item.
2242 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
2243 ;; Start with point after all type specifiers.
2244 (goto-char (or (match-beginning 13) (match-end 1)))
2245 ;; Finish with point after first type specifier.
2246 (goto-char (match-end 1))
2247 ;; Fontify as a variable or function name.
2248 (1 (cond ((match-beginning 2) 'font-lock-type-face)
2249 ((match-beginning 4) 'font-lock-function-name-face)
2250 (t 'font-lock-variable-name-face)))
2251 (3 (if (match-beginning 4)
2252 'font-lock-function-name-face
2253 'font-lock-variable-name-face) nil t)))
2255 ;; Fontify structures, or typedef names, plus their items.
2256 '("\\(}\\)[ \t*]*\\sw"
2257 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2258 (goto-char (match-end 1)) nil
2259 (1 (if (match-beginning 4)
2260 font-lock-function-name-face
2261 font-lock-variable-name-face))))
2263 ;; Fontify anything at beginning of line as a declaration or definition.
2264 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
2265 (1 font-lock-type-face)
2266 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2267 (goto-char (or (match-beginning 2) (match-end 1))) nil
2268 (1 (cond ((match-beginning 2) 'font-lock-type-face)
2269 ((match-beginning 4) 'font-lock-function-name-face)
2270 (t 'font-lock-variable-name-face)))
2271 (3 (if (match-beginning 4)
2272 'font-lock-function-name-face
2273 'font-lock-variable-name-face) nil t)))
2277 (defvar c-font-lock-keywords c-font-lock-keywords-1
2278 "Default expressions to highlight in C mode.")
2280 (defvar c++-font-lock-keywords c++-font-lock-keywords-1
2281 "Default expressions to highlight in C++ mode.")
2285 ;; Java support has been written by XEmacs people, and it's apparently
2286 ;; totally divergent from the FSF. I don't know if it's better or
2287 ;; worse, so I'm leaving it in until someone convinces me the FSF
2288 ;; version is better. --hniksic
2290 (defconst java-font-lock-keywords-1 nil
2291 "For consideration as a value of `java-font-lock-keywords'.
2292 This does fairly subdued highlighting.")
2294 (defconst java-font-lock-keywords-2 nil
2295 "For consideration as a value of `java-font-lock-keywords'.
2296 This adds highlighting of types and identifier names.")
2298 (defconst java-font-lock-keywords-3 nil
2299 "For consideration as a value of `java-font-lock-keywords'.
2300 This adds highlighting of Java documentation tags, such as @see.")
2302 (defvar java-font-lock-type-regexp
2303 (concat "\\<\\(boolean\\|byte\\|char\\|double\\|float\\|int"
2304 "\\|long\\|short\\|void\\)\\>")
2305 "Regexp which should match a primitive type.")
2307 (let ((capital-letter "A-Z\300-\326\330-\337")
2308 (letter "a-zA-Z_$\300-\326\330-\366\370-\377")
2310 (defvar java-font-lock-identifier-regexp
2311 (concat "\\<\\([" letter "][" letter digit "]*\\)\\>")
2312 "Regexp which should match all Java identifiers.")
2314 (defvar java-font-lock-class-name-regexp
2315 (concat "\\<\\([" capital-letter "][" letter digit "]*\\)\\>")
2316 "Regexp which should match a class or an interface name.
2317 The name is assumed to begin with a capital letter.")
2321 (let ((java-modifier-regexp
2322 (concat "\\<\\(abstract\\|const\\|final\\|native\\|"
2323 "private\\|protected\\|public\\|"
2324 "static\\|synchronized\\|transient\\|volatile\\)\\>")))
2326 ;; Basic font-lock support:
2327 (setq java-font-lock-keywords-1
2333 "break\\|byvalue\\|"
2334 "case\\|cast\\|catch\\|class\\|continue\\|"
2335 "do\\|else\\|extends\\|"
2336 "finally\\|for\\|future\\|"
2338 "if\\|implements\\|import\\|"
2339 "instanceof\\|interface\\|"
2340 "new\\|package\\|return\\|switch\\|"
2341 "throws?\\|try\\|while\\)\\>")
2342 1 'font-lock-keyword-face)
2345 (list java-modifier-regexp 1 font-lock-type-face)
2347 ;; Special constants:
2348 '("\\<\\(this\\|super\\)\\>" (1 font-lock-reference-face))
2349 '("\\<\\(false\\|null\\|true\\)\\>" (1 font-lock-keyword-face))
2352 (list (concat "\\<\\(class\\|interface\\)\\>\\s *"
2353 java-font-lock-identifier-regexp)
2354 2 'font-lock-function-name-face)
2356 ;; Package declarations:
2357 (list (concat "\\<\\(package\\|import\\)\\>\\s *"
2358 java-font-lock-identifier-regexp)
2359 '(2 font-lock-reference-face)
2361 "\\=\\.\\(" java-font-lock-identifier-regexp "\\)")
2362 nil nil '(1 (if (equal (char-after (match-end 0)) ?.)
2363 'font-lock-reference-face
2364 'font-lock-type-face))))
2368 "^\\s *\\(" java-modifier-regexp "\\s +\\)*"
2369 java-font-lock-class-name-regexp "\\s *\(")
2371 '(condition-case nil
2373 (goto-char (scan-sexps (- (match-end 0) 1) 1))
2374 (parse-partial-sexp (point) (point-max) nil t)
2375 (and (looking-at "\\($\\|\\<throws\\>\\|{\\)")
2376 'font-lock-function-name-face))
2377 (error 'font-lock-function-name-face))))
2380 (list (concat "\\(" java-font-lock-type-regexp "\\|"
2381 java-font-lock-class-name-regexp "\\)"
2382 "\\s *\\(\\[\\s *\\]\\s *\\)*"
2383 java-font-lock-identifier-regexp "\\s *\(")
2385 'font-lock-function-name-face)
2390 (concat "^\\s *" java-font-lock-identifier-regexp "\\s *:")
2391 '(beginning-of-line) '(end-of-line)
2392 '(1 font-lock-reference-face)))
2394 ;; `break' and continue' destination labels:
2395 (list (concat "\\<\\(break\\|continue\\)\\>\\s *"
2396 java-font-lock-identifier-regexp)
2397 2 'font-lock-reference-face)
2400 ;; In Java, any constant expression is allowed.
2401 '("\\<case\\>\\s *\\(.*\\):" 1 font-lock-reference-face)))
2403 ;; Types and declared variable names:
2404 (setq java-font-lock-keywords-2
2407 java-font-lock-keywords-1
2409 ;; Keywords followed by a type:
2410 (list (concat "\\<\\(extends\\|instanceof\\|new\\)\\>\\s *"
2411 java-font-lock-identifier-regexp)
2412 '(2 (if (equal (char-after (match-end 0)) ?.)
2413 'font-lock-reference-face 'font-lock-type-face))
2414 (list (concat "\\=\\." java-font-lock-identifier-regexp)
2415 '(goto-char (match-end 0)) nil
2416 '(1 (if (equal (char-after (match-end 0)) ?.)
2417 'font-lock-reference-face 'font-lock-type-face))))
2419 ;; Keywords followed by a type list:
2420 (list (concat "\\<\\(implements\\|throws\\)\\>\\ s*"
2421 java-font-lock-identifier-regexp)
2422 '(2 (if (equal (char-after (match-end 0)) ?.)
2423 font-lock-reference-face font-lock-type-face))
2424 (list (concat "\\=\\(\\.\\|\\s *\\(,\\)\\s *\\)"
2425 java-font-lock-identifier-regexp)
2426 '(goto-char (match-end 0)) nil
2427 '(3 (if (equal (char-after (match-end 0)) ?.)
2428 font-lock-reference-face font-lock-type-face))))
2430 ;; primitive types, can't be confused with anything else.
2431 (list java-font-lock-type-regexp
2432 '(1 font-lock-type-face)
2433 '(font-lock-match-java-declarations
2434 (goto-char (match-end 0))
2435 (goto-char (match-end 0))
2436 (0 font-lock-variable-name-face)))
2438 ;; Declarations, class types and capitalized variables:
2440 ;; Declarations are easy to recognize. Capitalized words
2441 ;; followed by a closing parenthesis are treated as casts if they
2442 ;; also are followed by an expression. Expressions beginning with
2443 ;; a unary numerical operator, e.g. +, can't be cast to an object
2446 ;; The path of a fully qualified type, e.g. java.lang.Foo, is
2447 ;; fontified in the reference face.
2449 ;; An access to a static field, e.g. System.out.println, is
2450 ;; not fontified since it can't be distinguished from the
2451 ;; usage of a capitalized variable, e.g. Foo.out.println.
2453 (list (concat java-font-lock-class-name-regexp
2454 "\\s *\\(\\[\\s *\\]\\s *\\)*"
2455 "\\(\\<\\|$\\|)\\s *\\([\(\"]\\|\\<\\)\\)")
2456 '(1 (save-match-data
2459 (match-beginning 3))
2460 (if (not (looking-at "\\<instanceof\\>"))
2461 'font-lock-type-face))))
2462 (list (concat "\\=" java-font-lock-identifier-regexp "\\.")
2464 (goto-char (match-beginning 0))
2465 (while (or (= (preceding-char) ?.)
2466 (= (char-syntax (preceding-char)) ?w))
2468 '(goto-char (match-end 0))
2469 '(1 font-lock-reference-face)
2470 '(0 nil)) ; Workaround for bug in XEmacs.
2471 '(font-lock-match-java-declarations
2472 (goto-char (match-end 1))
2473 (goto-char (match-end 0))
2474 (1 font-lock-variable-name-face))))))
2476 ;; Modifier keywords and Java doc tags
2477 (setq java-font-lock-keywords-3
2482 ;; These must come first or the Modifiers from keywords-1 will
2483 ;; catch them. We don't want to use override fontification here
2484 ;; because then these terms will be fontified within comments.
2485 ("\\<private\\>" 0 font-lock-string-face)
2486 ("\\<protected\\>" 0 font-lock-preprocessor-face)
2487 ("\\<public\\>" 0 font-lock-reference-face))
2488 java-font-lock-keywords-2
2493 '("@\\(author\\|exception\\|throws\\|deprecated\\|param\\|return\\|see\\|since\\|version\\)\\s "
2494 0 font-lock-keyword-face t)
2496 ;; Doc tag - Parameter identifiers
2497 (list (concat "@param\\s +" java-font-lock-identifier-regexp)
2498 1 'font-lock-variable-name-face t)
2500 ;; Doc tag - Exception types
2501 (list (concat "@\\(exception\\|throws\\)\\s +"
2502 java-font-lock-identifier-regexp)
2503 '(2 (if (equal (char-after (match-end 0)) ?.)
2504 font-lock-reference-face font-lock-type-face) t)
2505 (list (concat "\\=\\." java-font-lock-identifier-regexp)
2506 '(goto-char (match-end 0)) nil
2507 '(1 (if (equal (char-after (match-end 0)) ?.)
2508 'font-lock-reference-face 'font-lock-type-face) t)))
2510 ;; Doc tag - Cross-references, usually to methods
2511 '("@see\\s +\\(\\S *[^][ \t\n\r\f(){},.;:]\\)"
2512 1 font-lock-function-name-face t)
2514 ;; Doc tag - docRoot (1.3)
2515 '("\\({ *@docRoot *}\\)"
2516 0 font-lock-keyword-face t)
2517 ;; Doc tag - beaninfo, unofficial but widely used, even by Sun
2519 0 font-lock-keyword-face t)
2521 '("{ *@link\\s +\\([^}]+\\)}"
2522 0 font-lock-keyword-face t)
2524 '("{ *@link\\s +\\(\\(\\S +\\)\\|\\(\\S +\\s +\\S +\\)\\) *}"
2525 1 font-lock-function-name-face t)
2530 (defvar java-font-lock-keywords java-font-lock-keywords-1
2531 "Additional expressions to highlight in Java mode.")
2533 ;; Match and move over any declaration/definition item after
2534 ;; point. Does not match items which look like a type declaration
2535 ;; (primitive types and class names, i.e. capitalized words.)
2536 ;; Should the variable name be followed by a comma, we reposition
2537 ;; the cursor to fontify more identifiers.
2538 (defun font-lock-match-java-declarations (limit)
2539 "Match and skip over variable definitions."
2540 (if (looking-at "\\s *\\(\\[\\s *\\]\\s *\\)*")
2541 (goto-char (match-end 0)))
2543 (looking-at java-font-lock-identifier-regexp)
2545 (not (string-match java-font-lock-type-regexp
2546 (buffer-substring (match-beginning 1)
2550 (goto-char (match-beginning 1))
2552 (concat java-font-lock-class-name-regexp
2553 "\\s *\\(\\[\\s *\\]\\s *\\)*\\<")))))
2557 (narrow-to-region (point-min) limit)
2558 (goto-char (match-end 0))
2559 ;; Note: Both `scan-sexps' and the second goto-char can
2560 ;; generate an error which is caught by the
2561 ;; `condition-case' expression.
2562 (while (not (looking-at "\\s *\\(\\(,\\)\\|;\\|$\\)"))
2563 (goto-char (or (scan-sexps (point) 1) (point-max))))
2564 (goto-char (match-end 2))) ; non-nil
2568 (defvar tex-font-lock-keywords
2569 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
2570 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2571 ; 2 font-lock-function-name-face)
2572 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2573 ; 2 font-lock-reference-face)
2574 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2575 ; ;; not be able to display those fonts.
2576 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
2577 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
2578 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
2579 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
2580 ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
2581 '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2582 2 font-lock-function-name-face)
2583 ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2584 2 font-lock-reference-face)
2585 ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
2586 "\\\\\\([a-zA-Z@]+\\|.\\)"
2587 ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2588 ;; not be able to display those fonts.
2589 ;; LaTeX2e: \emph{This is emphasized}.
2590 ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
2591 ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
2592 ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
2593 3 (if (match-beginning 2) 'bold 'italic) keep)
2594 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables.
2595 ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
2596 3 (if (match-beginning 2) 'bold 'italic) keep))
2597 "Default expressions to highlight in TeX modes.")
2599 (defconst ksh-font-lock-keywords (purecopy
2601 '("\\(^\\|[^\$\\\]\\)#.*" . font-lock-comment-face)
2602 '("\\<\\(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)
2603 '("\\<\\[\\[.*\\]\\]\\>" . font-lock-type-face)
2604 '("\$\(.*\)" . font-lock-type-face)
2606 "Additional expressions to highlight in ksh-mode.")
2608 (defconst sh-font-lock-keywords (purecopy
2610 '("\\(^\\|[^\$\\\]\\)#.*" . font-lock-comment-face)
2611 '("\\<\\(if\\|then\\|else\\|elif\\|fi\\|case\\|esac\\|for\\|do\\|done\\|in\\|while\\|exec\\|export\\|set\\|echo\\|eval\\|cd\\)\\>" . font-lock-keyword-face)
2612 '("\\[.*\\]" . font-lock-type-face)
2613 '("`.*`" . font-lock-type-face)
2615 "Additional expressions to highlight in sh-mode.")
2618 ;; Install ourselves:
2620 (add-hook 'find-file-hooks 'font-lock-set-defaults t)
2623 (add-minor-mode 'font-lock-mode " Font")
2625 ;; Provide ourselves:
2627 (provide 'font-lock)
2629 ;;; font-lock.el ends here
projects / chise / xemacs-chise.git.1 / blob