1 ;;; fast-lock.el --- Automagic text properties caching for fast Font Lock mode.
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Simon Marshall <simon@gnu.ai.mit.edu>
6 ;; Keywords: faces files
9 ;;; This file is part of GNU Emacs.
11 ;; GNU Emacs 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, or (at your option)
16 ;; GNU Emacs 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.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; 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.
28 ;; Lazy Lock mode is a Font Lock support mode.
29 ;; It makes visiting a file in Font Lock mode faster by restoring its face text
30 ;; properties from automatically saved associated Font Lock cache files.
32 ;; See caveats and feedback below.
33 ;; See also the lazy-lock package. (But don't use the two at the same time!)
37 ;; Put in your ~/.emacs:
39 ;; (setq font-lock-support-mode 'fast-lock-mode)
41 ;; Start up a new Emacs and use font-lock as usual (except that you can use the
42 ;; so-called "gaudier" fontification regexps on big files without frustration).
44 ;; When you visit a file (which has `font-lock-mode' enabled) that has a
45 ;; corresponding Font Lock cache file associated with it, the Font Lock cache
46 ;; will be loaded from that file instead of being generated by Font Lock code.
50 ;; A cache will be saved when visiting a compressed file using crypt++, but not
51 ;; be read. This is a "feature"/"consequence"/"bug" of crypt++.
53 ;; Version control packages are likely to stamp all over file modification
54 ;; times. Therefore the act of checking out may invalidate a cache.
59 ;; - Changed name from turbo-prop to fast-lock. Automagic for font-lock only
60 ;; - Made `fast-lock-mode' a minor mode, like G. Dinesh Dutt's fss-mode
62 ;; - Turn on `fast-lock-mode' only if `buffer-file-name' or `interactive-p'
63 ;; - Made `fast-lock-file-name' use `buffer-name' if `buffer-file-name' is nil
64 ;; - Moved save-all conditions to `fast-lock-save-cache'
65 ;; - Added `fast-lock-save-text-properties' to `kill-buffer-hook'
66 ;; 1.01--2.00: complete rewrite---not worth the space to document
67 ;; - Changed structure of text properties cache and threw out file mod checks
69 ;; - Made `condition-case' forms understand `quit'.
70 ;; - Made `fast-lock' require `font-lock'
71 ;; - Made `fast-lock-cache-name' chase links (from Ben Liblit)
73 ;; - Changed structure of cache to include `font-lock-keywords' (from rms)
74 ;; - Changed `fast-lock-cache-mechanisms' to `fast-lock-cache-directories'
75 ;; - Removed `fast-lock-read-others'
76 ;; - Made `fast-lock-read-cache' ignore cache owner
77 ;; - Made `fast-lock-save-cache-external' create cache directory
78 ;; - Made `fast-lock-save-cache-external' save `font-lock-keywords'
79 ;; - Made `fast-lock-cache-data' check `font-lock-keywords'
80 ;; 3.00--3.01: incorporated port of 2.00 to Lucid, made by Barry Warsaw
81 ;; - Package now provides itself
82 ;; - Lucid: Use `font-lock-any-extents-p' for `font-lock-any-properties-p'
83 ;; - Lucid: Use `list-faces' for `face-list'
84 ;; - Lucid: Added `set-text-properties'
85 ;; - Lucid: Made `turn-on-fast-lock' pass 1 not t to `fast-lock-mode'
86 ;; - Removed test for `fast-lock-mode' from `fast-lock-read-cache'
87 ;; - Lucid: Added Lucid-specific `fast-lock-get-face-properties'
88 ;; 3.01--3.02: now works with Lucid Emacs, thanks to Barry Warsaw
89 ;; - Made `fast-lock-cache-name' map ":" to ";" for OS/2 (from Serganova Vera)
90 ;; - Made `fast-lock-cache-name' use abbreviated file name (from Barry Warsaw)
91 ;; - Lucid: Separated handlers for `error' and `quit' for `condition-case'
93 ;; - Changed `fast-lock-save-cache-external' to `fast-lock-save-cache-data'
94 ;; - Lucid: Added Lucid-specific `fast-lock-set-face-properties'
96 ;; - Corrected `subrp' test of Lucid code
97 ;; - Replaced `font-lock-any-properties-p' with `text-property-not-all'
98 ;; - Lucid: Made `fast-lock-set-face-properties' put `text-prop' on extents
99 ;; - Made `fast-lock-cache-directories' a regexp alist (from Colin Rafferty)
100 ;; - Made `fast-lock-cache-directory' to return a usable cache file directory
102 ;; - Lucid: Fix for XEmacs 19.11 `text-property-not-all'
103 ;; - Replaced `subrp' test of Lucid code with `emacs-version' `string-match'
104 ;; - Made `byte-compile-warnings' omit `unresolved' on compilation
105 ;; - Made `fast-lock-save-cache-data' use a buffer (from Rick Sladkey)
106 ;; - Reverted to old `fast-lock-get-face-properties' (from Rick Sladkey)
107 ;; 3.05--3.06: incorporated hack of 3.03, made by Jonathan Stigelman (Stig)
108 ;; - Reverted to 3.04 version of `fast-lock-get-face-properties'
109 ;; - XEmacs: Removed `list-faces' `defalias'
110 ;; - Made `fast-lock-mode' and `turn-on-fast-lock' succeed `autoload' cookies
111 ;; - Added `fast-lock-submit-bug-report'
112 ;; - Renamed `fast-lock-save-size' to `fast-lock-minimum-size'
113 ;; - Made `fast-lock-save-cache' output a message if no save ever attempted
114 ;; - Made `fast-lock-save-cache-data' output a message if save attempted
115 ;; - Made `fast-lock-cache-data' output a message if load attempted
116 ;; - Made `fast-lock-save-cache-data' do `condition-case' not `unwind-protect'
117 ;; - Made `fast-lock-save-cache' and `fast-lock-read-cache' return nothing
118 ;; - Made `fast-lock-save-cache' check `buffer-modified-p' (Stig)
119 ;; - Added `fast-lock-save-events'
120 ;; - Added `fast-lock-after-save-hook' to `after-save-hook' (Stig)
121 ;; - Added `fast-lock-kill-buffer-hook' to `kill-buffer-hook'
122 ;; - Changed `fast-lock-save-caches' to `fast-lock-kill-emacs-hook'
123 ;; - Added `fast-lock-kill-emacs-hook' to `kill-emacs-hook'
124 ;; - Made `fast-lock-save-cache' check `verify-visited-file-modtime' (Stig)
125 ;; - Made `visited-file-modtime' be the basis of the timestamp (Stig)
126 ;; - Made `fast-lock-save-cache-1' and `fast-lock-cache-data' use/reformat it
127 ;; - Added `fast-lock-cache-filename' to keep track of the cache file name
128 ;; - Added `fast-lock-after-fontify-buffer'
129 ;; - Added `fast-lock-save-faces' list of faces to save (idea from Stig/Tibor)
130 ;; - Made `fast-lock-get-face-properties' functions use it
131 ;; - XEmacs: Made `fast-lock-set-face-properties' do extents the Font Lock way
132 ;; - XEmacs: Removed fix for `text-property-not-all' (19.11 support dropped)
133 ;; - Made `fast-lock-mode' ensure `font-lock-mode' is on
134 ;; - Made `fast-lock-save-cache' do `cdr-safe' not `cdr' (from Dave Foster)
135 ;; - Made `fast-lock-save-cache' do `set-buffer' first (from Dave Foster)
136 ;; - Made `fast-lock-save-cache' loop until saved or quit (from Georg Nikodym)
137 ;; - Made `fast-lock-cache-data' check `buffer-modified-p'
138 ;; - Made `fast-lock-cache-data' do `font-lock-compile-keywords' if necessary
139 ;; - XEmacs: Made `font-lock-compile-keywords' `defalias'
141 ;; - XEmacs: Add `fast-lock-after-fontify-buffer' to the Font Lock hook
142 ;; - Made `fast-lock-cache-name' explain the use of `directory-abbrev-alist'
143 ;; - Made `fast-lock-mode' use `buffer-file-truename' not `buffer-file-name'
145 ;; - Made `fast-lock-read-cache' set `fast-lock-cache-filename'
147 ;; - Made `fast-lock-save-cache' cope if `fast-lock-minimum-size' is an a list
148 ;; - Made `fast-lock-mode' respect the value of `font-lock-inhibit-thing-lock'
149 ;; - Added `fast-lock-after-unfontify-buffer'
151 ;; - Rewrite for Common Lisp macros
152 ;; - Made fast-lock.el barf on a crap 8+3 pseudo-OS (Eli Zaretskii help)
153 ;; - XEmacs: Made `add-minor-mode' succeed `autoload' cookie
154 ;; - XEmacs: Made `fast-lock-save-faces' default to `font-lock-face-list'
155 ;; - Made `fast-lock-save-cache' use `font-lock-value-in-major-mode'
156 ;; - Wrap with `save-buffer-state' (Ray Van Tassle report)
157 ;; - Made `fast-lock-mode' wrap `font-lock-support-mode'
159 ;; - Made `fast-lock-get-face-properties' cope with face lists
160 ;; - Added `fast-lock-verbose'
161 ;; - XEmacs: Add `font-lock-value-in-major-mode' if necessary
162 ;; - Removed `fast-lock-submit-bug-report' and bade farewell
169 ;; Make sure fast-lock.el is supported.
170 (if (and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
171 (error "`fast-lock' was written for long file name systems"))
175 ;; We don't do this at the top-level as we only use non-autoloaded macros.
178 ;; I prefer lazy code---and lazy mode.
179 (setq byte-compile-dynamic t byte-compile-dynamic-docstrings t)
180 ;; But, we make sure that the code is as zippy as can be.
181 (setq byte-optimize t)
183 ;; We use this to preserve or protect things when modifying text properties.
184 (defmacro save-buffer-state (varlist &rest body)
185 "Bind variables according to VARLIST and eval BODY restoring buffer state."
186 (` (let* ((,@ (append varlist
187 '((modified (buffer-modified-p))
188 (inhibit-read-only t) (buffer-undo-list t)
189 before-change-functions after-change-functions
190 deactivate-mark buffer-file-name buffer-file-truename))))
192 (when (and (not modified) (buffer-modified-p))
193 (set-buffer-modified-p nil)))))
194 (put 'save-buffer-state 'lisp-indent-function 1)
196 ;; We use this to verify that a face should be saved.
197 (defmacro fast-lock-save-facep (face)
198 "Return non-nil if FACE is one of `fast-lock-save-faces'."
199 (` (or (null fast-lock-save-faces)
200 (if (symbolp (, face))
201 (memq (, face) fast-lock-save-faces)
202 (let ((faces (, face)))
203 (while (unless (memq (car faces) fast-lock-save-faces)
204 (setq faces (cdr faces))))
207 ;(defun fast-lock-submit-bug-report ()
208 ; "Submit via mail a bug report on fast-lock.el."
210 ; (let ((reporter-prompt-for-summary-p t))
211 ; (reporter-submit-bug-report "simon@gnu.ai.mit.edu" "fast-lock 3.11.01"
212 ; '(fast-lock-cache-directories fast-lock-minimum-size
213 ; fast-lock-save-others fast-lock-save-events fast-lock-save-faces
218 ;I want to report a bug. I've read the `Bugs' section of `Info' on Emacs, so I
219 ;know how to make a clear and unambiguous report. To reproduce the bug:
221 ;Start a fresh editor via `" invocation-name " -no-init-file -no-site-file'.
222 ;In the `*scratch*' buffer, evaluate:"))))
224 (defgroup fast-lock nil
225 "Automagic text properties caching for fast Font Lock mode"
229 (defcustom fast-lock-mode nil ;; customized for the options menu
230 "Non nil means `fast-lock-mode' is on"
232 :require 'fast-lock ;; which in turn requires font-lock.
234 :initialize 'custom-initialize-default
235 :set '(lambda (var val)
239 (add-hook 'font-lock-mode-hook 'turn-on-fast-lock))
241 (remove-hook 'font-lock-mode-hook 'turn-on-fast-lock))
242 (setq-default fast-lock-mode val))
245 (defvar fast-lock-cache-timestamp nil) ; For saving/reading.
246 (defvar fast-lock-cache-filename nil) ; For deleting.
250 (defcustom fast-lock-cache-directories '("~/.emacs-flc")
251 ; - `internal', keep each file's Font Lock cache file in the same file.
252 ; - `external', keep each file's Font Lock cache file in the same directory.
253 "*Directories in which Font Lock cache files are saved and read.
254 Each item should be either DIR or a cons pair of the form (REGEXP . DIR) where
255 DIR is a directory name (relative or absolute) and REGEXP is a regexp.
257 An attempt will be made to save or read Font Lock cache files using these items
258 until one succeeds (i.e., until a readable or writable one is found). If an
259 item contains REGEXP, DIR is used only if the buffer file name matches REGEXP.
262 (let ((home (expand-file-name (abbreviate-file-name (file-truename \"~/\")))))
263 (list (cons (concat \"^\" (regexp-quote home)) \".\") \"~/.emacs-flc\"))
265 ((\"^/your/true/home/directory/\" . \".\") \"~/.emacs-flc\")
267 would cause a file's current directory to be used if the file is under your
268 home directory hierarchy, or otherwise the absolute directory `~/.emacs-flc'.
269 This list should contain only trusted directories in order to avoid processing
270 potentially malicious cache files."
271 :type '(repeat (choice (cons regexp directory) directory))
275 (put 'fast-lock-cache-directories 'risky-local-variable t)
277 (defcustom fast-lock-minimum-size (* 25 1024)
278 "*Minimum size of a buffer for cached fontification.
279 Only buffers more than this can have associated Font Lock cache files saved.
280 If nil, means cache files are never created.
281 If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE),
282 where MAJOR-MODE is a symbol or t (meaning the default). For example:
283 ((c-mode . 25600) (c++-mode . 25600) (rmail-mode . 1048576))
284 means that the minimum size is 25K for buffers in C or C++ modes, one megabyte
285 for buffers in Rmail mode, and size is irrelevant otherwise."
286 :type '(choice (integer :tag "Size") (repeat (cons (symbol :tag "Major Mode")
287 (integer :tag "Size"))))
290 (defcustom fast-lock-save-events '(kill-buffer kill-emacs)
291 "*Events under which caches will be saved.
292 Valid events are `save-buffer', `kill-buffer' and `kill-emacs'.
293 If concurrent editing sessions use the same associated cache file for a file's
294 buffer, then you should add `save-buffer' to this list."
295 :type '(set (const kill-buffer) (const save-buffer) (const kill-emacs))
298 (defcustom fast-lock-save-others t
299 "*If non-nil, save Font Lock cache files irrespective of file owner.
300 If nil, means only buffer files known to be owned by you can have associated
301 Font Lock cache files saved. Ownership may be unknown for networked files."
305 (defvar fast-lock-save-faces
306 (when (save-match-data (string-match "XEmacs" (emacs-version)))
307 ;; XEmacs uses extents for everything, so we have to pick the right ones.
309 "Faces that will be saved in a Font Lock cache file.
310 If nil, means information for all faces will be saved.")
312 (defcustom fast-lock-verbose font-lock-verbose
313 "*If non-nil, means show status messages for cache processing.
314 If a number, only buffers greater than this size have processing messages."
315 :type '(choice integer boolean)
321 (defun fast-lock-mode (&optional arg)
322 "Toggle Fast Lock mode.
323 With arg, turn Fast Lock mode on if and only if arg is positive and the buffer
324 is associated with a file. Enable it automatically in your `~/.emacs' by:
326 (setq font-lock-support-mode 'fast-lock-mode)
328 If Fast Lock mode is enabled, and the current buffer does not contain any text
329 properties, any associated Font Lock cache is used if its timestamp matches the
330 buffer's file, and its `font-lock-keywords' match those that you are using.
332 Font Lock caches may be saved:
333 - When you save the file's buffer.
334 - When you kill an unmodified file's buffer.
335 - When you exit Emacs, for all unmodified or saved buffers.
336 Depending on the value of `fast-lock-save-events'.
337 See also the commands `fast-lock-read-cache' and `fast-lock-save-cache'.
339 Use \\[font-lock-fontify-buffer] to fontify the buffer if the cache is bad.
341 Various methods of control are provided for the Font Lock cache. In general,
342 see variable `fast-lock-cache-directories' and function `fast-lock-cache-name'.
343 For saving, see variables `fast-lock-minimum-size', `fast-lock-save-events',
344 `fast-lock-save-others' and `fast-lock-save-faces'."
346 ;; Only turn on if we are visiting a file. We could use `buffer-file-name',
347 ;; but many packages temporarily wrap that to nil when doing their own thing.
348 (set (make-local-variable 'fast-lock-mode)
349 (and buffer-file-truename
350 (not (memq 'fast-lock-mode font-lock-inhibit-thing-lock))
351 (if arg (> (prefix-numeric-value arg) 0) (not fast-lock-mode))))
352 (if (and fast-lock-mode (not font-lock-mode))
353 ;; Turned on `fast-lock-mode' rather than `font-lock-mode'.
354 (let ((font-lock-support-mode 'fast-lock-mode))
356 ;; Let's get down to business.
357 (set (make-local-variable 'fast-lock-cache-timestamp) nil)
358 (set (make-local-variable 'fast-lock-cache-filename) nil)
359 (when (and fast-lock-mode (not font-lock-fontified))
360 (fast-lock-read-cache))))
362 (defun fast-lock-read-cache ()
363 "Read the Font Lock cache for the current buffer.
365 The following criteria must be met for a Font Lock cache file to be read:
366 - Fast Lock mode must be turned on in the buffer.
367 - The buffer must not be modified.
368 - The buffer's `font-lock-keywords' must match the cache's.
369 - The buffer file's timestamp must match the cache's.
370 - Criteria imposed by `fast-lock-cache-directories'.
372 See `fast-lock-mode'."
374 (let ((directories fast-lock-cache-directories)
375 (modified (buffer-modified-p)) (inhibit-read-only t)
376 (fontified font-lock-fontified))
377 (set (make-local-variable 'font-lock-fontified) nil)
378 ;; Keep trying directories until fontification is turned off.
379 (while (and directories (not font-lock-fontified))
380 (let ((directory (fast-lock-cache-directory (car directories) nil)))
383 (setq fast-lock-cache-filename (fast-lock-cache-name directory))
384 (when (file-readable-p fast-lock-cache-filename)
385 (load fast-lock-cache-filename t t t)))
386 (error nil) (quit nil))
387 (setq directories (cdr directories))))
388 ;; Unset `fast-lock-cache-filename', and restore `font-lock-fontified', if
389 ;; we don't use a cache. (Note that `fast-lock-cache-data' sets the value
390 ;; of `fast-lock-cache-timestamp'.)
391 (set-buffer-modified-p modified)
392 (unless font-lock-fontified
393 (setq fast-lock-cache-filename nil font-lock-fontified fontified))))
395 (defun fast-lock-save-cache (&optional buffer)
396 "Save the Font Lock cache of BUFFER or the current buffer.
398 The following criteria must be met for a Font Lock cache file to be saved:
399 - Fast Lock mode must be turned on in the buffer.
400 - The event must be one of `fast-lock-save-events'.
401 - The buffer must be at least `fast-lock-minimum-size' bytes long.
402 - The buffer file must be owned by you, or `fast-lock-save-others' must be t.
403 - The buffer must contain at least one `face' text property.
404 - The buffer must not be modified.
405 - The buffer file's timestamp must be the same as the file's on disk.
406 - The on disk file's timestamp must be different than the buffer's cache.
407 - Criteria imposed by `fast-lock-cache-directories'.
409 See `fast-lock-mode'."
414 (let ((min-size (font-lock-value-in-major-mode fast-lock-minimum-size))
415 (file-timestamp (visited-file-modtime)) (saved nil))
416 (when (and fast-lock-mode
418 ;; "Only save if the buffer matches the file, the file has
419 ;; changed, and it was changed by the current emacs session."
421 ;; Only save if the buffer is not modified,
422 ;; (i.e., so we don't save for something not on disk)
423 (not (buffer-modified-p))
424 ;; and the file's timestamp is the same as the buffer's,
425 ;; (i.e., someone else hasn't written the file in the meantime)
426 (verify-visited-file-modtime (current-buffer))
427 ;; and the file's timestamp is different from the cache's.
428 ;; (i.e., a save has occurred since the cache was read)
429 (not (equal fast-lock-cache-timestamp file-timestamp))
431 ;; Only save if user's restrictions are satisfied.
432 (and min-size (>= (buffer-size) min-size))
433 (or fast-lock-save-others
434 (eq (user-uid) (nth 2 (file-attributes buffer-file-name))))
436 ;; Only save if there are `face' properties to save.
437 (text-property-not-all (point-min) (point-max) 'face nil))
439 ;; Try each directory until we manage to save or the user quits.
440 (let ((directories fast-lock-cache-directories))
441 (while (and directories (memq saved '(nil error)))
442 (let* ((dir (fast-lock-cache-directory (car directories) t))
443 (file (and dir (fast-lock-cache-name dir))))
444 (when (and file (file-writable-p file))
445 (setq saved (fast-lock-save-cache-1 file file-timestamp)))
446 (setq directories (cdr directories)))))))))
449 (defun turn-on-fast-lock ()
450 "Unconditionally turn on Fast Lock mode."
455 (defun fast-lock-after-fontify-buffer ()
456 ;; Delete the Font Lock cache file used to restore fontification, if any.
457 (when (and fast-lock-cache-filename (file-exists-p fast-lock-cache-filename))
458 (if (file-writable-p fast-lock-cache-filename)
459 (delete-file fast-lock-cache-filename)
460 (message "File %s font lock cache cannot be deleted" (buffer-name))))
461 ;; Flag so that a cache will be saved later even if the file is never saved.
462 (setq fast-lock-cache-timestamp nil))
464 (defalias 'fast-lock-after-unfontify-buffer
467 ;; Miscellaneous Functions:
469 (defun fast-lock-save-cache-after-save-file ()
470 ;; Do `fast-lock-save-cache' if `save-buffer' is on `fast-lock-save-events'.
471 (when (memq 'save-buffer fast-lock-save-events)
472 (fast-lock-save-cache)))
474 (defun fast-lock-save-cache-before-kill-buffer ()
475 ;; Do `fast-lock-save-cache' if `kill-buffer' is on `fast-lock-save-events'.
476 (when (memq 'kill-buffer fast-lock-save-events)
477 (fast-lock-save-cache)))
479 (defun fast-lock-save-caches-before-kill-emacs ()
480 ;; Do `fast-lock-save-cache's if `kill-emacs' is on `fast-lock-save-events'.
481 (when (memq 'kill-emacs fast-lock-save-events)
482 (mapcar 'fast-lock-save-cache (buffer-list))))
484 (defun fast-lock-cache-directory (directory create)
485 "Return usable directory based on DIRECTORY.
486 Returns nil if the directory does not exist, or, if CREATE non-nil, cannot be
487 created. DIRECTORY may be a string or a cons pair of the form (REGEXP . DIR).
488 See `fast-lock-cache-directories'."
490 (cond ((not buffer-file-name)
491 ;; Should never be nil, but `crypt++' screws it up.
497 ;; A directory iff the file name matches the regexp.
498 (let ((bufile (expand-file-name buffer-file-truename))
499 (case-fold-search nil))
500 (when (save-match-data (string-match (car directory) bufile))
501 (cdr directory)))))))
504 ((file-accessible-directory-p dir)
508 (progn (make-directory dir t) dir)
511 ;; If you are wondering why we only hash if the directory is not ".", rather
512 ;; than if `file-name-absolute-p', it is because if we just appended ".flc" for
513 ;; relative cache directories (that are not ".") then it is possible that more
514 ;; than one file would have the same cache name in that directory, if the luser
515 ;; made a link from one relative cache directory to another. (Phew!)
516 (defun fast-lock-cache-name (directory)
517 "Return full cache path name using caching DIRECTORY.
518 If DIRECTORY is `.', the path is the buffer file name appended with `.flc'.
519 Otherwise, the path name is constructed from DIRECTORY and the buffer's true
520 abbreviated file name, with all `/' characters in the name replaced with `#'
521 characters, and appended with `.flc'.
523 If the same file has different cache path names when edited on different
524 machines, e.g., on one machine the cache file name has the prefix `#home',
525 perhaps due to automount, try putting in your `~/.emacs' something like:
527 (setq directory-abbrev-alist (cons '(\"^/home/\" . \"/\") directory-abbrev-alist))
529 Emacs automagically removes the common `/tmp_mnt' automount prefix by default.
531 See `fast-lock-cache-directory'."
532 (if (string-equal directory ".")
533 (concat buffer-file-name ".flc")
534 (let* ((bufile (expand-file-name buffer-file-truename))
537 ((eq system-type 'emx)
538 '((?/ . (?#)) (?# . (?# ?#)) (?: . (?\;)) (?\; . (?\; ?\;))))
539 ((eq system-type 'windows-nt)
540 '((?\\ . (?#)) (?# . (?# ?#)) (?: . (?\;)) (?\; . (?\; ?\;))))
542 '((?/ . (?#)) (?# . (?# ?#))))))
544 (function (lambda (c) (or (cdr (assq c chars-alist)) (list c))))))
546 (file-name-as-directory (expand-file-name directory))
547 (mapconcat 'char-to-string (apply 'append (mapcar mapchars bufile)) "")
550 ;; Font Lock Cache Processing Functions:
552 (defun fast-lock-save-cache-1 (file timestamp)
553 ;; Save the FILE with the TIMESTAMP as:
554 ;; (fast-lock-cache-data Version=2 TIMESTAMP font-lock-keywords PROPERTIES).
555 ;; Returns non-nil if a save was attempted to a writable cache file.
556 (let ((tpbuf (generate-new-buffer " *fast-lock*"))
557 (verbose (if (numberp fast-lock-verbose)
558 (> (buffer-size) fast-lock-verbose)
561 (if verbose (message "Saving %s font lock cache..." (buffer-name)))
564 (print (list 'fast-lock-cache-data 2
565 (list 'quote timestamp)
566 (list 'quote font-lock-keywords)
567 (list 'quote (fast-lock-get-face-properties)))
570 (write-region (point-min) (point-max) file nil 'quietly)
571 (setq fast-lock-cache-timestamp timestamp
572 fast-lock-cache-filename file))
573 (error (setq saved 'error)) (quit (setq saved 'quit)))
575 (if verbose (message "Saving %s font lock cache...%s" (buffer-name)
576 (cond ((eq saved 'error) "failed")
577 ((eq saved 'quit) "aborted")
579 ;; We return non-nil regardless of whether a failure occurred.
582 (defun fast-lock-cache-data (version timestamp keywords properties
584 ;; Change from (HIGH LOW) for back compatibility. Remove for version 3!
585 (when (consp (cdr-safe timestamp))
586 (setcdr timestamp (nth 1 timestamp)))
587 ;; Compile KEYWORDS and `font-lock-keywords' in case one is and one isn't.
588 (let ((current font-lock-keywords))
589 (setq keywords (font-lock-compile-keywords keywords)
590 font-lock-keywords (font-lock-compile-keywords current)))
591 ;; Use the Font Lock cache PROPERTIES if we're using cache VERSION format 2,
592 ;; the current buffer's file timestamp matches the TIMESTAMP, and the current
593 ;; buffer's font-lock-keywords are the same as KEYWORDS.
594 (let ((buf-timestamp (visited-file-modtime))
595 (verbose (if (numberp fast-lock-verbose)
596 (> (buffer-size) fast-lock-verbose)
599 (if (or (/= version 2)
601 (not (equal timestamp buf-timestamp))
602 (not (equal keywords font-lock-keywords)))
604 (if verbose (message "Loading %s font lock cache..." (buffer-name)))
606 (fast-lock-set-face-properties properties)
607 (error (setq loaded 'error)) (quit (setq loaded 'quit)))
608 (if verbose (message "Loading %s font lock cache...%s" (buffer-name)
609 (cond ((eq loaded 'error) "failed")
610 ((eq loaded 'quit) "aborted")
612 (setq font-lock-fontified (eq loaded t)
613 fast-lock-cache-timestamp (and (eq loaded t) timestamp))))
615 ;; Text Properties Processing Functions:
617 ;; This is fast, but fails if adjacent characters have different `face' text
618 ;; properties. Maybe that's why I dropped it in the first place?
619 ;(defun fast-lock-get-face-properties ()
620 ; "Return a list of all `face' text properties in the current buffer.
621 ;Each element of the list is of the form (VALUE START1 END1 START2 END2 ...)
622 ;where VALUE is a `face' property value and STARTx and ENDx are positions."
625 ; (let ((start (text-property-not-all (point-min) (point-max) 'face nil))
626 ; (limit (point-max)) end properties value cell)
628 ; (setq end (next-single-property-change start 'face nil limit)
629 ; value (get-text-property start 'face))
630 ; ;; Make, or add to existing, list of regions with same `face'.
631 ; (if (setq cell (assq value properties))
632 ; (setcdr cell (cons start (cons end (cdr cell))))
633 ; (setq properties (cons (list value start end) properties)))
634 ; (setq start (next-single-property-change end 'face)))
637 ;; This is slow, but copes if adjacent characters have different `face' text
638 ;; properties, but fails if they are lists.
639 ;(defun fast-lock-get-face-properties ()
640 ; "Return a list of all `face' text properties in the current buffer.
641 ;Each element of the list is of the form (VALUE START1 END1 START2 END2 ...)
642 ;where VALUE is a `face' property value and STARTx and ENDx are positions.
643 ;Only those `face' VALUEs in `fast-lock-save-faces' are returned."
646 ; (let ((faces (or fast-lock-save-faces (face-list))) (limit (point-max))
647 ; properties regions face start end)
649 ; (setq face (car faces) faces (cdr faces) regions () end (point-min))
650 ; ;; Make a list of start/end regions with `face' property face.
651 ; (while (setq start (text-property-any end limit 'face face))
652 ; (setq end (or (text-property-not-all start limit 'face face) limit)
653 ; regions (cons start (cons end regions))))
654 ; ;; Add `face' face's regions, if any, to properties.
656 ; (push (cons face regions) properties)))
659 (defun fast-lock-get-face-properties ()
660 "Return a list of all `face' text properties in the current buffer.
661 Each element of the list is of the form (VALUE START1 END1 START2 END2 ...)
662 where VALUE is a `face' property value and STARTx and ENDx are positions."
665 (let ((start (text-property-not-all (point-min) (point-max) 'face nil))
666 end properties value cell)
668 (setq end (next-single-property-change start 'face nil (point-max))
669 value (get-text-property start 'face))
670 ;; Make, or add to existing, list of regions with same `face'.
671 (cond ((setq cell (assoc value properties))
672 (setcdr cell (cons start (cons end (cdr cell)))))
673 ((fast-lock-save-facep value)
674 (push (list value start end) properties)))
675 (setq start (text-property-not-all end (point-max) 'face nil)))
678 (defun fast-lock-set-face-properties (properties)
679 "Set all `face' text properties to PROPERTIES in the current buffer.
680 Any existing `face' text properties are removed first.
681 See `fast-lock-get-face-properties' for the format of PROPERTIES."
682 (save-buffer-state (plist regions)
685 (font-lock-unfontify-region (point-min) (point-max))
687 (setq plist (list 'face (car (car properties)))
688 regions (cdr (car properties))
689 properties (cdr properties))
690 ;; Set the `face' property for each start/end region.
692 (set-text-properties (nth 0 regions) (nth 1 regions) plist)
693 (setq regions (nthcdr 2 regions)))))))
695 ;; Functions for XEmacs:
697 (when (save-match-data (string-match "XEmacs" (emacs-version)))
699 ;; It would be better to use XEmacs' `map-extents' over extents with a
700 ;; `font-lock' property, but `face' properties are on different extents.
701 (defun fast-lock-get-face-properties ()
702 "Return a list of all `face' text properties in the current buffer.
703 Each element of the list is of the form (VALUE START1 END1 START2 END2 ...)
704 where VALUE is a `face' property value and STARTx and ENDx are positions.
705 Only those `face' VALUEs in `fast-lock-save-faces' are returned."
708 (let ((properties ()) cell)
710 (function (lambda (extent ignore)
711 (let ((value (extent-face extent)))
712 ;; We're only interested if it's one of `fast-lock-save-faces'.
713 (when (and value (fast-lock-save-facep value))
714 (let ((start (extent-start-position extent))
715 (end (extent-end-position extent)))
716 ;; Make or add to existing list of regions with the same
717 ;; `face' property value.
718 (if (setq cell (assoc value properties))
719 (setcdr cell (cons start (cons end (cdr cell))))
720 (push (list value start end) properties))))
721 ;; Return nil to keep `map-extents' going.
725 ;; Make extents just like XEmacs' font-lock.el does.
726 (defun fast-lock-set-face-properties (properties)
727 "Set all `face' text properties to PROPERTIES in the current buffer.
728 Any existing `face' text properties are removed first.
729 See `fast-lock-get-face-properties' for the format of PROPERTIES."
732 (font-lock-unfontify-region (point-min) (point-max))
734 (let ((face (car (car properties)))
735 (regions (cdr (car properties))))
736 ;; Set the `face' property, etc., for each start/end region.
738 (font-lock-set-face (nth 0 regions) (nth 1 regions) face)
739 (setq regions (nthcdr 2 regions)))
740 (setq properties (cdr properties))))))
742 ;; XEmacs 19.12 font-lock.el's `font-lock-fontify-buffer' runs a hook.
743 (add-hook 'font-lock-after-fontify-buffer-hook
744 'fast-lock-after-fontify-buffer))
746 (unless (boundp 'font-lock-inhibit-thing-lock)
747 (defvar font-lock-inhibit-thing-lock nil
748 "List of Font Lock mode related modes that should not be turned on."))
750 (unless (fboundp 'font-lock-value-in-major-mode)
751 (defun font-lock-value-in-major-mode (alist)
752 ;; Return value in ALIST for `major-mode'.
754 (cdr (or (assq major-mode alist) (assq t alist)))
757 (unless (fboundp 'font-lock-compile-keywords)
758 (defalias 'font-lock-compile-keywords 'identity))
760 ;; Install ourselves:
762 (add-hook 'after-save-hook 'fast-lock-save-cache-after-save-file)
763 (add-hook 'kill-buffer-hook 'fast-lock-save-cache-before-kill-buffer)
764 (add-hook 'kill-emacs-hook 'fast-lock-save-caches-before-kill-emacs)
767 (when (fboundp 'add-minor-mode)
768 (defvar fast-lock-mode nil)
769 (add-minor-mode 'fast-lock-mode nil))
771 (unless (assq 'fast-lock-mode minor-mode-alist)
772 (setq minor-mode-alist (append minor-mode-alist '((fast-lock-mode nil)))))
774 ;; Provide ourselves:
778 ;;; fast-lock.el ends here