XEmacs 21.2-b2
[chise/xemacs-chise.git.1] / lisp / font-lock.el
1 ;;; font-lock.el --- decorating source files with fonts/colors based on syntax
2
3 ;; Copyright (C) 1992-1995, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995 Amdahl Corporation.
5 ;; Copyright (C) 1996 Ben Wing.
6
7 ;; Author: Jamie Zawinski <jwz@netscape.com>, 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:
10 ;; Next Author: RMS
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
15
16 ;; This file is part of XEmacs.
17
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)
21 ;; any later version.
22
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.
27
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.
32
33 ;;; Synched up with: FSF 19.30 except for the code to initialize the faces.
34
35 ;;; Commentary:
36
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.
40 ;;
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'.
47 ;;
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.
54 ;;
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.
58 ;;
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.
63 ;;
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.
70 ;;
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.
75 ;;
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.
78 ;;
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'.
84 ;;
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.
93 ;;
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'.)
100
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.
108
109 ;; Further comments from the FSF:
110
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
113 ;; efficiency.
114
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.
122 ;;
123 ;; So, here are my opinions/advice/guidelines:
124 ;; 
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.
129 ;;   i.e., (a) above.
130 ;; - Make the face attributes fit the concept as far as possible.
131 ;;   i.e., function names might be a bold colour such as blue, comments might
132 ;;   be a bright colour 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.
138 ;; - Err, that's it.
139
140 \f
141 ;;; Code:
142
143 (require 'fontl-hooks)
144
145 ;;;;;;;;;;;;;;;;;;;;;;      user variables       ;;;;;;;;;;;;;;;;;;;;;;
146
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.
152
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'."
160   :group 'languages)
161
162 (defgroup font-lock-faces nil
163   "Faces used by the font-lock package."
164   :group 'font-lock
165   :group 'faces)
166
167
168 (defcustom font-lock-verbose t
169   "*If non-nil, means show status messages when fontifying.
170 See also `font-lock-message-threshold'."
171   :type 'boolean
172   :group 'font-lock)
173
174 (defcustom font-lock-message-threshold 6000
175   "*Minimum size of region being fontified for status messages to appear.
176
177 The size is measured in characters.  This affects `font-lock-fontify-region'
178 but not `font-lock-fontify-buffer'. (In other words, when you first visit
179 a file and it gets fontified, you will see status messages no matter what
180 size the file is.  However, if you do something else like paste a
181 chunk of text or revert a buffer, you will see status messages only if the
182 changed region is large enough.)
183
184 Note that setting `font-lock-verbose' to nil disables the status
185 messages entirely."
186   :type 'integer
187   :group 'font-lock)
188
189 ;;;###autoload
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'."
196   :type 'boolean
197   :group 'font-lock)
198
199 ;;;###autoload
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"))
203   :group 'font-lock)
204
205 ;;;###autoload
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"))
209   :group 'font-lock)
210
211 ;;;###autoload
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
217 should be one of
218
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.
225
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.)
229
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
232 how to do it."
233   ;; Hard to do right.
234   :type 'sexp
235   :group 'font-lock)
236
237 ;;;###autoload
238 (defcustom font-lock-use-fonts '(or (mono) (grayscale))
239   "*Specification for when Font Lock will set up non-color defaults.
240
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
245
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.
252
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.)
256
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
259 how to do it."
260   :type 'sexp
261   :group 'font-lock)
262
263 ;;;###autoload
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"
278                          :value ((t . t))
279                          (cons :tag "Instance"
280                                (radio :tag "Mode"
281                                       (const :tag "all" t)
282                                       (symbol :tag "name"))
283                                (radio :tag "Decoration"
284                                       (const :tag "default" nil)
285                                       (const :tag "maximum" t) 
286                                       (integer :tag "level" 1)))))
287   :group 'font-lock)
288
289 ;;;###autoload
290 (define-obsolete-variable-alias 'font-lock-use-maximal-decoration
291   'font-lock-maximum-decoration)
292
293 ;;;###autoload
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"
306                          :value ((t . nil))
307                          (cons :tag "Instance"
308                                (radio :tag "Mode"
309                                       (const :tag "all" t)
310                                       (symbol :tag "name"))
311                                (radio :tag "Size"
312                                       (const :tag "none" nil)
313                                       (integer :tag "size")))))
314   :group 'font-lock)
315
316 \f
317 ;; Fontification variables:
318
319 ;;;###autoload
320 (defvar font-lock-keywords nil
321   "A list of the keywords to highlight.
322 Each element should be of the form:
323
324  MATCHER
325  (MATCHER . MATCH)
326  (MATCHER . FACENAME)
327  (MATCHER . HIGHLIGHT)
328  (MATCHER HIGHLIGHT ...)
329  (eval . FORM)
330
331 where HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED.
332
333 FORM is an expression, whose value should be a keyword element,
334 evaluated when the keyword is (first) used in a buffer.  This feature
335 can be used to provide a keyword that can only be generated when Font
336 Lock mode is actually turned on.
337
338 For highlighting single items, typically only MATCH-HIGHLIGHT is required.
339 However, if an item or (typically) items is to be highlighted following the
340 instance of another item (the anchor) then MATCH-ANCHORED may be required.
341
342 MATCH-HIGHLIGHT should be of the form:
343
344  (MATCH FACENAME OVERRIDE LAXMATCH)
345
346 Where MATCHER can be either the regexp to search for, a variable
347 containing the regexp to search for, or the function to call to make
348 the search (called with one argument, the limit of the search).  MATCH
349 is the subexpression of MATCHER to be highlighted.  FACENAME is either
350 a symbol naming a face, or an expression whose value is the face name
351 to use.  If you want FACENAME to be a symbol that evaluates to a face,
352 use a form like \"(progn sym)\".
353
354 OVERRIDE and LAXMATCH are flags.  If OVERRIDE is t, existing fontification may
355 be overwritten.  If `keep', only parts not already fontified are highlighted.
356 If `prepend' or `append', existing fontification is merged with the new, in
357 which the new or existing fontification, respectively, takes precedence.
358 If LAXMATCH is non-nil, no error is signalled if there is no MATCH in MATCHER.
359
360 For example, an element of the form highlights (if not already highlighted):
361
362  \"\\\\\\=<foo\\\\\\=>\"                Discrete occurrences of \"foo\" in the value of the
363                         variable `font-lock-keyword-face'.
364  (\"fu\\\\(bar\\\\)\" . 1)      Substring \"bar\" within all occurrences of \"fubar\" in
365                         the value of `font-lock-keyword-face'.
366  (\"fubar\" . fubar-face)       Occurrences of \"fubar\" in the value of `fubar-face'.
367  (\"foo\\\\|bar\" 0 foo-bar-face t)
368                         Occurrences of either \"foo\" or \"bar\" in the value
369                         of `foo-bar-face', even if already highlighted.
370
371 MATCH-ANCHORED should be of the form:
372
373  (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...)
374
375 Where MATCHER is as for MATCH-HIGHLIGHT with one exception; see below.
376 PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after
377 the last, instance MATCH-ANCHORED's MATCHER is used.  Therefore they can be
378 used to initialise before, and cleanup after, MATCHER is used.  Typically,
379 PRE-MATCH-FORM is used to move to some position relative to the original
380 MATCHER, before starting with MATCH-ANCHORED's MATCHER.  POST-MATCH-FORM might
381 be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER.
382
383 For example, an element of the form highlights (if not already highlighted):
384
385  (\"\\\\\\=<anchor\\\\\\=>\" (0 anchor-face) (\"\\\\\\=<item\\\\\\=>\" nil nil (0 item-face)))
386
387  Discrete occurrences of \"anchor\" in the value of `anchor-face', and subsequent
388  discrete occurrences of \"item\" (on the same line) in the value of `item-face'.
389  (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil.  Therefore \"item\" is
390  initially searched for starting from the end of the match of \"anchor\", and
391  searching for subsequent instance of \"anchor\" resumes from where searching
392  for \"item\" concluded.)
393
394 The above-mentioned exception is as follows.  The limit of the MATCHER search
395 defaults to the end of the line after PRE-MATCH-FORM is evaluated.
396 However, if PRE-MATCH-FORM returns a position greater than the position after
397 PRE-MATCH-FORM is evaluated, that position is used as the limit of the search.
398 It is generally a bad idea to return a position greater than the end of the
399 line, i.e., cause the MATCHER search to span lines.
400
401 Note that the MATCH-ANCHORED feature is experimental; in the future, we may
402 replace it with other ways of providing this functionality.
403
404 These regular expressions should not match text which spans lines.  While
405 \\[font-lock-fontify-buffer] handles multi-line patterns correctly, updating
406 when you edit the buffer does not, since it considers text one line at a time.
407
408 Be very careful composing regexps for this list;
409 the wrong pattern can dramatically slow things down!")
410 ;;;###autoload
411 (make-variable-buffer-local 'font-lock-keywords)
412
413 (defvar font-lock-defaults nil
414   "The defaults font Font Lock mode for the current buffer.
415 Normally, do not set this directly.  If you are writing a major mode,
416 put a property of `font-lock-defaults' on the major-mode symbol with
417 the desired value.
418
419 It should be a list
420
421 \(KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN)
422
423 KEYWORDS may be a symbol (a variable or function whose value is the keywords
424 to use for fontification) or a list of symbols.  If KEYWORDS-ONLY is non-nil,
425 syntactic fontification (strings and comments) is not performed.  If CASE-FOLD
426 is non-nil, the case of the keywords is ignored when fontifying.  If
427 SYNTAX-ALIST is non-nil, it should be a list of cons pairs of the form (CHAR
428 . STRING) used to set the local Font Lock syntax table, for keyword and
429 syntactic fontification (see `modify-syntax-entry').
430
431 If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move
432 backwards outside any enclosing syntactic block, for syntactic fontification.
433 Typical values are `beginning-of-line' (i.e., the start of the line is known to
434 be outside a syntactic block), or `beginning-of-defun' for programming modes or
435 `backward-paragraph' for textual modes (i.e., the mode-dependent function is
436 known to move outside a syntactic block).  If nil, the beginning of the buffer
437 is used as a position outside of a syntactic block, in the worst case.
438
439 These item elements are used by Font Lock mode to set the variables
440 `font-lock-keywords', `font-lock-keywords-only',
441 `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and
442 `font-lock-beginning-of-syntax-function', respectively.
443
444 Alternatively, if the value is a symbol, it should name a major mode,
445 and the defaults for that mode will apply.")
446 (make-variable-buffer-local 'font-lock-defaults)
447
448 ;; FSF uses `font-lock-defaults-alist' and expects the major mode to
449 ;; set a value for `font-lock-defaults', but I don't like either of
450 ;; these -- requiring the mode to set `font-lock-defaults' makes it
451 ;; impossible to have defaults for a minor mode, and using an alist is
452 ;; generally a bad idea for information that really should be
453 ;; decentralized. (Who knows what strange modes might want
454 ;; font-locking?)
455
456 (defvar font-lock-keywords-only nil
457   "Non-nil means Font Lock should not do syntactic fontification.
458 This is normally set via `font-lock-defaults'.
459
460 This should be nil for all ``language'' modes, but other modes, like
461 dired, do not have anything useful in the syntax tables (no comment
462 or string delimiters, etc) and so there is no need to use them and
463 this variable should have a value of t.
464
465 You should not set this variable directly; its value is computed
466 from `font-lock-defaults', or (if that does not specify anything)
467 by examining the syntax table to see whether it appears to contain
468 anything useful.")
469 (make-variable-buffer-local 'font-lock-keywords-only)
470
471 (defvar font-lock-keywords-case-fold-search nil
472   "Whether the strings in `font-lock-keywords' should be case-folded.
473 This variable is automatically buffer-local, as the correct value depends
474 on the language in use.")
475 (make-variable-buffer-local 'font-lock-keywords-case-fold-search)
476
477 (defvar font-lock-after-fontify-buffer-hook nil
478   "Function or functions to run after completion of font-lock-fontify-buffer.")
479
480 (defvar font-lock-syntax-table nil
481   "Non-nil means use this syntax table for fontifying.
482 If this is nil, the major mode's syntax table is used.
483 This is normally set via `font-lock-defaults'.")
484 (make-variable-buffer-local 'font-lock-syntax-table)
485
486 ;; These are used in the FSF version in syntactic font-locking.
487 ;; We do this all in C.
488 ;;; These record the parse state at a particular position, always the
489 ;;; start of a line.  Used to make
490 ;;; `font-lock-fontify-syntactically-region' faster.
491 ;(defvar font-lock-cache-position nil)
492 ;(defvar font-lock-cache-state nil)
493 ;(make-variable-buffer-local 'font-lock-cache-position)
494 ;(make-variable-buffer-local 'font-lock-cache-state)
495
496 ;; If this is nil, we only use the beginning of the buffer if we can't use
497 ;; `font-lock-cache-position' and `font-lock-cache-state'.
498 (defvar font-lock-beginning-of-syntax-function nil
499   "Non-nil means use this function to move back outside of a syntactic block.
500 If this is nil, the beginning of the buffer is used (in the worst case).
501 This is normally set via `font-lock-defaults'.")
502 (make-variable-buffer-local 'font-lock-beginning-of-syntax-function)
503
504 (defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer
505   "Function to use for fontifying the buffer.
506 This is normally set via `font-lock-defaults'.")
507
508 (defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer
509   "Function to use for unfontifying the buffer.
510 This is used when turning off Font Lock mode.
511 This is normally set via `font-lock-defaults'.")
512
513 (defvar font-lock-fontify-region-function 'font-lock-default-fontify-region
514   "Function to use for fontifying a region.
515 It should take two args, the beginning and end of the region, and an optional
516 third arg VERBOSE.  If non-nil, the function should print status messages.
517 This is normally set via `font-lock-defaults'.")
518
519 (defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region
520   "Function to use for unfontifying a region.
521 It should take two args, the beginning and end of the region.
522 This is normally set via `font-lock-defaults'.")
523
524 (defvar font-lock-inhibit-thing-lock nil
525   "List of Font Lock mode related modes that should not be turned on.
526 Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'.
527 This is normally set via `font-lock-defaults'.")
528
529 ;;;###autoload
530 (defcustom font-lock-mode nil ;; customized for the option menu. dverna
531   "Non nil means `font-lock-mode' is on"
532   :group 'font-lock
533   :type 'boolean
534   :initialize 'custom-initialize-default
535   :require 'font-lock
536   :set '(lambda (var val)
537           (font-lock-mode (or val 0)))
538   )
539
540 (defvar font-lock-fontified nil) ; whether we have hacked this buffer
541 (put 'font-lock-fontified 'permanent-local t)
542
543 ;;;###autoload
544 (defvar font-lock-mode-hook nil
545   "Function or functions to run on entry to font-lock-mode.")
546
547 ; whether font-lock-set-defaults has already been run.
548 (defvar font-lock-defaults-computed nil)
549 (make-variable-buffer-local 'font-lock-defaults-computed)
550
551 \f
552 ;;; Initialization of faces.
553
554 ;; #### barf gag retch.  Horrid FSF lossage that we need to
555 ;; keep around for compatibility with font-lock-keywords that
556 ;; forget to properly quote their faces.
557 (defvar font-lock-comment-face 'font-lock-comment-face
558   "Don't even think of using this.")
559 (defvar font-lock-doc-string-face 'font-lock-doc-string-face
560   "Don't even think of using this.")
561 (defvar font-lock-string-face 'font-lock-string-face
562   "Don't even think of using this.")
563 (defvar font-lock-keyword-face 'font-lock-keyword-face
564   "Don't even think of using this.")
565 (defvar font-lock-function-name-face 'font-lock-function-name-face
566   "Don't even think of using this.")
567 (defvar font-lock-variable-name-face 'font-lock-variable-name-face
568   "Don't even think of using this.")
569 (defvar font-lock-type-face 'font-lock-type-face
570   "Don't even think of using this.")
571 (defvar font-lock-reference-face 'font-lock-reference-face
572   "Don't even think of using this.")
573 (defvar font-lock-preprocessor-face 'font-lock-preprocessor-face
574   "Don't even think of using this.")
575
576 (defconst font-lock-face-list
577   '(font-lock-comment-face
578     font-lock-string-face
579     font-lock-doc-string-face
580     font-lock-keyword-face
581     font-lock-function-name-face
582     font-lock-variable-name-face
583     font-lock-type-face
584     font-lock-reference-face
585     font-lock-preprocessor-face
586     font-lock-warning-face))
587
588 ;; #### There should be an emulation for the old font-lock-use-*
589 ;; settings!
590
591 (defface font-lock-comment-face
592   '((((class color) (background dark)) (:foreground "gray80"))
593     (((class color) (background light)) (:foreground "blue4"))
594     (((class grayscale) (background light))
595      (:foreground "DimGray" :bold t :italic t))
596     (((class grayscale) (background dark))
597      (:foreground "LightGray" :bold t :italic t))
598     (t (:bold t)))
599   "Font Lock mode face used to highlight comments."
600   :group 'font-lock-faces)
601
602 (defface font-lock-string-face
603   '((((class color) (background dark)) (:foreground "tan"))
604     (((class color) (background light)) (:foreground "green4"))
605     (((class grayscale) (background light)) (:foreground "DimGray" :italic t))
606     (((class grayscale) (background dark)) (:foreground "LightGray" :italic t))
607     (t (:bold t)))
608   "Font Lock mode face used to highlight strings."
609   :group 'font-lock-faces)
610
611 (defface font-lock-doc-string-face
612   '((((class color) (background dark)) (:foreground "light coral"))
613     (((class color) (background light)) (:foreground "green4"))
614     (t (:bold t)))
615   "Font Lock mode face used to highlight documentation strings."
616   :group 'font-lock-faces)
617
618 (defface font-lock-keyword-face
619   '((((class color) (background dark)) (:foreground "cyan"))
620     (((class color) (background light)) (:foreground "red4"))
621     (((class grayscale) (background light)) (:foreground "LightGray" :bold t))
622     (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
623     (t (:bold t)))
624   "Font Lock mode face used to highlight keywords."
625   :group 'font-lock-faces)
626
627 (defface font-lock-function-name-face
628   '((((class color) (background dark)) (:foreground "aquamarine"))
629     (((class color) (background light)) (:foreground "brown4"))
630     (t (:bold t :underline t)))
631   "Font Lock mode face used to highlight function names."
632   :group 'font-lock-faces)
633
634 (defface font-lock-variable-name-face
635   '((((class color) (background dark)) (:foreground "cyan3"))
636     (((class color) (background light)) (:foreground "magenta4"))
637     (((class grayscale) (background light))
638      (:foreground "Gray90" :bold t :italic t))
639     (((class grayscale) (background dark))
640      (:foreground "DimGray" :bold t :italic t))
641     (t (:underline t)))
642   "Font Lock mode face used to highlight variable names."
643   :group 'font-lock-faces)
644
645 (defface font-lock-type-face
646   '((((class color) (background dark)) (:foreground "wheat"))
647     (((class color) (background light)) (:foreground "steelblue"))
648     (((class grayscale) (background light)) (:foreground "Gray90" :bold t))
649     (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
650     (t (:bold t)))
651   "Font Lock mode face used to highlight types."
652   :group 'font-lock-faces)
653
654 (defface font-lock-reference-face
655   '((((class color) (background dark)) (:foreground "cadetblue2"))
656     (((class color) (background light)) (:foreground "red3"))
657     (((class grayscale) (background light))
658      (:foreground "LightGray" :bold t :underline t))
659     (((class grayscale) (background dark))
660      (:foreground "Gray50" :bold t :underline t)))
661   "Font Lock mode face used to highlight references."
662   :group 'font-lock-faces)
663
664 ;; #### FSF has font-lock-builtin-face.
665
666 (defface font-lock-preprocessor-face
667   '((((class color) (background dark)) (:foreground "steelblue1"))
668     (((class color) (background light)) (:foreground "blue3"))
669     (t (:underline t)))
670   "Font Lock Mode face used to highlight preprocessor conditionals."
671   :group 'font-lock-faces)
672
673 ;; #### Currently unused
674 (defface font-lock-warning-face
675   '((((class color) (background light)) (:foreground "Red" :bold t))
676     (((class color) (background dark)) (:foreground "Pink" :bold t))
677     (t (:inverse-video t :bold t)))
678   "Font Lock mode face used to highlight warnings."
679   :group 'font-lock-faces)
680
681 (defun font-lock-recompute-variables ()
682   ;; Is this a Draconian thing to do?
683   (mapc #'(lambda (buffer)
684             (with-current-buffer buffer
685               (font-lock-mode 0)
686               (font-lock-set-defaults t)))
687         (buffer-list)))
688
689 ;; Backwards-compatible crud.
690
691 (defun font-lock-reset-all-faces ()
692   (dolist (face font-lock-face-list)
693     (face-spec-set face (get face 'face-defface-spec))))
694
695 (defun font-lock-use-default-fonts ()
696   "Reset the font-lock faces to a default set of fonts."
697   (interactive)
698   ;; #### !!!!
699   (font-lock-reset-all-faces))
700
701 (defun font-lock-use-default-colors ()
702   "Reset the font-lock faces to a default set of colors."
703   (interactive)
704   ;; #### !!!!
705   (font-lock-reset-all-faces))
706
707 (defun font-lock-use-default-minimal-decoration ()
708   "Reset the font-lock patterns to a fast, minimal set of decorations."
709   (and font-lock-maximum-decoration
710        (setq font-lock-maximum-decoration nil)
711        (font-lock-recompute-variables)))
712
713 (defun font-lock-use-default-maximal-decoration ()
714   "Reset the font-lock patterns to a larger set of decorations."
715   (and (not (eq t font-lock-maximum-decoration))
716        (setq font-lock-maximum-decoration t)
717        (font-lock-recompute-variables)))
718
719 \f
720 ;;;;;;;;;;;;;;;;;;;;;;        actual code        ;;;;;;;;;;;;;;;;;;;;;;
721
722 ;;; To fontify the whole buffer by language syntax, we go through it a
723 ;;; character at a time, creating extents on the boundary of each syntactic
724 ;;; unit (that is, one extent for each block comment, one for each line
725 ;;; comment, one for each string, etc.)  This is done with the C function
726 ;;; syntactically-sectionize.  It's in C for speed (the speed of lisp function
727 ;;; calls was a real bottleneck for this task since it involves examining each
728 ;;; character in turn.)
729 ;;;
730 ;;; Then we make a second pass, to fontify the buffer based on other patterns
731 ;;; specified by regexp.  When we find a match for a region of text, we need
732 ;;; to change the fonts on those characters.  This is done with the
733 ;;; put-text-property function, which knows how to efficiently share extents.
734 ;;; Conceptually, we are attaching some particular face to each of the
735 ;;; characters in a range, but the implementation of this involves creating
736 ;;; extents, or resizing existing ones.
737 ;;;
738 ;;; Each time a modification happens to a line, we re-fontify the entire line.
739 ;;; We do this by first removing the extents (text properties) on the line,
740 ;;; and then doing the syntactic and keyword passes again on that line.  (More
741 ;;; generally, each modified region is extended to include the preceding and
742 ;;; following BOL or EOL.)
743 ;;;
744 ;;; This means that, as the user types, we repeatedly go back to the beginning
745 ;;; of the line, doing more work the longer the line gets.  This doesn't cost
746 ;;; much in practice, and if we don't, then we incorrectly fontify things when,
747 ;;; for example, inserting spaces into `intfoo () {}'.
748 ;;;
749
750 \f
751 ;; The user level functions
752
753 ;;;###autoload
754 (defun font-lock-mode (&optional arg)
755   "Toggle Font Lock Mode.
756 With arg, turn font-lock mode on if and only if arg is positive.
757
758 When Font Lock mode is enabled, text is fontified as you type it:
759
760  - Comments are displayed in `font-lock-comment-face';
761  - Strings are displayed in `font-lock-string-face';
762  - Documentation strings (in Lisp-like languages) are displayed in
763    `font-lock-doc-string-face';
764  - Language keywords (\"reserved words\") are displayed in
765    `font-lock-keyword-face';
766  - Function names in their defining form are displayed in
767    `font-lock-function-name-face';
768  - Variable names in their defining form are displayed in
769    `font-lock-variable-name-face';
770  - Type names are displayed in `font-lock-type-face';
771  - References appearing in help files and the like are displayed
772    in `font-lock-reference-face';
773  - Preprocessor declarations are displayed in
774   `font-lock-preprocessor-face';
775
776    and
777
778  - Certain other expressions are displayed in other faces according
779    to the value of the variable `font-lock-keywords'.
780
781 Where modes support different levels of fontification, you can use the variable
782 `font-lock-maximum-decoration' to specify which level you generally prefer.
783 When you turn Font Lock mode on/off the buffer is fontified/defontified, though
784 fontification occurs only if the buffer is less than `font-lock-maximum-size'.
785 To fontify a buffer without turning on Font Lock mode, and regardless of buffer
786 size, you can use \\[font-lock-fontify-buffer].
787
788 See the variable `font-lock-keywords' for customization."
789   (interactive "P")
790   (let ((on-p (if arg (> (prefix-numeric-value arg) 0) (not font-lock-mode)))
791         (maximum-size (if (not (consp font-lock-maximum-size))
792                           font-lock-maximum-size
793                         (cdr (or (assq major-mode font-lock-maximum-size)
794                                  (assq t font-lock-maximum-size))))))
795     ;; Font-lock mode will refuse to turn itself on if in batch mode, or if
796     ;; the current buffer is "invisible".  The latter is because packages
797     ;; sometimes put their temporary buffers into some particular major mode
798     ;; to get syntax tables and variables and whatnot, but we don't want the
799     ;; fact that the user has font-lock-mode on a mode hook to slow these
800     ;; things down.
801     (if (or noninteractive (eq (aref (buffer-name) 0) ?\ ))
802         (setq on-p nil))
803     (if (equal (buffer-name) " *Compiler Input*") ; hack for bytecomp...
804         (setq on-p nil))
805     (cond (on-p
806            (make-local-hook 'after-change-functions)
807            (add-hook 'after-change-functions
808                      'font-lock-after-change-function nil t)
809            (add-hook 'pre-idle-hook 'font-lock-pre-idle-hook))
810           (t
811            (remove-hook 'after-change-functions
812                         'font-lock-after-change-function t)
813            (setq font-lock-defaults-computed nil
814                  font-lock-keywords nil)
815            ;; We have no business doing this here, since 
816            ;; pre-idle-hook is global.  Other buffers may
817            ;; still be in font-lock mode.  -dkindred@cs.cmu.edu
818            ;; (remove-hook 'pre-idle-hook 'font-lock-pre-idle-hook)
819            ))
820     (set (make-local-variable 'font-lock-mode) on-p)
821     (cond (on-p
822            (font-lock-set-defaults-1)
823            (make-local-hook 'before-revert-hook)
824            (make-local-hook 'after-revert-hook)
825            ;; If buffer is reverted, must clean up the state.
826            (add-hook 'before-revert-hook 'font-lock-revert-setup nil t)
827            (add-hook 'after-revert-hook 'font-lock-revert-cleanup nil t)
828            (run-hooks 'font-lock-mode-hook)
829            (cond (font-lock-fontified
830                   nil)
831                  ((or (null maximum-size) (<= (buffer-size) maximum-size))
832                   (font-lock-fontify-buffer))
833                  (font-lock-verbose
834                   (lmessage 'command "Fontifying %s... buffer too big."
835                     (buffer-name)))))
836           (font-lock-fontified
837            (setq font-lock-fontified nil)
838            (remove-hook 'before-revert-hook 'font-lock-revert-setup t)
839            (remove-hook 'after-revert-hook 'font-lock-revert-cleanup t)
840            (font-lock-unfontify-region (point-min) (point-max))
841            (font-lock-thing-lock-cleanup))
842           (t
843            (remove-hook 'before-revert-hook 'font-lock-revert-setup t)
844            (remove-hook 'after-revert-hook 'font-lock-revert-cleanup t)
845            (font-lock-thing-lock-cleanup)))
846     (redraw-modeline)))
847
848 ;; For init-file hooks
849 ;;;###autoload
850 (defun turn-on-font-lock ()
851   "Unconditionally turn on Font Lock mode."
852   (font-lock-mode 1))
853
854 ;;;###autoload
855 (defun turn-off-font-lock ()
856   "Unconditionally turn off Font Lock mode."
857   (font-lock-mode 0))
858
859 ;;; FSF has here:
860
861 ;; support for add-keywords, global-font-lock-mode and
862 ;; font-lock-support-mode (unified support for various *-lock modes).
863
864 \f
865 ;; Fontification functions.
866
867 ;; We first define some defsubsts to encapsulate the way we add
868 ;; faces to a region of text.  I am planning on modifying the
869 ;; text-property mechanism so that multiple independent classes
870 ;; of text properties can exist.  That way, for example, ediff's
871 ;; face text properties don't interfere with font lock's face
872 ;; text properties.  Due to the XEmacs implementation of text
873 ;; properties in terms of extents, doing this is fairly trivial:
874 ;; instead of using the `text-prop' property, you just use a
875 ;; specified property.
876
877 (defsubst font-lock-set-face (start end face)
878   ;; Set the face on the characters in the range.
879   (put-nonduplicable-text-property start end 'face face)
880   (put-nonduplicable-text-property start end 'font-lock t))
881
882 (defsubst font-lock-remove-face (start end)
883   ;; Remove any syntax highlighting on the characters in the range.
884   (put-nonduplicable-text-property start end 'face nil)
885   (put-nonduplicable-text-property start end 'font-lock nil))
886
887 (defsubst font-lock-any-faces-p (start end)
888   ;; Return non-nil if we've put any syntax highlighting on
889   ;; the characters in the range.
890   ;;
891   ;; used to look for 'text-prop property, but this has problems if
892   ;; you put any other text properties in the vicinity.  Simon
893   ;; Marshall suggested looking for the 'face property (this is what
894   ;; FSF Emacs does) but that's equally bogus.  Only reliable way is
895   ;; for font-lock to specially mark its extents.
896   ;;
897   ;; FSF's (equivalent) definition of this defsubst would be
898   ;; (text-property-not-all start end 'font-lock nil)
899   ;;
900   ;; Perhaps our `map-extents' is faster than our definition
901   ;; of `text-property-not-all'.  #### If so, `text-property-not-all'
902   ;; should be fixed ...
903   ;;
904   (map-extents 'extent-property (current-buffer) start (1- end) 'font-lock))
905
906 \f
907 ;; Fontification functions.
908
909 ;; Rather than the function, e.g., `font-lock-fontify-region' containing the
910 ;; code to fontify a region, the function runs the function whose name is the
911 ;; value of the variable, e.g., `font-lock-fontify-region-function'.  Normally,
912 ;; the value of this variable is, e.g., `font-lock-default-fontify-region'
913 ;; which does contain the code to fontify a region.  However, the value of the
914 ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could
915 ;; do anything.  The indirection of the fontification functions gives major
916 ;; modes the capability of modifying the way font-lock.el fontifies.  Major
917 ;; modes can modify the values of, e.g., `font-lock-fontify-region-function',
918 ;; via the variable `font-lock-defaults'.
919 ;;
920 ;; For example, Rmail mode sets the variable `font-lock-defaults' so that
921 ;; font-lock.el uses its own function for buffer fontification.  This function
922 ;; makes fontification be on a message-by-message basis and so visiting an
923 ;; RMAIL file is much faster.  A clever implementation of the function might
924 ;; fontify the headers differently than the message body.  (It should, and
925 ;; correspondingly for Mail mode, but I can't be bothered to do the work.  Can
926 ;; you?)  This hints at a more interesting use...
927 ;;
928 ;; Languages that contain text normally contained in different major modes
929 ;; could define their own fontification functions that treat text differently
930 ;; depending on its context.  For example, Perl mode could arrange that here
931 ;; docs are fontified differently than Perl code.  Or Yacc mode could fontify
932 ;; rules one way and C code another.  Neat!
933 ;;
934 ;; A further reason to use the fontification indirection feature is when the
935 ;; default syntactual fontification, or the default fontification in general,
936 ;; is not flexible enough for a particular major mode.  For example, perhaps
937 ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to
938 ;; cope with.  You need to write your own version of that function, e.g.,
939 ;; `hairy-fontify-syntactically-region', and make your own version of
940 ;; `hairy-fontify-region' call that function before calling
941 ;; `font-lock-fontify-keywords-region' for the normal regexp fontification
942 ;; pass.  And Hairy mode would set `font-lock-defaults' so that font-lock.el
943 ;; would call your region fontification function instead of its own.  For
944 ;; example, TeX modes could fontify {\foo ...} and \bar{...}  etc. multi-line
945 ;; directives correctly and cleanly.  (It is the same problem as fontifying
946 ;; multi-line strings and comments; regexps are not appropriate for the job.)
947
948 ;;;###autoload
949 (defun font-lock-fontify-buffer ()
950   "Fontify the current buffer the way `font-lock-mode' would.
951 See `font-lock-mode' for details.
952
953 This can take a while for large buffers."
954   (interactive)
955   (let ((font-lock-verbose (or font-lock-verbose (interactive-p))))
956     (funcall font-lock-fontify-buffer-function)))
957
958 (defun font-lock-unfontify-buffer ()
959   (funcall font-lock-unfontify-buffer-function))
960
961 (defun font-lock-fontify-region (beg end &optional loudly)
962   (funcall font-lock-fontify-region-function beg end loudly))
963
964 (defun font-lock-unfontify-region (beg end &optional loudly)
965   (funcall font-lock-unfontify-region-function beg end loudly))
966
967 ;; #### In these functions, the FSF is careful to do
968 ;; (save-restriction
969 ;;   (widen)
970 ;; before anything else.  Should we copy?
971 (defun font-lock-default-fontify-buffer ()
972   (interactive)
973   (let ((was-on font-lock-mode)
974         (font-lock-verbose (or font-lock-verbose (interactive-p)))
975         (font-lock-message-threshold 0)
976         (aborted nil))
977     ;; Turn it on to run hooks and get the right font-lock-keywords.
978     (or was-on (font-lock-mode 1))
979     (font-lock-unfontify-region (point-min) (point-max) t)
980 ;;    (buffer-syntactic-context-flush-cache)
981     
982     ;; If a ^G is typed during fontification, abort the fontification, but
983     ;; return normally (do not signal.)  This is to make it easy to abort
984     ;; fontification if it's taking a long time, without also causing the
985     ;; buffer not to pop up.  If a real abort is desired, the user can ^G
986     ;; again.
987     ;;
988     ;; Possibly this should happen down in font-lock-fontify-region instead
989     ;; of here, but since that happens from the after-change-hook (meaning
990     ;; much more frequently) I'm afraid of the bad consequences of stealing
991     ;; the interrupt character at inopportune times.
992     ;;
993     (condition-case nil
994         (save-excursion
995           (font-lock-fontify-region (point-min) (point-max)))
996       (quit
997        (setq aborted t)))
998
999     (or was-on          ; turn it off if it was off.
1000         (let ((font-lock-fontified nil)) ; kludge to prevent defontification
1001           (font-lock-mode 0)))
1002     (set (make-local-variable 'font-lock-fontified) t)
1003     (when (and aborted font-lock-verbose)
1004         (lmessage 'command  "Fontifying %s... aborted." (buffer-name))))
1005   (run-hooks 'font-lock-after-fontify-buffer-hook))
1006
1007 (defun font-lock-default-unfontify-buffer ()
1008   (font-lock-unfontify-region (point-min) (point-max))
1009   (set (make-local-variable 'font-lock-fontified) nil))
1010
1011 ;; This used to be `font-lock-fontify-region', and before that,
1012 ;; `font-lock-fontify-region' used to be the name used for what is now
1013 ;; `font-lock-fontify-syntactically-region'.
1014 (defun font-lock-default-fontify-region (beg end &optional loudly)
1015   (let ((modified (buffer-modified-p))
1016         (buffer-undo-list t) (inhibit-read-only t)
1017         (old-syntax-table (syntax-table))
1018         buffer-file-name buffer-file-truename)
1019     (unwind-protect
1020         (progn
1021           ;; Use the fontification syntax table, if any.
1022           (if font-lock-syntax-table (set-syntax-table font-lock-syntax-table))
1023           ;; Now do the fontification.
1024           (if font-lock-keywords-only
1025               (font-lock-unfontify-region beg end)
1026             (font-lock-fontify-syntactically-region beg end loudly))
1027           (font-lock-fontify-keywords-region beg end loudly))
1028       ;; Clean up.
1029       (set-syntax-table old-syntax-table)
1030       (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil)))))
1031
1032 ;; The following must be rethought, since keywords can override fontification.
1033 ;      ;; Now scan for keywords, but not if we are inside a comment now.
1034 ;      (or (and (not font-lock-keywords-only)
1035 ;              (let ((state (parse-partial-sexp beg end nil nil 
1036 ;                                               font-lock-cache-state)))
1037 ;                (or (nth 4 state) (nth 7 state))))
1038 ;         (font-lock-fontify-keywords-region beg end))
1039
1040 (defun font-lock-default-unfontify-region (beg end &optional maybe-loudly)
1041   (when (and maybe-loudly font-lock-verbose
1042              (>= (- end beg) font-lock-message-threshold))
1043     (lmessage 'progress "Fontifying %s..." (buffer-name)))
1044   (let ((modified (buffer-modified-p))
1045         (buffer-undo-list t) (inhibit-read-only t)
1046         buffer-file-name buffer-file-truename)
1047     (font-lock-remove-face beg end)
1048     (and (not modified) (buffer-modified-p) (set-buffer-modified-p nil))))
1049
1050 ;; Following is the original FSF version (similar to our original
1051 ;; version, before all the crap I added below).
1052 ;;
1053 ;; Probably that crap should either be fixed up so it works better,
1054 ;; or tossed away.
1055 ;;
1056 ;; I think that lazy-lock v2 tries to do something similar.
1057 ;; Those efforts should be merged.
1058
1059 ;; Called when any modification is made to buffer text.
1060 ;(defun font-lock-after-change-function (beg end old-len)
1061 ;  (save-excursion
1062 ;    (save-match-data
1063 ;      ;; Rescan between start of line from `beg' and start of line after `end'.
1064 ;      (font-lock-fontify-region
1065 ;       (progn (goto-char beg) (beginning-of-line) (point))
1066 ;       (progn (goto-char end) (forward-line 1) (point))))))
1067
1068 (defvar font-lock-old-extent nil)
1069 (defvar font-lock-old-len 0)
1070
1071 (defun font-lock-fontify-glumped-region ()
1072   ;; even if something goes wrong in the fontification, mark the glumped
1073   ;; region as fontified; otherwise, the same error might get signaled
1074   ;; after every command.
1075   (unwind-protect
1076       ;; buffer/extent may be deleted.
1077       (if (and (extent-live-p font-lock-old-extent)
1078                (buffer-live-p (extent-object font-lock-old-extent)))
1079           (save-excursion
1080             (set-buffer (extent-object font-lock-old-extent))
1081             (font-lock-after-change-function-1
1082              (extent-start-position font-lock-old-extent)
1083              (extent-end-position font-lock-old-extent)
1084              font-lock-old-len)))
1085     (detach-extent font-lock-old-extent)
1086     (setq font-lock-old-extent nil)))
1087
1088 (defun font-lock-pre-idle-hook ()
1089   (condition-case nil
1090       (if font-lock-old-extent
1091           (font-lock-fontify-glumped-region))
1092     (error (warn "Error caught in `font-lock-pre-idle-hook'"))))
1093
1094 (defvar font-lock-always-fontify-immediately nil
1095   "Set this to non-nil to disable font-lock deferral.")
1096
1097 ;;; called when any modification is made to buffer text.  This function
1098 ;;; attempts to glump adjacent changes together so that excessive
1099 ;;; fontification is avoided.  This function could easily be adapted
1100 ;;; to other after-change-functions.
1101
1102 (defun font-lock-after-change-function (beg end old-len)
1103   (let ((obeg (and font-lock-old-extent
1104                    (extent-start-position font-lock-old-extent)))
1105         (oend (and font-lock-old-extent
1106                    (extent-end-position font-lock-old-extent)))
1107         (bc-end (+ beg old-len)))
1108
1109     ;; If this change can't be merged into the glumped one,
1110     ;; we need to fontify the glumped one right now.
1111     (if (and font-lock-old-extent
1112              (or (not (eq (current-buffer)
1113                           (extent-object font-lock-old-extent)))
1114                  (< bc-end obeg)
1115                  (> beg oend)))
1116         (font-lock-fontify-glumped-region))
1117   
1118     (if font-lock-old-extent
1119         ;; Update glumped region.
1120         (progn
1121           ;; Any characters in the before-change region that are
1122           ;; outside the glumped region go into the glumped
1123           ;; before-change region.
1124           (if (> bc-end oend)
1125               (setq font-lock-old-len (+ font-lock-old-len (- bc-end oend))))
1126           (if (> obeg beg)
1127               (setq font-lock-old-len (+ font-lock-old-len (- obeg beg))))
1128           ;; New glumped region is the union of the glumped region
1129           ;; and the new region.
1130           (set-extent-endpoints font-lock-old-extent
1131                                 (min obeg beg)
1132                                 (max oend end)))
1133
1134       ;; No glumped region, so create one.
1135       (setq font-lock-old-extent (make-extent beg end))
1136       (set-extent-property font-lock-old-extent 'detachable nil)
1137       (set-extent-property font-lock-old-extent 'end-open nil)
1138       (setq font-lock-old-len old-len))
1139
1140     (if font-lock-always-fontify-immediately
1141         (font-lock-fontify-glumped-region))))
1142
1143 (defun font-lock-after-change-function-1 (beg end old-len)
1144   (if (null font-lock-mode)
1145       nil
1146     (save-excursion
1147       (save-restriction
1148         ;; if we don't widen, then fill-paragraph (and any command that
1149         ;; operates on a narrowed region) confuses things, because the C
1150         ;; code will fail to realize that we're inside a comment.
1151         (widen)
1152         (save-match-data
1153           (let ((zmacs-region-stays zmacs-region-stays)) ; protect from change!
1154             (goto-char beg)
1155             ;; Maybe flush the internal cache used by syntactically-sectionize.
1156             ;; (It'd be nice if this was more automatic.)  Any deletions mean
1157             ;; the cache is invalid, and insertions at beginning or end of line
1158             ;; mean that the bol cache might be invalid.
1159 ;;          (if (or (> old-len 0) (bobp) (= (preceding-char) ?\n))
1160 ;;              (buffer-syntactic-context-flush-cache))
1161
1162             ;; Always recompute the whole line.
1163             (goto-char end)
1164             (forward-line 1)
1165             (setq end (point))
1166             (goto-char beg)
1167             (beginning-of-line)
1168             (setq beg (point))
1169             ;; Rescan between start of line from `beg' and start of line after
1170             ;; `end'.
1171             (font-lock-fontify-region beg end)))))))
1172
1173 \f
1174 ;; Syntactic fontification functions.
1175
1176 ;; Note: Here is the FSF version.  Our version is much faster because
1177 ;; of the C support we provide.  This may be useful for reference,
1178 ;; however, and perhaps there is something useful here that should
1179 ;; be merged into our version.
1180 ;;
1181 ;(defun font-lock-fontify-syntactically-region (start end &optional loudly)
1182 ;  "Put proper face on each string and comment between START and END.
1183 ;START should be at the beginning of a line."
1184 ;  (let ((synstart (if comment-start-skip
1185 ;                      (concat "\\s\"\\|" comment-start-skip)
1186 ;                    "\\s\""))
1187 ;        (comstart (if comment-start-skip
1188 ;                      (concat "\\s<\\|" comment-start-skip)
1189 ;                    "\\s<"))
1190 ;        state prev prevstate)
1191 ;    (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name)))
1192 ;    (save-restriction
1193 ;      (widen)
1194 ;      (goto-char start)
1195 ;      ;;
1196 ;      ;; Find the state at the `beginning-of-line' before `start'.
1197 ;      (if (eq start font-lock-cache-position)
1198 ;          ;; Use the cache for the state of `start'.
1199 ;          (setq state font-lock-cache-state)
1200 ;        ;; Find the state of `start'.
1201 ;        (if (null font-lock-beginning-of-syntax-function)
1202 ;            ;; Use the state at the previous cache position, if any, or
1203 ;            ;; otherwise calculate from `point-min'.
1204 ;            (if (or (null font-lock-cache-position)
1205 ;                    (< start font-lock-cache-position))
1206 ;                (setq state (parse-partial-sexp (point-min) start))
1207 ;              (setq state (parse-partial-sexp font-lock-cache-position start
1208 ;                                              nil nil font-lock-cache-state)))
1209 ;          ;; Call the function to move outside any syntactic block.
1210 ;          (funcall font-lock-beginning-of-syntax-function)
1211 ;          (setq state (parse-partial-sexp (point) start)))
1212 ;        ;; Cache the state and position of `start'.
1213 ;        (setq font-lock-cache-state state
1214 ;              font-lock-cache-position start))
1215 ;      ;;
1216 ;      ;; If the region starts inside a string, show the extent of it.
1217 ;      (if (nth 3 state)
1218 ;          (let ((beg (point)))
1219 ;            (while (and (re-search-forward "\\s\"" end 'move)
1220 ;                        (nth 3 (parse-partial-sexp beg (point)
1221 ;                                                   nil nil state))))
1222 ;            (put-text-property beg (point) 'face font-lock-string-face)
1223 ;            (setq state (parse-partial-sexp beg (point) nil nil state))))
1224 ;      ;;
1225 ;      ;; Likewise for a comment.
1226 ;      (if (or (nth 4 state) (nth 7 state))
1227 ;          (let ((beg (point)))
1228 ;            (save-restriction
1229 ;              (narrow-to-region (point-min) end)
1230 ;              (condition-case nil
1231 ;                  (progn
1232 ;                    (re-search-backward comstart (point-min) 'move)
1233 ;                    (forward-comment 1)
1234 ;                    ;; forward-comment skips all whitespace,
1235 ;                    ;; so go back to the real end of the comment.
1236 ;                    (skip-chars-backward " \t"))
1237 ;                (error (goto-char end))))
1238 ;            (put-text-property beg (point) 'face font-lock-comment-face)
1239 ;            (setq state (parse-partial-sexp beg (point) nil nil state))))
1240 ;      ;;
1241 ;      ;; Find each interesting place between here and `end'.
1242 ;      (while (and (< (point) end)
1243 ;                  (setq prev (point) prevstate state)
1244 ;                  (re-search-forward synstart end t)
1245 ;                  (progn
1246 ;                    ;; Clear out the fonts of what we skip over.
1247 ;                    (remove-text-properties prev (point) '(face nil))
1248 ;                    ;; Verify the state at that place
1249 ;                    ;; so we don't get fooled by \" or \;.
1250 ;                    (setq state (parse-partial-sexp prev (point)
1251 ;                                                    nil nil state))))
1252 ;        (let ((here (point)))
1253 ;          (if (or (nth 4 state) (nth 7 state))
1254 ;              ;;
1255 ;              ;; We found a real comment start.
1256 ;              (let ((beg (match-beginning 0)))
1257 ;                (goto-char beg)
1258 ;                (save-restriction
1259 ;                  (narrow-to-region (point-min) end)
1260 ;                  (condition-case nil
1261 ;                      (progn
1262 ;                        (forward-comment 1)
1263 ;                        ;; forward-comment skips all whitespace,
1264 ;                        ;; so go back to the real end of the comment.
1265 ;                        (skip-chars-backward " \t"))
1266 ;                    (error (goto-char end))))
1267 ;                (put-text-property beg (point) 'face
1268 ;                                   font-lock-comment-face)
1269 ;                (setq state (parse-partial-sexp here (point) nil nil state)))
1270 ;            (if (nth 3 state)
1271 ;                ;;
1272 ;                ;; We found a real string start.
1273 ;                (let ((beg (match-beginning 0)))
1274 ;                  (while (and (re-search-forward "\\s\"" end 'move)
1275 ;                              (nth 3 (parse-partial-sexp here (point)
1276 ;                                                         nil nil state))))
1277 ;                  (put-text-property beg (point) 'face font-lock-string-face)
1278 ;                  (setq state (parse-partial-sexp here (point)
1279 ;                                                  nil nil state))))))
1280 ;        ;;
1281 ;        ;; Make sure `prev' is non-nil after the loop
1282 ;        ;; only if it was set on the very last iteration.
1283 ;        (setq prev nil)))
1284 ;    ;;
1285 ;    ;; Clean up.
1286 ;    (and prev (remove-text-properties prev end '(face nil)))))
1287
1288 (defun font-lock-fontify-syntactically-region (start end &optional loudly)
1289   "Put proper face on each string and comment between START and END.
1290 START should be at the beginning of a line."
1291   (if font-lock-keywords-only
1292       nil
1293     (when (and font-lock-verbose
1294                (>= (- end start) font-lock-message-threshold))
1295       (lmessage 'progress "Fontifying %s... (syntactically...)"
1296         (buffer-name)))
1297     (font-lock-unfontify-region start end loudly)
1298     (goto-char start)
1299     (if (> end (point-max)) (setq end (point-max)))
1300     (syntactically-sectionize
1301       #'(lambda (s e context depth)
1302           (let (face)
1303             (cond ((eq context 'string)
1304                    ;;#### Should only do this is Lisp-like modes!
1305                    (setq face
1306                          (if (= depth 1)
1307                              ;; really we should only use this if
1308                              ;;  in position 3 depth 1, but that's
1309                              ;;  too expensive to compute.
1310                              'font-lock-doc-string-face
1311                            'font-lock-string-face)))
1312                   ((or (eq context 'comment)
1313                        (eq context 'block-comment))
1314                    (setq face 'font-lock-comment-face)
1315 ;                ;; Don't fontify whitespace at the beginning of lines;
1316 ;                ;;  otherwise comment blocks may not line up with code.
1317 ;                ;; (This is sometimes a good idea, sometimes not; in any
1318 ;                ;; event it should be in C for speed --jwz)
1319 ;                (save-excursion
1320 ;                    (goto-char s)
1321 ;                    (while (prog1 (search-forward "\n" (1- e) 'move)
1322 ;                             (setq face 'font-lock-comment-face)
1323 ;                             (setq e (point)))
1324 ;                      (skip-chars-forward " \t\n")
1325 ;                      (setq s (point)))
1326                    ))
1327             (font-lock-set-face s e face)))
1328       start end)
1329     ))
1330 \f
1331 ;;; Additional text property functions.
1332
1333 ;; The following three text property functions are not generally available (and
1334 ;; it's not certain that they should be) so they are inlined for speed.
1335 ;; The case for `fillin-text-property' is simple; it may or not be generally
1336 ;; useful.  (Since it is used here, it is useful in at least one place.;-)
1337 ;; However, the case for `append-text-property' and `prepend-text-property' is
1338 ;; more complicated.  Should they remove duplicate property values or not?  If
1339 ;; so, should the first or last duplicate item remain?  Or the one that was
1340 ;; added?  In our implementation, the first duplicate remains.
1341
1342 ;; XEmacs: modified all these functions to use
1343 ;; `put-nonduplicable-text-property' instead of `put-text-property', and
1344 ;; the first one to take both SETPROP and MARKPROP, in accordance with the
1345 ;; changed definitions of `font-lock-any-faces-p' and `font-lock-set-face'.
1346
1347 (defsubst font-lock-fillin-text-property (start end setprop markprop value &optional object)
1348   "Fill in one property of the text from START to END.
1349 Arguments PROP and VALUE specify the property and value to put where none are
1350 already in place.  Therefore existing property values are not overwritten.
1351 Optional argument OBJECT is the string or buffer containing the text."
1352   (let ((start (text-property-any start end markprop nil object)) next)
1353     (while start
1354       (setq next (next-single-property-change start markprop object end))
1355       (put-nonduplicable-text-property start next setprop value object)
1356       (put-nonduplicable-text-property start next markprop value object)
1357       (setq start (text-property-any next end markprop nil object)))))
1358
1359 ;; This function (from simon's unique.el) is rewritten and inlined for speed.
1360 ;(defun unique (list function)
1361 ;  "Uniquify LIST, deleting elements using FUNCTION.
1362 ;Return the list with subsequent duplicate items removed by side effects.
1363 ;FUNCTION is called with an element of LIST and a list of elements from LIST,
1364 ;and should return the list of elements with occurrences of the element removed,
1365 ;i.e., a function such as `delete' or `delq'.
1366 ;This function will work even if LIST is unsorted.  See also `uniq'."
1367 ;  (let ((list list))
1368 ;    (while list
1369 ;      (setq list (setcdr list (funcall function (car list) (cdr list))))))
1370 ;  list)
1371
1372 (defsubst font-lock-unique (list)
1373   "Uniquify LIST, deleting elements using `delq'.
1374 Return the list with subsequent duplicate items removed by side effects."
1375   (let ((list list))
1376     (while list
1377       (setq list (setcdr list (delq (car list) (cdr list))))))
1378   list)
1379
1380 ;; A generalisation of `facemenu-add-face' for any property, but without the
1381 ;; removal of inactive faces via `facemenu-discard-redundant-faces' and special
1382 ;; treatment of `default'.  Uses `unique' to remove duplicate property values.
1383 (defsubst font-lock-prepend-text-property (start end prop value &optional object)
1384   "Prepend to one property of the text from START to END.
1385 Arguments PROP and VALUE specify the property and value to prepend to the value
1386 already in place.  The resulting property values are always lists, and unique.
1387 Optional argument OBJECT is the string or buffer containing the text."
1388   (let ((val (if (listp value) value (list value))) next prev)
1389     (while (/= start end)
1390       (setq next (next-single-property-change start prop object end)
1391             prev (get-text-property start prop object))
1392       (put-text-property
1393        start next prop
1394        (font-lock-unique (append val (if (listp prev) prev (list prev))))
1395        object)
1396       (setq start next))))
1397
1398 (defsubst font-lock-append-text-property (start end prop value &optional object)
1399   "Append to one property of the text from START to END.
1400 Arguments PROP and VALUE specify the property and value to append to the value
1401 already in place.  The resulting property values are always lists, and unique.
1402 Optional argument OBJECT is the string or buffer containing the text."
1403   (let ((val (if (listp value) value (list value))) next prev)
1404     (while (/= start end)
1405       (setq next (next-single-property-change start prop object end)
1406             prev (get-text-property start prop object))
1407       (put-text-property
1408        start next prop
1409        (font-lock-unique (append (if (listp prev) prev (list prev)) val))
1410        object)
1411       (setq start next))))
1412 \f
1413 ;;; Regexp fontification functions.
1414
1415 (defsubst font-lock-apply-highlight (highlight)
1416   "Apply HIGHLIGHT following a match.
1417 HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'."
1418   (let* ((match (nth 0 highlight))
1419          (start (match-beginning match)) (end (match-end match))
1420          (override (nth 2 highlight)))
1421     (let ((newface (nth 1 highlight)))
1422       (or (symbolp newface)
1423           (setq newface (eval newface)))
1424       (cond ((not start)
1425              ;; No match but we might not signal an error.
1426              (or (nth 3 highlight)
1427                  (error "No match %d in highlight %S" match highlight)))
1428             ((= start end) nil)
1429             ((not override)
1430              ;; Cannot override existing fontification.
1431              (or (font-lock-any-faces-p start end)
1432                  (font-lock-set-face start end newface)))
1433             ((eq override t)
1434              ;; Override existing fontification.
1435              (font-lock-set-face start end newface))
1436             ((eq override 'keep)
1437              ;; Keep existing fontification.
1438              (font-lock-fillin-text-property start end 'face 'font-lock
1439                                              newface))
1440             ((eq override 'prepend)
1441              ;; Prepend to existing fontification.
1442              (font-lock-prepend-text-property start end 'face newface))
1443             ((eq override 'append)
1444              ;; Append to existing fontification.
1445              (font-lock-append-text-property start end 'face newface))))))
1446
1447 (defsubst font-lock-fontify-anchored-keywords (keywords limit)
1448   "Fontify according to KEYWORDS until LIMIT.
1449 KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords',
1450 LIMIT can be modified by the value of its PRE-MATCH-FORM."
1451   (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights
1452         ;; Evaluate PRE-MATCH-FORM.
1453         (pre-match-value (eval (nth 1 keywords))))
1454     ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
1455     (if (and (numberp pre-match-value) (> pre-match-value (point)))
1456         (setq limit pre-match-value)
1457       (save-excursion (end-of-line) (setq limit (point))))
1458     (save-match-data
1459       ;; Find an occurrence of `matcher' before `limit'.
1460       (while (if (stringp matcher)
1461                  (re-search-forward matcher limit t)
1462                (funcall matcher limit))
1463         ;; Apply each highlight to this instance of `matcher'.
1464         (setq highlights lowdarks)
1465         (while highlights
1466           (font-lock-apply-highlight (car highlights))
1467           (setq highlights (cdr highlights)))))
1468     ;; Evaluate POST-MATCH-FORM.
1469     (eval (nth 2 keywords))))
1470
1471 (defun font-lock-fontify-keywords-region (start end &optional loudvar)
1472   "Fontify according to `font-lock-keywords' between START and END.
1473 START should be at the beginning of a line."
1474   (let ((loudly (and font-lock-verbose
1475                      (>= (- end start) font-lock-message-threshold))))
1476     (let ((case-fold-search font-lock-keywords-case-fold-search)
1477           (keywords (cdr (if (eq (car-safe font-lock-keywords) t)
1478                              font-lock-keywords
1479                            (font-lock-compile-keywords))))
1480           (bufname (buffer-name)) (count 0)
1481           keyword matcher highlights)
1482       ;;
1483       ;; Fontify each item in `font-lock-keywords' from `start' to `end'.
1484       (while keywords
1485         (when loudly (lmessage 'progress "Fontifying %s... (regexps..%s)"
1486                        bufname
1487                        (make-string (setq count (1+ count)) ?.)))
1488         ;;
1489         ;; Find an occurrence of `matcher' from `start' to `end'.
1490         (setq keyword (car keywords) matcher (car keyword))
1491         (goto-char start)
1492         (while (and (< (point) end)
1493                     (if (stringp matcher)
1494                         (re-search-forward matcher end t)
1495                       (funcall matcher end)))
1496           ;; Apply each highlight to this instance of `matcher', which may be
1497           ;; specific highlights or more keywords anchored to `matcher'.
1498           (setq highlights (cdr keyword))
1499           (while highlights
1500             (if (numberp (car (car highlights)))
1501                 (let ((end (match-end (car (car highlights)))))
1502                   (font-lock-apply-highlight (car highlights))
1503                   ;; restart search just after the end of the
1504                   ;; keyword so keywords can share bracketing
1505                   ;; expressions.
1506                   (and end (goto-char end)))
1507               (font-lock-fontify-anchored-keywords (car highlights) end))
1508             (setq highlights (cdr highlights))))
1509         (setq keywords (cdr keywords))))
1510     (if loudly (lmessage 'progress "Fontifying %s... done." (buffer-name)))))
1511
1512 \f
1513 ;; Various functions.
1514
1515 ;; Turn off other related packages if they're on.  I prefer a hook. --sm.
1516 ;; These explicit calls are easier to understand
1517 ;; because people know what they will do.
1518 ;; A hook is a mystery because it might do anything whatever. --rms.
1519 (defun font-lock-thing-lock-cleanup ()
1520   (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
1521          (fast-lock-mode -1))
1522         ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
1523          (lazy-lock-mode -1))
1524         ((and (boundp 'lazy-shot-mode) lazy-shot-mode)
1525          (lazy-shot-mode -1))))
1526
1527 ;; Do something special for these packages after fontifying.  I prefer a hook.
1528 (defun font-lock-after-fontify-buffer ()
1529   (cond ((and (boundp 'fast-lock-mode) fast-lock-mode)
1530          (fast-lock-after-fontify-buffer))
1531         ((and (boundp 'lazy-lock-mode) lazy-lock-mode)
1532          (lazy-lock-after-fontify-buffer))))
1533
1534 ;; If the buffer is about to be reverted, it won't be fontified afterward.
1535 (defun font-lock-revert-setup ()
1536   (setq font-lock-fontified nil))
1537
1538 ;; If the buffer has just been reverted, normally that turns off
1539 ;; Font Lock mode.  So turn the mode back on if necessary.
1540 (defalias 'font-lock-revert-cleanup 'turn-on-font-lock)
1541
1542 \f
1543 ;; Various functions.
1544
1545 (defun font-lock-compile-keywords (&optional keywords)
1546   ;; Compile `font-lock-keywords' into the form (t KEYWORD ...) where KEYWORD
1547   ;; is the (MATCHER HIGHLIGHT ...) shown in the variable's doc string.
1548   (let ((keywords (or keywords font-lock-keywords)))
1549     (setq font-lock-keywords 
1550      (if (eq (car-safe keywords) t)
1551          keywords
1552        (cons t (mapcar 'font-lock-compile-keyword keywords))))))
1553
1554 (defun font-lock-compile-keyword (keyword)
1555   (cond ((nlistp keyword)               ; Just MATCHER
1556          (list keyword '(0 font-lock-keyword-face)))
1557         ((eq (car keyword) 'eval)       ; Specified (eval . FORM)
1558          (font-lock-compile-keyword (eval (cdr keyword))))
1559         ((numberp (cdr keyword))        ; Specified (MATCHER . MATCH)
1560          (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face)))
1561         ((symbolp (cdr keyword))        ; Specified (MATCHER . FACENAME)
1562          (list (car keyword) (list 0 (cdr keyword))))
1563         ((nlistp (nth 1 keyword))       ; Specified (MATCHER . HIGHLIGHT)
1564          (list (car keyword) (cdr keyword)))
1565         (t                              ; Hopefully (MATCHER HIGHLIGHT ...)
1566          keyword)))
1567
1568 (defun font-lock-choose-keywords (keywords level)
1569   ;; Return LEVELth element of KEYWORDS.  A LEVEL of nil is equal to a
1570   ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)).
1571   (let ((level (if (not (consp level))
1572                    level
1573                  (cdr (or (assq major-mode level) (assq t level))))))
1574     (cond ((symbolp keywords)
1575            keywords)
1576           ((numberp level)
1577            (or (nth level keywords) (car (reverse keywords))))
1578           ((eq level t)
1579            (car (reverse keywords)))
1580           (t
1581            (car keywords)))))
1582
1583 \f
1584 ;;; Determining which set of font-lock keywords to use.
1585
1586 (defun font-lock-find-font-lock-defaults (modesym)
1587   ;; Get the defaults based on the major mode.
1588   (let (raw-defaults)
1589     ;; I want a do-while loop!
1590     (while (progn
1591              (setq raw-defaults (get modesym 'font-lock-defaults))
1592              (and raw-defaults (symbolp raw-defaults)
1593                   (setq modesym raw-defaults)))
1594       )
1595     raw-defaults))
1596
1597 (defun font-lock-examine-syntax-table ()
1598   ; Computes the value of font-lock-keywords-only for this buffer.
1599   (if (eq (syntax-table) (standard-syntax-table))
1600       ;; Assume that modes which haven't bothered to install their own
1601       ;; syntax table don't do anything syntactically interesting.
1602       ;; Really, the standard-syntax-table shouldn't have comments and
1603       ;; strings in it, but changing that now might break things.
1604       nil
1605     ;; else map over the syntax table looking for strings or comments.
1606     (let (got-one)
1607       ;; XEmacs 20.0 ...
1608       (if (fboundp 'map-syntax-table)
1609           (setq got-one
1610                 (map-syntax-table
1611                  #'(lambda (key value)
1612                      (memq (char-syntax-from-code value)
1613                            '(?\" ?\< ?\> ?\$)))
1614                  (syntax-table)))
1615         ;; older Emacsen.
1616         (let ((i (1- (length (syntax-table)))))
1617           (while (>= i 0)
1618             (if (memq (char-syntax i) '(?\" ?\< ?\> ?\$))
1619                 (setq got-one t i 0))
1620             (setq i (1- i)))))
1621       (set (make-local-variable 'font-lock-keywords-only) (not got-one)))))
1622
1623 ;; font-lock-set-defaults is in fontl-hooks.el.
1624
1625 ;;;###autoload
1626 (defun font-lock-set-defaults-1 (&optional explicit-defaults)
1627   ;; does everything that font-lock-set-defaults does except
1628   ;; enable font-lock-mode.  This is called by `font-lock-mode'.
1629   ;; Note that the return value is used!
1630
1631   (if (and font-lock-defaults-computed (not explicit-defaults))
1632       ;; nothing to do.
1633       nil
1634
1635     (or font-lock-keywords
1636         (let* ((defaults (or (and (not (eq t explicit-defaults))
1637                                   explicit-defaults)
1638                              ;; in case modes decide to set
1639                              ;; `font-lock-defaults' themselves,
1640                              ;; as in FSF Emacs.
1641                              font-lock-defaults
1642                              (font-lock-find-font-lock-defaults major-mode)))
1643                (keywords (font-lock-choose-keywords
1644                           (nth 0 defaults) font-lock-maximum-decoration)))
1645           
1646           ;; Keywords?
1647           (setq font-lock-keywords (if (fboundp keywords)
1648                                        (funcall keywords)
1649                                      (eval keywords)))
1650           (or font-lock-keywords
1651               ;; older way:
1652               ;; try to look for a variable `foo-mode-font-lock-keywords',
1653               ;; or similar.
1654               (let ((major (symbol-name major-mode))
1655                     (try #'(lambda (n)
1656                              (if (stringp n) (setq n (intern-soft n)))
1657                              (if (and n
1658                                       (boundp n))
1659                                  n
1660                                nil))))
1661                 (setq font-lock-keywords 
1662                       (symbol-value
1663                        (or (funcall try (get major-mode 'font-lock-keywords))
1664                            (funcall try (concat major "-font-lock-keywords"))
1665                            (funcall try (and (string-match "-mode\\'" major)
1666                                              (concat (substring 
1667                                                       major 0 
1668                                                       (match-beginning 0))
1669                                                      "-font-lock-keywords")))
1670                            'font-lock-keywords)))))
1671
1672           ;; Case fold?
1673           (if (>= (length defaults) 3)
1674               (setq font-lock-keywords-case-fold-search (nth 2 defaults))
1675             ;; older way:
1676             ;; look for a property 'font-lock-keywords-case-fold-search on
1677             ;; the major-mode symbol.
1678             (let* ((nonexist (make-symbol ""))
1679                    (value (get major-mode 'font-lock-keywords-case-fold-search
1680                                nonexist)))
1681               (if (not (eq nonexist value))
1682                   (setq font-lock-keywords-case-fold-search value))))
1683
1684           ;; Syntactic?
1685           (if (>= (length defaults) 2)
1686               (setq font-lock-keywords-only (nth 1 defaults))
1687             ;; older way:
1688             ;; cleverly examine the syntax table.
1689             (font-lock-examine-syntax-table))
1690            
1691           ;; Syntax table?
1692           (if (nth 3 defaults)
1693               (let ((slist (nth 3 defaults)))
1694                 (setq font-lock-syntax-table
1695                       (copy-syntax-table (syntax-table)))
1696                 (while slist
1697                   (modify-syntax-entry (car (car slist)) (cdr (car slist))
1698                                        font-lock-syntax-table)
1699                   (setq slist (cdr slist)))))
1700
1701           ;; Syntax function?
1702           (cond (defaults
1703                   (setq font-lock-beginning-of-syntax-function
1704                         (nth 4 defaults)))
1705                 (t
1706                  ;; older way:
1707                  ;; defaults not specified at all, so use `beginning-of-defun'.
1708                  (setq font-lock-beginning-of-syntax-function
1709                        'beginning-of-defun)))))
1710
1711     (setq font-lock-defaults-computed t)))
1712
1713 \f
1714 ;;;;;;;;;;;;;;;;;;;;;;         keywords         ;;;;;;;;;;;;;;;;;;;;;;
1715
1716 ;;; Various major-mode interfaces.
1717 ;;; Probably these should go in with the source of the respective major modes.
1718
1719 ;; The defaults and keywords listed here should perhaps be moved into
1720 ;; mode-specific files.
1721
1722 ;; For C and Lisp modes we use `beginning-of-defun', rather than nil,
1723 ;; for SYNTAX-BEGIN.  Thus the calculation of the cache is usually
1724 ;; faster but not infallible, so we risk mis-fontification.  --sm.
1725
1726 (put 'c-mode 'font-lock-defaults 
1727      '((c-font-lock-keywords
1728         c-font-lock-keywords-1 c-font-lock-keywords-2 c-font-lock-keywords-3)
1729        nil nil ((?_ . "w")) beginning-of-defun))
1730 (put 'c++-c-mode 'font-lock-defaults 'c-mode)
1731 (put 'elec-c-mode 'font-lock-defaults 'c-mode)
1732
1733 (put 'c++-mode 'font-lock-defaults
1734      '((c++-font-lock-keywords
1735         c++-font-lock-keywords-1 c++-font-lock-keywords-2
1736         c++-font-lock-keywords-3)
1737        nil nil ((?_ . "w") (?~ . "w")) beginning-of-defun))
1738
1739 (put 'java-mode 'font-lock-defaults 
1740      '((java-font-lock-keywords
1741         java-font-lock-keywords-1 java-font-lock-keywords-2
1742         java-font-lock-keywords-3)
1743        nil nil ((?_ . "w")) beginning-of-defun
1744        (font-lock-mark-block-function . mark-defun)))
1745
1746 (put 'lisp-mode 'font-lock-defaults
1747      '((lisp-font-lock-keywords
1748         lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
1749        nil nil
1750        ((?: . "w") (?- . "w") (?* . "w") (?+ . "w") (?. . "w") (?< . "w")
1751         (?> . "w") (?= . "w") (?! . "w") (?? . "w") (?$ . "w") (?% . "w")
1752         (?_ . "w") (?& . "w") (?~ . "w") (?^ . "w") (?/ . "w"))
1753        beginning-of-defun))
1754 (put 'emacs-lisp-mode 'font-lock-defaults 'lisp-mode)
1755 (put 'lisp-interaction-mode 'font-lock-defaults 'lisp-mode)
1756
1757 (put 'scheme-mode 'font-lock-defaults
1758      '(scheme-font-lock-keywords
1759        nil t
1760        ((?: . "w") (?- . "w") (?* . "w") (?+ . "w") (?. . "w") (?< . "w")
1761         (?> . "w") (?= . "w") (?! . "w") (?? . "w") (?$ . "w") (?% . "w")
1762         (?_ . "w") (?& . "w") (?~ . "w") (?^ . "w") (?/ . "w"))
1763        beginning-of-defun))
1764 (put 'inferior-scheme-mode 'font-lock-defaults 'scheme-mode)
1765 (put 'scheme-interaction-mode 'font-lock-defaults 'scheme-mode)
1766
1767 (put 'tex-mode 'font-lock-defaults
1768      ;; For TeX modes we could use `backward-paragraph' for the same reason.
1769      '(tex-font-lock-keywords nil nil ((?$ . "\""))))
1770 ;; the nine billion names of TeX mode...
1771 (put 'bibtex-mode       'font-lock-defaults 'tex-mode)
1772 (put 'plain-tex-mode    'font-lock-defaults 'tex-mode)
1773 (put 'slitex-tex-mode   'font-lock-defaults 'tex-mode)
1774 (put 'SliTeX-mode       'font-lock-defaults 'tex-mode)
1775 (put 'slitex-mode       'font-lock-defaults 'tex-mode)
1776 (put 'latex-tex-mode    'font-lock-defaults 'tex-mode)
1777 (put 'LaTex-tex-mode    'font-lock-defaults 'tex-mode)
1778 (put 'latex-mode        'font-lock-defaults 'tex-mode)
1779 (put 'LaTeX-mode        'font-lock-defaults 'tex-mode)
1780 (put 'japanese-LaTeX-mode 'font-lock-defaults 'tex-mode)
1781 (put 'japanese-SliTeX-mode 'font-lock-defaults 'tex-mode)
1782 (put 'FoilTeX-mode      'font-lock-defaults 'tex-mode)
1783 (put 'LATeX-MoDe        'font-lock-defaults 'tex-mode)
1784 (put 'lATEx-mODe        'font-lock-defaults 'tex-mode)
1785 ;; ok, this is getting a bit silly ...
1786 (put 'eDOm-xETAl        'font-lock-defaults 'tex-mode)
1787
1788 ;;; Various regexp information shared by several modes.
1789 ;;; Information specific to a single mode should go in its load library.
1790
1791 (defconst lisp-font-lock-keywords-1
1792   (list
1793    ;; Anything not a variable or type declaration is fontified as a function.
1794    ;; It would be cleaner to allow preceding whitespace, but it would also be
1795    ;; about five times slower.
1796    (list (concat "^(\\(def\\("
1797                   ;; Variable declarations.
1798                   "\\(const\\(\\|ant\\)\\|ine-key\\(\\|-after\\)\\|var\\|custom\\)\\|"
1799                   ;; Structure declarations.
1800                   "\\(class\\|struct\\|type\\)\\|"
1801                   ;; Everything else is a function declaration.
1802                   "\\([^ \t\n\(\)]+\\)"
1803                   "\\)\\)\\>"
1804                   ;; Any whitespace and declared object.
1805                   "[ \t'\(]*"
1806                   "\\([^ \t\n\)]+\\)?")
1807           '(1 font-lock-keyword-face)
1808           '(8 (cond ((match-beginning 3) 'font-lock-variable-name-face)
1809                     ((match-beginning 6) 'font-lock-type-face)
1810                     (t 'font-lock-function-name-face))
1811               nil t))
1812    )
1813  "Subdued level highlighting Lisp modes.")
1814
1815 (defconst lisp-font-lock-keywords-2
1816   (append lisp-font-lock-keywords-1
1817    (list
1818     ;;
1819     ;; Control structures.  ELisp and CLisp combined.
1820     ;;
1821     ;;(regexp-opt
1822     ;;  '("cond" "if" "while" "let" "let*" "prog" "progn" "prog1"
1823     ;;    "prog2" "progv" "catch" "throw" "save-restriction"
1824     ;;    "save-excursion" "save-window-excursion"
1825     ;;    "save-current-buffer" "with-current-buffer"
1826     ;;    "with-temp-file" "with-temp-buffer" "with-output-to-string"
1827     ;;    "with-string-as-buffer-contents"
1828     ;;    "save-selected-window" "save-match-data" "unwind-protect"
1829     ;;    "condition-case" "track-mouse" "autoload"
1830     ;;    "eval-after-load" "eval-and-compile" "eval-when-compile"
1831     ;;    "when" "unless" "do" "dolist" "dotimes" "flet" "labels"
1832     ;;    "lambda" "return" "return-from"))
1833     (cons
1834      (concat
1835       "(\\("
1836       "autoload\\|c\\(atch\\|ond\\(ition-case\\)?\\)\\|do\\(list\\|"
1837       "times\\)?\\|eval-\\(a\\(fter-load\\|nd-compile\\)\\|when-compile\\)\\|"
1838       "flet\\|if\\|l\\(a\\(bels\\|mbda\\)\\|et\\*?\\)\\|"
1839       "prog[nv12\\*]?\\|return\\(-from\\)?\\|save-\\(current-buffer\\|"
1840       "excursion\\|match-data\\|restriction\\|selected-window\\|"
1841       "window-excursion\\)\\|t\\(hrow\\|rack-mouse\\)\\|un\\(less\\|"
1842       "wind-protect\\)\\|w\\(h\\(en\\|ile\\)\\|ith-\\(current-buffer\\|"
1843       "output-to-string\\|string-as-buffer-contents\\|temp-\\(buffer\\|"
1844       "file\\)\\)\\)"
1845       "\\)\\>") 1)
1846     ;;
1847     ;; Feature symbols as references.
1848     '("(\\(featurep\\|provide\\|require\\)\\>[ \t']*\\(\\sw+\\)?"
1849       (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
1850     ;;
1851     ;; Words inside \\[] tend to be for `substitute-command-keys'.
1852     '("\\\\\\\\\\[\\(\\sw+\\)]" 1 font-lock-reference-face prepend)
1853     ;;
1854     ;; Words inside `' tend to be symbol names.
1855     '("`\\(\\sw\\sw+\\)'" 1 font-lock-reference-face prepend)
1856     ;;
1857     ;; CLisp `:' keywords as references.
1858     '("\\<:\\sw+\\>" 0 font-lock-reference-face prepend)
1859     ;;
1860     ;; ELisp and CLisp `&' keywords as types.
1861     '("\\<\\&\\(optional\\|rest\\|whole\\)\\>" . font-lock-type-face)
1862     ))
1863   "Gaudy level highlighting for Lisp modes.")
1864
1865 (defvar lisp-font-lock-keywords lisp-font-lock-keywords-1
1866   "Default expressions to highlight in Lisp modes.")
1867
1868 ;; The previous version, before replacing it with the FSF version.
1869 ;(defconst lisp-font-lock-keywords-1 (purecopy
1870 ; '(;;
1871 ;   ;; highlight defining forms.  This doesn't work too nicely for
1872 ;   ;; (defun (setf foo) ...) but it does work for (defvar foo) which
1873 ;   ;; is more important.
1874 ;   ("^(def[-a-z]+\\s +\\([^ \t\n\)]+\\)" 1 font-lock-function-name-face)
1875 ;   ;;
1876 ;   ;; highlight CL keywords (three clauses seems faster than one)
1877 ;   ("\\s :\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1878 ;   ("(:\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1879 ;   ("':\\(\\(\\sw\\|\\s_\\)+\\)\\>" . 1)
1880 ;   ;;
1881 ;   ;; this is highlights things like (def* (setf foo) (bar baz)), but may
1882 ;   ;; be slower (I haven't really thought about it)
1883 ;;   ("^(def[-a-z]+\\s +\\(\\s(\\S)*\\s)\\|\\S(\\S *\\)"
1884 ;;    1 font-lock-function-name-face)
1885 ;   ))
1886 ; "For consideration as a value of `lisp-font-lock-keywords'.
1887 ;This does fairly subdued highlighting.")
1888 ;
1889 ;(defconst lisp-font-lock-keywords-2 (purecopy
1890 ;  (append lisp-font-lock-keywords-1
1891 ;   '(;;
1892 ;     ;; Highlight control structures
1893 ;     ("(\\(cond\\|if\\|when\\|unless\\|[ec]?\\(type\\)?case\\)[ \t\n]" . 1)
1894 ;     ("(\\(while\\|do\\|let\\*?\\|flet\\|labels\\|prog[nv12*]?\\)[ \t\n]" . 1)
1895 ;     ("(\\(do\\*\\|dotimes\\|dolist\\|loop\\)[ \t\n]" . 1)
1896 ;     ("(\\(catch\\|\\throw\\|block\\|return\\|return-from\\)[ \t\n]" . 1)
1897 ;     ("(\\(save-restriction\\|save-window-restriction\\)[ \t\n]" . 1)
1898 ;     ("(\\(save-excursion\\|unwind-protect\\|condition-case\\)[ \t\n]" . 1)
1899 ;     ;;
1900 ;     ;; highlight function names in emacs-lisp docstrings (in the syntax
1901 ;     ;; that substitute-command-keys understands.)
1902 ;     ("\\\\\\\\\\[\\([^]\\\n]+\\)]" 1 font-lock-keyword-face t)
1903 ;     ;;
1904 ;     ;; highlight words inside `' which tend to be function names
1905 ;     ("`\\([-a-zA-Z0-9_][-a-zA-Z0-9_][-a-zA-Z0-9_.]+\\)'"
1906 ;      1 font-lock-keyword-face t)
1907 ;     )))
1908 ; "For consideration as a value of `lisp-font-lock-keywords'.
1909 ;
1910 ;This does a lot more highlighting.")
1911
1912 (defvar scheme-font-lock-keywords
1913   (eval-when-compile
1914     (list
1915      ;;
1916      ;; Declarations.  Hannes Haug <hannes.haug@student.uni-tuebingen.de> says
1917      ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS.
1918      (list (concat "(\\(define\\("
1919                    ;; Function names.
1920                    "\\(\\|-\\(generic\\(\\|-procedure\\)\\|method\\)\\)\\|"
1921                    ;; Macro names, as variable names.  A bit dubious, this.
1922                    "\\(-syntax\\)\\|"
1923                    ;; Class names.
1924                    "\\(-class\\)"
1925                    "\\)\\)\\>"
1926                    ;; Any whitespace and declared object.
1927                    "[ \t]*(?"
1928                    "\\(\\sw+\\)?")
1929            '(1 font-lock-keyword-face)
1930            '(8 (cond ((match-beginning 3) 'font-lock-function-name-face)
1931                      ((match-beginning 6) 'font-lock-variable-name-face)
1932                      (t 'font-lock-type-face))
1933                nil t))
1934      ;;
1935      ;; Control structures.
1936 ;(regexp-opt '("begin" "call-with-current-continuation" "call/cc"
1937 ;              "call-with-input-file" "call-with-output-file" "case" "cond"
1938 ;              "do" "else" "for-each" "if" "lambda"
1939 ;              "let\\*?" "let-syntax" "letrec" "letrec-syntax"
1940 ;              ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants:
1941 ;              "and" "or" "delay"
1942 ;              ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother:
1943 ;              ;;"quasiquote" "quote" "unquote" "unquote-splicing"
1944 ;              "map" "syntax" "syntax-rules"))
1945      (cons
1946       (concat "(\\("
1947               "and\\|begin\\|c\\(a\\(ll\\(-with-\\(current-continuation\\|"
1948               "input-file\\|output-file\\)\\|/cc\\)\\|se\\)\\|ond\\)\\|"
1949               "d\\(elay\\|o\\)\\|else\\|for-each\\|if\\|"
1950               "l\\(ambda\\|et\\(-syntax\\|\\*?\\|rec\\(\\|-syntax\\)\\)\\)\\|"
1951               "map\\|or\\|syntax\\(\\|-rules\\)"
1952               "\\)\\>") 1)
1953      ;;
1954      ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers.
1955      '("\\<<\\sw+>\\>" . font-lock-type-face)
1956      ;;
1957      ;; Scheme `:' keywords as references.
1958      '("\\<:\\sw+\\>" . font-lock-reference-face)
1959      ))
1960 "Default expressions to highlight in Scheme modes.")
1961
1962 ;; The previous version, before replacing it with the FSF version.
1963 ;(defconst scheme-font-lock-keywords (purecopy
1964 ; '(("(define[ \t]+(?\\([^ \t\n\)]+\\)" 1 font-lock-function-name-face)
1965 ;   ("(\\(cond\\|lambda\\|begin\\|if\\|else\\|case\\|do\\)[ \t\n]" . 1)
1966 ;   ("(\\(\\|letrec\\|let\\*?\\|set!\\|and\\|or\\)[ \t\n]" . 1)
1967 ;   ("(\\(quote\\|unquote\\|quasiquote\\|unquote-splicing\\)[ \t\n]" . 1)
1968 ;   ("(\\(syntax\\|syntax-rules\\|define-syntax\\|let-syntax\\|letrec-syntax\\)[ \t\n]" . 1)))
1969 ;  "Expressions to highlight in Scheme buffers.")
1970
1971 (defconst c-font-lock-keywords-1 nil
1972   "Subdued level highlighting for C modes.")
1973
1974 (defconst c-font-lock-keywords-2 nil
1975   "Medium level highlighting for C modes.")
1976
1977 (defconst c-font-lock-keywords-3 nil
1978   "Gaudy level highlighting for C modes.")
1979
1980 (defconst c++-font-lock-keywords-1 nil
1981   "Subdued level highlighting for C++ modes.")
1982
1983 (defconst c++-font-lock-keywords-2 nil
1984   "Medium level highlighting for C++ modes.")
1985
1986 (defconst c++-font-lock-keywords-3 nil
1987   "Gaudy level highlighting for C++ modes.")
1988
1989 (defun font-lock-match-c++-style-declaration-item-and-skip-to-next (limit)
1990   ;; Match, and move over, any declaration/definition item after point.
1991   ;; The expect syntax of an item is "word" or "word::word", possibly ending
1992   ;; with optional whitespace and a "(".  Everything following the item (but
1993   ;; belonging to it) is expected to by skip-able by `forward-sexp', and items
1994   ;; are expected to be separated with a "," or ";".
1995   (if (looking-at "[ \t*&]*\\(\\(?:\\sw\\|\\s_\\)+\\)\\(::\\(\\(?:\\sw\\|\\s_\\)+\\)\\)?[ \t]*\\((\\)?")
1996       (save-match-data
1997         (condition-case nil
1998             (save-restriction
1999               ;; Restrict to the end of line, currently guaranteed to be LIMIT.
2000               (narrow-to-region (point-min) limit)
2001               (goto-char (match-end 1))
2002               ;; Move over any item value, etc., to the next item.
2003               (while (not (looking-at "[ \t]*\\([,;]\\|$\\)"))
2004                 (goto-char (or (scan-sexps (point) 1) (point-max))))
2005               (goto-char (match-end 0)))
2006           (error t)))))
2007
2008 (let ((c-keywords
2009 ;      ("break" "continue" "do" "else" "for" "if" "return" "switch" "while")
2010        "break\\|continue\\|do\\|else\\|for\\|if\\|return\\|switch\\|while")
2011       (c-type-types
2012 ;      ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2013 ;       "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2014 ;       "void" "volatile" "const")
2015        (concat "auto\\|c\\(har\\|onst\\)\\|double\\|e\\(num\\|xtern\\)\\|"
2016                "float\\|int\\|long\\|register\\|"
2017                "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|typedef\\|"
2018                "un\\(ion\\|signed\\)\\|vo\\(id\\|latile\\)"))   ; 6 ()s deep.
2019       (c++-keywords
2020 ;      ("break" "continue" "do" "else" "for" "if" "return" "switch" "while"
2021 ;       "asm" "catch" "delete" "new" "operator" "sizeof" "this" "throw" "try"
2022 ;       "protected" "private" "public")
2023        (concat "asm\\|break\\|c\\(atch\\|ontinue\\)\\|d\\(elete\\|o\\)\\|"
2024                "else\\|for\\|if\\|new\\|"
2025                "p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|return\\|"
2026                "s\\(izeof\\|witch\\)\\|t\\(h\\(is\\|row\\)\\|ry\\)\\|while"))
2027       (c++-type-types
2028 ;      ("auto" "extern" "register" "static" "typedef" "struct" "union" "enum"
2029 ;       "signed" "unsigned" "short" "long" "int" "char" "float" "double"
2030 ;       "void" "volatile" "const" "class" "inline" "friend" "bool"
2031 ;       "virtual" "complex" "template")
2032        (concat "auto\\|bool\\|c\\(har\\|lass\\|o\\(mplex\\|nst\\)\\)\\|"
2033                "double\\|e\\(num\\|xtern\\)\\|f\\(loat\\|riend\\)\\|"
2034                "in\\(line\\|t\\)\\|long\\|register\\|"
2035                "s\\(hort\\|igned\\|t\\(atic\\|ruct\\)\\)\\|"
2036                "t\\(emplate\\|ypedef\\)\\|un\\(ion\\|signed\\)\\|"
2037                "v\\(irtual\\|o\\(id\\|latile\\)\\)"))           ; 11 ()s deep.
2038       (ctoken "\\(\\sw\\|\\s_\\|[:~*&]\\)+")
2039       )
2040  (setq c-font-lock-keywords-1
2041   (list
2042    ;;
2043    ;; These are all anchored at the beginning of line for speed.
2044    ;;
2045    ;; Fontify function name definitions (GNU style; without type on line).
2046    
2047    ;; In FSF this has the simpler definition of "\\sw+" for ctoken.
2048    ;; I'm not sure if ours is more correct.
2049    ;; This is a subset of the next rule, and is slower when present. --dmoore
2050    ;; (list (concat "^\\(" ctoken "\\)[ \t]*(") 1 'font-lock-function-name-face)
2051    ;;
2052    ;; fontify the names of functions being defined.
2053    ;; FSF doesn't have this but I think it should be fast for us because
2054    ;; our regexp routines are more intelligent than FSF's about handling
2055    ;; anchored-at-newline. (When I added this hack in regex.c, it halved
2056    ;; the time to do the regexp phase of font-lock for a C file!) Not
2057    ;; including this discriminates against those who don't follow the
2058    ;; GNU coding style. --ben
2059    ;; x?x?x?y?z should always be: (x(xx?)?)?y?z --dmoore
2060    (list (concat
2061           "^\\("
2062           "\\(" ctoken "[ \t]+\\)"      ; type specs; there can be no
2063           "\\("
2064           "\\(" ctoken "[ \t]+\\)"      ; more than 3 tokens, right?
2065           "\\(" ctoken "[ \t]+\\)"
2066           "?\\)?\\)?"
2067           "\\([*&]+[ \t]*\\)?"          ; pointer
2068           "\\(" ctoken "\\)[ \t]*(")    ; name
2069          10 'font-lock-function-name-face)
2070    ;;
2071    ;; This is faster but not by much.  I don't see why not.
2072    ;(list (concat "^\\(" ctoken "\\)[ \t]*(") 1 'font-lock-function-name-face)
2073    ;;
2074    ;; Added next two; they're both jolly-good fastmatch candidates so
2075    ;; should be fast. --ben
2076    ;;
2077    ;; Fontify structure names (in structure definition form).
2078    (list (concat "^\\(typedef[ \t]+struct\\|struct\\|static[ \t]+struct\\)"
2079            "[ \t]+\\(" ctoken "\\)[ \t]*\\(\{\\|$\\)")
2080          2 'font-lock-function-name-face)
2081    ;;
2082    ;; Fontify case clauses.  This is fast because its anchored on the left.
2083    '("case[ \t]+\\(\\(\\sw\\|\\s_\\)+\\)[ \t]+:". 1)
2084    ;;
2085    '("\\<\\(default\\):". 1)
2086    ;; Fontify filenames in #include <...> preprocessor directives as strings.
2087    '("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
2088    ;;
2089    ;; Fontify function macro names.
2090    '("^#[ \t]*define[ \t]+\\(\\(\\sw+\\)(\\)" 2 font-lock-function-name-face)
2091    ;;
2092    ;; Fontify symbol names in #if ... defined preprocessor directives.
2093    '("^#[ \t]*if\\>"
2094      ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
2095       (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t)))
2096    ;;
2097    ;; Fontify symbol names in #elif ... defined preprocessor directives.
2098    '("^#[ \t]*elif\\>"
2099      ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
2100       (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t)))
2101    ;;
2102    ;; Fontify otherwise as symbol names, and the preprocessor directive names.
2103    '("^\\(#[ \t]*[a-z]+\\)\\>[ \t]*\\(\\sw+\\)?"
2104      (1 font-lock-preprocessor-face) (2 font-lock-variable-name-face nil t))
2105    ))
2106
2107  (setq c-font-lock-keywords-2
2108   (append c-font-lock-keywords-1
2109    (list
2110     ;;
2111     ;; Simple regexps for speed.
2112     ;;
2113     ;; Fontify all type specifiers.
2114     (cons (concat "\\<\\(" c-type-types "\\)\\>") 'font-lock-type-face)
2115     ;;
2116     ;; Fontify all builtin keywords (except case, default and goto; see below).
2117     (cons (concat "\\<\\(" c-keywords "\\)\\>") 'font-lock-keyword-face)
2118     ;;
2119     ;; Fontify case/goto keywords and targets, and case default/goto tags.
2120     '("\\<\\(case\\|goto\\)\\>[ \t]*\\([^ \t\n:;]+\\)?"
2121       (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2122     '("^[ \t]*\\(\\sw+\\)[ \t]*:" 1 font-lock-reference-face)
2123     )))
2124
2125  (setq c-font-lock-keywords-3
2126   (append c-font-lock-keywords-2
2127    ;;
2128    ;; More complicated regexps for more complete highlighting for types.
2129    ;; We still have to fontify type specifiers individually, as C is so hairy.
2130    (list
2131     ;;
2132     ;; Fontify all storage classes and type specifiers, plus their items.
2133     (list (concat "\\<\\(" c-type-types "\\)\\>"
2134                   "\\([ \t*&]+\\sw+\\>\\)*")
2135           ;; Fontify each declaration item.
2136           '(font-lock-match-c++-style-declaration-item-and-skip-to-next
2137             ;; Start with point after all type specifiers.
2138             (goto-char (or (match-beginning 8) (match-end 1)))
2139             ;; Finish with point after first type specifier.
2140             (goto-char (match-end 1))
2141             ;; Fontify as a variable or function name.
2142             (1 (if (match-beginning 4)
2143                    font-lock-function-name-face
2144                  font-lock-variable-name-face))))
2145     ;;
2146     ;; Fontify structures, or typedef names, plus their items.
2147     '("\\(}\\)[ \t*]*\\sw"
2148       (font-lock-match-c++-style-declaration-item-and-skip-to-next
2149        (goto-char (match-end 1)) nil
2150        (1 (if (match-beginning 4)
2151               font-lock-function-name-face
2152             font-lock-variable-name-face))))
2153     ;;
2154     ;; Fontify anything at beginning of line as a declaration or definition.
2155     '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
2156       (1 font-lock-type-face)
2157       (font-lock-match-c++-style-declaration-item-and-skip-to-next
2158        (goto-char (or (match-beginning 2) (match-end 1))) nil
2159        (1 (if (match-beginning 4)
2160               font-lock-function-name-face
2161             font-lock-variable-name-face))))
2162     )))
2163
2164  (setq c++-font-lock-keywords-1
2165   (append
2166    ;;
2167    ;; The list `c-font-lock-keywords-1' less that for function names.
2168    ;; the simple function form regexp has been removed. --dmoore
2169    ;;(cdr c-font-lock-keywords-1)
2170    c-font-lock-keywords-1
2171    ;;
2172    ;; Fontify function name definitions, possibly incorporating class name.
2173    (list
2174     '("^\\(\\sw+\\)\\(::\\(\\sw+\\)\\)?[ \t]*("
2175       (1 (if (match-beginning 2)
2176              font-lock-type-face
2177            font-lock-function-name-face))
2178       (3 (if (match-beginning 2) font-lock-function-name-face) nil t))
2179     )))
2180
2181  (setq c++-font-lock-keywords-2
2182   (append c++-font-lock-keywords-1
2183    (list
2184     ;;
2185     ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading.
2186     (cons (concat "\\<\\(" c++-type-types "\\)\\>") 'font-lock-type-face)
2187     ;;
2188     ;; Fontify operator function name overloading.
2189     '("\\<\\(operator\\)\\>[ \t]*\\([][)(><!=+-][][)(><!=+-]?\\)?"
2190       (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
2191     ;;
2192     ;; Fontify case/goto keywords and targets, and case default/goto tags.
2193     '("\\<\\(case\\|goto\\)\\>[ \t]*\\([^ \t\n:;]+\\)?"
2194       (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
2195     '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-reference-face)
2196     ;;
2197     ;; Fontify other builtin keywords.
2198     (cons (concat "\\<\\(" c++-keywords "\\)\\>") 'font-lock-keyword-face)
2199     )))
2200
2201  (setq c++-font-lock-keywords-3
2202   (append c++-font-lock-keywords-2
2203    ;;
2204    ;; More complicated regexps for more complete highlighting for types.
2205    (list
2206     ;;
2207     ;; Fontify all storage classes and type specifiers, plus their items.
2208     (list (concat "\\<\\(" c++-type-types "\\)\\>"
2209                   "\\([ \t*&]+\\sw+\\>\\)*")
2210           ;; Fontify each declaration item.
2211           '(font-lock-match-c++-style-declaration-item-and-skip-to-next
2212             ;; Start with point after all type specifiers.
2213             (goto-char (or (match-beginning 13) (match-end 1)))
2214             ;; Finish with point after first type specifier.
2215             (goto-char (match-end 1))
2216             ;; Fontify as a variable or function name.
2217             (1 (cond ((match-beginning 2) 'font-lock-type-face)
2218                      ((match-beginning 4) 'font-lock-function-name-face)
2219                      (t 'font-lock-variable-name-face)))
2220             (3 (if (match-beginning 4)
2221                    'font-lock-function-name-face
2222                  'font-lock-variable-name-face) nil t)))
2223     ;;
2224     ;; Fontify structures, or typedef names, plus their items.
2225     '("\\(}\\)[ \t*]*\\sw"
2226       (font-lock-match-c++-style-declaration-item-and-skip-to-next
2227        (goto-char (match-end 1)) nil
2228        (1 (if (match-beginning 4)
2229               font-lock-function-name-face
2230             font-lock-variable-name-face))))
2231     ;;
2232     ;; Fontify anything at beginning of line as a declaration or definition.
2233     '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*"
2234       (1 font-lock-type-face)
2235       (font-lock-match-c++-style-declaration-item-and-skip-to-next
2236        (goto-char (or (match-beginning 2) (match-end 1))) nil
2237        (1 (cond ((match-beginning 2) 'font-lock-type-face)
2238                 ((match-beginning 4) 'font-lock-function-name-face)
2239                 (t 'font-lock-variable-name-face)))
2240        (3 (if (match-beginning 4)
2241               'font-lock-function-name-face
2242             'font-lock-variable-name-face) nil t)))
2243     )))
2244  )
2245
2246 (defvar c-font-lock-keywords c-font-lock-keywords-1
2247   "Default expressions to highlight in C mode.")
2248
2249 (defvar c++-font-lock-keywords c++-font-lock-keywords-1
2250   "Default expressions to highlight in C++ mode.")
2251 \f
2252 ;;; Java.
2253
2254 ;; Java support has been written by XEmacs people, and it's apparently
2255 ;; totally divergent from the FSF.  I don't know if it's better or
2256 ;; worse, so I'm leaving it in until someone convinces me the FSF
2257 ;; version is better.  --hniksic
2258
2259 (defconst java-font-lock-keywords-1 nil
2260  "For consideration as a value of `java-font-lock-keywords'.
2261 This does fairly subdued highlighting.")
2262
2263 (defconst java-font-lock-keywords-2 nil
2264  "For consideration as a value of `java-font-lock-keywords'.
2265 This adds highlighting of types and identifier names.")
2266
2267 (defconst java-font-lock-keywords-3 nil
2268  "For consideration as a value of `java-font-lock-keywords'.
2269 This adds highlighting of Java documentation tags, such as @see.")
2270
2271 (defvar java-font-lock-type-regexp
2272   (concat "\\<\\(boolean\\|byte\\|char\\|double\\|float\\|int"
2273          "\\|long\\|short\\|void\\)\\>")
2274   "Regexp which should match a primitive type.")
2275
2276 (let ((capital-letter "A-Z\300-\326\330-\337")
2277       (letter "a-zA-Z_$\300-\326\330-\366\370-\377")
2278       (digit  "0-9"))
2279 (defvar java-font-lock-identifier-regexp
2280   (concat "\\<\\([" letter "][" letter digit "]*\\)\\>")
2281   "Regexp which should match all Java identifiers.")
2282
2283 (defvar java-font-lock-class-name-regexp
2284   (concat "\\<\\([" capital-letter "][" letter digit "]*\\)\\>")
2285   "Regexp which should match a class or an interface name.
2286 The name is assumed to begin with a capital letter.")
2287 )
2288
2289
2290 (let ((java-modifier-regexp
2291        (concat "\\<\\(abstract\\|const\\|final\\|native\\|"
2292                "private\\|protected\\|public\\|"
2293                "static\\|synchronized\\|transient\\|volatile\\)\\>")))
2294
2295   ;; Basic font-lock support:
2296   (setq java-font-lock-keywords-1
2297         (list
2298          ;; Keywords:
2299          (list        
2300           (concat
2301            "\\<\\("
2302            "break\\|byvalue\\|"
2303            "case\\|cast\\|catch\\|class\\|continue\\|"
2304            "do\\|else\\|extends\\|"
2305            "finally\\|for\\|future\\|"
2306            "generic\\|goto\\|"
2307            "if\\|implements\\|import\\|"
2308            "instanceof\\|interface\\|"
2309            "new\\|package\\|return\\|switch\\|"
2310            "throws?\\|try\\|while\\)\\>")
2311           1 'font-lock-keyword-face)
2312
2313          ;; Modifiers:
2314          (list java-modifier-regexp 1 font-lock-type-face)
2315
2316          ;; Special constants:
2317          '("\\<\\(this\\|super\\)\\>" (1 font-lock-reference-face))
2318          '("\\<\\(false\\|null\\|true\\)\\>" (1 font-lock-keyword-face))
2319
2320          ;; Class names:
2321          (list (concat "\\<class\\>\\s *" java-font-lock-identifier-regexp)
2322                1 'font-lock-function-name-face)
2323         
2324          ;; Package declarations:
2325          (list (concat "\\<\\(package\\|import\\)\\>\\s *"
2326                        java-font-lock-identifier-regexp)
2327                '(2 font-lock-reference-face)
2328                (list (concat
2329                       "\\=\\.\\(" java-font-lock-identifier-regexp "\\)")
2330                      nil nil '(1 (if (equal (char-after (match-end 0)) ?.)
2331                                      'font-lock-reference-face
2332                                    'font-lock-type-face))))
2333          
2334          ;; Constructors:
2335          (list (concat
2336                 "^\\s *\\(" java-modifier-regexp "\\s +\\)*"
2337                 java-font-lock-class-name-regexp "\\s *\(")
2338                (list 3
2339                      '(condition-case nil
2340                           (save-excursion
2341                             (goto-char (scan-sexps (- (match-end 0) 1) 1))
2342                             (parse-partial-sexp (point) (point-max) nil t)
2343                             (and (looking-at "\\($\\|\\<throws\\>\\|{\\)")
2344                                  'font-lock-function-name-face))
2345                         (error 'font-lock-function-name-face))))
2346
2347          ;; Methods:
2348          (list (concat "\\(" java-font-lock-type-regexp "\\|"
2349                        java-font-lock-class-name-regexp "\\)"
2350                        "\\s *\\(\\[\\s *\\]\\s *\\)*"
2351                        java-font-lock-identifier-regexp "\\s *\(")
2352                5
2353                'font-lock-function-name-face)
2354
2355          ;; Labels:
2356          (list ":"
2357                (list
2358                 (concat "^\\s *" java-font-lock-identifier-regexp "\\s *:")
2359                 '(beginning-of-line) '(end-of-line)
2360                 '(1 font-lock-reference-face)))
2361
2362          ;; `break' and continue' destination labels:
2363          (list (concat "\\<\\(break\\|continue\\)\\>\\s *"
2364                        java-font-lock-identifier-regexp)
2365                2 'font-lock-reference-face)
2366
2367          ;; Case statements:
2368          ;; In Java, any constant expression is allowed.
2369          '("\\<case\\>\\s *\\(.*\\):" 1 font-lock-reference-face)))
2370
2371   ;; Types and declared variable names:
2372   (setq java-font-lock-keywords-2
2373         (append 
2374
2375          java-font-lock-keywords-1
2376          (list
2377           ;; Keywords followed by a type:
2378           (list (concat "\\<\\(extends\\|instanceof\\|new\\)\\>\\s *"
2379                         java-font-lock-identifier-regexp)
2380                 '(2 (if (equal (char-after (match-end 0)) ?.)
2381                         'font-lock-reference-face 'font-lock-type-face))
2382                 (list (concat "\\=\\." java-font-lock-identifier-regexp)
2383                       '(goto-char (match-end 0)) nil
2384                       '(1 (if (equal (char-after (match-end 0)) ?.)
2385                               'font-lock-reference-face 'font-lock-type-face))))
2386
2387           ;; Keywords followed by a type list:
2388           (list (concat "\\<\\(implements\\|throws\\)\\>\\ s*"
2389                         java-font-lock-identifier-regexp)
2390                 '(2 (if (equal (char-after (match-end 0)) ?.)
2391                         font-lock-reference-face font-lock-type-face))
2392                 (list (concat "\\=\\(\\.\\|\\s *\\(,\\)\\s *\\)"
2393                               java-font-lock-identifier-regexp)
2394                       '(goto-char (match-end 0)) nil
2395                       '(3 (if (equal (char-after (match-end 0)) ?.)
2396                               font-lock-reference-face font-lock-type-face))))
2397
2398           ;; primitive types, can't be confused with anything else.
2399           (list java-font-lock-type-regexp
2400                 '(1 font-lock-type-face)
2401                 '(font-lock-match-java-declarations
2402                   (goto-char (match-end 0))
2403                   (goto-char (match-end 0))
2404                   (0 font-lock-variable-name-face)))
2405
2406           ;; Declarations, class types and capitalized variables:
2407           ;;
2408           ;; Declarations are easy to recognize.  Capitalized words
2409           ;; followed by a closing parenthesis are treated as casts if they
2410           ;; also are followed by an expression.  Expressions beginning with
2411           ;; a unary numerical operator, e.g. +, can't be cast to an object
2412           ;; type.
2413           ;;
2414           ;; The path of a fully qualified type, e.g. java.lang.Foo, is
2415           ;; fontified in the reference face.
2416           ;;
2417           ;; An access to a static field, e.g. System.out.println, is
2418           ;; not fontified since it can't be distinguished from the
2419           ;; usage of a capitalized variable, e.g. Foo.out.println.
2420
2421           (list (concat java-font-lock-class-name-regexp
2422                         "\\s *\\(\\[\\s *\\]\\s *\\)*"
2423                         "\\(\\<\\|$\\|)\\s *\\([\(\"]\\|\\<\\)\\)")
2424                 '(1 (save-match-data
2425                       (save-excursion
2426                         (goto-char
2427                          (match-beginning 3))
2428                         (if (not (looking-at "\\<instanceof\\>"))
2429                             'font-lock-type-face))))
2430                 (list (concat "\\=" java-font-lock-identifier-regexp "\\.")
2431                       '(progn
2432                          (goto-char (match-beginning 0))
2433                          (while (or (= (preceding-char) ?.)
2434                                     (= (char-syntax (preceding-char)) ?w))
2435                            (backward-char)))
2436                       '(goto-char (match-end 0))
2437                       '(1 font-lock-reference-face)
2438                       '(0 nil))         ; Workaround for bug in XEmacs.
2439                 '(font-lock-match-java-declarations
2440                   (goto-char (match-end 1))
2441                   (goto-char (match-end 0))
2442                   (1 font-lock-variable-name-face))))))
2443
2444   ;; Modifier keywords and Java doc tags
2445   (setq java-font-lock-keywords-3
2446         (append
2447
2448          '(
2449            ;; Feature scoping:
2450            ;; These must come first or the Modifiers from keywords-1 will
2451            ;; catch them.  We don't want to use override fontification here
2452            ;; because then these terms will be fontified within comments.
2453            ("\\<private\\>"   0 font-lock-string-face)
2454            ("\\<protected\\>" 0 font-lock-preprocessor-face)
2455            ("\\<public\\>"    0 font-lock-reference-face))
2456          java-font-lock-keywords-2
2457
2458          (list
2459
2460           ;; Java doc tags
2461           '("@\\(author\\|exception\\|param\\|return\\|see\\|version\\)\\s "
2462             0 font-lock-keyword-face t)
2463
2464           ;; Doc tag - Parameter identifiers
2465           (list (concat "@param\\s +" java-font-lock-identifier-regexp)
2466                 1 'font-lock-variable-name-face t)
2467
2468           ;; Doc tag - Exception types
2469           (list (concat "@exception\\ s*"
2470                         java-font-lock-identifier-regexp)
2471                 '(1 (if (equal (char-after (match-end 0)) ?.)
2472                         font-lock-reference-face font-lock-type-face) t)
2473                 (list (concat "\\=\\." java-font-lock-identifier-regexp)
2474                       '(goto-char (match-end 0)) nil
2475                       '(1 (if (equal (char-after (match-end 0)) ?.)
2476                               'font-lock-reference-face 'font-lock-type-face) t)))
2477
2478           ;; Doc tag - Cross-references, usually to methods 
2479           '("@see\\s +\\(\\S *[^][ \t\n\r\f(){},.;:]\\)"
2480             1 font-lock-function-name-face t)
2481
2482           )))
2483   )
2484
2485 (defvar java-font-lock-keywords java-font-lock-keywords-1
2486   "Additional expressions to highlight in Java mode.")
2487
2488 ;; Match and move over any declaration/definition item after
2489 ;; point.  Does not match items which look like a type declaration
2490 ;; (primitive types and class names, i.e. capitalized words.)
2491 ;; Should the variable name be followed by a comma, we reposition
2492 ;; the cursor to fontify more identifiers.
2493 (defun font-lock-match-java-declarations (limit)
2494   "Match and skip over variable definitions."
2495   (if (looking-at "\\s *\\(\\[\\s *\\]\\s *\\)*")
2496       (goto-char (match-end 0)))
2497   (and
2498    (looking-at java-font-lock-identifier-regexp)
2499    (save-match-data
2500      (not (string-match java-font-lock-type-regexp
2501                         (buffer-substring (match-beginning 1)
2502                                           (match-end 1)))))
2503    (save-match-data
2504      (save-excursion
2505        (goto-char (match-beginning 1))
2506        (not (looking-at
2507              (concat java-font-lock-class-name-regexp
2508                      "\\s *\\(\\[\\s *\\]\\s *\\)*\\<")))))
2509    (save-match-data
2510      (condition-case nil
2511          (save-restriction
2512            (narrow-to-region (point-min) limit)
2513            (goto-char (match-end 0))
2514            ;; Note: Both `scan-sexps' and the second goto-char can
2515            ;; generate an error which is caught by the
2516            ;; `condition-case' expression.
2517            (while (not (looking-at "\\s *\\(\\(,\\)\\|;\\|$\\)"))
2518              (goto-char (or (scan-sexps (point) 1) (point-max))))
2519            (goto-char (match-end 2)))   ; non-nil
2520        (error t)))))
2521
2522
2523 (defvar tex-font-lock-keywords
2524 ;  ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>.
2525 ;  '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2526 ;     2 font-lock-function-name-face)
2527 ;    ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2528 ;     2 font-lock-reference-face)
2529 ;    ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2530 ;    ;; not be able to display those fonts.
2531 ;    ("{\\\\bf\\([^}]+\\)}" 1 'bold keep)
2532 ;    ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep)
2533 ;    ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face)
2534 ;    ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep))
2535   ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>.
2536   '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}"
2537      2 font-lock-function-name-face)
2538     ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}"
2539      2 font-lock-reference-face)
2540     ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face)
2541     "\\\\\\([a-zA-Z@]+\\|.\\)"
2542     ;; It seems a bit dubious to use `bold' and `italic' faces since we might
2543     ;; not be able to display those fonts.
2544     ;; LaTeX2e: \emph{This is emphasized}.
2545     ("\\\\emph{\\([^}]+\\)}" 1 'italic keep)
2546     ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...}
2547     ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}"
2548      3 (if (match-beginning 2) 'bold 'italic) keep)
2549     ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables.
2550     ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)"
2551      3 (if (match-beginning 2) 'bold 'italic) keep))
2552   "Default expressions to highlight in TeX modes.")
2553
2554 (defconst ksh-font-lock-keywords (purecopy
2555   (list
2556    '("\\(^\\|[^\$\\\]\\)#.*" . font-lock-comment-face)
2557    '("\\<\\(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)
2558    '("\\<\\[\\[.*\\]\\]\\>" . font-lock-type-face)
2559    '("\$\(.*\)" . font-lock-type-face)
2560    ))
2561   "Additional expressions to highlight in ksh-mode.")
2562
2563 (defconst sh-font-lock-keywords (purecopy
2564   (list
2565    '("\\(^\\|[^\$\\\]\\)#.*" . font-lock-comment-face)
2566    '("\\<\\(if\\|then\\|else\\|elif\\|fi\\|case\\|esac\\|for\\|do\\|done\\|in\\|while\\|exec\\|export\\|set\\|echo\\|eval\\|cd\\)\\>" . font-lock-keyword-face)
2567    '("\\[.*\\]" . font-lock-type-face)
2568    '("`.*`" . font-lock-type-face)
2569    ))
2570   "Additional expressions to highlight in sh-mode.")
2571
2572 \f
2573 ;; Install ourselves:
2574
2575 (add-hook 'find-file-hooks 'font-lock-set-defaults t)
2576
2577 ;;;###autoload
2578 (add-minor-mode 'font-lock-mode " Font")
2579
2580 ;; Provide ourselves:
2581
2582 (provide 'font-lock)
2583
2584 ;;; font-lock.el ends here