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. I tried just let-binding
584 ;; them when we eval the face expression, but that failes because
585 ;; some files actually use the variables directly in their init code
586 ;; without quoting them. --ben
587 (defvar font-lock-comment-face 'font-lock-comment-face
588 "This variable should not be set.
589 It is present only for horrid FSF compatibility reasons.
590 The corresponding face should be set using `edit-faces' or the
591 `set-face-*' functions.")
592 (defvar font-lock-doc-string-face 'font-lock-doc-string-face
593 "This variable should not be set.
594 It is present only for horrid FSF compatibility reasons.
595 The corresponding face should be set using `edit-faces' or the
596 `set-face-*' functions.")
597 (defvar font-lock-string-face 'font-lock-string-face
598 "This variable should not be set.
599 It is present only for horrid FSF compatibility reasons.
600 The corresponding face should be set using `edit-faces' or the
601 `set-face-*' functions.")
602 (defvar font-lock-keyword-face 'font-lock-keyword-face
603 "This variable should not be set.
604 It is present only for horrid FSF compatibility reasons.
605 The corresponding face should be set using `edit-faces' or the
606 `set-face-*' functions.")
607 (defvar font-lock-function-name-face 'font-lock-function-name-face
608 "This variable should not be set.
609 It is present only for horrid FSF compatibility reasons.
610 The corresponding face should be set using `edit-faces' or the
611 `set-face-*' functions.")
612 (defvar font-lock-variable-name-face 'font-lock-variable-name-face
613 "This variable should not be set.
614 It is present only for horrid FSF compatibility reasons.
615 The corresponding face should be set using `edit-faces' or the
616 `set-face-*' functions.")
617 (defvar font-lock-type-face 'font-lock-type-face
618 "This variable should not be set.
619 It is present only for horrid FSF compatibility reasons.
620 The corresponding face should be set using `edit-faces' or the
621 `set-face-*' functions.")
622 (defvar font-lock-reference-face 'font-lock-reference-face
623 "This variable should not be set.
624 It is present only for horrid FSF compatibility reasons.
625 The corresponding face should be set using `edit-faces' or the
626 `set-face-*' functions.")
627 (defvar font-lock-preprocessor-face 'font-lock-preprocessor-face
628 "This variable should not be set.
629 It is present only for horrid FSF compatibility reasons.
630 The corresponding face should be set using `edit-faces' or the
631 `set-face-*' functions.")
633 (defconst font-lock-face-list
634 '(font-lock-comment-face
635 font-lock-string-face
636 font-lock-doc-string-face
637 font-lock-keyword-face
638 font-lock-function-name-face
639 font-lock-variable-name-face
641 font-lock-reference-face
642 font-lock-preprocessor-face
643 font-lock-warning-face))
645 (defface font-lock-comment-face
646 '((((class color) (background dark)) (:foreground "gray80"))
647 ;; blue4 is hardly different from black on windows.
648 (((class color) (background light) (type mswindows)) (:foreground "blue"))
649 (((class color) (background light)) (:foreground "blue4"))
650 (((class grayscale) (background light))
651 (:foreground "DimGray" :bold t :italic t))
652 (((class grayscale) (background dark))
653 (:foreground "LightGray" :bold t :italic t))
655 "Font Lock mode face used to highlight comments."
656 :group 'font-lock-faces)
658 (defface font-lock-string-face
659 '((((class color) (background dark)) (:foreground "tan"))
660 (((class color) (background light)) (:foreground "green4"))
661 (((class grayscale) (background light)) (:foreground "DimGray" :italic t))
662 (((class grayscale) (background dark)) (:foreground "LightGray" :italic t))
664 "Font Lock mode face used to highlight strings."
665 :group 'font-lock-faces)
667 (defface font-lock-doc-string-face
668 '((((class color) (background dark)) (:foreground "light coral"))
669 (((class color) (background light)) (:foreground "green4"))
671 "Font Lock mode face used to highlight documentation strings.
672 This is currently supported only in Lisp-like modes, which are those
673 with \"lisp\" or \"scheme\" in their name. You can explicitly make
674 a mode Lisp-like by putting a non-nil `font-lock-lisp-like' property
675 on the major mode's symbol."
676 :group 'font-lock-faces)
678 (defface font-lock-keyword-face
679 '((((class color) (background dark)) (:foreground "cyan"))
680 ;; red4 is hardly different from black on windows.
681 (((class color) (background light) (type mswindows)) (:foreground "red"))
682 (((class color) (background light)) (:foreground "red4"))
683 (((class grayscale) (background light)) (:foreground "LightGray" :bold t))
684 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
686 "Font Lock mode face used to highlight keywords."
687 :group 'font-lock-faces)
689 (defface font-lock-function-name-face
690 '((((class color) (background dark)) (:foreground "aquamarine"))
691 ;; brown4 is hardly different from black on windows.
692 ;; I changed it to red because IMO it's pointless and ugly to
693 ;; use a million slightly different colors for niggly syntactic
694 ;; differences. --ben
695 (((class color) (background light) (type mswindows)) (:foreground "red"))
696 (((class color) (background light)) (:foreground "brown4"))
697 (t (:bold t :underline t)))
698 "Font Lock mode face used to highlight function names."
699 :group 'font-lock-faces)
701 (defface font-lock-variable-name-face
702 '((((class color) (background dark)) (:foreground "cyan3"))
703 (((class color) (background light)) (:foreground "magenta4"))
704 (((class grayscale) (background light))
705 (:foreground "Gray90" :bold t :italic t))
706 (((class grayscale) (background dark))
707 (:foreground "DimGray" :bold t :italic t))
709 "Font Lock mode face used to highlight variable names."
710 :group 'font-lock-faces)
712 (defface font-lock-type-face
713 '((((class color) (background dark)) (:foreground "wheat"))
714 (((class color) (background light)) (:foreground "steelblue"))
715 (((class grayscale) (background light)) (:foreground "Gray90" :bold t))
716 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
718 "Font Lock mode face used to highlight types."
719 :group 'font-lock-faces)
721 (defface font-lock-reference-face
722 '((((class color) (background dark)) (:foreground "cadetblue2"))
723 (((class color) (background light)) (:foreground "red3"))
724 (((class grayscale) (background light))
725 (:foreground "LightGray" :bold t :underline t))
726 (((class grayscale) (background dark))
727 (:foreground "Gray50" :bold t :underline t)))
728 "Font Lock mode face used to highlight references."
729 :group 'font-lock-faces)
731 ;; #### FSF has font-lock-builtin-face.
733 (defface font-lock-preprocessor-face
734 '((((class color) (background dark)) (:foreground "steelblue1"))
735 (((class color) (background light)) (:foreground "blue3"))
737 "Font Lock Mode face used to highlight preprocessor conditionals."
738 :group 'font-lock-faces)
740 ;; #### Currently unused
741 (defface font-lock-warning-face
742 '((((class color) (background light)) (:foreground "Red" :bold t))
743 (((class color) (background dark)) (:foreground "Pink" :bold t))
744 (t (:inverse-video t :bold t)))
745 "Font Lock mode face used to highlight warnings."
746 :group 'font-lock-faces)
748 (defun font-lock-recompute-variables ()
749 ;; Is this a Draconian thing to do?
750 (mapc #'(lambda (buffer)
751 (with-current-buffer buffer
753 (font-lock-set-defaults t)))
756 ;; Backwards-compatible crud.
758 (defun font-lock-reset-all-faces ()
759 (dolist (face font-lock-face-list)
760 (face-spec-set face (get face 'face-defface-spec))))
762 (defun font-lock-use-default-fonts ()
763 "Reset the font-lock faces to a default set of fonts."
766 (font-lock-reset-all-faces))
768 (defun font-lock-use-default-colors ()
769 "Reset the font-lock faces to a default set of colors."
772 (font-lock-reset-all-faces))
774 (defun font-lock-use-default-minimal-decoration ()
775 "Reset the font-lock patterns to a fast, minimal set of decorations."
776 (and font-lock-maximum-decoration
777 (setq font-lock-maximum-decoration nil)
778 (font-lock-recompute-variables)))
780 (defun font-lock-use-default-maximal-decoration ()
781 "Reset the font-lock patterns to a larger set of decorations."
782 (and (not (eq t font-lock-maximum-decoration))
783 (setq font-lock-maximum-decoration t)
784 (font-lock-recompute-variables)))
787 ;;;;;;;;;;;;;;;;;;;;;; actual code ;;;;;;;;;;;;;;;;;;;;;;
789 ;;; To fontify the whole buffer by language syntax, we go through it a
790 ;;; character at a time, creating extents on the boundary of each syntactic
791 ;;; unit (that is, one extent for each block comment, one for each line
792 ;;; comment, one for each string, etc.) This is done with the C function
793 ;;; syntactically-sectionize. It's in C for speed (the speed of lisp function
794 ;;; calls was a real bottleneck for this task since it involves examining each
795 ;;; character in turn.)
797 ;;; Then we make a second pass, to fontify the buffer based on other patterns
798 ;;; specified by regexp. When we find a match for a region of text, we need
799 ;;; to change the fonts on those characters. This is done with the
800 ;;; put-text-property function, which knows how to efficiently share extents.
801 ;;; Conceptually, we are attaching some particular face to each of the
802 ;;; characters in a range, but the implementation of this involves creating
803 ;;; extents, or resizing existing ones.
805 ;;; Each time a modification happens to a line, we re-fontify the entire line.
806 ;;; We do this by first removing the extents (text properties) on the line,
807 ;;; and then doing the syntactic and keyword passes again on that line. (More
808 ;;; generally, each modified region is extended to include the preceding and
809 ;;; following BOL or EOL.)
811 ;;; This means that, as the user types, we repeatedly go back to the beginning
812 ;;; of the line, doing more work the longer the line gets. This doesn't cost
813 ;;; much in practice, and if we don't, then we incorrectly fontify things when,
814 ;;; for example, inserting spaces into `intfoo () {}'.
818 ;; The user level functions
821 (defun font-lock-mode (&optional arg)
822 "Toggle Font Lock Mode.
823 With arg, turn font-lock mode on if and only if arg is positive.
825 When Font Lock mode is enabled, text is fontified as you type it:
827 - Comments are displayed in `font-lock-comment-face';
828 - Strings are displayed in `font-lock-string-face';
829 - Documentation strings (in Lisp-like languages) are displayed in
830 `font-lock-doc-string-face';
831 - Language keywords (\"reserved words\") are displayed in
832 `font-lock-keyword-face';
833 - Function names in their defining form are displayed in
834 `font-lock-function-name-face';
835 - Variable names in their defining form are displayed in
836 `font-lock-variable-name-face';
837 - Type names are displayed in `font-lock-type-face';
838 - References appearing in help files and the like are displayed
839 in `font-lock-reference-face';
840 - Preprocessor declarations are displayed in
841 `font-lock-preprocessor-face';
845 - Certain other expressions are displayed in other faces according
846 to the value of the variable `font-lock-keywords'.
848 Where modes support different levels of fontification, you can use the variable
849 `font-lock-maximum-decoration' to specify which level you generally prefer.
850 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
851 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
852 To fontify a buffer without turning on Font Lock mode, and regardless of buffer
853 size, you can use \\[font-lock-fontify-buffer].
855 See the variable `font-lock-keywords' for customization."
857 (let ((on-p (if arg (> (prefix-numeric-value arg) 0) (not font-lock-mode)))
858 (maximum-size (if (not (consp font-lock-maximum-size))
859 font-lock-maximum-size
860 (cdr (or (assq major-mode font-lock-maximum-size)
861 (assq t font-lock-maximum-size))))))
862 ;; Font-lock mode will refuse to turn itself on if in batch mode, or if
863 ;; the current buffer is "invisible". The latter is because packages
864 ;; sometimes put their temporary buffers into some particular major mode
865 ;; to get syntax tables and variables and whatnot, but we don't want the
866 ;; fact that the user has font-lock-mode on a mode hook to slow these
868 (if (or noninteractive (eq (aref (buffer-name) 0) ?\ ))
870 (if (equal (buffer-name) " *Compiler Input*") ; hack for bytecomp...
873 (make-local-hook 'after-change-functions)
874 (add-hook 'after-change-functions
875 'font-lock-after-change-function nil t)
876 (add-hook 'pre-idle-hook 'font-lock-pre-idle-hook))
878 (remove-hook 'after-change-functions
879 'font-lock-after-change-function t)
880 (setq font-lock-defaults-computed nil
881 font-lock-keywords nil)
882 ;; We have no business doing this here, since
883 ;; pre-idle-hook is global. Other buffers may
884 ;; still be in font-lock mode. -dkindred@cs.cmu.edu
885 ;; (remove-hook 'pre-idle-hook 'font-lock-pre-idle-hook)
887 (set (make-local-variable 'font-lock-mode) on-p)
889 (font-lock-set-defaults-1)
890 (run-hooks 'font-lock-mode-hook)
891 (cond (font-lock-fontified
893 ((or (null maximum-size) (<= (buffer-size) maximum-size))
894 (font-lock-fontify-buffer))
896 (lprogress-display 'font-lock
897 "Fontifying %s... buffer too big." 'abort
900 (setq font-lock-fontified nil)
901 (font-lock-unfontify-region (point-min) (point-max))
902 (font-lock-thing-lock-cleanup))
904 (font-lock-thing-lock-cleanup)))
907 ;; For init-file hooks
909 (defun turn-on-font-lock ()
910 "Unconditionally turn on Font Lock mode."
914 (defun turn-off-font-lock ()
915 "Unconditionally turn off Font Lock mode."
920 ;; support for add-keywords, global-font-lock-mode and
921 ;; font-lock-support-mode (unified support for various *-lock modes).
924 ;; Fontification functions.
926 ;; We first define some defsubsts to encapsulate the way we add
927 ;; faces to a region of text. I am planning on modifying the
928 ;; text-property mechanism so that multiple independent classes
929 ;; of text properties can exist. That way, for example, ediff's
930 ;; face text properties don't interfere with font lock's face
931 ;; text properties. Due to the XEmacs implementation of text
932 ;; properties in terms of extents, doing this is fairly trivial:
933 ;; instead of using the `text-prop' property, you just use a
934 ;; specified property.
936 (defsubst font-lock-set-face (start end face)
937 ;; Set the face on the characters in the range.
938 (put-nonduplicable-text-property start end 'face face)
939 (put-nonduplicable-text-property start end 'font-lock t))
941 (defsubst font-lock-remove-face (start end)
942 ;; Remove any syntax highlighting on the characters in the range.
943 (put-nonduplicable-text-property start end 'face nil)
944 (put-nonduplicable-text-property start end 'font-lock nil))
946 (defsubst font-lock-any-faces-p (start end)
947 ;; Return non-nil if we've put any syntax highlighting on
948 ;; the characters in the range.
950 ;; used to look for 'text-prop property, but this has problems if
951 ;; you put any other text properties in the vicinity. Simon
952 ;; Marshall suggested looking for the 'face property (this is what
953 ;; FSF Emacs does) but that's equally bogus. Only reliable way is
954 ;; for font-lock to specially mark its extents.
956 ;; FSF's (equivalent) definition of this defsubst would be
957 ;; (text-property-not-all start end 'font-lock nil)
959 ;; Perhaps our `map-extents' is faster than our definition
960 ;; of `text-property-not-all'. #### If so, `text-property-not-all'
961 ;; should be fixed ...
963 (map-extents 'extent-property (current-buffer) start (1- end) 'font-lock))
966 ;; Fontification functions.
968 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
969 ;; code to fontify a region, the function runs the function whose name is the
970 ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally,
971 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
972 ;; which does contain the code to fontify a region. However, the value of the
973 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
974 ;; do anything. The indirection of the fontification functions gives major
975 ;; modes the capability of modifying the way font-lock.el fontifies. Major
976 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
977 ;; via the variable `font-lock-defaults'.
979 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
980 ;; font-lock.el uses its own function for buffer fontification. This function
981 ;; makes fontification be on a message-by-message basis and so visiting an
982 ;; RMAIL file is much faster. A clever implementation of the function might
983 ;; fontify the headers differently than the message body. (It should, and
984 ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can
985 ;; you?) This hints at a more interesting use...
987 ;; Languages that contain text normally contained in different major modes
988 ;; could define their own fontification functions that treat text differently
989 ;; depending on its context. For example, Perl mode could arrange that here
990 ;; docs are fontified differently than Perl code. Or Yacc mode could fontify
991 ;; rules one way and C code another. Neat!
993 ;; A further reason to use the fontification indirection feature is when the
994 ;; default syntactual fontification, or the default fontification in general,
995 ;; is not flexible enough for a particular major mode. For example, perhaps
996 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
997 ;; cope with. You need to write your own version of that function, e.g.,
998 ;; `hairy-fontify-syntactically-region', and make your own version of
999 ;; `hairy-fontify-region' call that function before calling
1000 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
1001 ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el
1002 ;; would call your region fontification function instead of its own. For
1003 ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line
1004 ;; directives correctly and cleanly. (It is the same problem as fontifying
1005 ;; multi-line strings and comments; regexps are not appropriate for the job.)
1008 (defun font-lock-fontify-buffer ()
1009 "Fontify the current buffer the way `font-lock-mode' would.
1010 See `font-lock-mode' for details.
1012 This can take a while for large buffers."
1014 (let ((font-lock-verbose (or font-lock-verbose (interactive-p))))
1015 (funcall font-lock-fontify-buffer-function)))
1017 (defun font-lock-unfontify-buffer ()
1018 (funcall font-lock-unfontify-buffer-function))
1020 (defun font-lock-fontify-region (beg end &optional loudly)
1021 (funcall font-lock-fontify-region-function beg end loudly))
1023 (defun font-lock-unfontify-region (beg end &optional loudly)
1024 (funcall font-lock-unfontify-region-function beg end loudly))
1026 (defun font-lock-default-fontify-buffer ()
1028 ;; if we don't widen, then the C code will fail to
1029 ;; realize that we're inside a comment.
1032 (let ((was-on font-lock-mode)
1033 (font-lock-verbose (or font-lock-verbose (interactive-p)))
1034 (font-lock-message-threshold 0)
1036 ;; Turn it on to run hooks and get the right font-lock-keywords.
1037 (or was-on (font-lock-mode 1))
1038 (font-lock-unfontify-region (point-min) (point-max) t)
1039 ;; (buffer-syntactic-context-flush-cache)
1041 ;; If a ^G is typed during fontification, abort the fontification, but
1042 ;; return normally (do not signal.) This is to make it easy to abort
1043 ;; fontification if it's taking a long time, without also causing the
1044 ;; buffer not to pop up. If a real abort is desired, the user can ^G
1047 ;; Possibly this should happen down in font-lock-fontify-region instead
1048 ;; of here, but since that happens from the after-change-hook (meaning
1049 ;; much more frequently) I'm afraid of the bad consequences of stealing
1050 ;; the interrupt character at inopportune times.
1054 (font-lock-fontify-region (point-min) (point-max)))
1058 (or was-on ; turn it off if it was off.
1059 (let ((font-lock-fontified nil)) ; kludge to prevent defontification
1060 (font-lock-mode 0)))
1061 (set (make-local-variable 'font-lock-fontified) t)
1062 (when (and aborted font-lock-verbose)
1063 (lprogress-display 'font-lock "Fontifying %s... aborted."
1064 'abort (buffer-name))))
1065 (run-hooks 'font-lock-after-fontify-buffer-hook)))
1067 (defun font-lock-default-unfontify-buffer ()
1068 (font-lock-unfontify-region (point-min) (point-max))
1069 (set (make-local-variable 'font-lock-fontified) nil))
1071 ;; This used to be `font-lock-fontify-region', and before that,
1072 ;; `font-lock-fontify-region' used to be the name used for what is now
1073 ;; `font-lock-fontify-syntactically-region'.
1074 (defun font-lock-default-fontify-region (beg end &optional loudly)
1075 (let ((modified (buffer-modified-p))
1076 (buffer-undo-list t) (inhibit-read-only t)
1077 (old-syntax-table (syntax-table))
1078 buffer-file-name buffer-file-truename)
1081 ;; Use the fontification syntax table, if any.
1082 (if font-lock-syntax-table (set-syntax-table font-lock-syntax-table))
1083 ;; Now do the fontification.
1084 (if font-lock-keywords-only
1085 (font-lock-unfontify-region beg end)
1086 (font-lock-fontify-syntactically-region beg end loudly))
1087 (font-lock-fontify-keywords-region beg end loudly))
1089 (set-syntax-table old-syntax-table)
1090 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil)))))
1092 ;; The following must be rethought, since keywords can override fontification.
1093 ; ;; Now scan for keywords, but not if we are inside a comment now.
1094 ; (or (and (not font-lock-keywords-only)
1095 ; (let ((state (parse-partial-sexp beg end nil nil
1096 ; font-lock-cache-state)))
1097 ; (or (nth 4 state) (nth 7 state))))
1098 ; (font-lock-fontify-keywords-region beg end))
1100 (defun font-lock-default-unfontify-region (beg end &optional maybe-loudly)
1101 (when (and maybe-loudly font-lock-verbose
1102 (>= (- end beg) font-lock-message-threshold))
1103 (lprogress-display 'font-lock "Fontifying %s..." 0 (buffer-name)))
1104 (let ((modified (buffer-modified-p))
1105 (buffer-undo-list t) (inhibit-read-only t)
1106 buffer-file-name buffer-file-truename)
1107 (font-lock-remove-face beg end)
1108 (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil))))
1110 ;; Following is the original FSF version (similar to our original
1111 ;; version, before the deferred stuff was added).
1113 ;; I think that lazy-lock v2 tries to do something similar.
1114 ;; Those efforts should be merged.
1116 ;; Called when any modification is made to buffer text.
1117 ;(defun font-lock-after-change-function (beg end old-len)
1120 ; ;; Rescan between start of line from `beg' and start of line after `end'.
1121 ; (font-lock-fontify-region
1122 ; (progn (goto-char beg) (beginning-of-line) (point))
1123 ; (progn (goto-char end) (forward-line 1) (point))))))
1125 (defvar font-lock-always-fontify-immediately nil
1126 "Set this to non-nil to disable font-lock deferral.
1127 Otherwise, changes to existing text will not be processed until the
1128 next redisplay cycle, avoiding excessive fontification when many
1129 buffer modifications are performed or a buffer is reverted.")
1131 (defvar font-lock-pending-extent-table (make-hash-table :weakness 'key))
1132 (defvar font-lock-range-table (make-range-table))
1134 (defun font-lock-pre-idle-hook ()
1135 (condition-case font-lock-error
1136 (if (> (hash-table-count font-lock-pending-extent-table) 0)
1137 (font-lock-fontify-pending-extents))
1138 (error (warn "Error caught in `font-lock-pre-idle-hook': %s"
1141 ;;; called when any modification is made to buffer text. This function
1142 ;;; remembers the changed ranges until the next redisplay, at which point
1143 ;;; the extents are merged and pruned, and the resulting ranges fontified.
1144 ;;; This function could easily be adapted to other after-change-functions.
1146 (defun font-lock-after-change-function (beg end old-len)
1147 (when font-lock-mode
1148 (let ((ex (make-extent beg end)))
1149 (set-extent-property ex 'detachable nil)
1150 (set-extent-property ex 'end-open nil)
1151 (let ((exs (gethash (current-buffer) font-lock-pending-extent-table)))
1153 (puthash (current-buffer) exs font-lock-pending-extent-table)))
1154 (if font-lock-always-fontify-immediately
1155 (font-lock-fontify-pending-extents))))
1157 (defun font-lock-fontify-pending-extents ()
1158 ;; ah, the beauty of mapping functions.
1159 ;; this function is actually shorter than the old version, which handled
1160 ;; only one buffer and one contiguous region!
1163 #'(lambda (buffer exs)
1164 ;; remove first, to avoid infinite reprocessing if error
1165 (remhash buffer font-lock-pending-extent-table)
1166 (when (buffer-live-p buffer)
1167 (clear-range-table font-lock-range-table)
1168 (with-current-buffer buffer
1171 ;; if we don't widen, then the C code will fail to
1172 ;; realize that we're inside a comment.
1174 (let ((zmacs-region-stays
1175 zmacs-region-stays)) ; protect from change!
1179 (when (and (extent-live-p ex)
1180 (not (extent-detached-p ex)))
1181 ;; first expand the ranges to full lines, because
1182 ;; that is what will be fontified; then use a
1183 ;; range table to merge the ranges.
1184 (let* ((beg (extent-start-position ex))
1185 (end (extent-end-position ex))
1186 (beg (progn (goto-char beg)
1189 (end (progn (goto-char end)
1193 (put-range-table beg end t
1194 font-lock-range-table))))
1197 #'(lambda (beg end val)
1198 ;; Maybe flush the internal cache used by
1199 ;; syntactically-sectionize. (It'd be nice if this
1200 ;; was more automatic.) Any deletions mean the
1201 ;; cache is invalid, and insertions at beginning or
1202 ;; end of line mean that the bol cache might be
1204 ;; #### This code has been commented out for some time
1205 ;; now and is bit-rotting. Someone should look into
1207 ;; (if (or change-was-deletion (bobp)
1208 ;; (= (preceding-char) ?\n))
1209 ;; (buffer-syntactic-context-flush-cache))
1210 ;; #### This creates some unnecessary progress gauges.
1211 ;; (if (and (= beg (point-min))
1212 ;; (= end (point-max)))
1213 ;; (font-lock-fontify-buffer)
1214 ;; (font-lock-fontify-region beg end)))
1215 (font-lock-fontify-region beg end))
1216 font-lock-range-table)))))))
1217 font-lock-pending-extent-table)))
1219 ;; Syntactic fontification functions.
1221 ;; Note: Here is the FSF version. Our version is much faster because
1222 ;; of the C support we provide. This may be useful for reference,
1223 ;; however, and perhaps there is something useful here that should
1224 ;; be merged into our version.
1226 ;(defun font-lock-fontify-syntactically-region (start end &optional loudly)
1227 ; "Put proper face on each string and comment between START and END.
1228 ;START should be at the beginning of a line."
1229 ; (let ((synstart (if comment-start-skip
1230 ; (concat "\\s\"\\|" comment-start-skip)
1232 ; (comstart (if comment-start-skip
1233 ; (concat "\\s<\\|" comment-start-skip)
1235 ; state prev prevstate)
1236 ; (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
1241 ; ;; Find the state at the `beginning-of-line' before `start'.
1242 ; (if (eq start font-lock-cache-position)
1243 ; ;; Use the cache for the state of `start'.
1244 ; (setq state font-lock-cache-state)
1245 ; ;; Find the state of `start'.
1246 ; (if (null font-lock-beginning-of-syntax-function)
1247 ; ;; Use the state at the previous cache position, if any, or
1248 ; ;; otherwise calculate from `point-min'.
1249 ; (if (or (null font-lock-cache-position)
1250 ; (< start font-lock-cache-position))
1251 ; (setq state (parse-partial-sexp (point-min) start))
1252 ; (setq state (parse-partial-sexp font-lock-cache-position start
1253 ; nil nil font-lock-cache-state)))
1254 ; ;; Call the function to move outside any syntactic block.
1255 ; (funcall font-lock-beginning-of-syntax-function)
1256 ; (setq state (parse-partial-sexp (point) start)))
1257 ; ;; Cache the state and position of `start'.
1258 ; (setq font-lock-cache-state state
1259 ; font-lock-cache-position start))
1261 ; ;; If the region starts inside a string, show the extent of it.
1263 ; (let ((beg (point)))
1264 ; (while (and (re-search-forward "\\s\"" end 'move)
1265 ; (nth 3 (parse-partial-sexp beg (point)
1267 ; (put-text-property beg (point) 'face font-lock-string-face)
1268 ; (setq state (parse-partial-sexp beg (point) nil nil state))))
1270 ; ;; Likewise for a comment.
1271 ; (if (or (nth 4 state) (nth 7 state))
1272 ; (let ((beg (point)))
1274 ; (narrow-to-region (point-min) end)
1275 ; (condition-case nil
1277 ; (re-search-backward comstart (point-min) 'move)
1278 ; (forward-comment 1)
1279 ; ;; forward-comment skips all whitespace,
1280 ; ;; so go back to the real end of the comment.
1281 ; (skip-chars-backward " \t"))
1282 ; (error (goto-char end))))
1283 ; (put-text-property beg (point) 'face font-lock-comment-face)
1284 ; (setq state (parse-partial-sexp beg (point) nil nil state))))
1286 ; ;; Find each interesting place between here and `end'.
1287 ; (while (and (< (point) end)
1288 ; (setq prev (point) prevstate state)
1289 ; (re-search-forward synstart end t)
1291 ; ;; Clear out the fonts of what we skip over.
1292 ; (remove-text-properties prev (point) '(face nil))
1293 ; ;; Verify the state at that place
1294 ; ;; so we don't get fooled by \" or \;.
1295 ; (setq state (parse-partial-sexp prev (point)
1297 ; (let ((here (point)))
1298 ; (if (or (nth 4 state) (nth 7 state))
1300 ; ;; We found a real comment start.
1301 ; (let ((beg (match-beginning 0)))
1304 ; (narrow-to-region (point-min) end)
1305 ; (condition-case nil
1307 ; (forward-comment 1)
1308 ; ;; forward-comment skips all whitespace,
1309 ; ;; so go back to the real end of the comment.
1310 ; (skip-chars-backward " \t"))
1311 ; (error (goto-char end))))
1312 ; (put-text-property beg (point) 'face
1313 ; font-lock-comment-face)
1314 ; (setq state (parse-partial-sexp here (point) nil nil state)))
1317 ; ;; We found a real string start.
1318 ; (let ((beg (match-beginning 0)))
1319 ; (while (and (re-search-forward "\\s\"" end 'move)
1320 ; (nth 3 (parse-partial-sexp here (point)
1322 ; (put-text-property beg (point) 'face font-lock-string-face)
1323 ; (setq state (parse-partial-sexp here (point)
1324 ; nil nil state))))))
1326 ; ;; Make sure `prev' is non-nil after the loop
1327 ; ;; only if it was set on the very last iteration.
1331 ; (and prev (remove-text-properties prev end '(face nil)))))
1333 (defun font-lock-lisp-like (mode)
1334 ;; Note: (or (get mode 'font-lock-lisp-like) (string-match ...)) is
1335 ;; not enough because the property needs to be able to specify a nil
1337 (if (plist-member (symbol-plist mode) 'font-lock-lisp-like)
1338 (get mode 'font-lock-lisp-like)
1339 ;; If the property is not specified, guess. Similar logic exists
1340 ;; in add-log, but I think this encompasses more modes.
1341 (string-match "lisp\\|scheme" (symbol-name mode))))
1343 (defun font-lock-fontify-syntactically-region (start end &optional loudly)
1344 "Put proper face on each string and comment between START and END.
1345 START should be at the beginning of a line."
1346 (if font-lock-keywords-only
1348 (when (and font-lock-verbose
1349 (>= (- end start) font-lock-message-threshold))
1350 (lprogress-display 'font-lock "Fontifying %s... (syntactically)" 5
1352 (font-lock-unfontify-region start end loudly)
1354 (if (> end (point-max)) (setq end (point-max)))
1355 (let ((lisp-like (font-lock-lisp-like major-mode)))
1356 (syntactically-sectionize
1357 #'(lambda (s e context depth)
1359 (cond ((eq context 'string)
1361 ;; #### It would be nice if we handled
1362 ;; Python and other non-Lisp languages with
1363 ;; docstrings correctly.
1364 (if (and lisp-like (= depth 1))
1365 ;; really we should only use this if
1366 ;; in position 3 depth 1, but that's
1367 ;; too expensive to compute.
1368 'font-lock-doc-string-face
1369 'font-lock-string-face)))
1370 ((or (eq context 'comment)
1371 (eq context 'block-comment))
1372 (setq face 'font-lock-comment-face)
1373 ; ;; Don't fontify whitespace at the beginning of lines;
1374 ; ;; otherwise comment blocks may not line up with code.
1375 ; ;; (This is sometimes a good idea, sometimes not; in any
1376 ; ;; event it should be in C for speed --jwz)
1379 ; (while (prog1 (search-forward "\n" (1- e) 'move)
1380 ; (setq face 'font-lock-comment-face)
1382 ; (skip-chars-forward " \t\n")
1385 (font-lock-set-face s e face)))
1389 ;;; Additional text property functions.
1391 ;; The following three text property functions are not generally available (and
1392 ;; it's not certain that they should be) so they are inlined for speed.
1393 ;; The case for `fillin-text-property' is simple; it may or not be generally
1394 ;; useful. (Since it is used here, it is useful in at least one place.;-)
1395 ;; However, the case for `append-text-property' and `prepend-text-property' is
1396 ;; more complicated. Should they remove duplicate property values or not? If
1397 ;; so, should the first or last duplicate item remain? Or the one that was
1398 ;; added? In our implementation, the first duplicate remains.
1400 ;; XEmacs: modified all these functions to use
1401 ;; `put-nonduplicable-text-property' instead of `put-text-property', and
1402 ;; the first one to take both SETPROP and MARKPROP, in accordance with the
1403 ;; changed definitions of `font-lock-any-faces-p' and `font-lock-set-face'.
1405 (defsubst font-lock-fillin-text-property (start end setprop markprop value &optional object)
1406 "Fill in one property of the text from START to END.
1407 Arguments PROP and VALUE specify the property and value to put where none are
1408 already in place. Therefore existing property values are not overwritten.
1409 Optional argument OBJECT is the string or buffer containing the text."
1410 (let ((start (text-property-any start end markprop nil object)) next)
1412 (setq next (next-single-property-change start markprop object end))
1413 (put-nonduplicable-text-property start next setprop value object)
1414 (put-nonduplicable-text-property start next markprop value object)
1415 (setq start (text-property-any next end markprop nil object)))))
1417 ;; This function (from simon's unique.el) is rewritten and inlined for speed.
1418 ;(defun unique (list function)
1419 ; "Uniquify LIST, deleting elements using FUNCTION.
1420 ;Return the list with subsequent duplicate items removed by side effects.
1421 ;FUNCTION is called with an element of LIST and a list of elements from LIST,
1422 ;and should return the list of elements with occurrences of the element removed,
1423 ;i.e., a function such as `delete' or `delq'.
1424 ;This function will work even if LIST is unsorted. See also `uniq'."
1425 ; (let ((list list))
1427 ; (setq list (setcdr list (funcall function (car list) (cdr list))))))
1430 (defsubst font-lock-unique (list)
1431 "Uniquify LIST, deleting elements using `delq'.
1432 Return the list with subsequent duplicate items removed by side effects."
1435 (setq list (setcdr list (delq (car list) (cdr list))))))
1438 ;; A generalisation of `facemenu-add-face' for any property, but without the
1439 ;; removal of inactive faces via `facemenu-discard-redundant-faces' and special
1440 ;; treatment of `default'. Uses `unique' to remove duplicate property values.
1441 (defsubst font-lock-prepend-text-property (start end prop value &optional object)
1442 "Prepend to one property of the text from START to END.
1443 Arguments PROP and VALUE specify the property and value to prepend to the value
1444 already in place. The resulting property values are always lists, and unique.
1445 Optional argument OBJECT is the string or buffer containing the text."
1446 (let ((val (if (listp value) value (list value))) next prev)
1447 (while (/= start end)
1448 (setq next (next-single-property-change start prop object end)
1449 prev (get-text-property start prop object))
1452 (font-lock-unique (append val (if (listp prev) prev (list prev))))
1454 (setq start next))))
1456 (defsubst font-lock-append-text-property (start end prop value &optional object)
1457 "Append to one property of the text from START to END.
1458 Arguments PROP and VALUE specify the property and value to append to the value
1459 already in place. The resulting property values are always lists, and unique.
1460 Optional argument OBJECT is the string or buffer containing the text."
1461 (let ((val (if (listp value) value (list value))) next prev)
1462 (while (/= start end)
1463 (setq next (next-single-property-change start prop object end)
1464 prev (get-text-property start prop object))
1467 (font-lock-unique (append (if (listp prev) prev (list prev)) val))
1469 (setq start next))))
1471 ;;; Regexp fontification functions.
1473 (defsubst font-lock-apply-highlight (highlight)
1474 "Apply HIGHLIGHT following a match.
1475 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1476 (let* ((match (nth 0 highlight))
1477 (start (match-beginning match)) (end (match-end match))
1478 (override (nth 2 highlight)))
1479 (let ((newface (nth 1 highlight)))
1480 (or (symbolp newface)
1481 (setq newface (eval newface)))
1483 ;; No match but we might not signal an error.
1484 (or (nth 3 highlight)
1485 (error "No match %d in highlight %S" match highlight)))
1488 ;; Cannot override existing fontification.
1489 (or (font-lock-any-faces-p start end)
1490 (font-lock-set-face start end newface)))
1492 ;; Override existing fontification.
1493 (font-lock-set-face start end newface))
1494 ((eq override 'keep)
1495 ;; Keep existing fontification.
1496 (font-lock-fillin-text-property start end 'face 'font-lock
1498 ((eq override 'prepend)
1499 ;; Prepend to existing fontification.
1500 (font-lock-prepend-text-property start end 'face newface))
1501 ((eq override 'append)
1502 ;; Append to existing fontification.
1503 (font-lock-append-text-property start end 'face newface))))))
1505 (defsubst font-lock-fontify-anchored-keywords (keywords limit)
1506 "Fontify according to KEYWORDS until LIMIT.
1507 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1508 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1509 (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
1510 ;; Evaluate PRE-MATCH-FORM.
1511 (pre-match-value (eval (nth 1 keywords))))
1512 ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1513 (if (and (numberp pre-match-value) (> pre-match-value (point)))
1514 (setq limit pre-match-value)
1515 (save-excursion (end-of-line) (setq limit (point))))
1517 ;; Find an occurrence of `matcher' before `limit'.
1518 (while (if (stringp matcher)
1519 (re-search-forward matcher limit t)
1520 (funcall matcher limit))
1521 ;; Apply each highlight to this instance of `matcher'.
1522 (setq highlights lowdarks)
1524 (font-lock-apply-highlight (car highlights))
1525 (setq highlights (cdr highlights)))))
1526 ;; Evaluate POST-MATCH-FORM.
1527 (eval (nth 2 keywords))))
1529 (defun font-lock-fontify-keywords-region (start end &optional loudvar)
1530 "Fontify according to `font-lock-keywords' between START and END.
1531 START should be at the beginning of a line."
1532 (let ((loudly (and font-lock-verbose
1533 (>= (- end start) font-lock-message-threshold))))
1534 (let* ((case-fold-search font-lock-keywords-case-fold-search)
1535 (keywords (cdr (if (eq (car-safe font-lock-keywords) t)
1537 (font-lock-compile-keywords))))
1538 (bufname (buffer-name))
1539 (progress 5) (old-progress 5)
1541 (nkeywords (length keywords))
1542 keyword matcher highlights)
1544 ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1545 ;; In order to measure progress accurately we need to know how
1546 ;; many keywords we have and how big the region is. Then progress
1547 ;; is ((pos - start)/ (end - start) * nkeywords
1548 ;; + iteration / nkeywords) * 100
1551 ;; Find an occurrence of `matcher' from `start' to `end'.
1552 (setq keyword (car keywords) matcher (car keyword))
1554 (while (and (< (point) end)
1555 (if (stringp matcher)
1556 (re-search-forward matcher end t)
1557 (funcall matcher end)))
1558 ;; calculate progress
1560 (+ (/ (* (- (point) start) 95) (* (- end start) nkeywords))
1561 (/ (* iter 95) nkeywords) 5))
1562 (when (and loudly (> progress old-progress))
1563 (lprogress-display 'font-lock "Fontifying %s... (regexps)"
1565 (setq old-progress progress)
1566 ;; Apply each highlight to this instance of `matcher', which may be
1567 ;; specific highlights or more keywords anchored to `matcher'.
1568 (setq highlights (cdr keyword))
1570 (if (numberp (car (car highlights)))
1571 (let ((end (match-end (car (car highlights)))))
1572 (font-lock-apply-highlight (car highlights))
1573 ;; restart search just after the end of the
1574 ;; keyword so keywords can share bracketing
1576 (and end (goto-char end)))
1577 (font-lock-fontify-anchored-keywords (car highlights) end))
1578 (setq highlights (cdr highlights))))
1579 (setq iter (1+ iter))
1580 (setq keywords (cdr keywords))))
1581 (if loudly (lprogress-display 'font-lock "Fontifying %s... " 100 (buffer-name)))))
1584 ;; Various functions.
1586 ;; Turn off other related packages if they're on. I prefer a hook. --sm.
1587 ;; These explicit calls are easier to understand
1588 ;; because people know what they will do.
1589 ;; A hook is a mystery because it might do anything whatever. --rms.
1590 (defun font-lock-thing-lock-cleanup ()
1591 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
1592 (fast-lock-mode -1))
1593 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
1594 (lazy-lock-mode -1))
1595 ((and (boundp 'lazy-shot-mode) lazy-shot-mode)
1596 (lazy-shot-mode -1))))
1598 ;; Do something special for these packages after fontifying. I prefer a hook.
1599 (defun font-lock-after-fontify-buffer ()
1600 (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
1601 (fast-lock-after-fontify-buffer))
1602 ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
1603 (lazy-lock-after-fontify-buffer))))
1606 ;; Various functions.
1608 (defun font-lock-compile-keywords (&optional keywords)
1609 ;; Compile `font-lock-keywords' into the form (t KEYWORD ...) where KEYWORD
1610 ;; is the (MATCHER HIGHLIGHT ...) shown in the variable's doc string.
1611 (let ((keywords (or keywords font-lock-keywords)))
1612 (setq font-lock-keywords
1613 (if (eq (car-safe keywords) t)
1615 (cons t (mapcar 'font-lock-compile-keyword keywords))))))
1617 (defun font-lock-compile-keyword (keyword)
1618 (cond ((nlistp keyword) ; Just MATCHER
1619 (list keyword '(0 font-lock-keyword-face)))
1620 ((eq (car keyword) 'eval) ; Specified (eval . FORM)
1621 (font-lock-compile-keyword (eval (cdr keyword))))
1622 ((numberp (cdr keyword)) ; Specified (MATCHER . MATCH)
1623 (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
1624 ((symbolp (cdr keyword)) ; Specified (MATCHER . FACENAME)
1625 (list (car keyword) (list 0 (cdr keyword))))
1626 ((nlistp (nth 1 keyword)) ; Specified (MATCHER . HIGHLIGHT)
1627 (list (car keyword) (cdr keyword)))
1628 (t ; Hopefully (MATCHER HIGHLIGHT ...)
1631 (defun font-lock-choose-keywords (keywords level)
1632 ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a
1633 ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
1634 (let ((level (if (not (consp level))
1636 (cdr (or (assq major-mode level) (assq t level))))))
1637 (cond ((symbolp keywords)
1640 (or (nth level keywords) (car (reverse keywords))))
1642 (car (reverse keywords)))
1647 ;;; Determining which set of font-lock keywords to use.
1649 (defun font-lock-find-font-lock-defaults (modesym)
1650 ;; Get the defaults based on the major mode.
1652 ;; I want a do-while loop!
1654 (setq raw-defaults (get modesym 'font-lock-defaults))
1655 (and raw-defaults (symbolp raw-defaults)
1656 (setq modesym raw-defaults)))
1660 (defun font-lock-examine-syntax-table ()
1661 ; Computes the value of font-lock-keywords-only for this buffer.
1662 (if (eq (syntax-table) (standard-syntax-table))
1663 ;; Assume that modes which haven't bothered to install their own
1664 ;; syntax table don't do anything syntactically interesting.
1665 ;; Really, the standard-syntax-table shouldn't have comments and
1666 ;; strings in it, but changing that now might break things.
1668 ;; else map over the syntax table looking for strings or comments.
1671 (if (fboundp 'map-syntax-table)
1674 #'(lambda (key value)
1675 (memq (char-syntax-from-code value)
1676 '(?\" ?\< ?\> ?\$)))
1679 (let ((i (1- (length (syntax-table)))))
1681 (if (memq (char-syntax i) '(?\" ?\< ?\> ?\$))
1682 (setq got-one t i 0))
1684 (set (make-local-variable 'font-lock-keywords-only) (not got-one)))))
1686 ;; font-lock-set-defaults is in fontl-hooks.el.
1689 (defun font-lock-set-defaults-1 (&optional explicit-defaults)
1690 ;; does everything that font-lock-set-defaults does except
1691 ;; enable font-lock-mode. This is called by `font-lock-mode'.
1692 ;; Note that the return value is used!
1694 (if (and font-lock-defaults-computed (not explicit-defaults))
1698 (or font-lock-keywords
1699 (let* ((defaults (or (and (not (eq t explicit-defaults))
1701 ;; in case modes decide to set
1702 ;; `font-lock-defaults' themselves,
1705 (font-lock-find-font-lock-defaults major-mode)))
1706 (keywords (font-lock-choose-keywords
1707 (nth 0 defaults) font-lock-maximum-decoration)))
1710 (setq font-lock-keywords (if (fboundp keywords)
1713 (or font-lock-keywords
1715 ;; try to look for a variable `foo-mode-font-lock-keywords',
1717 (let ((major (symbol-name major-mode))
1719 (if (stringp n) (setq n (intern-soft n)))
1724 (setq font-lock-keywords
1726 (or (funcall try (get major-mode 'font-lock-keywords))
1727 (funcall try (concat major "-font-lock-keywords"))
1728 (funcall try (and (string-match "-mode\\'" major)
1731 (match-beginning 0))
1732 "-font-lock-keywords")))
1733 'font-lock-keywords)))))
1736 (if (>= (length defaults) 3)
1737 (setq font-lock-keywords-case-fold-search (nth 2 defaults))
1739 ;; look for a property 'font-lock-keywords-case-fold-search on
1740 ;; the major-mode symbol.
1741 (let* ((nonexist (make-symbol ""))
1742 (value (get major-mode 'font-lock-keywords-case-fold-search
1744 (if (not (eq nonexist value))
1745 (setq font-lock-keywords-case-fold-search value))))
1748 (if (>= (length defaults) 2)
1749 (setq font-lock-keywords-only (nth 1 defaults))
1751 ;; cleverly examine the syntax table.
1752 (font-lock-examine-syntax-table))
1755 (if (nth 3 defaults)
1756 (let ((slist (nth 3 defaults)))
1757 (setq font-lock-syntax-table
1758 (copy-syntax-table (syntax-table)))
1760 (modify-syntax-entry (car (car slist)) (cdr (car slist))
1761 font-lock-syntax-table)
1762 (setq slist (cdr slist)))))
1766 (setq font-lock-beginning-of-syntax-function
1770 ;; defaults not specified at all, so use `beginning-of-defun'.
1771 (setq font-lock-beginning-of-syntax-function
1772 'beginning-of-defun)))))
1774 (setq font-lock-defaults-computed t)))
1777 ;;;;;;;;;;;;;;;;;;;;;; keywords ;;;;;;;;;;;;;;;;;;;;;;
1779 ;;; Various major-mode interfaces.
1780 ;;; Probably these should go in with the source of the respective major modes.
1782 ;; The defaults and keywords listed here should perhaps be moved into
1783 ;; mode-specific files.
1785 ;; For C and Lisp modes we use `beginning-of-defun', rather than nil,
1786 ;; for SYNTAX-BEGIN. Thus the calculation of the cache is usually
1787 ;; faster but not infallible, so we risk mis-fontification. --sm.
1789 (put 'c-mode 'font-lock-defaults
1790 '((c-font-lock-keywords
1791 c-font-lock-keywords-1 c-font-lock-keywords-2 c-font-lock-keywords-3)
1792 nil nil ((?_ . "w")) beginning-of-defun))
1793 (put 'c++-c-mode 'font-lock-defaults 'c-mode)
1794 (put 'elec-c-mode 'font-lock-defaults 'c-mode)
1796 (put 'c++-mode 'font-lock-defaults
1797 '((c++-font-lock-keywords
1798 c++-font-lock-keywords-1 c++-font-lock-keywords-2
1799 c++-font-lock-keywords-3)
1800 nil nil ((?_ . "w") (?~ . "w")) beginning-of-defun))
1802 (put 'java-mode 'font-lock-defaults
1803 '((java-font-lock-keywords
1804 java-font-lock-keywords-1 java-font-lock-keywords-2
1805 java-font-lock-keywords-3)
1806 nil nil ((?_ . "w")) beginning-of-defun
1807 (font-lock-mark-block-function . mark-defun)))
1809 (put 'lisp-mode 'font-lock-defaults
1810 '((lisp-font-lock-keywords
1811 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
1813 ((?: . "w") (?- . "w") (?* . "w") (?+ . "w") (?. . "w") (?< . "w")
1814 (?> . "w") (?= . "w") (?! . "w") (?? . "w") (?$ . "w") (?% . "w")
1815 (?_ . "w") (?& . "w") (?~ . "w") (?^ . "w") (?/ . "w"))
1816 beginning-of-defun))
1817 (put 'emacs-lisp-mode 'font-lock-defaults 'lisp-mode)
1818 (put 'lisp-interaction-mode 'font-lock-defaults 'lisp-mode)
1820 (put 'scheme-mode 'font-lock-defaults
1821 '(scheme-font-lock-keywords
1823 ((?: . "w") (?- . "w") (?* . "w") (?+ . "w") (?. . "w") (?< . "w")
1824 (?> . "w") (?= . "w") (?! . "w") (?? . "w") (?$ . "w") (?% . "w")
1825 (?_ . "w") (?& . "w") (?~ . "w") (?^ . "w") (?/ . "w"))
1826 beginning-of-defun))
1827 (put 'inferior-scheme-mode 'font-lock-defaults 'scheme-mode)
1828 (put 'scheme-interaction-mode 'font-lock-defaults 'scheme-mode)
1830 (put 'tex-mode 'font-lock-defaults
1831 ;; For TeX modes we could use `backward-paragraph' for the same reason.
1832 '(tex-font-lock-keywords nil nil ((?$ . "\""))))
1833 ;; the nine billion names of TeX mode...
1834 (put 'bibtex-mode 'font-lock-defaults 'tex-mode)
1835 (put 'plain-tex-mode 'font-lock-defaults 'tex-mode)
1836 (put 'slitex-tex-mode 'font-lock-defaults 'tex-mode)
1837 (put 'SliTeX-mode 'font-lock-defaults 'tex-mode)
1838 (put 'slitex-mode 'font-lock-defaults 'tex-mode)
1839 (put 'latex-tex-mode 'font-lock-defaults 'tex-mode)
1840 (put 'LaTex-tex-mode 'font-lock-defaults 'tex-mode)
1841 (put 'latex-mode 'font-lock-defaults 'tex-mode)
1842 (put 'LaTeX-mode 'font-lock-defaults 'tex-mode)
1843 (put 'japanese-LaTeX-mode 'font-lock-defaults 'tex-mode)
1844 (put 'japanese-SliTeX-mode 'font-lock-defaults 'tex-mode)
1845 (put 'FoilTeX-mode 'font-lock-defaults 'tex-mode)
1846 (put 'LATeX-MoDe 'font-lock-defaults 'tex-mode)
1847 (put 'lATEx-mODe 'font-lock-defaults 'tex-mode)
1848 ;; ok, this is getting a bit silly ...
1849 (put 'eDOm-xETAl 'font-lock-defaults 'tex-mode)
1851 ;;; Various regexp information shared by several modes.
1852 ;;; Information specific to a single mode should go in its load library.
1854 (defconst lisp-font-lock-keywords-1
1856 ;; Anything not a variable or type declaration is fontified as a function.
1857 ;; It would be cleaner to allow preceding whitespace, but it would also be
1858 ;; about five times slower.
1859 (list (concat "^(\\(def\\("
1860 ;; Variable declarations.
1861 "\\(const\\(\\|ant\\)\\|ine-key\\(\\|-after\\)\\|var\\|custom\\)\\|"
1862 ;; Structure declarations.
1863 "\\(class\\|struct\\|type\\)\\|"
1864 ;; Everything else is a function declaration.
1865 "\\([^ \t\n\(\)]+\\)"
1867 ;; Any whitespace and declared object.
1869 "\\([^ \t\n\)]+\\)?")
1870 '(1 font-lock-keyword-face)
1871 '(8 (cond ((match-beginning 3) 'font-lock-variable-name-face)
1872 ((match-beginning 6) 'font-lock-type-face)
1873 (t 'font-lock-function-name-face))
1876 "Subdued level highlighting Lisp modes.")
1878 (defconst lisp-font-lock-keywords-2
1879 (append lisp-font-lock-keywords-1
1882 ;; Control structures. ELisp and CLisp combined.
1885 ;; '("cond" "if" "while" "let" "let*" "prog" "progn" "prog1"
1886 ;; "prog2" "progv" "catch" "throw" "save-restriction"
1887 ;; "save-excursion" "save-window-excursion"
1888 ;; "save-current-buffer" "with-current-buffer"
1889 ;; "with-temp-file" "with-temp-buffer" "with-output-to-string"
1890 ;; "with-string-as-buffer-contents"
1891 ;; "save-selected-window" "save-match-data" "unwind-protect"
1892 ;; "condition-case" "track-mouse" "autoload"
1893 ;; "eval-after-load" "eval-and-compile" "eval-when-compile"
1894 ;; "when" "unless" "do" "dolist" "dotimes" "flet" "labels"
1895 ;; "lambda" "return" "return-from"))
1899 "autoload\\|c\\(atch\\|ond\\(ition-case\\)?\\)\\|do\\(list\\|"
1900 "times\\)?\\|eval-\\(a\\(fter-load\\|nd-compile\\)\\|when-compile\\)\\|"
1901 "flet\\|if\\|l\\(a\\(bels\\|mbda\\)\\|et\\*?\\)\\|"
1902 "prog[nv12\\*]?\\|return\\(-from\\)?\\|save-\\(current-buffer\\|"
1903 "excursion\\|match-data\\|restriction\\|selected-window\\|"
1904 "window-excursion\\)\\|t\\(hrow\\|rack-mouse\\)\\|un\\(less\\|"
1905 "wind-protect\\)\\|w\\(h\\(en\\|ile\\)\\|ith-\\(current-buffer\\|"
1906 "output-to-string\\|string-as-buffer-contents\\|temp-\\(buffer\\|"
1910 ;; Feature symbols as references.
1911 '("(\\(featurep\\|provide\\|require\\)\\>[ \t']*\\(\\sw+\\)?"
1912 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1914 ;; Words inside \\[] tend to be for `substitute-command-keys'.
1915 '("\\\\\\\\\\[\\(\\sw+\\)]" 1 font-lock-reference-face prepend)
1917 ;; Words inside `' tend to be symbol names.
1918 '("`\\(\\sw\\sw+\\)'" 1 font-lock-reference-face prepend)
1920 ;; CLisp `:' keywords as references.
1921 '("\\<:\\sw+\\>" 0 font-lock-reference-face prepend)
1923 ;; ELisp and CLisp `&' keywords as types.
1924 '("\\<\\&\\(optional\\|rest\\|whole\\)\\>" . font-lock-type-face)
1926 "Gaudy level highlighting for Lisp modes.")
1928 (defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
1929 "Default expressions to highlight in Lisp modes.")
1931 ;; The previous version, before replacing it with the FSF version.
1932 ;(defconst lisp-font-lock-keywords-1 (purecopy
1934 ; ;; highlight defining forms. This doesn't work too nicely for
1935 ; ;; (defun (setf foo) ...) but it does work for (defvar foo) which
1936 ; ;; is more important.
1937 ; ("^(def[-a-z]+\\s +\\([^ \t\n\)]+\\)" 1 font-lock-function-name-face)
1939 ; ;; highlight CL keywords (three clauses seems faster than one)
1940 ; ("\\s :\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1941 ; ("(:\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1942 ; ("':\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1944 ; ;; this is highlights things like (def* (setf foo) (bar baz)), but may
1945 ; ;; be slower (I haven't really thought about it)
1946 ;; ("^(def[-a-z]+\\s +\\(\\s(\\S)*\\s)\\|\\S(\\S *\\)"
1947 ;; 1 font-lock-function-name-face)
1949 ; "For consideration as a value of `lisp-font-lock-keywords'.
1950 ;This does fairly subdued highlighting.")
1952 ;(defconst lisp-font-lock-keywords-2 (purecopy
1953 ; (append lisp-font-lock-keywords-1
1955 ; ;; Highlight control structures
1956 ; ("(\\(cond\\|if\\|when\\|unless\\|[ec]?\\(type\\)?case\\)[ \t\n]" . 1)
1957 ; ("(\\(while\\|do\\|let\\*?\\|flet\\|labels\\|prog[nv12*]?\\)[ \t\n]" . 1)
1958 ; ("(\\(do\\*\\|dotimes\\|dolist\\|loop\\)[ \t\n]" . 1)
1959 ; ("(\\(catch\\|\\throw\\|block\\|return\\|return-from\\)[ \t\n]" . 1)
1960 ; ("(\\(save-restriction\\|save-window-restriction\\)[ \t\n]" . 1)
1961 ; ("(\\(save-excursion\\|unwind-protect\\|condition-case\\)[ \t\n]" . 1)
1963 ; ;; highlight function names in emacs-lisp docstrings (in the syntax
1964 ; ;; that substitute-command-keys understands.)
1965 ; ("\\\\\\\\\\[\\([^]\\\n]+\\)]" 1 font-lock-keyword-face t)
1967 ; ;; highlight words inside `' which tend to be function names
1968 ; ("`\\([-a-zA-Z0-9_][-a-zA-Z0-9_][-a-zA-Z0-9_.]+\\)'"
1969 ; 1 font-lock-keyword-face t)
1971 ; "For consideration as a value of `lisp-font-lock-keywords'.
1973 ;This does a lot more highlighting.")
1975 (defvar scheme-font-lock-keywords
1979 ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1980 ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1981 (list (concat "(\\(define\\("
1983 "\\(\\|-\\(generic\\(\\|-procedure\\)\\|method\\)\\)\\|"
1984 ;; Macro names, as variable names. A bit dubious, this.
1989 ;; Any whitespace and declared object.
1992 '(1 font-lock-keyword-face)
1993 '(8 (cond ((match-beginning 3) 'font-lock-function-name-face)
1994 ((match-beginning 6) 'font-lock-variable-name-face)
1995 (t 'font-lock-type-face))
1998 ;; Control structures.
1999 ;(regexp-opt '("begin" "call-with-current-continuation" "call/cc"
2000 ; "call-with-input-file" "call-with-output-file" "case" "cond"
2001 ; "do" "else" "for-each" "if" "lambda"
2002 ; "let\\*?" "let-syntax" "letrec" "letrec-syntax"
2003 ; ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
2004 ; "and" "or" "delay"
2005 ; ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
2006 ; ;;"quasiquote" "quote" "unquote" "unquote-splicing"
2007 ; "map" "syntax" "syntax-rules"))
2010 "and\\|begin\\|c\\(a\\(ll\\(-with-\\(current-continuation\\|"
2011 "input-file\\|output-file\\)\\|/cc\\)\\|se\\)\\|ond\\)\\|"
2012 "d\\(elay\\|o\\)\\|else\\|for-each\\|if\\|"
2013 "l\\(ambda\\|et\\(-syntax\\|\\*?\\|rec\\(\\|-syntax\\)\\)\\)\\|"
2014 "map\\|or\\|syntax\\(\\|-rules\\)"
2017 ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
2018 '("\\<<\\sw+>\\>" . font-lock-type-face)
2020 ;; Scheme `:' keywords as references.
2021 '("\\<:\\sw+\\>" . font-lock-reference-face)
2023 "Default expressions to highlight in Scheme modes.")
2025 ;; The previous version, before replacing it with the FSF version.
2026 ;(defconst scheme-font-lock-keywords (purecopy
2027 ; '(("(define[ \t]+(?\\([^ \t\n\)]+\\)" 1 font-lock-function-name-face)
2028 ; ("(\\(cond\\|lambda\\|begin\\|if\\|else\\|case\\|do\\)[ \t\n]" . 1)
2029 ; ("(\\(\\|letrec\\|let\\*?\\|set!\\|and\\|or\\)[ \t\n]" . 1)
2030 ; ("(\\(quote\\|unquote\\|quasiquote\\|unquote-splicing\\)[ \t\n]" . 1)
2031 ; ("(\\(syntax\\|syntax-rules\\|define-syntax\\|let-syntax\\|letrec-syntax\\)[ \t\n]" . 1)))
2032 ; "Expressions to highlight in Scheme buffers.")
2034 (defconst c-font-lock-keywords-1 nil
2035 "Subdued level highlighting for C modes.")
2037 (defconst c-font-lock-keywords-2 nil
2038 "Medium level highlighting for C modes.")
2040 (defconst c-font-lock-keywords-3 nil
2041 "Gaudy level highlighting for C modes.")
2043 (defconst c++-font-lock-keywords-1 nil
2044 "Subdued level highlighting for C++ modes.")
2046 (defconst c++-font-lock-keywords-2 nil
2047 "Medium level highlighting for C++ modes.")
2049 (defconst c++-font-lock-keywords-3 nil
2050 "Gaudy level highlighting for C++ modes.")
2052 (defun font-lock-match-c++-style-declaration-item-and-skip-to-next (limit)
2053 ;; Match, and move over, any declaration/definition item after point.
2054 ;; The expect syntax of an item is "word" or "word::word", possibly ending
2055 ;; with optional whitespace and a "(". Everything following the item (but
2056 ;; belonging to it) is expected to by skip-able by `forward-sexp', and items
2057 ;; are expected to be separated with a "," or ";".
2058 (if (looking-at "[ \t*&]*\\(\\(?:\\sw\\|\\s_\\)+\\)\\(::\\(\\(?:\\sw\\|\\s_\\)+\\)\\)?[ \t]*\\((\\)?")
2062 ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2063 (narrow-to-region (point-min) limit)
2064 (goto-char (match-end 1))
2065 ;; Move over any item value, etc., to the next item.
2066 (while (not (looking-at "[ \t]*\\([,;]\\|$\\)"))
2067 (goto-char (or (scan-sexps (point) 1) (point-max))))
2068 (goto-char (match-end 0)))
2072 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while")
2073 "break\\|continue\\|do\\|else\\|for\\|if\\|return\\|switch\\|while")
2075 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2076 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2077 ; "void" "volatile" "const")
2078 (concat "auto\\|c\\(har\\|onst\\)\\|double\\|e\\(num\\|xtern\\)\\|"
2079 "float\\|int\\|long\\|register\\|"
2080 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|typedef\\|"
2081 "un\\(ion\\|signed\\)\\|vo\\(id\\|latile\\)")) ; 6 ()s deep.
2083 ; ("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
2084 ; "asm" "catch" "delete" "new" "operator" "sizeof" "this" "throw" "try"
2085 ; "protected" "private" "public")
2086 (concat "asm\\|break\\|c\\(atch\\|ontinue\\)\\|d\\(elete\\|o\\)\\|"
2087 "else\\|for\\|if\\|new\\|"
2088 "p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|return\\|"
2089 "s\\(izeof\\|witch\\)\\|t\\(h\\(is\\|row\\)\\|ry\\)\\|while"))
2091 ; ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2092 ; "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2093 ; "void" "volatile" "const" "class" "inline" "friend" "bool"
2094 ; "virtual" "complex" "template")
2095 (concat "auto\\|bool\\|c\\(har\\|lass\\|o\\(mplex\\|nst\\)\\)\\|"
2096 "double\\|e\\(num\\|xtern\\)\\|f\\(loat\\|riend\\)\\|"
2097 "in\\(line\\|t\\)\\|long\\|register\\|"
2098 "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|"
2099 "t\\(emplate\\|ypedef\\)\\|un\\(ion\\|signed\\)\\|"
2100 "v\\(irtual\\|o\\(id\\|latile\\)\\)")) ; 11 ()s deep.
2101 (ctoken "\\(\\sw\\|\\s_\\|[:~*&]\\)+")
2103 (setq c-font-lock-keywords-1
2106 ;; These are all anchored at the beginning of line for speed.
2108 ;; Fontify function name definitions (GNU style; without type on line).
2110 ;; In FSF this has the simpler definition of "\\sw+" for ctoken.
2111 ;; I'm not sure if ours is more correct.
2112 ;; This is a subset of the next rule, and is slower when present. --dmoore
2113 ;; (list (concat "^\\(" ctoken "\\)[ \t]*(") 1 'font-lock-function-name-face)
2115 ;; fontify the names of functions being defined.
2116 ;; FSF doesn't have this but I think it should be fast for us because
2117 ;; our regexp routines are more intelligent than FSF's about handling
2118 ;; anchored-at-newline. (When I added this hack in regex.c, it halved
2119 ;; the time to do the regexp phase of font-lock for a C file!) Not
2120 ;; including this discriminates against those who don't follow the
2121 ;; GNU coding style. --ben
2122 ;; x?x?x?y?z should always be: (x(xx?)?)?y?z --dmoore
2125 "\\(" ctoken "[ \t]+\\)" ; type specs; there can be no
2127 "\\(" ctoken "[ \t]+\\)" ; more than 3 tokens, right?
2128 "\\(" ctoken "[ \t]+\\)"
2130 "\\([*&]+[ \t]*\\)?" ; pointer
2131 "\\(" ctoken "\\)[ \t]*(") ; name
2132 10 'font-lock-function-name-face)
2134 ;; This is faster but not by much. I don't see why not.
2135 ;(list (concat "^\\(" ctoken "\\)[ \t]*(") 1 'font-lock-function-name-face)
2137 ;; Added next two; they're both jolly-good fastmatch candidates so
2138 ;; should be fast. --ben
2140 ;; Fontify structure names (in structure definition form).
2141 (list (concat "^\\(typedef[ \t]+struct\\|struct\\|static[ \t]+struct\\)"
2142 "[ \t]+\\(" ctoken "\\)[ \t]*\\(\{\\|$\\)")
2143 2 'font-lock-function-name-face)
2145 ;; Fontify case clauses. This is fast because its anchored on the left.
2146 '("case[ \t]+\\(\\(\\sw\\|\\s_\\)+\\)[ \t]+:". 1)
2148 '("\\<\\(default\\):". 1)
2149 ;; Fontify filenames in #include <...> preprocessor directives as strings.
2150 '("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
2152 ;; Fontify function macro names.
2153 '("^#[ \t]*define[ \t]+\\(\\(\\sw+\\)(\\)" 2 font-lock-function-name-face)
2155 ;; Fontify symbol names in #if ... defined preprocessor directives.
2157 ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
2158 (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t)))
2160 ;; Fontify symbol names in #elif ... defined preprocessor directives.
2162 ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
2163 (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t)))
2165 ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2166 '("^\\(#[ \t]*[a-z]+\\)\\>[ \t]*\\(\\sw+\\)?"
2167 (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t))
2170 (setq c-font-lock-keywords-2
2171 (append c-font-lock-keywords-1
2174 ;; Simple regexps for speed.
2176 ;; Fontify all type specifiers.
2177 (cons (concat "\\<\\(" c-type-types "\\)\\>") 'font-lock-type-face)
2179 ;; Fontify all builtin keywords (except case, default and goto; see below).
2180 (cons (concat "\\<\\(" c-keywords "\\)\\>") 'font-lock-keyword-face)
2182 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2183 '("\\<\\(case\\|goto\\)\\>[ \t]*\\([^ \t\n:;]+\\)?"
2184 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2185 '("^[ \t]*\\(\\sw+\\)[ \t]*:" 1 font-lock-reference-face)
2188 (setq c-font-lock-keywords-3
2189 (append c-font-lock-keywords-2
2191 ;; More complicated regexps for more complete highlighting for types.
2192 ;; We still have to fontify type specifiers individually, as C is so hairy.
2195 ;; Fontify all storage classes and type specifiers, plus their items.
2196 (list (concat "\\<\\(" c-type-types "\\)\\>"
2197 "\\([ \t*&]+\\sw+\\>\\)*")
2198 ;; Fontify each declaration item.
2199 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
2200 ;; Start with point after all type specifiers.
2201 (goto-char (or (match-beginning 8) (match-end 1)))
2202 ;; Finish with point after first type specifier.
2203 (goto-char (match-end 1))
2204 ;; Fontify as a variable or function name.
2205 (1 (if (match-beginning 4)
2206 font-lock-function-name-face
2207 font-lock-variable-name-face))))
2209 ;; Fontify structures, or typedef names, plus their items.
2210 '("\\(}\\)[ \t*]*\\sw"
2211 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2212 (goto-char (match-end 1)) nil
2213 (1 (if (match-beginning 4)
2214 font-lock-function-name-face
2215 font-lock-variable-name-face))))
2217 ;; Fontify anything at beginning of line as a declaration or definition.
2218 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
2219 (1 font-lock-type-face)
2220 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2221 (goto-char (or (match-beginning 2) (match-end 1))) nil
2222 (1 (if (match-beginning 4)
2223 font-lock-function-name-face
2224 font-lock-variable-name-face))))
2227 (setq c++-font-lock-keywords-1
2230 ;; The list `c-font-lock-keywords-1' less that for function names.
2231 ;; the simple function form regexp has been removed. --dmoore
2232 ;;(cdr c-font-lock-keywords-1)
2233 c-font-lock-keywords-1
2235 ;; Fontify function name definitions, possibly incorporating class name.
2237 '("^\\(\\sw+\\)\\(::\\(\\sw+\\)\\)?[ \t]*("
2238 (1 (if (match-beginning 2)
2240 font-lock-function-name-face))
2241 (3 (if (match-beginning 2) font-lock-function-name-face) nil t))
2244 (setq c++-font-lock-keywords-2
2245 (append c++-font-lock-keywords-1
2248 ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2249 (cons (concat "\\<\\(" c++-type-types "\\)\\>") 'font-lock-type-face)
2251 ;; Fontify operator function name overloading.
2252 '("\\<\\(operator\\)\\>[ \t]*\\([][)(><!=+-][][)(><!=+-]?\\)?"
2253 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
2255 ;; Fontify case/goto keywords and targets, and case default/goto tags.
2256 '("\\<\\(case\\|goto\\)\\>[ \t]*\\([^ \t\n:;]+\\)?"
2257 (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2258 '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-reference-face)
2260 ;; Fontify other builtin keywords.
2261 (cons (concat "\\<\\(" c++-keywords "\\)\\>") 'font-lock-keyword-face)
2264 (setq c++-font-lock-keywords-3
2265 (append c++-font-lock-keywords-2
2267 ;; More complicated regexps for more complete highlighting for types.
2270 ;; Fontify all storage classes and type specifiers, plus their items.
2271 (list (concat "\\<\\(" c++-type-types "\\)\\>"
2272 "\\([ \t*&]+\\sw+\\>\\)*")
2273 ;; Fontify each declaration item.
2274 '(font-lock-match-c++-style-declaration-item-and-skip-to-next
2275 ;; Start with point after all type specifiers.
2276 (goto-char (or (match-beginning 13) (match-end 1)))
2277 ;; Finish with point after first type specifier.
2278 (goto-char (match-end 1))
2279 ;; Fontify as a variable or function name.
2280 (1 (cond ((match-beginning 2) 'font-lock-type-face)
2281 ((match-beginning 4) 'font-lock-function-name-face)
2282 (t 'font-lock-variable-name-face)))
2283 (3 (if (match-beginning 4)
2284 'font-lock-function-name-face
2285 'font-lock-variable-name-face) nil t)))
2287 ;; Fontify structures, or typedef names, plus their items.
2288 '("\\(}\\)[ \t*]*\\sw"
2289 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2290 (goto-char (match-end 1)) nil
2291 (1 (if (match-beginning 4)
2292 font-lock-function-name-face
2293 font-lock-variable-name-face))))
2295 ;; Fontify anything at beginning of line as a declaration or definition.
2296 '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
2297 (1 font-lock-type-face)
2298 (font-lock-match-c++-style-declaration-item-and-skip-to-next
2299 (goto-char (or (match-beginning 2) (match-end 1))) nil
2300 (1 (cond ((match-beginning 2) 'font-lock-type-face)
2301 ((match-beginning 4) 'font-lock-function-name-face)
2302 (t 'font-lock-variable-name-face)))
2303 (3 (if (match-beginning 4)
2304 'font-lock-function-name-face
2305 'font-lock-variable-name-face) nil t)))
2309 (defvar c-font-lock-keywords c-font-lock-keywords-1
2310 "Default expressions to highlight in C mode.")
2312 (defvar c++-font-lock-keywords c++-font-lock-keywords-1
2313 "Default expressions to highlight in C++ mode.")
2317 ;; Java support has been written by XEmacs people, and it's apparently
2318 ;; totally divergent from the FSF. I don't know if it's better or
2319 ;; worse, so I'm leaving it in until someone convinces me the FSF
2320 ;; version is better. --hniksic
2322 (defconst java-font-lock-keywords-1 nil
2323 "For consideration as a value of `java-font-lock-keywords'.
2324 This does fairly subdued highlighting.")
2326 (defconst java-font-lock-keywords-2 nil
2327 "For consideration as a value of `java-font-lock-keywords'.
2328 This adds highlighting of types and identifier names.")
2330 (defconst java-font-lock-keywords-3 nil
2331 "For consideration as a value of `java-font-lock-keywords'.
2332 This adds highlighting of Java documentation tags, such as @see.")
2334 (defvar java-font-lock-type-regexp
2335 (concat "\\<\\(boolean\\|byte\\|char\\|double\\|float\\|int"
2336 "\\|long\\|short\\|void\\)\\>")
2337 "Regexp which should match a primitive type.")
2339 (let ((capital-letter "A-Z\300-\326\330-\337")
2340 (letter "a-zA-Z_$\300-\326\330-\366\370-\377")
2342 (defvar java-font-lock-identifier-regexp
2343 (concat "\\<\\([" letter "][" letter digit "]*\\)\\>")
2344 "Regexp which should match all Java identifiers.")
2346 (defvar java-font-lock-class-name-regexp
2347 (concat "\\<\\([" capital-letter "][" letter digit "]*\\)\\>")
2348 "Regexp which should match a class or an interface name.
2349 The name is assumed to begin with a capital letter.")
2353 (let ((java-modifier-regexp
2354 (concat "\\<\\(abstract\\|const\\|final\\|native\\|"
2355 "private\\|protected\\|public\\|"
2356 "static\\|synchronized\\|transient\\|volatile\\)\\>")))
2358 ;; Basic font-lock support:
2359 (setq java-font-lock-keywords-1
2365 "break\\|byvalue\\|"
2366 "case\\|cast\\|catch\\|class\\|continue\\|"
2367 "do\\|else\\|extends\\|"
2368 "finally\\|for\\|future\\|"
2370 "if\\|implements\\|import\\|"
2371 "instanceof\\|interface\\|"
2372 "new\\|package\\|return\\|switch\\|"
2373 "throws?\\|try\\|while\\)\\>")
2374 1 'font-lock-keyword-face)
2377 (list java-modifier-regexp 1 font-lock-type-face)
2379 ;; Special constants:
2380 '("\\<\\(this\\|super\\)\\>" (1 font-lock-reference-face))
2381 '("\\<\\(false\\|null\\|true\\)\\>" (1 font-lock-keyword-face))
2384 (list (concat "\\<\\(class\\|interface\\)\\>\\s *"
2385 java-font-lock-identifier-regexp)
2386 2 'font-lock-function-name-face)
2388 ;; Package declarations:
2389 (list (concat "\\<\\(package\\|import\\)\\>\\s *"
2390 java-font-lock-identifier-regexp)
2391 '(2 font-lock-reference-face)
2393 "\\=\\.\\(" java-font-lock-identifier-regexp "\\)")
2394 nil nil '(1 (if (equal (char-after (match-end 0)) ?.)
2395 'font-lock-reference-face
2396 'font-lock-type-face))))
2400 "^\\s *\\(" java-modifier-regexp "\\s +\\)*"
2401 java-font-lock-class-name-regexp "\\s *\(")
2403 '(condition-case nil
2405 (goto-char (scan-sexps (- (match-end 0) 1) 1))
2406 (parse-partial-sexp (point) (point-max) nil t)
2407 (and (looking-at "\\($\\|\\<throws\\>\\|{\\)")
2408 'font-lock-function-name-face))
2409 (error 'font-lock-function-name-face))))
2412 (list (concat "\\(" java-font-lock-type-regexp "\\|"
2413 java-font-lock-class-name-regexp "\\)"
2414 "\\s *\\(\\[\\s *\\]\\s *\\)*"
2415 java-font-lock-identifier-regexp "\\s *\(")
2417 'font-lock-function-name-face)
2422 (concat "^\\s *" java-font-lock-identifier-regexp "\\s *:")
2423 '(beginning-of-line) '(end-of-line)
2424 '(1 font-lock-reference-face)))
2426 ;; `break' and continue' destination labels:
2427 (list (concat "\\<\\(break\\|continue\\)\\>\\s *"
2428 java-font-lock-identifier-regexp)
2429 2 'font-lock-reference-face)
2432 ;; In Java, any constant expression is allowed.
2433 '("\\<case\\>\\s *\\(.*\\):" 1 font-lock-reference-face)))
2435 ;; Types and declared variable names:
2436 (setq java-font-lock-keywords-2
2439 java-font-lock-keywords-1
2441 ;; Keywords followed by a type:
2442 (list (concat "\\<\\(extends\\|instanceof\\|new\\)\\>\\s *"
2443 java-font-lock-identifier-regexp)
2444 '(2 (if (equal (char-after (match-end 0)) ?.)
2445 'font-lock-reference-face 'font-lock-type-face))
2446 (list (concat "\\=\\." java-font-lock-identifier-regexp)
2447 '(goto-char (match-end 0)) nil
2448 '(1 (if (equal (char-after (match-end 0)) ?.)
2449 'font-lock-reference-face 'font-lock-type-face))))
2451 ;; Keywords followed by a type list:
2452 (list (concat "\\<\\(implements\\|throws\\)\\>\\ s*"
2453 java-font-lock-identifier-regexp)
2454 '(2 (if (equal (char-after (match-end 0)) ?.)
2455 font-lock-reference-face font-lock-type-face))
2456 (list (concat "\\=\\(\\.\\|\\s *\\(,\\)\\s *\\)"
2457 java-font-lock-identifier-regexp)
2458 '(goto-char (match-end 0)) nil
2459 '(3 (if (equal (char-after (match-end 0)) ?.)
2460 font-lock-reference-face font-lock-type-face))))
2462 ;; primitive types, can't be confused with anything else.
2463 (list java-font-lock-type-regexp
2464 '(1 font-lock-type-face)
2465 '(font-lock-match-java-declarations
2466 (goto-char (match-end 0))
2467 (goto-char (match-end 0))
2468 (0 font-lock-variable-name-face)))
2470 ;; Declarations, class types and capitalized variables:
2472 ;; Declarations are easy to recognize. Capitalized words
2473 ;; followed by a closing parenthesis are treated as casts if they
2474 ;; also are followed by an expression. Expressions beginning with
2475 ;; a unary numerical operator, e.g. +, can't be cast to an object
2478 ;; The path of a fully qualified type, e.g. java.lang.Foo, is
2479 ;; fontified in the reference face.
2481 ;; An access to a static field, e.g. System.out.println, is
2482 ;; not fontified since it can't be distinguished from the
2483 ;; usage of a capitalized variable, e.g. Foo.out.println.
2485 (list (concat java-font-lock-class-name-regexp
2486 "\\s *\\(\\[\\s *\\]\\s *\\)*"
2487 "\\(\\<\\|$\\|)\\s *\\([\(\"]\\|\\<\\)\\)")
2488 '(1 (save-match-data
2491 (match-beginning 3))
2492 (if (not (looking-at "\\<instanceof\\>"))
2493 'font-lock-type-face))))
2494 (list (concat "\\=" java-font-lock-identifier-regexp "\\.")
2496 (goto-char (match-beginning 0))
2497 (while (or (= (preceding-char) ?.)
2498 (= (char-syntax (preceding-char)) ?w))
2500 '(goto-char (match-end 0))
2501 '(1 font-lock-reference-face)
2502 '(0 nil)) ; Workaround for bug in XEmacs.
2503 '(font-lock-match-java-declarations
2504 (goto-char (match-end 1))
2505 (goto-char (match-end 0))
2506 (1 font-lock-variable-name-face))))))
2508 ;; Modifier keywords and Java doc tags
2509 (setq java-font-lock-keywords-3
2514 ;; These must come first or the Modifiers from keywords-1 will
2515 ;; catch them. We don't want to use override fontification here
2516 ;; because then these terms will be fontified within comments.
2517 ("\\<private\\>" 0 font-lock-string-face)
2518 ("\\<protected\\>" 0 font-lock-preprocessor-face)
2519 ("\\<public\\>" 0 font-lock-reference-face))
2520 java-font-lock-keywords-2
2525 '("@\\(author\\|deprecated\\|exception\\|throws\\|param\\|return\\|see\\|since\\|version\\|serial\\|serialData\\|serialField\\)\\s "
2526 0 font-lock-keyword-face t)
2528 ;; Doc tag - Parameter identifiers
2529 (list (concat "@param\\s +" java-font-lock-identifier-regexp)
2530 1 'font-lock-variable-name-face t)
2532 ;; Doc tag - Exception types
2533 (list (concat "@\\(exception\\|throws\\)\\s +"
2534 java-font-lock-identifier-regexp)
2535 '(2 (if (equal (char-after (match-end 0)) ?.)
2536 font-lock-reference-face font-lock-type-face) t)
2537 (list (concat "\\=\\." java-font-lock-identifier-regexp)
2538 '(goto-char (match-end 0)) nil
2539 '(1 (if (equal (char-after (match-end 0)) ?.)
2540 'font-lock-reference-face 'font-lock-type-face) t)))
2542 ;; Doc tag - Cross-references, usually to methods
2543 '("@see\\s +\\(\\S *[^][ \t\n\r\f(){},.;:]\\)"
2544 1 font-lock-function-name-face t)
2546 ;; Doc tag - docRoot (1.3)
2547 '("\\({ *@docRoot *}\\)"
2548 0 font-lock-keyword-face t)
2549 ;; Doc tag - beaninfo, unofficial but widely used, even by Sun
2551 0 font-lock-keyword-face t)
2553 '("{ *@link\\s +\\([^}]+\\)}"
2554 0 font-lock-keyword-face t)
2556 '("{ *@link\\s +\\(\\(\\S +\\)\\|\\(\\S +\\s +\\S +\\)\\) *}"
2557 1 font-lock-function-name-face t)
2562 (defvar java-font-lock-keywords java-font-lock-keywords-1
2563 "Additional expressions to highlight in Java mode.")
2565 ;; Match and move over any declaration/definition item after
2566 ;; point. Does not match items which look like a type declaration
2567 ;; (primitive types and class names, i.e. capitalized words.)
2568 ;; Should the variable name be followed by a comma, we reposition
2569 ;; the cursor to fontify more identifiers.
2570 (defun font-lock-match-java-declarations (limit)
2571 "Match and skip over variable definitions."
2572 (if (looking-at "\\s *\\(\\[\\s *\\]\\s *\\)*")
2573 (goto-char (match-end 0)))
2575 (looking-at java-font-lock-identifier-regexp)
2577 (not (string-match java-font-lock-type-regexp
2578 (buffer-substring (match-beginning 1)
2582 (goto-char (match-beginning 1))
2584 (concat java-font-lock-class-name-regexp
2585 "\\s *\\(\\[\\s *\\]\\s *\\)*\\<")))))
2589 (narrow-to-region (point-min) limit)
2590 (goto-char (match-end 0))
2591 ;; Note: Both `scan-sexps' and the second goto-char can
2592 ;; generate an error which is caught by the
2593 ;; `condition-case' expression.
2594 (while (not (looking-at "\\s *\\(\\(,\\)\\|;\\|$\\)"))
2595 (goto-char (or (scan-sexps (point) 1) (point-max))))
2596 (goto-char (match-end 2))) ; non-nil
2600 (defvar tex-font-lock-keywords
2601 ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
2602 ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2603 ; 2 font-lock-function-name-face)
2604 ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2605 ; 2 font-lock-reference-face)
2606 ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2607 ; ;; not be able to display those fonts.
2608 ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
2609 ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
2610 ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
2611 ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
2612 ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
2613 '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2614 2 font-lock-function-name-face)
2615 ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2616 2 font-lock-reference-face)
2617 ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
2618 "\\\\\\([a-zA-Z@]+\\|.\\)"
2619 ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2620 ;; not be able to display those fonts.
2621 ;; LaTeX2e: \emph{This is emphasized}.
2622 ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
2623 ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
2624 ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
2625 3 (if (match-beginning 2) 'bold 'italic) keep)
2626 ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables.
2627 ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
2628 3 (if (match-beginning 2) 'bold 'italic) keep))
2629 "Default expressions to highlight in TeX modes.")
2631 (defconst ksh-font-lock-keywords (purecopy
2633 '("\\(^\\|[^\$\\\]\\)#.*" . font-lock-comment-face)
2634 '("\\<\\(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)
2635 '("\\<\\[\\[.*\\]\\]\\>" . font-lock-type-face)
2636 '("\$\(.*\)" . font-lock-type-face)
2638 "Additional expressions to highlight in ksh-mode.")
2640 (defconst sh-font-lock-keywords (purecopy
2642 '("\\(^\\|[^\$\\\]\\)#.*" . font-lock-comment-face)
2643 '("\\<\\(if\\|then\\|else\\|elif\\|fi\\|case\\|esac\\|for\\|do\\|done\\|in\\|while\\|exec\\|export\\|set\\|echo\\|eval\\|cd\\)\\>" . font-lock-keyword-face)
2644 '("\\[.*\\]" . font-lock-type-face)
2645 '("`.*`" . font-lock-type-face)
2647 "Additional expressions to highlight in sh-mode.")
2650 ;; Install ourselves:
2652 (add-hook 'find-file-hooks 'font-lock-set-defaults t)
2655 (add-minor-mode 'font-lock-mode " Font")
2657 ;; Provide ourselves:
2659 (provide 'font-lock)
2661 ;;; font-lock.el ends here
projects / chise / xemacs-chise.git.1 / blob