annotate lisp/packages/fontl-hooks.el @ 0:376386a54a3c r19-14

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