Mercurial > hg > xemacs-beta

comparison lisp/packages/fast-lock.el @ 0:376386a54a3c r19-14

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