|
0
|
1 ;;; fast-lock.el --- Automagic text properties caching for fast Font Lock mode.
|
|
|
2
|
|
2
|
3 ;; Copyright (C) 1994, 1995, 1996 Free Software Foundation, Inc.
|
|
0
|
4
|
|
|
5 ;; Author: Simon Marshall <simon@gnu.ai.mit.edu>
|
|
|
6 ;; Keywords: faces files
|
|
2
|
7 ;; Version: 3.10.01
|
|
0
|
8
|
|
|
9 ;; This file is part of XEmacs.
|
|
|
10 ;;
|
|
|
11 ;; XEmacs is free software; you can redistribute it and/or modify
|
|
|
12 ;; it under the terms of the GNU General Public License as published by
|
|
|
13 ;; the Free Software Foundation; either version 2 of the License, or
|
|
|
14 ;; (at your option) any later version.
|
|
|
15 ;;
|
|
|
16 ;; XEmacs is distributed in the hope that it will be useful,
|
|
|
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
19 ;; GNU General Public License for more details.
|
|
|
20 ;;
|
|
|
21 ;; You should have received a copy of the GNU General Public License
|
|
2
|
22 ;; along with XEmacs; see the file COPYING. If not, write to the
|
|
|
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
24 ;; Boston, MA 02111-1307, USA.
|
|
0
|
25
|
|
2
|
26 ;;; Synched up with: FSF 19.34.
|
|
0
|
27
|
|
|
28 ;;; Commentary:
|
|
|
29
|
|
|
30 ;; Purpose:
|
|
|
31 ;;
|
|
|
32 ;; To make visiting a file in `font-lock-mode' faster by restoring its face
|
|
|
33 ;; text properties from automatically saved associated Font Lock cache files.
|
|
|
34 ;;
|
|
|
35 ;; See caveats and feedback below.
|
|
|
36 ;; See also the lazy-lock package. (But don't use the two at the same time!)
|
|
|
37
|
|
|
38 ;; Installation:
|
|
|
39 ;;
|
|
|
40 ;; Put in your ~/.emacs:
|
|
|
41 ;;
|
|
2
|
42 ;; (setq font-lock-support-mode 'fast-lock-mode)
|
|
0
|
43 ;;
|
|
|
44 ;; Start up a new Emacs and use font-lock as usual (except that you can use the
|
|
|
45 ;; so-called "gaudier" fontification regexps on big files without frustration).
|
|
|
46 ;;
|
|
|
47 ;; When you visit a file (which has `font-lock-mode' enabled) that has a
|
|
|
48 ;; corresponding Font Lock cache file associated with it, the Font Lock cache
|
|
|
49 ;; will be loaded from that file instead of being generated by Font Lock code.
|
|
|
50
|
|
|
51 ;; Caveats:
|
|
|
52 ;;
|
|
|
53 ;; A cache will be saved when visiting a compressed file using crypt++, but not
|
|
|
54 ;; be read. This is a "feature"/"consequence"/"bug" of crypt++.
|
|
|
55 ;;
|
|
|
56 ;; Version control packages are likely to stamp all over file modification
|
|
|
57 ;; times. Therefore the act of checking out may invalidate a cache.
|
|
|
58
|
|
|
59 ;; Feedback:
|
|
|
60 ;;
|
|
|
61 ;; Feedback is welcome.
|
|
|
62 ;; To submit a bug report (or make comments) please use the mechanism provided:
|
|
|
63 ;;
|
|
|
64 ;; M-x fast-lock-submit-bug-report RET
|
|
|
65
|
|
|
66 ;; History:
|
|
|
67 ;;
|
|
|
68 ;; 0.02--1.00:
|
|
2
|
69 ;; - Changed name from turbo-prop to fast-lock. Automagic for font-lock only
|
|
|
70 ;; - Made `fast-lock-mode' a minor mode, like G. Dinesh Dutt's fss-mode
|
|
0
|
71 ;; 1.00--1.01:
|
|
2
|
72 ;; - Turn on `fast-lock-mode' only if `buffer-file-name' or `interactive-p'
|
|
|
73 ;; - Made `fast-lock-file-name' use `buffer-name' if `buffer-file-name' is nil
|
|
|
74 ;; - Moved save-all conditions to `fast-lock-save-cache'
|
|
|
75 ;; - Added `fast-lock-save-text-properties' to `kill-buffer-hook'
|
|
|
76 ;; 1.01--2.00: complete rewrite---not worth the space to document
|
|
|
77 ;; - Changed structure of text properties cache and threw out file mod checks
|
|
0
|
78 ;; 2.00--2.01:
|
|
|
79 ;; - Made `condition-case' forms understand `quit'.
|
|
2
|
80 ;; - Made `fast-lock' require `font-lock'
|
|
|
81 ;; - Made `fast-lock-cache-name' chase links (from Ben Liblit)
|
|
0
|
82 ;; 2.01--3.00:
|
|
2
|
83 ;; - Changed structure of cache to include `font-lock-keywords' (from rms)
|
|
|
84 ;; - Changed `fast-lock-cache-mechanisms' to `fast-lock-cache-directories'
|
|
|
85 ;; - Removed `fast-lock-read-others'
|
|
|
86 ;; - Made `fast-lock-read-cache' ignore cache owner
|
|
|
87 ;; - Made `fast-lock-save-cache-external' create cache directory
|
|
|
88 ;; - Made `fast-lock-save-cache-external' save `font-lock-keywords'
|
|
|
89 ;; - Made `fast-lock-cache-data' check `font-lock-keywords'
|
|
|
90 ;; 3.00--3.01: incorporated port of 2.00 to Lucid, made by Barry Warsaw
|
|
|
91 ;; - Package now provides itself
|
|
|
92 ;; - Lucid: Use `font-lock-any-extents-p' for `font-lock-any-properties-p'
|
|
|
93 ;; - Lucid: Use `list-faces' for `face-list'
|
|
|
94 ;; - Lucid: Added `set-text-properties'
|
|
|
95 ;; - Lucid: Made `turn-on-fast-lock' pass 1 not t to `fast-lock-mode'
|
|
|
96 ;; - Removed test for `fast-lock-mode' from `fast-lock-read-cache'
|
|
|
97 ;; - Lucid: Added Lucid-specific `fast-lock-get-face-properties'
|
|
|
98 ;; 3.01--3.02: now works with Lucid Emacs, thanks to Barry Warsaw
|
|
|
99 ;; - Made `fast-lock-cache-name' map ":" to ";" for OS/2 (from Serganova Vera)
|
|
|
100 ;; - Made `fast-lock-cache-name' use abbreviated file name (from Barry Warsaw)
|
|
|
101 ;; - Lucid: Separated handlers for `error' and `quit' for `condition-case'
|
|
0
|
102 ;; 3.02--3.03:
|
|
2
|
103 ;; - Changed `fast-lock-save-cache-external' to `fast-lock-save-cache-data'
|
|
|
104 ;; - Lucid: Added Lucid-specific `fast-lock-set-face-properties'
|
|
0
|
105 ;; 3.03--3.04:
|
|
2
|
106 ;; - Corrected `subrp' test of Lucid code
|
|
|
107 ;; - Replaced `font-lock-any-properties-p' with `text-property-not-all'
|
|
|
108 ;; - Lucid: Made `fast-lock-set-face-properties' put `text-prop' on extents
|
|
|
109 ;; - Made `fast-lock-cache-directories' a regexp alist (from Colin Rafferty)
|
|
|
110 ;; - Made `fast-lock-cache-directory' to return a usable cache file directory
|
|
0
|
111 ;; 3.04--3.05:
|
|
2
|
112 ;; - Lucid: Fix for XEmacs 19.11 `text-property-not-all'
|
|
|
113 ;; - Replaced `subrp' test of Lucid code with `emacs-version' `string-match'
|
|
|
114 ;; - Made `byte-compile-warnings' omit `unresolved' on compilation
|
|
|
115 ;; - Made `fast-lock-save-cache-data' use a buffer (from Rick Sladkey)
|
|
|
116 ;; - Reverted to old `fast-lock-get-face-properties' (from Rick Sladkey)
|
|
|
117 ;; 3.05--3.06: incorporated hack of 3.03, made by Jonathan Stigelman (Stig)
|
|
|
118 ;; - Reverted to 3.04 version of `fast-lock-get-face-properties'
|
|
|
119 ;; - XEmacs: Removed `list-faces' `defalias'
|
|
|
120 ;; - Made `fast-lock-mode' and `turn-on-fast-lock' succeed `autoload' cookies
|
|
|
121 ;; - Added `fast-lock-submit-bug-report'
|
|
|
122 ;; - Renamed `fast-lock-save-size' to `fast-lock-minimum-size'
|
|
|
123 ;; - Made `fast-lock-save-cache' output a message if no save ever attempted
|
|
|
124 ;; - Made `fast-lock-save-cache-data' output a message if save attempted
|
|
|
125 ;; - Made `fast-lock-cache-data' output a message if load attempted
|
|
|
126 ;; - Made `fast-lock-save-cache-data' do `condition-case' not `unwind-protect'
|
|
|
127 ;; - Made `fast-lock-save-cache' and `fast-lock-read-cache' return nothing
|
|
|
128 ;; - Made `fast-lock-save-cache' check `buffer-modified-p' (Stig)
|
|
|
129 ;; - Added `fast-lock-save-events'
|
|
|
130 ;; - Added `fast-lock-after-save-hook' to `after-save-hook' (Stig)
|
|
|
131 ;; - Added `fast-lock-kill-buffer-hook' to `kill-buffer-hook'
|
|
|
132 ;; - Changed `fast-lock-save-caches' to `fast-lock-kill-emacs-hook'
|
|
|
133 ;; - Added `fast-lock-kill-emacs-hook' to `kill-emacs-hook'
|
|
|
134 ;; - Made `fast-lock-save-cache' check `verify-visited-file-modtime' (Stig)
|
|
|
135 ;; - Made `visited-file-modtime' be the basis of the timestamp (Stig)
|
|
|
136 ;; - Made `fast-lock-save-cache-1' and `fast-lock-cache-data' use/reformat it
|
|
|
137 ;; - Added `fast-lock-cache-filename' to keep track of the cache file name
|
|
|
138 ;; - Added `fast-lock-after-fontify-buffer'
|
|
|
139 ;; - Added `fast-lock-save-faces' list of faces to save (idea from Stig/Tibor)
|
|
|
140 ;; - Made `fast-lock-get-face-properties' functions use it
|
|
|
141 ;; - XEmacs: Made `fast-lock-set-face-properties' do extents the Font Lock way
|
|
|
142 ;; - XEmacs: Removed fix for `text-property-not-all' (19.11 support dropped)
|
|
|
143 ;; - Made `fast-lock-mode' ensure `font-lock-mode' is on
|
|
|
144 ;; - Made `fast-lock-save-cache' do `cdr-safe' not `cdr' (from Dave Foster)
|
|
|
145 ;; - Made `fast-lock-save-cache' do `set-buffer' first (from Dave Foster)
|
|
|
146 ;; - Made `fast-lock-save-cache' loop until saved or quit (from Georg Nikodym)
|
|
|
147 ;; - Made `fast-lock-cache-data' check `buffer-modified-p'
|
|
|
148 ;; - Made `fast-lock-cache-data' do `font-lock-compile-keywords' if necessary
|
|
|
149 ;; - XEmacs: Made `font-lock-compile-keywords' `defalias'
|
|
0
|
150 ;; 3.06--3.07:
|
|
2
|
151 ;; - XEmacs: Add `fast-lock-after-fontify-buffer' to the Font Lock hook
|
|
|
152 ;; - Made `fast-lock-cache-name' explain the use of `directory-abbrev-alist'
|
|
|
153 ;; - Made `fast-lock-mode' use `buffer-file-truename' not `buffer-file-name'
|
|
0
|
154 ;; 3.07--3.08:
|
|
2
|
155 ;; - Made `fast-lock-read-cache' set `fast-lock-cache-filename'
|
|
|
156 ;; 3.08--3.09:
|
|
|
157 ;; - Made `fast-lock-save-cache' cope if `fast-lock-minimum-size' is an a list
|
|
|
158 ;; - Made `fast-lock-mode' respect the value of `font-lock-inhibit-thing-lock'
|
|
|
159 ;; - Added `fast-lock-after-unfontify-buffer'
|
|
|
160 ;; 3.09--3.10:
|
|
|
161 ;; - Rewrite for Common Lisp macros
|
|
|
162 ;; - Made fast-lock.el barf on a crap 8+3 pseudo-OS (Eli Zaretskii help)
|
|
|
163 ;; - XEmacs: Made `add-minor-mode' succeed `autoload' cookie
|
|
|
164 ;; - XEmacs: Made `fast-lock-save-faces' default to `font-lock-face-list'
|
|
|
165 ;; - Made `fast-lock-save-cache' use `font-lock-value-in-major-mode'
|
|
|
166 ;; - Wrap with `save-buffer-state' (Ray Van Tassle report)
|
|
|
167 ;; - Made `fast-lock-mode' wrap `font-lock-support-mode'
|
|
|
168 ;; 3.10--3.11:
|
|
0
|
169
|
|
|
170 (require 'font-lock)
|
|
|
171
|
|
2
|
172 ;; Make sure fast-lock.el is supported.
|
|
|
173 (if (and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
|
|
|
174 (error "`fast-lock' was written for long file name systems"))
|
|
|
175
|
|
0
|
176 (eval-when-compile
|
|
2
|
177 ;;
|
|
|
178 ;; We don't do this at the top-level as we only use non-autoloaded macros.
|
|
|
179 (require 'cl)
|
|
|
180 ;;
|
|
|
181 ;; I prefer lazy code---and lazy mode.
|
|
|
182 (setq byte-compile-dynamic t byte-compile-dynamic-docstrings t)
|
|
|
183 ;; But, we make sure that the code is as zippy as can be.
|
|
|
184 (setq byte-optimize t)
|
|
|
185 ;;
|
|
|
186 ;; We use this to preserve or protect things when modifying text properties.
|
|
|
187 (defmacro save-buffer-state (varlist &rest body)
|
|
|
188 "Bind variables according to VARLIST and eval BODY restoring buffer state."
|
|
|
189 (` (let* ((,@ (append varlist
|
|
|
190 '((modified (buffer-modified-p))
|
|
|
191 (inhibit-read-only t) (buffer-undo-list t)
|
|
|
192 before-change-functions after-change-functions
|
|
|
193 deactivate-mark buffer-file-name buffer-file-truename))))
|
|
|
194 (,@ body)
|
|
|
195 (when (and (not modified) (buffer-modified-p))
|
|
|
196 (set-buffer-modified-p nil)))))
|
|
|
197 (put 'save-buffer-state 'lisp-indent-function 1))
|
|
0
|
198
|
|
|
199 (defun fast-lock-submit-bug-report ()
|
|
|
200 "Submit via mail a bug report on fast-lock.el."
|
|
|
201 (interactive)
|
|
|
202 (let ((reporter-prompt-for-summary-p t))
|
|
2
|
203 (reporter-submit-bug-report "simon@gnu.ai.mit.edu" "fast-lock 3.10.01"
|
|
0
|
204 '(fast-lock-cache-directories fast-lock-minimum-size
|
|
|
205 fast-lock-save-others fast-lock-save-events fast-lock-save-faces)
|
|
|
206 nil nil
|
|
|
207 (concat "Hi Si.,
|
|
|
208
|
|
|
209 I want to report a bug. I've read the `Bugs' section of `Info' on Emacs, so I
|
|
|
210 know how to make a clear and unambiguous report. To reproduce the bug:
|
|
|
211
|
|
2
|
212 Start a fresh editor via `" invocation-name " -no-init-file -no-site-file'.
|
|
0
|
213 In the `*scratch*' buffer, evaluate:"))))
|
|
|
214
|
|
|
215 ;;;###autoload
|
|
2
|
216 (defvar fast-lock-mode nil)
|
|
0
|
217 (defvar fast-lock-cache-timestamp nil) ; for saving/reading
|
|
|
218 (defvar fast-lock-cache-filename nil) ; for deleting
|
|
|
219
|
|
|
220 ;; User Variables:
|
|
|
221
|
|
|
222 (defvar fast-lock-cache-directories '("." "~/.emacs-flc")
|
|
|
223 ; - `internal', keep each file's Font Lock cache file in the same file.
|
|
|
224 ; - `external', keep each file's Font Lock cache file in the same directory.
|
|
2
|
225 "*Directories in which Font Lock cache files are saved and read.
|
|
0
|
226 Each item should be either DIR or a cons pair of the form (REGEXP . DIR) where
|
|
|
227 DIR is a directory name (relative or absolute) and REGEXP is a regexp.
|
|
|
228
|
|
|
229 An attempt will be made to save or read Font Lock cache files using these items
|
|
|
230 until one succeeds (i.e., until a readable or writable one is found). If an
|
|
|
231 item contains REGEXP, DIR is used only if the buffer file name matches REGEXP.
|
|
|
232 For example:
|
|
|
233
|
|
|
234 (let ((home (expand-file-name (abbreviate-file-name (file-truename \"~/\")))))
|
|
|
235 (list (cons (concat \"^\" (regexp-quote home)) \".\") \"~/.emacs-flc\"))
|
|
|
236 =>
|
|
|
237 ((\"^/your/true/home/directory/\" . \".\") \"~/.emacs-flc\")
|
|
|
238
|
|
|
239 would cause a file's current directory to be used if the file is under your
|
|
|
240 home directory hierarchy, or otherwise the absolute directory `~/.emacs-flc'.")
|
|
|
241
|
|
|
242 (defvar fast-lock-minimum-size (* 25 1024)
|
|
2
|
243 "*Minimum size of a buffer for cached fontification.
|
|
0
|
244 Only buffers more than this can have associated Font Lock cache files saved.
|
|
2
|
245 If nil, means cache files are never created.
|
|
|
246 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
|
|
|
247 where MAJOR-MODE is a symbol or t (meaning the default). For example:
|
|
|
248 ((c-mode . 25600) (c++-mode . 25600) (rmail-mode . 1048576))
|
|
|
249 means that the minimum size is 25K for buffers in C or C++ modes, one megabyte
|
|
|
250 for buffers in Rmail mode, and size is irrelevant otherwise.")
|
|
0
|
251
|
|
|
252 (defvar fast-lock-save-events '(kill-buffer kill-emacs)
|
|
2
|
253 "*Events under which caches will be saved.
|
|
0
|
254 Valid events are `save-buffer', `kill-buffer' and `kill-emacs'.
|
|
|
255 If concurrent editing sessions use the same associated cache file for a file's
|
|
|
256 buffer, then you should add `save-buffer' to this list.")
|
|
|
257
|
|
|
258 (defvar fast-lock-save-others t
|
|
2
|
259 "*If non-nil, save Font Lock cache files irrespective of file owner.
|
|
0
|
260 If nil, means only buffer files known to be owned by you can have associated
|
|
|
261 Font Lock cache files saved. Ownership may be unknown for networked files.")
|
|
|
262
|
|
|
263 (defvar fast-lock-save-faces
|
|
2
|
264 (when (save-match-data (string-match "XEmacs" (emacs-version)))
|
|
|
265 ;; XEmacs uses extents for everything, so we have to pick the right ones.
|
|
|
266 font-lock-face-list)
|
|
|
267 "Faces that will be saved in a Font Lock cache file.
|
|
0
|
268 If nil, means information for all faces will be saved.")
|
|
|
269
|
|
|
270 ;; User Functions:
|
|
|
271
|
|
|
272 ;;;###autoload
|
|
|
273 (defun fast-lock-mode (&optional arg)
|
|
|
274 "Toggle Fast Lock mode.
|
|
|
275 With arg, turn Fast Lock mode on if and only if arg is positive and the buffer
|
|
|
276 is associated with a file. Enable it automatically in your `~/.emacs' by:
|
|
|
277
|
|
2
|
278 (setq font-lock-support-mode 'fast-lock-mode)
|
|
0
|
279
|
|
|
280 If Fast Lock mode is enabled, and the current buffer does not contain any text
|
|
|
281 properties, any associated Font Lock cache is used if its timestamp matches the
|
|
|
282 buffer's file, and its `font-lock-keywords' match those that you are using.
|
|
|
283
|
|
|
284 Font Lock caches may be saved:
|
|
|
285 - When you save the file's buffer.
|
|
|
286 - When you kill an unmodified file's buffer.
|
|
|
287 - When you exit Emacs, for all unmodified or saved buffers.
|
|
|
288 Depending on the value of `fast-lock-save-events'.
|
|
|
289 See also the commands `fast-lock-read-cache' and `fast-lock-save-cache'.
|
|
|
290
|
|
|
291 Use \\[font-lock-fontify-buffer] to fontify the buffer if the cache is bad.
|
|
|
292
|
|
|
293 Various methods of control are provided for the Font Lock cache. In general,
|
|
|
294 see variable `fast-lock-cache-directories' and function `fast-lock-cache-name'.
|
|
|
295 For saving, see variables `fast-lock-minimum-size', `fast-lock-save-events',
|
|
|
296 `fast-lock-save-others' and `fast-lock-save-faces'.
|
|
|
297
|
|
|
298 Use \\[fast-lock-submit-bug-report] to send bug reports or feedback."
|
|
|
299 (interactive "P")
|
|
|
300 ;; Only turn on if we are visiting a file. We could use `buffer-file-name',
|
|
|
301 ;; but many packages temporarily wrap that to nil when doing their own thing.
|
|
|
302 (set (make-local-variable 'fast-lock-mode)
|
|
|
303 (and buffer-file-truename
|
|
2
|
304 (not (memq 'fast-lock-mode font-lock-inhibit-thing-lock))
|
|
0
|
305 (if arg (> (prefix-numeric-value arg) 0) (not fast-lock-mode))))
|
|
|
306 (if (and fast-lock-mode (not font-lock-mode))
|
|
2
|
307 ;; Turned on `fast-lock-mode' rather than `font-lock-mode'.
|
|
|
308 (let ((font-lock-support-mode 'fast-lock-mode))
|
|
0
|
309 (font-lock-mode t))
|
|
|
310 ;; Let's get down to business.
|
|
|
311 (set (make-local-variable 'fast-lock-cache-timestamp) nil)
|
|
|
312 (set (make-local-variable 'fast-lock-cache-filename) nil)
|
|
2
|
313 (when (and fast-lock-mode (not font-lock-fontified))
|
|
|
314 (fast-lock-read-cache))))
|
|
0
|
315
|
|
|
316 (defun fast-lock-read-cache ()
|
|
|
317 "Read the Font Lock cache for the current buffer.
|
|
|
318
|
|
|
319 The following criteria must be met for a Font Lock cache file to be read:
|
|
|
320 - Fast Lock mode must be turned on in the buffer.
|
|
|
321 - The buffer must not be modified.
|
|
|
322 - The buffer's `font-lock-keywords' must match the cache's.
|
|
|
323 - The buffer file's timestamp must match the cache's.
|
|
|
324 - Criteria imposed by `fast-lock-cache-directories'.
|
|
|
325
|
|
|
326 See `fast-lock-mode'."
|
|
|
327 (interactive)
|
|
|
328 (let ((directories fast-lock-cache-directories)
|
|
|
329 (modified (buffer-modified-p)) (inhibit-read-only t)
|
|
|
330 (fontified font-lock-fontified))
|
|
|
331 (set (make-local-variable 'font-lock-fontified) nil)
|
|
|
332 ;; Keep trying directories until fontification is turned off.
|
|
|
333 (while (and directories (not font-lock-fontified))
|
|
|
334 (let ((directory (fast-lock-cache-directory (car directories) nil)))
|
|
2
|
335 (condition-case nil
|
|
|
336 (when directory
|
|
|
337 (setq fast-lock-cache-filename (fast-lock-cache-name directory))
|
|
|
338 (when (file-readable-p fast-lock-cache-filename)
|
|
|
339 (load fast-lock-cache-filename t t t)))
|
|
|
340 (error nil) (quit nil))
|
|
0
|
341 (setq directories (cdr directories))))
|
|
|
342 ;; Unset `fast-lock-cache-filename', and restore `font-lock-fontified', if
|
|
|
343 ;; we don't use a cache. (Note that `fast-lock-cache-data' sets the value
|
|
|
344 ;; of `fast-lock-cache-timestamp'.)
|
|
|
345 (set-buffer-modified-p modified)
|
|
2
|
346 (unless font-lock-fontified
|
|
|
347 (setq fast-lock-cache-filename nil font-lock-fontified fontified))))
|
|
0
|
348
|
|
|
349 (defun fast-lock-save-cache (&optional buffer)
|
|
|
350 "Save the Font Lock cache of BUFFER or the current buffer.
|
|
|
351
|
|
|
352 The following criteria must be met for a Font Lock cache file to be saved:
|
|
|
353 - Fast Lock mode must be turned on in the buffer.
|
|
|
354 - The event must be one of `fast-lock-save-events'.
|
|
|
355 - The buffer must be at least `fast-lock-minimum-size' bytes long.
|
|
|
356 - The buffer file must be owned by you, or `fast-lock-save-others' must be t.
|
|
|
357 - The buffer must contain at least one `face' text property.
|
|
|
358 - The buffer must not be modified.
|
|
|
359 - The buffer file's timestamp must be the same as the file's on disk.
|
|
|
360 - The on disk file's timestamp must be different than the buffer's cache.
|
|
|
361 - Criteria imposed by `fast-lock-cache-directories'.
|
|
|
362
|
|
|
363 See `fast-lock-mode'."
|
|
|
364 (interactive)
|
|
|
365 (save-excursion
|
|
2
|
366 (when buffer
|
|
|
367 (set-buffer buffer))
|
|
|
368 (let ((min-size (font-lock-value-in-major-mode fast-lock-minimum-size))
|
|
|
369 (file-timestamp (visited-file-modtime)) (saved nil))
|
|
|
370 (when (and fast-lock-mode
|
|
|
371 ;;
|
|
|
372 ;; "Only save if the buffer matches the file, the file has
|
|
|
373 ;; changed, and it was changed by the current emacs session."
|
|
|
374 ;;
|
|
|
375 ;; Only save if the buffer is not modified,
|
|
|
376 ;; (i.e., so we don't save for something not on disk)
|
|
|
377 (not (buffer-modified-p))
|
|
|
378 ;; and the file's timestamp is the same as the buffer's,
|
|
|
379 ;; (i.e., someone else hasn't written the file in the meantime)
|
|
|
380 (verify-visited-file-modtime (current-buffer))
|
|
|
381 ;; and the file's timestamp is different from the cache's.
|
|
|
382 ;; (i.e., a save has occurred since the cache was read)
|
|
|
383 (not (equal fast-lock-cache-timestamp file-timestamp))
|
|
|
384 ;;
|
|
|
385 ;; Only save if user's restrictions are satisfied.
|
|
|
386 (and min-size (>= (buffer-size) min-size))
|
|
|
387 (or fast-lock-save-others
|
|
|
388 (eq (user-uid) (nth 2 (file-attributes buffer-file-name))))
|
|
|
389 ;;
|
|
|
390 ;; Only save if there are `face' properties to save.
|
|
|
391 (text-property-not-all (point-min) (point-max) 'face nil))
|
|
|
392 ;;
|
|
|
393 ;; Try each directory until we manage to save or the user quits.
|
|
|
394 (let ((directories fast-lock-cache-directories))
|
|
|
395 (while (and directories (memq saved '(nil error)))
|
|
|
396 (let* ((dir (fast-lock-cache-directory (car directories) t))
|
|
|
397 (file (and dir (fast-lock-cache-name dir))))
|
|
|
398 (when (and file (file-writable-p file))
|
|
|
399 (setq saved (fast-lock-save-cache-1 file file-timestamp)))
|
|
|
400 (setq directories (cdr directories)))))))))
|
|
0
|
401
|
|
|
402 ;;;###autoload
|
|
|
403 (defun turn-on-fast-lock ()
|
|
|
404 "Unconditionally turn on Fast Lock mode."
|
|
|
405 (fast-lock-mode t))
|
|
|
406
|
|
|
407 ;;; API Functions:
|
|
|
408
|
|
|
409 (defun fast-lock-after-fontify-buffer ()
|
|
|
410 ;; Delete the Font Lock cache file used to restore fontification, if any.
|
|
2
|
411 (when fast-lock-cache-filename
|
|
|
412 (if (file-writable-p fast-lock-cache-filename)
|
|
|
413 (delete-file fast-lock-cache-filename)
|
|
|
414 (message "File %s font lock cache cannot be deleted" (buffer-name))))
|
|
0
|
415 ;; Flag so that a cache will be saved later even if the file is never saved.
|
|
|
416 (setq fast-lock-cache-timestamp nil))
|
|
2
|
417
|
|
|
418 (defalias 'fast-lock-after-unfontify-buffer
|
|
|
419 'ignore)
|
|
0
|
420
|
|
|
421 ;; Miscellaneous Functions:
|
|
|
422
|
|
2
|
423 (defun fast-lock-save-cache-after-save-file ()
|
|
0
|
424 ;; Do `fast-lock-save-cache' if `save-buffer' is on `fast-lock-save-events'.
|
|
2
|
425 (when (memq 'save-buffer fast-lock-save-events)
|
|
|
426 (fast-lock-save-cache)))
|
|
0
|
427
|
|
2
|
428 (defun fast-lock-save-cache-before-kill-buffer ()
|
|
0
|
429 ;; Do `fast-lock-save-cache' if `kill-buffer' is on `fast-lock-save-events'.
|
|
2
|
430 (when (memq 'kill-buffer fast-lock-save-events)
|
|
|
431 (fast-lock-save-cache)))
|
|
0
|
432
|
|
2
|
433 (defun fast-lock-save-caches-before-kill-emacs ()
|
|
0
|
434 ;; Do `fast-lock-save-cache's if `kill-emacs' is on `fast-lock-save-events'.
|
|
2
|
435 (when (memq 'kill-emacs fast-lock-save-events)
|
|
|
436 (mapcar 'fast-lock-save-cache (buffer-list))))
|
|
0
|
437
|
|
|
438 (defun fast-lock-cache-directory (directory create)
|
|
|
439 "Return usable directory based on DIRECTORY.
|
|
|
440 Returns nil if the directory does not exist, or, if CREATE non-nil, cannot be
|
|
|
441 created. DIRECTORY may be a string or a cons pair of the form (REGEXP . DIR).
|
|
|
442 See `fast-lock-cache-directories'."
|
|
|
443 (let ((dir
|
|
|
444 (cond ((not buffer-file-name)
|
|
|
445 ;; Should never be nil, but `crypt++' screws it up.
|
|
|
446 nil)
|
|
|
447 ((stringp directory)
|
|
|
448 ;; Just a directory.
|
|
|
449 directory)
|
|
|
450 (t
|
|
|
451 ;; A directory iff the file name matches the regexp.
|
|
|
452 (let ((bufile (expand-file-name buffer-file-truename))
|
|
|
453 (case-fold-search nil))
|
|
2
|
454 (when (save-match-data (string-match (car directory) bufile))
|
|
|
455 (cdr directory)))))))
|
|
0
|
456 (cond ((not dir)
|
|
|
457 nil)
|
|
|
458 ((file-accessible-directory-p dir)
|
|
|
459 dir)
|
|
|
460 (create
|
|
|
461 (condition-case nil
|
|
|
462 (progn (make-directory dir t) dir)
|
|
|
463 (error nil))))))
|
|
|
464
|
|
|
465 ;; If you are wondering why we only hash if the directory is not ".", rather
|
|
|
466 ;; than if `file-name-absolute-p', it is because if we just appended ".flc" for
|
|
|
467 ;; relative cache directories (that are not ".") then it is possible that more
|
|
|
468 ;; than one file would have the same cache name in that directory, if the luser
|
|
|
469 ;; made a link from one relative cache directory to another. (Phew!)
|
|
|
470 (defun fast-lock-cache-name (directory)
|
|
|
471 "Return full cache path name using caching DIRECTORY.
|
|
|
472 If DIRECTORY is `.', the path is the buffer file name appended with `.flc'.
|
|
|
473 Otherwise, the path name is constructed from DIRECTORY and the buffer's true
|
|
|
474 abbreviated file name, with all `/' characters in the name replaced with `#'
|
|
|
475 characters, and appended with `.flc'.
|
|
|
476
|
|
|
477 If the same file has different cache path names when edited on different
|
|
|
478 machines, e.g., on one machine the cache file name has the prefix `#home',
|
|
|
479 perhaps due to automount, try putting in your `~/.emacs' something like:
|
|
|
480
|
|
|
481 (setq directory-abbrev-alist (cons '(\"^/home/\" . \"/\") directory-abbrev-alist))
|
|
|
482
|
|
|
483 Emacs automagically removes the common `/tmp_mnt' automount prefix by default.
|
|
|
484
|
|
|
485 See `fast-lock-cache-directory'."
|
|
|
486 (if (string-equal directory ".")
|
|
|
487 (concat buffer-file-name ".flc")
|
|
|
488 (let* ((bufile (expand-file-name buffer-file-truename))
|
|
|
489 (chars-alist
|
|
|
490 (if (eq system-type 'emx)
|
|
|
491 '((?/ . (?#)) (?# . (?# ?#)) (?: . (?\;)) (?\; . (?\; ?\;)))
|
|
|
492 '((?/ . (?#)) (?# . (?# ?#)))))
|
|
|
493 (mapchars
|
|
|
494 (function (lambda (c) (or (cdr (assq c chars-alist)) (list c))))))
|
|
|
495 (concat
|
|
|
496 (file-name-as-directory (expand-file-name directory))
|
|
|
497 (mapconcat 'char-to-string (apply 'append (mapcar mapchars bufile)) "")
|
|
|
498 ".flc"))))
|
|
|
499
|
|
|
500 ;; Font Lock Cache Processing Functions:
|
|
|
501
|
|
|
502 (defun fast-lock-save-cache-1 (file timestamp)
|
|
|
503 ;; Save the FILE with the TIMESTAMP as:
|
|
|
504 ;; (fast-lock-cache-data Version=2 TIMESTAMP font-lock-keywords PROPERTIES).
|
|
|
505 ;; Returns non-nil if a save was attempted to a writable cache file.
|
|
|
506 (let ((tpbuf (generate-new-buffer " *fast-lock*"))
|
|
|
507 (buname (buffer-name)) (saved t))
|
|
|
508 (message "Saving %s font lock cache..." buname)
|
|
|
509 (condition-case nil
|
|
|
510 (save-excursion
|
|
|
511 (print (list 'fast-lock-cache-data 2
|
|
|
512 (list 'quote timestamp)
|
|
|
513 (list 'quote font-lock-keywords)
|
|
|
514 (list 'quote (fast-lock-get-face-properties)))
|
|
|
515 tpbuf)
|
|
|
516 (set-buffer tpbuf)
|
|
|
517 (write-region (point-min) (point-max) file nil 'quietly)
|
|
|
518 (setq fast-lock-cache-timestamp timestamp
|
|
|
519 fast-lock-cache-filename file))
|
|
|
520 (error (setq saved 'error)) (quit (setq saved 'quit)))
|
|
|
521 (kill-buffer tpbuf)
|
|
2
|
522 (message "Saving %s font lock cache...%s" buname
|
|
0
|
523 (cond ((eq saved 'error) "failed")
|
|
|
524 ((eq saved 'quit) "aborted")
|
|
|
525 (t "done")))
|
|
|
526 ;; We return non-nil regardless of whether a failure occurred.
|
|
|
527 saved))
|
|
|
528
|
|
|
529 (defun fast-lock-cache-data (version timestamp keywords properties
|
|
|
530 &rest ignored)
|
|
|
531 ;; Change from (HIGH LOW) for back compatibility. Remove for version 3!
|
|
2
|
532 (when (consp (cdr-safe timestamp))
|
|
|
533 (setcdr timestamp (nth 1 timestamp)))
|
|
0
|
534 ;; Compile KEYWORDS and `font-lock-keywords' in case one is and one isn't.
|
|
|
535 (let ((current font-lock-keywords))
|
|
|
536 (setq keywords (font-lock-compile-keywords keywords)
|
|
|
537 font-lock-keywords (font-lock-compile-keywords current)))
|
|
|
538 ;; Use the Font Lock cache PROPERTIES if we're using cache VERSION format 2,
|
|
|
539 ;; the current buffer's file timestamp matches the TIMESTAMP, and the current
|
|
|
540 ;; buffer's font-lock-keywords are the same as KEYWORDS.
|
|
|
541 (let ((buf-timestamp (visited-file-modtime))
|
|
|
542 (buname (buffer-name)) (loaded t))
|
|
|
543 (if (or (/= version 2)
|
|
|
544 (buffer-modified-p)
|
|
|
545 (not (equal timestamp buf-timestamp))
|
|
|
546 (not (equal keywords font-lock-keywords)))
|
|
|
547 (setq loaded nil)
|
|
|
548 (message "Loading %s font lock cache..." buname)
|
|
|
549 (condition-case nil
|
|
|
550 (fast-lock-set-face-properties properties)
|
|
|
551 (error (setq loaded 'error)) (quit (setq loaded 'quit)))
|
|
2
|
552 (message "Loading %s font lock cache...%s" buname
|
|
0
|
553 (cond ((eq loaded 'error) "failed")
|
|
|
554 ((eq loaded 'quit) "aborted")
|
|
|
555 (t "done"))))
|
|
|
556 (setq font-lock-fontified (eq loaded t)
|
|
|
557 fast-lock-cache-timestamp (and (eq loaded t) timestamp))))
|
|
|
558
|
|
|
559 ;; Text Properties Processing Functions:
|
|
|
560
|
|
|
561 ;; This is faster, but fails if adjacent characters have different `face' text
|
|
|
562 ;; properties. Maybe that's why I dropped it in the first place?
|
|
|
563 ;(defun fast-lock-get-face-properties ()
|
|
|
564 ; "Return a list of all `face' text properties in the current buffer.
|
|
|
565 ;Each element of the list is of the form (VALUE START1 END1 START2 END2 ...)
|
|
|
566 ;where VALUE is a `face' property value and STARTx and ENDx are positions."
|
|
|
567 ; (save-restriction
|
|
|
568 ; (widen)
|
|
|
569 ; (let ((start (text-property-not-all (point-min) (point-max) 'face nil))
|
|
|
570 ; (limit (point-max)) end properties value cell)
|
|
|
571 ; (while start
|
|
|
572 ; (setq end (next-single-property-change start 'face nil limit)
|
|
|
573 ; value (get-text-property start 'face))
|
|
|
574 ; ;; Make, or add to existing, list of regions with same `face'.
|
|
|
575 ; (if (setq cell (assq value properties))
|
|
|
576 ; (setcdr cell (cons start (cons end (cdr cell))))
|
|
|
577 ; (setq properties (cons (list value start end) properties)))
|
|
|
578 ; (setq start (next-single-property-change end 'face)))
|
|
|
579 ; properties)))
|
|
|
580
|
|
|
581 (defun fast-lock-get-face-properties ()
|
|
|
582 "Return a list of all `face' text properties in the current buffer.
|
|
|
583 Each element of the list is of the form (VALUE START1 END1 START2 END2 ...)
|
|
|
584 where VALUE is a `face' property value and STARTx and ENDx are positions.
|
|
|
585 Only those `face' VALUEs in `fast-lock-save-faces' are returned."
|
|
|
586 (save-restriction
|
|
|
587 (widen)
|
|
|
588 (let ((faces (or fast-lock-save-faces (face-list))) (limit (point-max))
|
|
|
589 properties regions face start end)
|
|
|
590 (while faces
|
|
|
591 (setq face (car faces) faces (cdr faces) regions () end (point-min))
|
|
|
592 ;; Make a list of start/end regions with `face' property face.
|
|
|
593 (while (setq start (text-property-any end limit 'face face))
|
|
|
594 (setq end (or (text-property-not-all start limit 'face face) limit)
|
|
|
595 regions (cons start (cons end regions))))
|
|
|
596 ;; Add `face' face's regions, if any, to properties.
|
|
2
|
597 (when regions
|
|
|
598 (push (cons face regions) properties)))
|
|
0
|
599 properties)))
|
|
|
600
|
|
|
601 (defun fast-lock-set-face-properties (properties)
|
|
|
602 "Set all `face' text properties to PROPERTIES in the current buffer.
|
|
2
|
603 Any existing `face' text properties are removed first.
|
|
0
|
604 See `fast-lock-get-face-properties' for the format of PROPERTIES."
|
|
2
|
605 (save-buffer-state (plist regions)
|
|
|
606 (save-restriction
|
|
|
607 (widen)
|
|
|
608 (font-lock-unfontify-region (point-min) (point-max))
|
|
|
609 (while properties
|
|
|
610 (setq plist (list 'face (car (car properties)))
|
|
|
611 regions (cdr (car properties))
|
|
|
612 properties (cdr properties))
|
|
0
|
613 ;; Set the `face' property for each start/end region.
|
|
|
614 (while regions
|
|
|
615 (set-text-properties (nth 0 regions) (nth 1 regions) plist)
|
|
2
|
616 (setq regions (nthcdr 2 regions)))))))
|
|
0
|
617
|
|
|
618 ;; Functions for XEmacs:
|
|
|
619
|
|
2
|
620 (when (save-match-data (string-match "XEmacs" (emacs-version)))
|
|
|
621 ;;
|
|
|
622 ;; It would be better to use XEmacs' `map-extents' over extents with a
|
|
|
623 ;; `font-lock' property, but `face' properties are on different extents.
|
|
|
624 (defun fast-lock-get-face-properties ()
|
|
|
625 "Return a list of all `face' text properties in the current buffer.
|
|
0
|
626 Each element of the list is of the form (VALUE START1 END1 START2 END2 ...)
|
|
|
627 where VALUE is a `face' property value and STARTx and ENDx are positions.
|
|
|
628 Only those `face' VALUEs in `fast-lock-save-faces' are returned."
|
|
2
|
629 (save-restriction
|
|
|
630 (widen)
|
|
|
631 (let ((properties ()) cell)
|
|
|
632 (map-extents
|
|
|
633 (function (lambda (extent ignore)
|
|
|
634 (let ((value (extent-face extent)))
|
|
|
635 ;; We're only interested if it's one of `fast-lock-save-faces'.
|
|
|
636 (when (and value (or (null fast-lock-save-faces)
|
|
0
|
637 (memq value fast-lock-save-faces)))
|
|
2
|
638 (let ((start (extent-start-position extent))
|
|
|
639 (end (extent-end-position extent)))
|
|
|
640 ;; Make or add to existing list of regions with the same
|
|
|
641 ;; `face' property value.
|
|
|
642 (if (setq cell (assq value properties))
|
|
|
643 (setcdr cell (cons start (cons end (cdr cell))))
|
|
|
644 (push (list value start end) properties))))
|
|
|
645 ;; Return nil to keep `map-extents' going.
|
|
|
646 nil))))
|
|
|
647 properties)))
|
|
|
648 ;;
|
|
|
649 ;; Make extents just like XEmacs' font-lock.el does.
|
|
|
650 (defun fast-lock-set-face-properties (properties)
|
|
|
651 "Set all `face' text properties to PROPERTIES in the current buffer.
|
|
0
|
652 Any existing `face' text properties are removed first.
|
|
|
653 See `fast-lock-get-face-properties' for the format of PROPERTIES."
|
|
2
|
654 (save-restriction
|
|
|
655 (widen)
|
|
|
656 (font-lock-unfontify-region (point-min) (point-max))
|
|
|
657 (while properties
|
|
|
658 (let ((face (car (car properties)))
|
|
|
659 (regions (cdr (car properties))))
|
|
|
660 ;; Set the `face' property, etc., for each start/end region.
|
|
|
661 (while regions
|
|
|
662 (font-lock-set-face (nth 0 regions) (nth 1 regions) face)
|
|
|
663 (setq regions (nthcdr 2 regions)))
|
|
|
664 (setq properties (cdr properties))))))
|
|
|
665 ;;
|
|
|
666 ;; XEmacs 19.12 font-lock.el's `font-lock-fontify-buffer' runs a hook.
|
|
|
667 (add-hook 'font-lock-after-fontify-buffer-hook
|
|
|
668 'fast-lock-after-fontify-buffer))
|
|
0
|
669
|
|
2
|
670 (unless (boundp 'font-lock-inhibit-thing-lock)
|
|
|
671 (defvar font-lock-inhibit-thing-lock nil
|
|
|
672 "List of Font Lock mode related modes that should not be turned on."))
|
|
0
|
673
|
|
2
|
674 (unless (fboundp 'font-lock-value-in-major-mode)
|
|
|
675 (defun font-lock-value-in-major-mode (alist)
|
|
|
676 ;; Return value in ALIST for `major-mode'.
|
|
|
677 (if (consp alist)
|
|
|
678 (cdr (or (assq major-mode alist) (assq t alist)))
|
|
|
679 alist)))
|
|
|
680
|
|
|
681 (unless (fboundp 'font-lock-compile-keywords)
|
|
|
682 (defalias 'font-lock-compile-keywords 'identity))
|
|
0
|
683
|
|
|
684 ;; Install ourselves:
|
|
|
685
|
|
2
|
686 (add-hook 'after-save-hook 'fast-lock-save-cache-after-save-file)
|
|
|
687 (add-hook 'kill-buffer-hook 'fast-lock-save-cache-before-kill-buffer)
|
|
|
688 (add-hook 'kill-emacs-hook 'fast-lock-save-caches-before-kill-emacs)
|
|
0
|
689
|
|
|
690 ;;;###autoload
|
|
2
|
691 (if (fboundp 'add-minor-mode) (add-minor-mode 'fast-lock-mode nil))
|
|
|
692 ;;;###dont-autoload
|
|
|
693 (unless (assq 'fast-lock-mode minor-mode-alist)
|
|
|
694 (setq minor-mode-alist (append minor-mode-alist '((fast-lock-mode nil)))))
|
|
0
|
695
|
|
|
696 ;; Provide ourselves:
|
|
|
697
|
|
|
698 (provide 'fast-lock)
|
|
|
699
|
|
|
700 ;;; fast-lock.el ends here
|
