annotate lisp/fontl-hooks.el @ 290:c9fe270a4101 r21-0b43

Import from CVS: tag r21-0b43
author cvs
date Mon, 13 Aug 2007 10:36:47 +0200
parents d44af0c54775
children 308d34e9f07d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
217
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
1 ;;; fontl-hooks.el --- pre-loaded stuff for font-lock.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
2
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
3 ;; Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
4 ;; Copyright (C) 1995 Amdahl Corporation.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
5 ;; Copyright (C) 1996 Ben Wing.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
6
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
7 ;; This file is part of XEmacs.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
8
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
9 ;; XEmacs is free software; you can redistribute it and/or modify it
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
10 ;; under the terms of the GNU General Public License as published by
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
11 ;; the Free Software Foundation; either version 2, or (at your option)
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
12 ;; any later version.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
13
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
14 ;; XEmacs is distributed in the hope that it will be useful, but
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
17 ;; General Public License for more details.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
18
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
19 ;; You should have received a copy of the GNU General Public License
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
20 ;; along with XEmacs; see the file COPYING. If not, write to the
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
22 ;; Boston, MA 02111-1307, USA.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
23
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
24 ;;; Synched up with: FSF 19.30. (font-lock.el)
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
25
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
26 ;;; Commentary:
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
27
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
28 ;; The reason for the existence of this file is so that modes can
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
29 ;; call `font-lock-set-defaults' without worrying about whether
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
30 ;; font-lock is loaded. We don't autoload this from font-lock.el
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
31 ;; because loading font-lock.el automatically turns font-lock on.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
32
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
33 ;;; Code:
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
34
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
35 (defun font-lock-set-defaults (&optional explicit-defaults)
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
36 "Set fontification defaults appropriately for this mode.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
37 Sets `font-lock-keywords', `font-lock-keywords-only', `font-lock-syntax-table',
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
38 `font-lock-beginning-of-syntax-function' and
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
39 `font-lock-keywords-case-fold-search'.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
40
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
41 If `font-lock-defaults' is currently set, it is used. Otherwise, the
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
42 symbol naming the major mode is examined for a `font-lock-defaults'
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
43 property. If that is not present, but a variable `foo-mode-font-lock-keywords'
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
44 is, the value of that variable is used as the default for
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
45 `font-lock-keywords'. Various other backward-compatible behaviors also
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
46 exist -- if you're curious, look at the source.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
47
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
48 The value of `font-lock-maximum-decoration' is used to determine which
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
49 set of keywords applies, if more than one exists.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
50
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
51 This will also put the buffer into Font Lock mode if any keywords exist
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
52 and if auto-fontification is called for, as determined by
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
53 `font-lock-auto-fontify', `font-lock-mode-enable-list', and
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
54 `font-lock-mode-disable-list'.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
55
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
56 Calling this function multiple times in the same buffer is safe -- this
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
57 function keeps track of whether it has already been called in this
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
58 buffer, and does nothing if so. This allows for multiple ways of getting
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
59 Font Lock properly initialized in a buffer, to deal with existing major
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
60 modes that do not call this function. (For example, Font Lock adds this
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
61 function to `find-file-hooks'.)
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
62
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
63 Major modes that have any font-lock defaults specified should call this
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
64 function during their initialization process, after they have set
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
65 the variable `major-mode'.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
66
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
67 If EXPLICIT-DEFAULTS is t, this function will not check whether it
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
68 has already been run in this buffer, and will always do the full
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
69 computation.
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
70
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
71 If EXPLICIT-DEFAULTS is not nil and not t, it should be something
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
72 that is allowable as a value for `font-lock-defaults' and will be
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
73 used to initialize the Font Lock variables."
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
74
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
75 (when
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
76 (and
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
77 (featurep 'font-lock)
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
78 (if font-lock-auto-fontify
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
79 (not (memq major-mode font-lock-mode-disable-list))
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
80 (memq major-mode font-lock-mode-enable-list))
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
81 (font-lock-set-defaults-1 explicit-defaults)
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
82 font-lock-keywords)
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
83 (turn-on-font-lock)))
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
84
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
85 (provide 'fontl-hooks)
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
86
d44af0c54775 Import from CVS: tag r20-4b7
cvs
parents:
diff changeset
87 ;;; fontl-hooks.el ends here