Commit | Line | Data |
---|---|---|
550bd514 | 1 | ;;; jka-cmpr-hook.el --- preloaded code to enable jka-compr.el |
216b5993 | 2 | |
fde4e97e | 3 | ;; Copyright (C) 1993, 1994, 1995, 1997, 1999, 2000, 2002, 2003, |
409cc4a3 | 4 | ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
216b5993 RS |
5 | |
6 | ;; Author: jka@ece.cmu.edu (Jay K. Adams) | |
7 | ;; Maintainer: FSF | |
8 | ;; Keywords: data | |
9 | ||
10 | ;; This file is part of GNU Emacs. | |
11 | ||
12 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 | ;; it under the terms of the GNU General Public License as published by | |
b4aa6026 | 14 | ;; the Free Software Foundation; either version 3, or (at your option) |
216b5993 RS |
15 | ;; any later version. |
16 | ||
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
086add15 LK |
24 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
25 | ;; Boston, MA 02110-1301, USA. | |
216b5993 RS |
26 | |
27 | ;;; Commentary: | |
28 | ||
ea8e0537 | 29 | ;; This file contains the code to enable and disable Auto-Compression mode. |
216b5993 RS |
30 | ;; It is preloaded. The guts of this mode are in jka-compr.el, which |
31 | ;; is loaded only when you really try to uncompress something. | |
32 | ||
33 | ;;; Code: | |
34 | ||
35 | (defgroup compression nil | |
7ae4587b | 36 | "Data compression utilities." |
216b5993 RS |
37 | :group 'data) |
38 | ||
39 | (defgroup jka-compr nil | |
7ae4587b | 40 | "jka-compr customization." |
216b5993 RS |
41 | :group 'compression) |
42 | ||
216b5993 RS |
43 | ;; List of all the elements we actually added to file-coding-system-alist. |
44 | (defvar jka-compr-added-to-file-coding-system-alist nil) | |
45 | ||
46 | (defvar jka-compr-file-name-handler-entry | |
47 | nil | |
ea8e0537 LT |
48 | "`file-name-handler-alist' entry used by jka-compr I/O functions.") |
49 | ||
50 | ;; Compiler defvars. These three variables will be defined later with | |
51 | ;; `defcustom' when everything used in the :set functions is defined. | |
52 | (defvar jka-compr-compression-info-list) | |
53 | (defvar jka-compr-mode-alist-additions) | |
54 | (defvar jka-compr-load-suffixes) | |
55 | ||
56 | (defvar jka-compr-compression-info-list--internal nil | |
57 | "Stored value of `jka-compr-compression-info-list'. | |
58 | If Auto Compression mode is enabled, this is the value of | |
59 | `jka-compr-compression-info-list' when `jka-compr-install' was last called. | |
60 | Otherwise, it is nil.") | |
61 | ||
62 | (defvar jka-compr-mode-alist-additions--internal nil | |
63 | "Stored value of `jka-compr-mode-alist-additions'. | |
64 | If Auto Compression mode is enabled, this is the value of | |
65 | `jka-compr-mode-alist-additions' when `jka-compr-install' was last called. | |
66 | Otherwise, it is nil.") | |
67 | ||
68 | (defvar jka-compr-load-suffixes--internal nil | |
69 | "Stored value of `jka-compr-load-suffixes'. | |
70 | If Auto Compression mode is enabled, this is the value of | |
71 | `jka-compr-load-suffixes' when `jka-compr-install' was last called. | |
72 | Otherwise, it is nil.") | |
73 | ||
216b5993 RS |
74 | \f |
75 | (defun jka-compr-build-file-regexp () | |
76 | (mapconcat | |
77 | 'jka-compr-info-regexp | |
78 | jka-compr-compression-info-list | |
79 | "\\|")) | |
80 | ||
be93a2c4 | 81 | ;; Functions for accessing the return value of jka-compr-get-compression-info |
216b5993 RS |
82 | (defun jka-compr-info-regexp (info) (aref info 0)) |
83 | (defun jka-compr-info-compress-message (info) (aref info 1)) | |
84 | (defun jka-compr-info-compress-program (info) (aref info 2)) | |
85 | (defun jka-compr-info-compress-args (info) (aref info 3)) | |
86 | (defun jka-compr-info-uncompress-message (info) (aref info 4)) | |
87 | (defun jka-compr-info-uncompress-program (info) (aref info 5)) | |
88 | (defun jka-compr-info-uncompress-args (info) (aref info 6)) | |
89 | (defun jka-compr-info-can-append (info) (aref info 7)) | |
90 | (defun jka-compr-info-strip-extension (info) (aref info 8)) | |
91 | (defun jka-compr-info-file-magic-bytes (info) (aref info 9)) | |
92 | ||
93 | ||
94 | (defun jka-compr-get-compression-info (filename) | |
95 | "Return information about the compression scheme of FILENAME. | |
96 | The determination as to which compression scheme, if any, to use is | |
97 | based on the filename itself and `jka-compr-compression-info-list'." | |
98 | (catch 'compression-info | |
99 | (let ((case-fold-search nil)) | |
6d2d1b7d | 100 | (mapc |
216b5993 RS |
101 | (function (lambda (x) |
102 | (and (string-match (jka-compr-info-regexp x) filename) | |
103 | (throw 'compression-info x)))) | |
104 | jka-compr-compression-info-list) | |
105 | nil))) | |
106 | ||
107 | (defun jka-compr-install () | |
108 | "Install jka-compr. | |
109 | This adds entries to `file-name-handler-alist' and `auto-mode-alist' | |
110 | and `inhibit-first-line-modes-suffixes'." | |
111 | ||
112 | (setq jka-compr-file-name-handler-entry | |
113 | (cons (jka-compr-build-file-regexp) 'jka-compr-handler)) | |
114 | ||
be93a2c4 SM |
115 | (push jka-compr-file-name-handler-entry file-name-handler-alist) |
116 | ||
ea8e0537 LT |
117 | (setq jka-compr-compression-info-list--internal |
118 | jka-compr-compression-info-list | |
119 | jka-compr-mode-alist-additions--internal | |
120 | jka-compr-mode-alist-additions | |
121 | jka-compr-load-suffixes--internal | |
122 | jka-compr-load-suffixes) | |
123 | ||
be93a2c4 SM |
124 | (dolist (x jka-compr-compression-info-list) |
125 | ;; Don't do multibyte encoding on the compressed files. | |
126 | (let ((elt (cons (jka-compr-info-regexp x) | |
127 | '(no-conversion . no-conversion)))) | |
128 | (push elt file-coding-system-alist) | |
129 | (push elt jka-compr-added-to-file-coding-system-alist)) | |
130 | ||
131 | (and (jka-compr-info-strip-extension x) | |
132 | ;; Make entries in auto-mode-alist so that modes | |
133 | ;; are chosen right according to the file names | |
134 | ;; sans `.gz'. | |
135 | (push (list (jka-compr-info-regexp x) nil 'jka-compr) auto-mode-alist) | |
136 | ;; Also add these regexps to | |
137 | ;; inhibit-first-line-modes-suffixes, so that a | |
138 | ;; -*- line in the first file of a compressed tar | |
139 | ;; file doesn't override tar-mode. | |
140 | (push (jka-compr-info-regexp x) | |
141 | inhibit-first-line-modes-suffixes))) | |
216b5993 RS |
142 | (setq auto-mode-alist |
143 | (append auto-mode-alist jka-compr-mode-alist-additions)) | |
144 | ||
145 | ;; Make sure that (load "foo") will find /bla/foo.el.gz. | |
ea8e0537 LT |
146 | (setq load-file-rep-suffixes |
147 | (append load-file-rep-suffixes jka-compr-load-suffixes nil))) | |
216b5993 RS |
148 | |
149 | (defun jka-compr-installed-p () | |
150 | "Return non-nil if jka-compr is installed. | |
151 | The return value is the entry in `file-name-handler-alist' for jka-compr." | |
152 | ||
153 | (let ((fnha file-name-handler-alist) | |
154 | (installed nil)) | |
155 | ||
156 | (while (and fnha (not installed)) | |
157 | (and (eq (cdr (car fnha)) 'jka-compr-handler) | |
158 | (setq installed (car fnha))) | |
159 | (setq fnha (cdr fnha))) | |
160 | ||
161 | installed)) | |
162 | ||
ea8e0537 LT |
163 | (defun jka-compr-update () |
164 | "Update Auto Compression mode for changes in option values. | |
165 | If you change the options `jka-compr-compression-info-list', | |
166 | `jka-compr-mode-alist-additions' or `jka-compr-load-suffixes' | |
167 | outside Custom, while Auto Compression mode is already enabled | |
168 | \(as it is by default), then you have to call this function | |
169 | afterward to properly update other variables. Setting these | |
170 | options through Custom does this automatically." | |
171 | (when (jka-compr-installed-p) | |
172 | (jka-compr-uninstall) | |
173 | (jka-compr-install))) | |
174 | ||
175 | (defun jka-compr-set (variable value) | |
176 | "Internal Custom :set function." | |
177 | (set-default variable value) | |
178 | (jka-compr-update)) | |
179 | ||
df66263e LT |
180 | ;; I have this defined so that .Z files are assumed to be in unix |
181 | ;; compress format; and .gz files, in gzip format, and .bz2 files in bzip fmt. | |
a16b6564 GM |
182 | |
183 | ;; FIXME? It seems ugly that one has to add "\\(~\\|\\.~[0-9]+~\\)?" to | |
184 | ;; all the regexps here, in order to match backup files etc. | |
185 | ;; It's trivial to modify jka-compr-get-compression-info to match | |
186 | ;; regexps against file-name-sans-versions, but this regexp is also | |
187 | ;; used to build a file-name-handler-alist entry. | |
188 | ;; find-file-name-handler does not use file-name-sans-versions. | |
189 | ;; Perhaps it should, | |
190 | ;; http://lists.gnu.org/archive/html/emacs-devel/2008-02/msg00812.html, | |
191 | ;; but it's used all over the place and there are probably other ramifications. | |
192 | ;; One could modify jka-compr-build-file-regexp to add the backup regexp, | |
193 | ;; but jka-compr-compression-info-list is a defcustom to which | |
194 | ;; anything could be added, so it's easiest to leave things as they are. | |
df66263e LT |
195 | (defcustom jka-compr-compression-info-list |
196 | ;;[regexp | |
197 | ;; compr-message compr-prog compr-args | |
198 | ;; uncomp-message uncomp-prog uncomp-args | |
5b668628 | 199 | ;; can-append strip-extension-flag file-magic-bytes] |
df66263e LT |
200 | '(["\\.Z\\(~\\|\\.~[0-9]+~\\)?\\'" |
201 | "compressing" "compress" ("-c") | |
13c8188a | 202 | ;; gzip is more common than uncompress. It can only read, not write. |
aad96659 | 203 | "uncompressing" "gzip" ("-c" "-q" "-d") |
df66263e LT |
204 | nil t "\037\235"] |
205 | ;; Formerly, these had an additional arg "-c", but that fails with | |
206 | ;; "Version 0.1pl2, 29-Aug-97." (RedHat 5.1 GNU/Linux) and | |
207 | ;; "Version 0.9.0b, 9-Sept-98". | |
73c03f76 | 208 | ["\\.bz2\\(~\\|\\.~[0-9]+~\\)?\\'" |
df66263e LT |
209 | "bzip2ing" "bzip2" nil |
210 | "bunzip2ing" "bzip2" ("-d") | |
211 | nil t "BZh"] | |
212 | ["\\.tbz\\'" | |
213 | "bzip2ing" "bzip2" nil | |
214 | "bunzip2ing" "bzip2" ("-d") | |
215 | nil nil "BZh"] | |
14414dd3 | 216 | ["\\.\\(?:tgz\\|svgz\\|sifz\\)\\(~\\|\\.~[0-9]+~\\)?\\'" |
df66263e LT |
217 | "compressing" "gzip" ("-c" "-q") |
218 | "uncompressing" "gzip" ("-c" "-q" "-d") | |
219 | t nil "\037\213"] | |
220 | ["\\.g?z\\(~\\|\\.~[0-9]+~\\)?\\'" | |
221 | "compressing" "gzip" ("-c" "-q") | |
222 | "uncompressing" "gzip" ("-c" "-q" "-d") | |
223 | t t "\037\213"] | |
224 | ;; dzip is gzip with random access. Its compression program can't | |
225 | ;; read/write stdin/out, so .dz files can only be viewed without | |
226 | ;; saving, having their contents decompressed with gzip. | |
227 | ["\\.dz\\'" | |
228 | nil nil nil | |
229 | "uncompressing" "gzip" ("-c" "-q" "-d") | |
230 | nil t "\037\213"]) | |
231 | ||
232 | "List of vectors that describe available compression techniques. | |
233 | Each element, which describes a compression technique, is a vector of | |
234 | the form [REGEXP COMPRESS-MSG COMPRESS-PROGRAM COMPRESS-ARGS | |
235 | UNCOMPRESS-MSG UNCOMPRESS-PROGRAM UNCOMPRESS-ARGS | |
236 | APPEND-FLAG STRIP-EXTENSION-FLAG FILE-MAGIC-CHARS], where: | |
237 | ||
238 | regexp is a regexp that matches filenames that are | |
239 | compressed with this format | |
240 | ||
241 | compress-msg is the message to issue to the user when doing this | |
242 | type of compression (nil means no message) | |
243 | ||
244 | compress-program is a program that performs this compression | |
245 | (nil means visit file in read-only mode) | |
246 | ||
247 | compress-args is a list of args to pass to the compress program | |
248 | ||
249 | uncompress-msg is the message to issue to the user when doing this | |
250 | type of uncompression (nil means no message) | |
251 | ||
252 | uncompress-program is a program that performs this compression | |
253 | ||
254 | uncompress-args is a list of args to pass to the uncompress program | |
255 | ||
256 | append-flag is non-nil if this compression technique can be | |
257 | appended | |
258 | ||
259 | strip-extension-flag non-nil means strip the regexp from file names | |
260 | before attempting to set the mode. | |
261 | ||
262 | file-magic-chars is a string of characters that you would find | |
263 | at the beginning of a file compressed in this way. | |
264 | ||
df66263e LT |
265 | If you set this outside Custom while Auto Compression mode is |
266 | already enabled \(as it is by default), you have to call | |
267 | `jka-compr-update' after setting it to properly update other | |
268 | variables. Setting this through Custom does that automatically." | |
269 | :type '(repeat (vector regexp | |
270 | (choice :tag "Compress Message" | |
271 | (string :format "%v") | |
272 | (const :tag "No Message" nil)) | |
273 | (choice :tag "Compress Program" | |
274 | (string) | |
275 | (const :tag "None" nil)) | |
276 | (repeat :tag "Compress Arguments" string) | |
277 | (choice :tag "Uncompress Message" | |
278 | (string :format "%v") | |
279 | (const :tag "No Message" nil)) | |
280 | (choice :tag "Uncompress Program" | |
281 | (string) | |
282 | (const :tag "None" nil)) | |
283 | (repeat :tag "Uncompress Arguments" string) | |
284 | (boolean :tag "Append") | |
285 | (boolean :tag "Strip Extension") | |
286 | (string :tag "Magic Bytes"))) | |
287 | :set 'jka-compr-set | |
288 | :group 'jka-compr) | |
289 | ||
290 | (defcustom jka-compr-mode-alist-additions | |
291 | (list (cons "\\.tgz\\'" 'tar-mode) (cons "\\.tbz\\'" 'tar-mode)) | |
292 | "List of pairs added to `auto-mode-alist' when installing jka-compr. | |
293 | Uninstalling jka-compr removes all pairs from `auto-mode-alist' that | |
294 | installing added. | |
295 | ||
296 | If you set this outside Custom while Auto Compression mode is | |
297 | already enabled \(as it is by default), you have to call | |
298 | `jka-compr-update' after setting it to properly update other | |
299 | variables. Setting this through Custom does that automatically." | |
300 | :type '(repeat (cons string symbol)) | |
301 | :set 'jka-compr-set | |
302 | :group 'jka-compr) | |
303 | ||
304 | (defcustom jka-compr-load-suffixes '(".gz") | |
305 | "List of compression related suffixes to try when loading files. | |
306 | Enabling Auto Compression mode appends this list to `load-file-rep-suffixes', | |
307 | which see. Disabling Auto Compression mode removes all suffixes | |
308 | from `load-file-rep-suffixes' that enabling added. | |
309 | ||
310 | If you set this outside Custom while Auto Compression mode is | |
311 | already enabled \(as it is by default), you have to call | |
312 | `jka-compr-update' after setting it to properly update other | |
313 | variables. Setting this through Custom does that automatically." | |
314 | :type '(repeat string) | |
315 | :set 'jka-compr-set | |
316 | :group 'jka-compr) | |
317 | ||
216b5993 RS |
318 | (define-minor-mode auto-compression-mode |
319 | "Toggle automatic file compression and uncompression. | |
320 | With prefix argument ARG, turn auto compression on if positive, else off. | |
ea8e0537 | 321 | Return the new status of auto compression (non-nil means on)." |
e64a3dcf | 322 | :global t :init-value t :group 'jka-compr :version "22.1" |
216b5993 RS |
323 | (let* ((installed (jka-compr-installed-p)) |
324 | (flag auto-compression-mode)) | |
325 | (cond | |
326 | ((and flag installed) t) ; already installed | |
327 | ((and (not flag) (not installed)) nil) ; already not installed | |
328 | (flag (jka-compr-install)) | |
329 | (t (jka-compr-uninstall))))) | |
330 | ||
331 | (defmacro with-auto-compression-mode (&rest body) | |
332 | "Evalute BODY with automatic file compression and uncompression enabled." | |
333 | (let ((already-installed (make-symbol "already-installed"))) | |
334 | `(let ((,already-installed (jka-compr-installed-p))) | |
335 | (unwind-protect | |
336 | (progn | |
337 | (unless ,already-installed | |
338 | (jka-compr-install)) | |
339 | ,@body) | |
340 | (unless ,already-installed | |
341 | (jka-compr-uninstall)))))) | |
342 | (put 'with-auto-compression-mode 'lisp-indent-function 0) | |
343 | ||
344 | ||
be93a2c4 SM |
345 | ;; This is what we need to know about jka-compr-handler |
346 | ;; in order to decide when to call it. | |
216b5993 RS |
347 | |
348 | (put 'jka-compr-handler 'safe-magic t) | |
9c40111a | 349 | (put 'jka-compr-handler 'operations '(byte-compiler-base-file-name |
216b5993 RS |
350 | write-region insert-file-contents |
351 | file-local-copy load)) | |
352 | ||
be93a2c4 | 353 | ;; Turn on the mode. |
12d94429 | 354 | (when auto-compression-mode (auto-compression-mode 1)) |
216b5993 | 355 | |
550bd514 | 356 | (provide 'jka-cmpr-hook) |
216b5993 | 357 | |
b21eabf6 | 358 | ;; arch-tag: 4bd73429-f400-45fe-a065-270a113e31a8 |
550bd514 | 359 | ;;; jka-cmpr-hook.el ends here |