Commit | Line | Data |
---|---|---|
be010748 RS |
1 | ;;; jka-compr.el --- reading/writing/loading compressed files |
2 | ||
d7c33854 | 3 | ;; Copyright (C) 1993, 1994, 1995, 1997, 1999, 2000, 2003 Free Software Foundation, Inc. |
acd622cc RS |
4 | |
5 | ;; Author: jka@ece.cmu.edu (Jay K. Adams) | |
4228277d | 6 | ;; Maintainer: FSF |
acd622cc RS |
7 | ;; Keywords: data |
8 | ||
f4454a14 RS |
9 | ;; This file is part of GNU Emacs. |
10 | ||
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) | |
14 | ;; any later version. | |
15 | ||
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. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
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. | |
f4454a14 | 25 | |
55535639 | 26 | ;;; Commentary: |
acd622cc | 27 | |
b578f267 EN |
28 | ;; This package implements low-level support for reading, writing, |
29 | ;; and loading compressed files. It hooks into the low-level file | |
30 | ;; I/O functions (including write-region and insert-file-contents) so | |
31 | ;; that they automatically compress or uncompress a file if the file | |
32 | ;; appears to need it (based on the extension of the file name). | |
33 | ;; Packages like Rmail, VM, GNUS, and Info should be able to work | |
34 | ;; with compressed files without modification. | |
35 | ||
36 | ||
37 | ;; INSTRUCTIONS: | |
38 | ;; | |
7391213d MB |
39 | ;; To use jka-compr, invoke the command `auto-compression-mode' (which |
40 | ;; see), or customize the variable of the same name. Its operation | |
41 | ;; should be transparent to the user (except for messages appearing when | |
42 | ;; a file is being compressed or uncompressed). | |
b578f267 EN |
43 | ;; |
44 | ;; The variable, jka-compr-compression-info-list can be used to | |
45 | ;; customize jka-compr to work with other compression programs. | |
46 | ;; The default value of this variable allows jka-compr to work with | |
47 | ;; Unix compress and gzip. | |
48 | ;; | |
49 | ;; If you are concerned about the stderr output of gzip and other | |
50 | ;; compression/decompression programs showing up in your buffers, you | |
51 | ;; should set the discard-error flag in the compression-info-list. | |
52 | ;; This will cause the stderr of all programs to be discarded. | |
53 | ;; However, it also causes emacs to call compression/uncompression | |
54 | ;; programs through a shell (which is specified by jka-compr-shell). | |
55 | ;; This may be a drag if, on your system, starting up a shell is | |
56 | ;; slow. | |
57 | ;; | |
58 | ;; If you don't want messages about compressing and decompressing | |
59 | ;; to show up in the echo area, you can set the compress-name and | |
60 | ;; decompress-name fields of the jka-compr-compression-info-list to | |
61 | ;; nil. | |
62 | ||
63 | ||
64 | ;; APPLICATION NOTES: | |
65 | ;; | |
66 | ;; crypt++ | |
5f320490 | 67 | ;; jka-compr can coexist with crypt++ if you take all the decompression |
b578f267 EN |
68 | ;; entries out of the crypt-encoding-list. Clearly problems will arise if |
69 | ;; you have two programs trying to compress/decompress files. jka-compr | |
70 | ;; will not "work with" crypt++ in the following sense: you won't be able to | |
71 | ;; decode encrypted compressed files--that is, files that have been | |
72 | ;; compressed then encrypted (in that order). Theoretically, crypt++ and | |
73 | ;; jka-compr could properly handle a file that has been encrypted then | |
74 | ;; compressed, but there is little point in trying to compress an encrypted | |
75 | ;; file. | |
76 | ;; | |
77 | ||
78 | ||
79 | ;; ACKNOWLEDGMENTS | |
f1180544 | 80 | ;; |
b578f267 | 81 | ;; jka-compr is a V19 adaptation of jka-compr for V18 of Emacs. Many people |
f1180544 | 82 | ;; have made helpful suggestions, reported bugs, and even fixed bugs in |
b578f267 EN |
83 | ;; jka-compr. I recall the following people as being particularly helpful. |
84 | ;; | |
85 | ;; Jean-loup Gailly | |
86 | ;; David Hughes | |
87 | ;; Richard Pieri | |
88 | ;; Daniel Quinlan | |
89 | ;; Chris P. Ross | |
90 | ;; Rick Sladkey | |
91 | ;; | |
92 | ;; Andy Norman's ange-ftp was the inspiration for the original jka-compr for | |
93 | ;; Version 18 of Emacs. | |
94 | ;; | |
95 | ;; After I had made progress on the original jka-compr for V18, I learned of a | |
96 | ;; package written by Kazushi Jam Marukawa, called jam-zcat, that did exactly | |
97 | ;; what I was trying to do. I looked over the jam-zcat source code and | |
98 | ;; probably got some ideas from it. | |
99 | ;; | |
acd622cc RS |
100 | |
101 | ;;; Code: | |
102 | ||
bbf5eb28 RS |
103 | (defgroup compression nil |
104 | "Data compression utilities" | |
105 | :group 'data) | |
106 | ||
107 | (defgroup jka-compr nil | |
108 | "jka-compr customization" | |
109 | :group 'compression) | |
110 | ||
111 | ||
112 | (defcustom jka-compr-shell "sh" | |
acd622cc RS |
113 | "*Shell to be used for calling compression programs. |
114 | The value of this variable only matters if you want to discard the | |
115 | stderr of a compression/decompression program (see the documentation | |
bbf5eb28 RS |
116 | for `jka-compr-compression-info-list')." |
117 | :type 'string | |
118 | :group 'jka-compr) | |
acd622cc | 119 | |
f1180544 | 120 | (defvar jka-compr-use-shell |
eb915452 | 121 | (not (memq system-type '(ms-dos windows-nt)))) |
acd622cc RS |
122 | |
123 | ;;; I have this defined so that .Z files are assumed to be in unix | |
060c3cc9 | 124 | ;;; compress format; and .gz files, in gzip format, and .bz2 files in bzip fmt. |
bbf5eb28 | 125 | (defcustom jka-compr-compression-info-list |
acd622cc | 126 | ;;[regexp |
ede9c6a8 RS |
127 | ;; compr-message compr-prog compr-args |
128 | ;; uncomp-message uncomp-prog uncomp-args | |
e073a356 | 129 | ;; can-append auto-mode-flag strip-extension-flag file-magic-bytes] |
094cf604 | 130 | '(["\\.Z\\(~\\|\\.~[0-9]+~\\)?\\'" |
acd622cc RS |
131 | "compressing" "compress" ("-c") |
132 | "uncompressing" "uncompress" ("-c") | |
e073a356 | 133 | nil t "\037\235"] |
df312987 DL |
134 | ;; Formerly, these had an additional arg "-c", but that fails with |
135 | ;; "Version 0.1pl2, 29-Aug-97." (RedHat 5.1 GNU/Linux) and | |
136 | ;; "Version 0.9.0b, 9-Sept-98". | |
060c3cc9 | 137 | ["\\.bz2\\'" |
df312987 DL |
138 | "bzip2ing" "bzip2" nil |
139 | "bunzip2ing" "bzip2" ("-d") | |
e073a356 | 140 | nil t "BZh"] |
74b2c737 RS |
141 | ["\\.tgz\\'" |
142 | "zipping" "gzip" ("-c" "-q") | |
143 | "unzipping" "gzip" ("-c" "-q" "-d") | |
e073a356 | 144 | t nil "\037\213"] |
0166aed1 | 145 | ["\\.g?z\\(~\\|\\.~[0-9]+~\\)?\\'" |
acd622cc RS |
146 | "zipping" "gzip" ("-c" "-q") |
147 | "unzipping" "gzip" ("-c" "-q" "-d") | |
e073a356 | 148 | t t "\037\213"]) |
acd622cc RS |
149 | |
150 | "List of vectors that describe available compression techniques. | |
151 | Each element, which describes a compression technique, is a vector of | |
ede9c6a8 RS |
152 | the form [REGEXP COMPRESS-MSG COMPRESS-PROGRAM COMPRESS-ARGS |
153 | UNCOMPRESS-MSG UNCOMPRESS-PROGRAM UNCOMPRESS-ARGS | |
e073a356 | 154 | APPEND-FLAG STRIP-EXTENSION-FLAG FILE-MAGIC-CHARS], where: |
acd622cc RS |
155 | |
156 | regexp is a regexp that matches filenames that are | |
157 | compressed with this format | |
158 | ||
ede9c6a8 RS |
159 | compress-msg is the message to issue to the user when doing this |
160 | type of compression (nil means no message) | |
161 | ||
acd622cc RS |
162 | compress-program is a program that performs this compression |
163 | ||
164 | compress-args is a list of args to pass to the compress program | |
165 | ||
ede9c6a8 RS |
166 | uncompress-msg is the message to issue to the user when doing this |
167 | type of uncompression (nil means no message) | |
acd622cc RS |
168 | |
169 | uncompress-program is a program that performs this compression | |
170 | ||
171 | uncompress-args is a list of args to pass to the uncompress program | |
172 | ||
173 | append-flag is non-nil if this compression technique can be | |
174 | appended | |
175 | ||
e073a356 | 176 | strip-extension-flag non-nil means strip the regexp from file names |
acd622cc RS |
177 | before attempting to set the mode. |
178 | ||
e073a356 RS |
179 | file-magic-chars is a string of characters that you would find |
180 | at the beginning of a file compressed in this way. | |
181 | ||
8fb1a583 | 182 | Because of the way `call-process' is defined, discarding the stderr output of |
acd622cc | 183 | a program adds the overhead of starting a shell each time the program is |
bbf5eb28 RS |
184 | invoked." |
185 | :type '(repeat (vector regexp | |
186 | (choice :tag "Compress Message" | |
187 | (string :format "%v") | |
188 | (const :tag "No Message" nil)) | |
189 | (string :tag "Compress Program") | |
190 | (repeat :tag "Compress Arguments" string) | |
191 | (choice :tag "Uncompress Message" | |
192 | (string :format "%v") | |
193 | (const :tag "No Message" nil)) | |
194 | (string :tag "Uncompress Program") | |
195 | (repeat :tag "Uncompress Arguments" string) | |
196 | (boolean :tag "Append") | |
a3fdb58a DL |
197 | (boolean :tag "Strip Extension") |
198 | (string :tag "Magic Bytes"))) | |
bbf5eb28 | 199 | :group 'jka-compr) |
acd622cc | 200 | |
242d2673 | 201 | (defcustom jka-compr-mode-alist-additions |
74b2c737 | 202 | (list (cons "\\.tgz\\'" 'tar-mode)) |
242d2673 RS |
203 | "A list of pairs to add to `auto-mode-alist' when jka-compr is installed." |
204 | :type '(repeat (cons string symbol)) | |
205 | :group 'jka-compr) | |
4eec33ae | 206 | |
242d2673 RS |
207 | (defcustom jka-compr-load-suffixes '(".gz") |
208 | "List of suffixes to try when loading files." | |
209 | :type '(repeat string) | |
210 | :group 'jka-compr) | |
aab8a6e3 | 211 | |
4eec33ae RS |
212 | ;; List of all the elements we actually added to file-coding-system-alist. |
213 | (defvar jka-compr-added-to-file-coding-system-alist nil) | |
acd622cc | 214 | |
555235e6 RS |
215 | (defvar jka-compr-file-name-handler-entry |
216 | nil | |
217 | "The entry in `file-name-handler-alist' used by the jka-compr I/O functions.") | |
e073a356 RS |
218 | |
219 | (defvar jka-compr-really-do-compress nil | |
220 | "Non-nil in a buffer whose visited file was uncompressed on visiting it.") | |
221 | (put 'jka-compr-really-do-compress 'permanent-local t) | |
555235e6 | 222 | \f |
43a3bdcc | 223 | ;;; Functions for accessing the return value of jka-compr-get-compression-info |
acd622cc RS |
224 | (defun jka-compr-info-regexp (info) (aref info 0)) |
225 | (defun jka-compr-info-compress-message (info) (aref info 1)) | |
226 | (defun jka-compr-info-compress-program (info) (aref info 2)) | |
227 | (defun jka-compr-info-compress-args (info) (aref info 3)) | |
228 | (defun jka-compr-info-uncompress-message (info) (aref info 4)) | |
229 | (defun jka-compr-info-uncompress-program (info) (aref info 5)) | |
230 | (defun jka-compr-info-uncompress-args (info) (aref info 6)) | |
231 | (defun jka-compr-info-can-append (info) (aref info 7)) | |
232 | (defun jka-compr-info-strip-extension (info) (aref info 8)) | |
e073a356 | 233 | (defun jka-compr-info-file-magic-bytes (info) (aref info 9)) |
acd622cc RS |
234 | |
235 | ||
236 | (defun jka-compr-get-compression-info (filename) | |
237 | "Return information about the compression scheme of FILENAME. | |
238 | The determination as to which compression scheme, if any, to use is | |
99bee6a4 | 239 | based on the filename itself and `jka-compr-compression-info-list'." |
acd622cc RS |
240 | (catch 'compression-info |
241 | (let ((case-fold-search nil)) | |
242 | (mapcar | |
243 | (function (lambda (x) | |
244 | (and (string-match (jka-compr-info-regexp x) filename) | |
245 | (throw 'compression-info x)))) | |
246 | jka-compr-compression-info-list) | |
247 | nil))) | |
248 | ||
249 | ||
250 | (put 'compression-error 'error-conditions '(compression-error file-error error)) | |
251 | ||
252 | ||
30c78e11 | 253 | (defvar jka-compr-acceptable-retval-list '(0 2 141)) |
acd622cc RS |
254 | |
255 | ||
256 | (defun jka-compr-error (prog args infile message &optional errfile) | |
257 | ||
258 | (let ((errbuf (get-buffer-create " *jka-compr-error*")) | |
259 | (curbuf (current-buffer))) | |
75e9c107 RS |
260 | (with-current-buffer errbuf |
261 | (widen) (erase-buffer) | |
262 | (insert (format "Error while executing \"%s %s < %s\"\n\n" | |
263 | prog | |
264 | (mapconcat 'identity args " ") | |
265 | infile)) | |
266 | ||
267 | (and errfile | |
268 | (insert-file-contents errfile))) | |
acd622cc RS |
269 | (display-buffer errbuf)) |
270 | ||
75e9c107 RS |
271 | (signal 'compression-error |
272 | (list "Opening input file" (format "error %s" message) infile))) | |
f1180544 JB |
273 | |
274 | ||
242d2673 RS |
275 | (defcustom jka-compr-dd-program "/bin/dd" |
276 | "How to invoke `dd'." | |
277 | :type 'string | |
278 | :group 'jka-compr) | |
acd622cc RS |
279 | |
280 | ||
dfe05fac | 281 | (defvar jka-compr-dd-blocksize 256) |
acd622cc RS |
282 | |
283 | ||
284 | (defun jka-compr-partial-uncompress (prog message args infile beg len) | |
285 | "Call program PROG with ARGS args taking input from INFILE. | |
286 | Fourth and fifth args, BEG and LEN, specify which part of the output | |
ee139ed3 | 287 | to keep: LEN chars starting BEG chars from the beginning." |
242d2673 RS |
288 | (let ((start (point)) |
289 | (prefix beg)) | |
290 | (if (and jka-compr-use-shell jka-compr-dd-program) | |
291 | ;; Put the uncompression output through dd | |
292 | ;; to discard the part we don't want. | |
293 | (let ((skip (/ beg jka-compr-dd-blocksize)) | |
294 | (err-file (jka-compr-make-temp-name)) | |
295 | count) | |
296 | ;; Update PREFIX based on the text that we won't read in. | |
297 | (setq prefix (- beg (* skip jka-compr-dd-blocksize)) | |
298 | count (and len (1+ (/ (+ len prefix) jka-compr-dd-blocksize)))) | |
299 | (unwind-protect | |
300 | (or (memq (call-process | |
301 | jka-compr-shell infile t nil "-c" | |
302 | (format | |
152e2693 | 303 | "%s %s 2> %s | %s bs=%d skip=%d %s 2> %s" |
242d2673 RS |
304 | prog |
305 | (mapconcat 'identity args " ") | |
306 | err-file | |
307 | jka-compr-dd-program | |
308 | jka-compr-dd-blocksize | |
309 | skip | |
310 | ;; dd seems to be unreliable about | |
311 | ;; providing the last block. So, always | |
312 | ;; read one more than you think you need. | |
152e2693 EZ |
313 | (if count (format "count=%d" (1+ count)) "") |
314 | null-device)) | |
242d2673 RS |
315 | jka-compr-acceptable-retval-list) |
316 | (jka-compr-error prog args infile message err-file)) | |
317 | (jka-compr-delete-temp-file err-file))) | |
318 | ;; Run the uncompression program directly. | |
319 | ;; We get the whole file and must delete what we don't want. | |
320 | (jka-compr-call-process prog message infile t nil args)) | |
acd622cc | 321 | |
ee139ed3 | 322 | ;; Delete the stuff after what we want, if there is any. |
acd622cc | 323 | (and |
dfe05fac | 324 | len |
ee139ed3 | 325 | (< (+ start prefix len) (point)) |
dfe05fac | 326 | (delete-region (+ start prefix len) (point))) |
acd622cc | 327 | |
ee139ed3 | 328 | ;; Delete the stuff before what we want. |
acd622cc RS |
329 | (delete-region start (+ start prefix)))) |
330 | ||
331 | ||
332 | (defun jka-compr-call-process (prog message infile output temp args) | |
333 | (if jka-compr-use-shell | |
334 | ||
a81635fc | 335 | (let ((err-file (jka-compr-make-temp-name)) |
baefb016 | 336 | (coding-system-for-read (or coding-system-for-read 'undecided)) |
70c7850e | 337 | (coding-system-for-write 'no-conversion)) |
a81635fc | 338 | |
acd622cc RS |
339 | (unwind-protect |
340 | ||
341 | (or (memq | |
342 | (call-process jka-compr-shell infile | |
343 | (if (stringp output) nil output) | |
344 | nil | |
345 | "-c" | |
346 | (format "%s %s 2> %s %s" | |
347 | prog | |
348 | (mapconcat 'identity args " ") | |
349 | err-file | |
350 | (if (stringp output) | |
351 | (concat "> " output) | |
352 | ""))) | |
353 | jka-compr-acceptable-retval-list) | |
354 | ||
355 | (jka-compr-error prog args infile message err-file)) | |
356 | ||
357 | (jka-compr-delete-temp-file err-file))) | |
358 | ||
359 | (or (zerop | |
360 | (apply 'call-process | |
361 | prog | |
362 | infile | |
363 | (if (stringp output) temp output) | |
364 | nil | |
365 | args)) | |
366 | (jka-compr-error prog args infile message)) | |
367 | ||
368 | (and (stringp output) | |
75e9c107 | 369 | (with-current-buffer temp |
acd622cc | 370 | (write-region (point-min) (point-max) output) |
75e9c107 | 371 | (erase-buffer))))) |
acd622cc RS |
372 | |
373 | ||
374 | ;;; Support for temp files. Much of this was inspired if not lifted | |
375 | ;;; from ange-ftp. | |
376 | ||
bbf5eb28 | 377 | (defcustom jka-compr-temp-name-template |
11757e2f | 378 | (expand-file-name "jka-com" temporary-file-directory) |
362b539a | 379 | "Prefix added to all temp files created by jka-compr. |
bbf5eb28 RS |
380 | There should be no more than seven characters after the final `/'." |
381 | :type 'string | |
382 | :group 'jka-compr) | |
acd622cc | 383 | |
acd622cc RS |
384 | (defun jka-compr-make-temp-name (&optional local-copy) |
385 | "This routine will return the name of a new file." | |
767d12f2 SM |
386 | (make-temp-file jka-compr-temp-name-template)) |
387 | ||
388 | (defalias 'jka-compr-delete-temp-file 'delete-file) | |
acd622cc RS |
389 | |
390 | ||
391 | (defun jka-compr-write-region (start end file &optional append visit) | |
acd622cc RS |
392 | (let* ((filename (expand-file-name file)) |
393 | (visit-file (if (stringp visit) (expand-file-name visit) filename)) | |
e073a356 RS |
394 | (info (jka-compr-get-compression-info visit-file)) |
395 | (magic (and info (jka-compr-info-file-magic-bytes info)))) | |
396 | ||
b6e8d238 RS |
397 | ;; If START is nil, use the whole buffer. |
398 | (if (null start) | |
399 | (setq start 1 end (1+ (buffer-size)))) | |
400 | ||
e073a356 RS |
401 | ;; If we uncompressed this file when visiting it, |
402 | ;; then recompress it when writing it | |
403 | ;; even if the contents look compressed already. | |
404 | (if (and jka-compr-really-do-compress | |
405 | (eq start 1) | |
406 | (eq end (1+ (buffer-size)))) | |
407 | (setq magic nil)) | |
408 | ||
409 | (if (and info | |
410 | ;; If the contents to be written out | |
411 | ;; are properly compressed already, | |
412 | ;; don't try to compress them over again. | |
413 | (not (and magic | |
414 | (equal (if (stringp start) | |
415 | (substring start 0 (min (length start) | |
416 | (length magic))) | |
417 | (buffer-substring start | |
418 | (min end | |
419 | (+ start (length magic))))) | |
420 | magic)))) | |
421 | (let ((can-append (jka-compr-info-can-append info)) | |
422 | (compress-program (jka-compr-info-compress-program info)) | |
423 | (compress-message (jka-compr-info-compress-message info)) | |
424 | (uncompress-program (jka-compr-info-uncompress-program info)) | |
425 | (uncompress-message (jka-compr-info-uncompress-message info)) | |
426 | (compress-args (jka-compr-info-compress-args info)) | |
427 | (uncompress-args (jka-compr-info-uncompress-args info)) | |
428 | (base-name (file-name-nondirectory visit-file)) | |
429 | temp-file temp-buffer | |
430 | ;; we need to leave `last-coding-system-used' set to its | |
431 | ;; value after calling write-region the first time, so | |
432 | ;; that `basic-save-buffer' sees the right value. | |
433 | (coding-system-used last-coding-system-used)) | |
434 | ||
435 | (setq temp-buffer (get-buffer-create " *jka-compr-wr-temp*")) | |
436 | (with-current-buffer temp-buffer | |
437 | (widen) (erase-buffer)) | |
438 | ||
439 | (if (and append | |
440 | (not can-append) | |
441 | (file-exists-p filename)) | |
442 | ||
443 | (let* ((local-copy (file-local-copy filename)) | |
444 | (local-file (or local-copy filename))) | |
445 | ||
446 | (setq temp-file local-file)) | |
447 | ||
448 | (setq temp-file (jka-compr-make-temp-name))) | |
449 | ||
f1180544 | 450 | (and |
e073a356 RS |
451 | compress-message |
452 | (message "%s %s..." compress-message base-name)) | |
453 | ||
454 | (jka-compr-run-real-handler 'write-region | |
455 | (list start end temp-file t 'dont)) | |
456 | ;; save value used by the real write-region | |
457 | (setq coding-system-used last-coding-system-used) | |
458 | ||
459 | ;; Here we must read the output of compress program as is | |
460 | ;; without any code conversion. | |
461 | (let ((coding-system-for-read 'no-conversion)) | |
462 | (jka-compr-call-process compress-program | |
463 | (concat compress-message | |
464 | " " base-name) | |
465 | temp-file | |
466 | temp-buffer | |
467 | nil | |
468 | compress-args)) | |
469 | ||
470 | (with-current-buffer temp-buffer | |
471 | (let ((coding-system-for-write 'no-conversion)) | |
472 | (if (memq system-type '(ms-dos windows-nt)) | |
473 | (setq buffer-file-type t) ) | |
474 | (jka-compr-run-real-handler 'write-region | |
475 | (list (point-min) (point-max) | |
476 | filename | |
477 | (and append can-append) 'dont)) | |
478 | (erase-buffer)) ) | |
479 | ||
480 | (jka-compr-delete-temp-file temp-file) | |
acd622cc | 481 | |
e073a356 RS |
482 | (and |
483 | compress-message | |
484 | (message "%s %s...done" compress-message base-name)) | |
485 | ||
486 | (cond | |
487 | ((eq visit t) | |
488 | (setq buffer-file-name filename) | |
489 | (setq jka-compr-really-do-compress t) | |
490 | (set-visited-file-modtime)) | |
491 | ((stringp visit) | |
492 | (setq buffer-file-name visit) | |
493 | (let ((buffer-file-name filename)) | |
494 | (set-visited-file-modtime)))) | |
495 | ||
496 | (and (or (eq visit t) | |
497 | (eq visit nil) | |
498 | (stringp visit)) | |
499 | (message "Wrote %s" visit-file)) | |
500 | ||
501 | ;; ensure `last-coding-system-used' has an appropriate value | |
502 | (setq last-coding-system-used coding-system-used) | |
503 | ||
504 | nil) | |
f1180544 | 505 | |
e073a356 RS |
506 | (jka-compr-run-real-handler 'write-region |
507 | (list start end filename append visit))))) | |
acd622cc RS |
508 | |
509 | ||
54b2aa5c | 510 | (defun jka-compr-insert-file-contents (file &optional visit beg end replace) |
acd622cc RS |
511 | (barf-if-buffer-read-only) |
512 | ||
513 | (and (or beg end) | |
514 | visit | |
515 | (error "Attempt to visit less than an entire file")) | |
516 | ||
517 | (let* ((filename (expand-file-name file)) | |
518 | (info (jka-compr-get-compression-info filename))) | |
519 | ||
520 | (if info | |
521 | ||
522 | (let ((uncompress-message (jka-compr-info-uncompress-message info)) | |
523 | (uncompress-program (jka-compr-info-uncompress-program info)) | |
524 | (uncompress-args (jka-compr-info-uncompress-args info)) | |
525 | (base-name (file-name-nondirectory filename)) | |
526 | (notfound nil) | |
8fb1a583 RS |
527 | (local-copy |
528 | (jka-compr-run-real-handler 'file-local-copy (list filename))) | |
acd622cc | 529 | local-file |
f54a7168 | 530 | size start) |
acd622cc RS |
531 | |
532 | (setq local-file (or local-copy filename)) | |
533 | ||
534 | (and | |
535 | visit | |
536 | (setq buffer-file-name filename)) | |
537 | ||
538 | (unwind-protect ; to make sure local-copy gets deleted | |
539 | ||
540 | (progn | |
f1180544 | 541 | |
acd622cc RS |
542 | (and |
543 | uncompress-message | |
544 | (message "%s %s..." uncompress-message base-name)) | |
545 | ||
546 | (condition-case error-code | |
547 | ||
f54a7168 | 548 | (let ((coding-system-for-read 'no-conversion)) |
094cf604 RS |
549 | (if replace |
550 | (goto-char (point-min))) | |
acd622cc RS |
551 | (setq start (point)) |
552 | (if (or beg end) | |
553 | (jka-compr-partial-uncompress uncompress-program | |
554 | (concat uncompress-message | |
555 | " " base-name) | |
556 | uncompress-args | |
557 | local-file | |
558 | (or beg 0) | |
559 | (if (and beg end) | |
560 | (- end beg) | |
561 | end)) | |
ae849784 RS |
562 | ;; If visiting, bind off buffer-file-name so that |
563 | ;; file-locking will not ask whether we should | |
564 | ;; really edit the buffer. | |
565 | (let ((buffer-file-name | |
566 | (if visit nil buffer-file-name))) | |
567 | (jka-compr-call-process uncompress-program | |
568 | (concat uncompress-message | |
569 | " " base-name) | |
570 | local-file | |
571 | t | |
572 | nil | |
573 | uncompress-args))) | |
acd622cc | 574 | (setq size (- (point) start)) |
094cf604 | 575 | (if replace |
31b55e80 | 576 | (delete-region (point) (point-max))) |
094cf604 | 577 | (goto-char start)) |
acd622cc RS |
578 | (error |
579 | (if (and (eq (car error-code) 'file-error) | |
580 | (eq (nth 3 error-code) local-file)) | |
581 | (if visit | |
582 | (setq notfound error-code) | |
f1180544 | 583 | (signal 'file-error |
acd622cc RS |
584 | (cons "Opening input file" |
585 | (nthcdr 2 error-code)))) | |
586 | (signal (car error-code) (cdr error-code)))))) | |
587 | ||
588 | (and | |
589 | local-copy | |
590 | (file-exists-p local-copy) | |
591 | (delete-file local-copy))) | |
592 | ||
8bdf601f | 593 | (decode-coding-inserted-region |
f1180544 | 594 | (point) (+ (point) size) |
f54a7168 KH |
595 | (jka-compr-byte-compiler-base-file-name file) |
596 | visit beg end replace) | |
597 | ||
acd622cc RS |
598 | (and |
599 | visit | |
600 | (progn | |
8fb1a583 | 601 | (unlock-buffer) |
acd622cc | 602 | (setq buffer-file-name filename) |
e073a356 | 603 | (setq jka-compr-really-do-compress t) |
acd622cc | 604 | (set-visited-file-modtime))) |
f1180544 | 605 | |
acd622cc RS |
606 | (and |
607 | uncompress-message | |
608 | (message "%s %s...done" uncompress-message base-name)) | |
609 | ||
610 | (and | |
611 | visit | |
612 | notfound | |
613 | (signal 'file-error | |
614 | (cons "Opening input file" (nth 2 notfound)))) | |
615 | ||
5c6f2f2a RS |
616 | ;; This is done in insert-file-contents after we return. |
617 | ;; That is a little weird, but better to go along with it now | |
618 | ;; than to change it now. | |
619 | ||
620 | ;;; ;; Run the functions that insert-file-contents would. | |
621 | ;;; (let ((p after-insert-file-functions) | |
622 | ;;; (insval size)) | |
623 | ;;; (while p | |
624 | ;;; (setq insval (funcall (car p) size)) | |
625 | ;;; (if insval | |
626 | ;;; (progn | |
627 | ;;; (or (integerp insval) | |
628 | ;;; (signal 'wrong-type-argument | |
629 | ;;; (list 'integerp insval))) | |
630 | ;;; (setq size insval))) | |
631 | ;;; (setq p (cdr p)))) | |
094cf604 | 632 | |
acd622cc RS |
633 | (list filename size)) |
634 | ||
8fb1a583 RS |
635 | (jka-compr-run-real-handler 'insert-file-contents |
636 | (list file visit beg end replace))))) | |
acd622cc RS |
637 | |
638 | ||
639 | (defun jka-compr-file-local-copy (file) | |
acd622cc RS |
640 | (let* ((filename (expand-file-name file)) |
641 | (info (jka-compr-get-compression-info filename))) | |
642 | ||
643 | (if info | |
644 | ||
645 | (let ((uncompress-message (jka-compr-info-uncompress-message info)) | |
646 | (uncompress-program (jka-compr-info-uncompress-program info)) | |
647 | (uncompress-args (jka-compr-info-uncompress-args info)) | |
648 | (base-name (file-name-nondirectory filename)) | |
8fb1a583 RS |
649 | (local-copy |
650 | (jka-compr-run-real-handler 'file-local-copy (list filename))) | |
acd622cc | 651 | (temp-file (jka-compr-make-temp-name t)) |
30c78e11 | 652 | (temp-buffer (get-buffer-create " *jka-compr-flc-temp*")) |
acd622cc | 653 | (notfound nil) |
acd622cc RS |
654 | local-file) |
655 | ||
656 | (setq local-file (or local-copy filename)) | |
657 | ||
658 | (unwind-protect | |
659 | ||
75e9c107 | 660 | (with-current-buffer temp-buffer |
f1180544 | 661 | |
acd622cc RS |
662 | (and |
663 | uncompress-message | |
664 | (message "%s %s..." uncompress-message base-name)) | |
f1180544 | 665 | |
baefb016 KH |
666 | ;; Here we must read the output of uncompress program |
667 | ;; and write it to TEMP-FILE without any code | |
668 | ;; conversion. An appropriate code conversion (if | |
669 | ;; necessary) is done by the later I/O operation | |
670 | ;; (e.g. load). | |
671 | (let ((coding-system-for-read 'no-conversion) | |
672 | (coding-system-for-write 'no-conversion)) | |
673 | ||
674 | (jka-compr-call-process uncompress-program | |
675 | (concat uncompress-message | |
676 | " " base-name) | |
677 | local-file | |
678 | t | |
679 | nil | |
680 | uncompress-args) | |
681 | ||
682 | (and | |
683 | uncompress-message | |
684 | (message "%s %s...done" uncompress-message base-name)) | |
685 | ||
686 | (write-region | |
687 | (point-min) (point-max) temp-file nil 'dont))) | |
acd622cc RS |
688 | |
689 | (and | |
690 | local-copy | |
691 | (file-exists-p local-copy) | |
692 | (delete-file local-copy)) | |
693 | ||
acd622cc RS |
694 | (kill-buffer temp-buffer)) |
695 | ||
696 | temp-file) | |
f1180544 | 697 | |
8fb1a583 | 698 | (jka-compr-run-real-handler 'file-local-copy (list filename))))) |
acd622cc RS |
699 | |
700 | ||
701 | ;;; Support for loading compressed files. | |
702 | (defun jka-compr-load (file &optional noerror nomessage nosuffix) | |
703 | "Documented as original." | |
704 | ||
705 | (let* ((local-copy (jka-compr-file-local-copy file)) | |
706 | (load-file (or local-copy file))) | |
707 | ||
708 | (unwind-protect | |
709 | ||
8fb1a583 RS |
710 | (let (inhibit-file-name-operation |
711 | inhibit-file-name-handlers) | |
acd622cc RS |
712 | (or nomessage |
713 | (message "Loading %s..." file)) | |
714 | ||
9b37d8a9 RS |
715 | (let ((load-force-doc-strings t)) |
716 | (load load-file noerror t t)) | |
acd622cc | 717 | (or nomessage |
e645e77b DL |
718 | (message "Loading %s...done." file)) |
719 | ;; Fix up the load history to point at the right library. | |
720 | (let ((l (assoc load-file load-history))) | |
721 | ;; Remove .gz and .elc?. | |
722 | (while (file-name-extension file) | |
723 | (setq file (file-name-sans-extension file))) | |
724 | (setcar l file))) | |
acd622cc | 725 | |
acd622cc RS |
726 | (jka-compr-delete-temp-file local-copy)) |
727 | ||
728 | t)) | |
3068998d RS |
729 | |
730 | (defun jka-compr-byte-compiler-base-file-name (file) | |
731 | (let ((info (jka-compr-get-compression-info file))) | |
732 | (if (and info (jka-compr-info-strip-extension info)) | |
733 | (save-match-data | |
734 | (substring file 0 (string-match (jka-compr-info-regexp info) file))) | |
735 | file))) | |
8fb1a583 RS |
736 | \f |
737 | (put 'write-region 'jka-compr 'jka-compr-write-region) | |
738 | (put 'insert-file-contents 'jka-compr 'jka-compr-insert-file-contents) | |
739 | (put 'file-local-copy 'jka-compr 'jka-compr-file-local-copy) | |
740 | (put 'load 'jka-compr 'jka-compr-load) | |
3068998d RS |
741 | (put 'byte-compiler-base-file-name 'jka-compr |
742 | 'jka-compr-byte-compiler-base-file-name) | |
acd622cc | 743 | |
9fdf055b KH |
744 | (defvar jka-compr-inhibit nil |
745 | "Non-nil means inhibit automatic uncompression temporarily. | |
746 | Lisp programs can bind this to t to do that. | |
747 | It is not recommended to set this variable permanently to anything but nil.") | |
748 | ||
68890d7e | 749 | (put 'jka-compr-handler 'safe-magic t) |
acd622cc | 750 | (defun jka-compr-handler (operation &rest args) |
8fb1a583 RS |
751 | (save-match-data |
752 | (let ((jka-op (get operation 'jka-compr))) | |
9fdf055b | 753 | (if (and jka-op (not jka-compr-inhibit)) |
8fb1a583 RS |
754 | (apply jka-op args) |
755 | (jka-compr-run-real-handler operation args))))) | |
acd622cc | 756 | |
99bee6a4 RS |
757 | ;; If we are given an operation that we don't handle, |
758 | ;; call the Emacs primitive for that operation, | |
759 | ;; and manipulate the inhibit variables | |
760 | ;; to prevent the primitive from calling our handler again. | |
761 | (defun jka-compr-run-real-handler (operation args) | |
762 | (let ((inhibit-file-name-handlers | |
763 | (cons 'jka-compr-handler | |
764 | (and (eq inhibit-file-name-operation operation) | |
765 | inhibit-file-name-handlers))) | |
766 | (inhibit-file-name-operation operation)) | |
767 | (apply operation args))) | |
768 | ||
523b128c | 769 | |
acd622cc | 770 | (defun jka-compr-build-file-regexp () |
defdd32e SM |
771 | (mapconcat |
772 | 'jka-compr-info-regexp | |
773 | jka-compr-compression-info-list | |
774 | "\\|")) | |
acd622cc RS |
775 | |
776 | ||
777 | (defun jka-compr-install () | |
778 | "Install jka-compr. | |
919a07bb RS |
779 | This adds entries to `file-name-handler-alist' and `auto-mode-alist' |
780 | and `inhibit-first-line-modes-suffixes'." | |
acd622cc RS |
781 | |
782 | (setq jka-compr-file-name-handler-entry | |
783 | (cons (jka-compr-build-file-regexp) 'jka-compr-handler)) | |
784 | ||
785 | (setq file-name-handler-alist (cons jka-compr-file-name-handler-entry | |
786 | file-name-handler-alist)) | |
787 | ||
4eec33ae RS |
788 | (setq jka-compr-added-to-file-coding-system-alist nil) |
789 | ||
acd622cc RS |
790 | (mapcar |
791 | (function (lambda (x) | |
4eec33ae RS |
792 | ;; Don't do multibyte encoding on the compressed files. |
793 | (let ((elt (cons (jka-compr-info-regexp x) | |
794 | '(no-conversion . no-conversion)))) | |
795 | (setq file-coding-system-alist | |
796 | (cons elt file-coding-system-alist)) | |
797 | (setq jka-compr-added-to-file-coding-system-alist | |
798 | (cons elt jka-compr-added-to-file-coding-system-alist))) | |
799 | ||
469f4e8c RS |
800 | (and (jka-compr-info-strip-extension x) |
801 | ;; Make entries in auto-mode-alist so that modes | |
802 | ;; are chosen right according to the file names | |
803 | ;; sans `.gz'. | |
804 | (setq auto-mode-alist | |
805 | (cons (list (jka-compr-info-regexp x) | |
806 | nil 'jka-compr) | |
807 | auto-mode-alist)) | |
808 | ;; Also add these regexps to | |
809 | ;; inhibit-first-line-modes-suffixes, so that a | |
810 | ;; -*- line in the first file of a compressed tar | |
811 | ;; file doesn't override tar-mode. | |
812 | (setq inhibit-first-line-modes-suffixes | |
813 | (cons (jka-compr-info-regexp x) | |
814 | inhibit-first-line-modes-suffixes))))) | |
74b2c737 RS |
815 | jka-compr-compression-info-list) |
816 | (setq auto-mode-alist | |
aab8a6e3 SM |
817 | (append auto-mode-alist jka-compr-mode-alist-additions)) |
818 | ||
819 | ;; Make sure that (load "foo") will find /bla/foo.el.gz. | |
820 | (setq load-suffixes | |
821 | (apply 'append | |
822 | (mapcar (lambda (suffix) | |
823 | (cons suffix | |
824 | (mapcar (lambda (ext) (concat suffix ext)) | |
825 | jka-compr-load-suffixes))) | |
826 | load-suffixes)))) | |
acd622cc RS |
827 | |
828 | ||
829 | (defun jka-compr-uninstall () | |
830 | "Uninstall jka-compr. | |
99bee6a4 | 831 | This removes the entries in `file-name-handler-alist' and `auto-mode-alist' |
919a07bb RS |
832 | and `inhibit-first-line-modes-suffixes' that were added |
833 | by `jka-compr-installed'." | |
834 | ;; Delete from inhibit-first-line-modes-suffixes | |
835 | ;; what jka-compr-install added. | |
836 | (mapcar | |
837 | (function (lambda (x) | |
838 | (and (jka-compr-info-strip-extension x) | |
839 | (setq inhibit-first-line-modes-suffixes | |
840 | (delete (jka-compr-info-regexp x) | |
841 | inhibit-first-line-modes-suffixes))))) | |
842 | jka-compr-compression-info-list) | |
acd622cc RS |
843 | |
844 | (let* ((fnha (cons nil file-name-handler-alist)) | |
845 | (last fnha)) | |
846 | ||
847 | (while (cdr last) | |
848 | (if (eq (cdr (car (cdr last))) 'jka-compr-handler) | |
849 | (setcdr last (cdr (cdr last))) | |
850 | (setq last (cdr last)))) | |
851 | ||
852 | (setq file-name-handler-alist (cdr fnha))) | |
853 | ||
854 | (let* ((ama (cons nil auto-mode-alist)) | |
855 | (last ama) | |
856 | entry) | |
857 | ||
858 | (while (cdr last) | |
859 | (setq entry (car (cdr last))) | |
74b2c737 RS |
860 | (if (or (member entry jka-compr-mode-alist-additions) |
861 | (and (consp (cdr entry)) | |
862 | (eq (nth 2 entry) 'jka-compr))) | |
acd622cc RS |
863 | (setcdr last (cdr (cdr last))) |
864 | (setq last (cdr last)))) | |
f1180544 | 865 | |
4eec33ae RS |
866 | (setq auto-mode-alist (cdr ama))) |
867 | ||
868 | (let* ((ama (cons nil file-coding-system-alist)) | |
869 | (last ama) | |
870 | entry) | |
871 | ||
872 | (while (cdr last) | |
873 | (setq entry (car (cdr last))) | |
874 | (if (member entry jka-compr-added-to-file-coding-system-alist) | |
875 | (setcdr last (cdr (cdr last))) | |
876 | (setq last (cdr last)))) | |
f1180544 | 877 | |
aab8a6e3 SM |
878 | (setq file-coding-system-alist (cdr ama))) |
879 | ||
880 | ;; Remove the suffixes that were added by jka-compr. | |
881 | (let ((suffixes nil) | |
882 | (re (jka-compr-build-file-regexp))) | |
883 | (dolist (suffix load-suffixes) | |
884 | (unless (string-match re suffix) | |
885 | (push suffix suffixes))) | |
886 | (setq load-suffixes (nreverse suffixes)))) | |
acd622cc | 887 | |
f1180544 | 888 | |
acd622cc RS |
889 | (defun jka-compr-installed-p () |
890 | "Return non-nil if jka-compr is installed. | |
99bee6a4 | 891 | The return value is the entry in `file-name-handler-alist' for jka-compr." |
acd622cc RS |
892 | |
893 | (let ((fnha file-name-handler-alist) | |
894 | (installed nil)) | |
895 | ||
896 | (while (and fnha (not installed)) | |
897 | (and (eq (cdr (car fnha)) 'jka-compr-handler) | |
898 | (setq installed (car fnha))) | |
899 | (setq fnha (cdr fnha))) | |
900 | ||
901 | installed)) | |
902 | ||
903 | ||
7dbc9c8a MB |
904 | ;;; Add the file I/O hook if it does not already exist. |
905 | ;;; Make sure that jka-compr-file-name-handler-entry is eq to the | |
906 | ;;; entry for jka-compr in file-name-handler-alist. | |
907 | (and (jka-compr-installed-p) | |
908 | (jka-compr-uninstall)) | |
909 | ||
910 | ||
6fee86a3 MB |
911 | ;;;###autoload |
912 | (define-minor-mode auto-compression-mode | |
913 | "Toggle automatic file compression and uncompression. | |
914 | With prefix argument ARG, turn auto compression on if positive, else off. | |
915 | Returns the new status of auto compression (non-nil means on)." | |
754005f7 | 916 | :global t :group 'jka-compr |
6fee86a3 MB |
917 | (let* ((installed (jka-compr-installed-p)) |
918 | (flag auto-compression-mode)) | |
919 | (cond | |
920 | ((and flag installed) t) ; already installed | |
921 | ((and (not flag) (not installed)) nil) ; already not installed | |
922 | (flag (jka-compr-install)) | |
923 | (t (jka-compr-uninstall))))) | |
924 | ||
925 | ||
926 | ;;;###autoload | |
927 | (defmacro with-auto-compression-mode (&rest body) | |
7dbc9c8a | 928 | "Evalute BODY with automatic file compression and uncompression enabled." |
6fee86a3 MB |
929 | (let ((already-installed (make-symbol "already-installed"))) |
930 | `(let ((,already-installed (jka-compr-installed-p))) | |
931 | (unwind-protect | |
932 | (progn | |
933 | (unless ,already-installed | |
934 | (jka-compr-install)) | |
935 | ,@body) | |
936 | (unless ,already-installed | |
937 | (jka-compr-uninstall)))))) | |
938 | (put 'with-auto-compression-mode 'lisp-indent-function 0) | |
939 | ||
940 | ||
acd622cc RS |
941 | (provide 'jka-compr) |
942 | ||
ab5796a9 | 943 | ;;; arch-tag: 3f15b630-e9a7-46c4-a22a-94afdde86ebc |
55535639 | 944 | ;;; jka-compr.el ends here |