Mercurial > emacs
annotate lisp/jka-compr.el @ 10052:c51fcff184b7
Initial revision
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 22 Nov 1994 19:30:44 +0000 |
parents | 0160fca3dee1 |
children | 9ff0cfb97106 |
rev | line source |
---|---|
6002 | 1 ;;; jka-compr.el - reading/writing/loading compressed files. |
2 ;;; Copyright (C) 1993, 1994 Free Software Foundation, Inc. | |
3 | |
4 ;; Author: jka@ece.cmu.edu (Jay K. Adams) | |
5 ;; Keywords: data | |
6 | |
7 ;;; Commentary: | |
8 | |
9 ;;; This package implements low-level support for reading, writing, | |
10 ;;; and loading compressed files. It hooks into the low-level file | |
11 ;;; I/O functions (including write-region and insert-file-contents) so | |
12 ;;; that they automatically compress or uncompress a file if the file | |
13 ;;; appears to need it (based on the extension of the file name). | |
6041
649926e9c1a8
(jka-compr-partial-uncompress): Make dd give you
Richard M. Stallman <rms@gnu.org>
parents:
6002
diff
changeset
|
14 ;;; Packages like Rmail, VM, GNUS, and Info should be able to work |
6002 | 15 ;;; with compressed files without modification. |
16 | |
17 | |
18 ;;; INSTRUCTIONS: | |
19 ;;; | |
20 ;;; To use jka-compr, simply load this package, and edit as usual. | |
21 ;;; Its operation should be transparent to the user (except for | |
22 ;;; messages appearing when a file is being compressed or | |
23 ;;; uncompressed). | |
24 ;;; | |
25 ;;; The variable, jka-compr-compression-info-list can be used to | |
26 ;;; customize jka-compr to work with other compression programs. | |
27 ;;; The default value of this variable allows jka-compr to work with | |
28 ;;; Unix compress and gzip. | |
29 ;;; | |
30 ;;; If you are concerned about the stderr output of gzip and other | |
31 ;;; compression/decompression programs showing up in your buffers, you | |
32 ;;; should set the discard-error flag in the compression-info-list. | |
33 ;;; This will cause the stderr of all programs to be discarded. | |
34 ;;; However, it also causes emacs to call compression/uncompression | |
35 ;;; programs through a shell (which is specified by jka-compr-shell). | |
36 ;;; This may be a drag if, on your system, starting up a shell is | |
37 ;;; slow. | |
38 ;;; | |
39 ;;; If you don't want messages about compressing and decompressing | |
40 ;;; to show up in the echo area, you can set the compress-name and | |
41 ;;; decompress-name fields of the jka-compr-compression-info-list to | |
42 ;;; nil. | |
43 | |
44 | |
45 ;;; APPLICATION NOTES: | |
46 ;;; | |
47 ;;; crypt++ | |
48 ;;; jka-compr can coexist with crpyt++ if you take all the decompression | |
49 ;;; entries out of the crypt-encoding-list. Clearly problems will arise if | |
50 ;;; you have two programs trying to compress/decompress files. jka-compr | |
51 ;;; will not "work with" crypt++ in the following sense: you won't be able to | |
52 ;;; decode encrypted compressed files--that is, files that have been | |
53 ;;; compressed then encrypted (in that order). Theoretically, crypt++ and | |
54 ;;; jka-compr could properly handle a file that has been encrypted then | |
55 ;;; compressed, but there is little point in trying to compress an encrypted | |
56 ;;; file. | |
57 ;;; | |
58 | |
59 | |
60 ;;; ACKNOWLEDGMENTS | |
61 ;;; | |
62 ;;; jka-compr is a V19 adaptation of jka-compr for V18 of Emacs. Many people | |
63 ;;; have made helpful suggestions, reported bugs, and even fixed bugs in | |
64 ;;; jka-compr. I recall the following people as being particularly helpful. | |
65 ;;; | |
66 ;;; Jean-loup Gailly | |
67 ;;; David Hughes | |
68 ;;; Richard Pieri | |
69 ;;; Daniel Quinlan | |
70 ;;; Chris P. Ross | |
71 ;;; Rick Sladkey | |
72 ;;; | |
73 ;;; Andy Norman's ange-ftp was the inspiration for the original jka-compr for | |
74 ;;; Version 18 of Emacs. | |
75 ;;; | |
76 ;;; After I had made progress on the original jka-compr for V18, I learned of a | |
77 ;;; package written by Kazushi Jam Marukawa, called jam-zcat, that did exactly | |
78 ;;; what I was trying to do. I looked over the jam-zcat source code and | |
79 ;;; probably got some ideas from it. | |
80 ;;; | |
81 | |
82 ;;; Code: | |
83 | |
84 (defvar jka-compr-shell "sh" | |
85 "*Shell to be used for calling compression programs. | |
86 The value of this variable only matters if you want to discard the | |
87 stderr of a compression/decompression program (see the documentation | |
7066 | 88 for `jka-compr-compression-info-list').") |
6002 | 89 |
90 | |
91 (defvar jka-compr-use-shell t) | |
92 | |
93 | |
94 ;;; I have this defined so that .Z files are assumed to be in unix | |
95 ;;; compress format; and .gz files, in gzip format. | |
96 (defvar jka-compr-compression-info-list | |
97 ;;[regexp | |
7616
b0098553bafe
(jka-compr-compression-info-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7066
diff
changeset
|
98 ;; compr-message compr-prog compr-args |
b0098553bafe
(jka-compr-compression-info-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7066
diff
changeset
|
99 ;; uncomp-message uncomp-prog uncomp-args |
6002 | 100 ;; can-append auto-mode-flag] |
8774
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
101 '(["\\.Z\\(~\\|\\.~[0-9]+~\\)?\\'" |
6002 | 102 "compressing" "compress" ("-c") |
103 "uncompressing" "uncompress" ("-c") | |
104 nil t] | |
9493
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
105 ["\\.tgz\\'" |
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
106 "zipping" "gzip" ("-c" "-q") |
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
107 "unzipping" "gzip" ("-c" "-q" "-d") |
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
108 t nil] |
8774
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
109 ["\\.gz\\(~\\|\\.~[0-9]+~\\)?\\'" |
6002 | 110 "zipping" "gzip" ("-c" "-q") |
111 "unzipping" "gzip" ("-c" "-q" "-d") | |
112 t t]) | |
113 | |
114 "List of vectors that describe available compression techniques. | |
115 Each element, which describes a compression technique, is a vector of | |
7616
b0098553bafe
(jka-compr-compression-info-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7066
diff
changeset
|
116 the form [REGEXP COMPRESS-MSG COMPRESS-PROGRAM COMPRESS-ARGS |
b0098553bafe
(jka-compr-compression-info-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7066
diff
changeset
|
117 UNCOMPRESS-MSG UNCOMPRESS-PROGRAM UNCOMPRESS-ARGS |
b0098553bafe
(jka-compr-compression-info-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7066
diff
changeset
|
118 APPEND-FLAG EXTENSION], where: |
6002 | 119 |
120 regexp is a regexp that matches filenames that are | |
121 compressed with this format | |
122 | |
7616
b0098553bafe
(jka-compr-compression-info-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7066
diff
changeset
|
123 compress-msg is the message to issue to the user when doing this |
b0098553bafe
(jka-compr-compression-info-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7066
diff
changeset
|
124 type of compression (nil means no message) |
b0098553bafe
(jka-compr-compression-info-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7066
diff
changeset
|
125 |
6002 | 126 compress-program is a program that performs this compression |
127 | |
128 compress-args is a list of args to pass to the compress program | |
129 | |
7616
b0098553bafe
(jka-compr-compression-info-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7066
diff
changeset
|
130 uncompress-msg is the message to issue to the user when doing this |
b0098553bafe
(jka-compr-compression-info-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7066
diff
changeset
|
131 type of uncompression (nil means no message) |
6002 | 132 |
133 uncompress-program is a program that performs this compression | |
134 | |
135 uncompress-args is a list of args to pass to the uncompress program | |
136 | |
137 append-flag is non-nil if this compression technique can be | |
138 appended | |
139 | |
140 auto-mode flag non-nil means strip the regexp from file names | |
141 before attempting to set the mode. | |
142 | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
143 Because of the way `call-process' is defined, discarding the stderr output of |
6002 | 144 a program adds the overhead of starting a shell each time the program is |
145 invoked.") | |
146 | |
9493
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
147 (defvar jka-compr-mode-alist-additions |
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
148 (list (cons "\\.tgz\\'" 'tar-mode)) |
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
149 "A list of pairs to add to auto-mode-alist when jka-compr is installed.") |
6002 | 150 |
7617
edc853e14f7b
(jka-compr-op-table, jka-compr-file-name-handler-entry): Move defvars.
Richard M. Stallman <rms@gnu.org>
parents:
7616
diff
changeset
|
151 (defvar jka-compr-file-name-handler-entry |
edc853e14f7b
(jka-compr-op-table, jka-compr-file-name-handler-entry): Move defvars.
Richard M. Stallman <rms@gnu.org>
parents:
7616
diff
changeset
|
152 nil |
edc853e14f7b
(jka-compr-op-table, jka-compr-file-name-handler-entry): Move defvars.
Richard M. Stallman <rms@gnu.org>
parents:
7616
diff
changeset
|
153 "The entry in `file-name-handler-alist' used by the jka-compr I/O functions.") |
edc853e14f7b
(jka-compr-op-table, jka-compr-file-name-handler-entry): Move defvars.
Richard M. Stallman <rms@gnu.org>
parents:
7616
diff
changeset
|
154 |
6002 | 155 ;;; Functions for accessing the return value of jka-get-compression-info |
156 (defun jka-compr-info-regexp (info) (aref info 0)) | |
157 (defun jka-compr-info-compress-message (info) (aref info 1)) | |
158 (defun jka-compr-info-compress-program (info) (aref info 2)) | |
159 (defun jka-compr-info-compress-args (info) (aref info 3)) | |
160 (defun jka-compr-info-uncompress-message (info) (aref info 4)) | |
161 (defun jka-compr-info-uncompress-program (info) (aref info 5)) | |
162 (defun jka-compr-info-uncompress-args (info) (aref info 6)) | |
163 (defun jka-compr-info-can-append (info) (aref info 7)) | |
164 (defun jka-compr-info-strip-extension (info) (aref info 8)) | |
165 | |
166 | |
167 (defun jka-compr-get-compression-info (filename) | |
168 "Return information about the compression scheme of FILENAME. | |
169 The determination as to which compression scheme, if any, to use is | |
7066 | 170 based on the filename itself and `jka-compr-compression-info-list'." |
6002 | 171 (catch 'compression-info |
172 (let ((case-fold-search nil)) | |
173 (mapcar | |
174 (function (lambda (x) | |
175 (and (string-match (jka-compr-info-regexp x) filename) | |
176 (throw 'compression-info x)))) | |
177 jka-compr-compression-info-list) | |
178 nil))) | |
179 | |
180 | |
181 (put 'compression-error 'error-conditions '(compression-error file-error error)) | |
182 | |
183 | |
184 (defvar jka-compr-acceptable-retval-list '(0 141)) | |
185 | |
186 | |
187 (defun jka-compr-error (prog args infile message &optional errfile) | |
188 | |
189 (let ((errbuf (get-buffer-create " *jka-compr-error*")) | |
190 (curbuf (current-buffer))) | |
191 (set-buffer errbuf) | |
192 (widen) (erase-buffer) | |
193 (insert (format "Error while executing \"%s %s < %s\"\n\n" | |
194 prog | |
195 (mapconcat 'identity args " ") | |
196 infile)) | |
197 | |
198 (and errfile | |
199 (insert-file-contents errfile)) | |
200 | |
201 (set-buffer curbuf) | |
202 (display-buffer errbuf)) | |
203 | |
204 (signal 'compression-error (list "Opening input file" (format "error %s" message) infile))) | |
205 | |
206 | |
207 (defvar jka-compr-dd-program | |
208 "/bin/dd") | |
209 | |
210 | |
6041
649926e9c1a8
(jka-compr-partial-uncompress): Make dd give you
Richard M. Stallman <rms@gnu.org>
parents:
6002
diff
changeset
|
211 (defvar jka-compr-dd-blocksize 256) |
6002 | 212 |
213 | |
214 (defun jka-compr-partial-uncompress (prog message args infile beg len) | |
215 "Call program PROG with ARGS args taking input from INFILE. | |
216 Fourth and fifth args, BEG and LEN, specify which part of the output | |
8065
31eb7a0e2763
(jka-compr-partial-uncompress): Handle the case where
Richard M. Stallman <rms@gnu.org>
parents:
7976
diff
changeset
|
217 to keep: LEN chars starting BEG chars from the beginning." |
6002 | 218 (let* ((skip (/ beg jka-compr-dd-blocksize)) |
219 (prefix (- beg (* skip jka-compr-dd-blocksize))) | |
220 (count (and len (1+ (/ (+ len prefix) jka-compr-dd-blocksize)))) | |
221 (start (point)) | |
222 (err-file (jka-compr-make-temp-name)) | |
223 (run-string (format "%s %s 2> %s | %s bs=%d skip=%d %s 2> /dev/null" | |
224 prog | |
225 (mapconcat 'identity args " ") | |
226 err-file | |
227 jka-compr-dd-program | |
228 jka-compr-dd-blocksize | |
229 skip | |
6041
649926e9c1a8
(jka-compr-partial-uncompress): Make dd give you
Richard M. Stallman <rms@gnu.org>
parents:
6002
diff
changeset
|
230 ;; dd seems to be unreliable about |
649926e9c1a8
(jka-compr-partial-uncompress): Make dd give you
Richard M. Stallman <rms@gnu.org>
parents:
6002
diff
changeset
|
231 ;; providing the last block. So, always |
649926e9c1a8
(jka-compr-partial-uncompress): Make dd give you
Richard M. Stallman <rms@gnu.org>
parents:
6002
diff
changeset
|
232 ;; read one more than you think you need. |
649926e9c1a8
(jka-compr-partial-uncompress): Make dd give you
Richard M. Stallman <rms@gnu.org>
parents:
6002
diff
changeset
|
233 (if count (concat "count=" (1+ count)) "")))) |
6002 | 234 |
235 (unwind-protect | |
236 (or (memq (call-process jka-compr-shell | |
237 infile t nil "-c" | |
238 run-string) | |
239 jka-compr-acceptable-retval-list) | |
240 | |
241 (jka-compr-error prog args infile message err-file)) | |
242 | |
243 (jka-compr-delete-temp-file err-file)) | |
244 | |
8065
31eb7a0e2763
(jka-compr-partial-uncompress): Handle the case where
Richard M. Stallman <rms@gnu.org>
parents:
7976
diff
changeset
|
245 ;; Delete the stuff after what we want, if there is any. |
6002 | 246 (and |
6041
649926e9c1a8
(jka-compr-partial-uncompress): Make dd give you
Richard M. Stallman <rms@gnu.org>
parents:
6002
diff
changeset
|
247 len |
8065
31eb7a0e2763
(jka-compr-partial-uncompress): Handle the case where
Richard M. Stallman <rms@gnu.org>
parents:
7976
diff
changeset
|
248 (< (+ start prefix len) (point)) |
6041
649926e9c1a8
(jka-compr-partial-uncompress): Make dd give you
Richard M. Stallman <rms@gnu.org>
parents:
6002
diff
changeset
|
249 (delete-region (+ start prefix len) (point))) |
6002 | 250 |
8065
31eb7a0e2763
(jka-compr-partial-uncompress): Handle the case where
Richard M. Stallman <rms@gnu.org>
parents:
7976
diff
changeset
|
251 ;; Delete the stuff before what we want. |
6002 | 252 (delete-region start (+ start prefix)))) |
253 | |
254 | |
255 (defun jka-compr-call-process (prog message infile output temp args) | |
256 (if jka-compr-use-shell | |
257 | |
258 (let ((err-file (jka-compr-make-temp-name))) | |
259 | |
260 (unwind-protect | |
261 | |
262 (or (memq | |
263 (call-process jka-compr-shell infile | |
264 (if (stringp output) nil output) | |
265 nil | |
266 "-c" | |
267 (format "%s %s 2> %s %s" | |
268 prog | |
269 (mapconcat 'identity args " ") | |
270 err-file | |
271 (if (stringp output) | |
272 (concat "> " output) | |
273 ""))) | |
274 jka-compr-acceptable-retval-list) | |
275 | |
276 (jka-compr-error prog args infile message err-file)) | |
277 | |
278 (jka-compr-delete-temp-file err-file))) | |
279 | |
280 (or (zerop | |
281 (apply 'call-process | |
282 prog | |
283 infile | |
284 (if (stringp output) temp output) | |
285 nil | |
286 args)) | |
287 (jka-compr-error prog args infile message)) | |
288 | |
289 (and (stringp output) | |
290 (let ((cbuf (current-buffer))) | |
291 (set-buffer temp) | |
292 (write-region (point-min) (point-max) output) | |
293 (erase-buffer) | |
294 (set-buffer cbuf))))) | |
295 | |
296 | |
297 ;;; Support for temp files. Much of this was inspired if not lifted | |
298 ;;; from ange-ftp. | |
299 | |
300 (defvar jka-compr-temp-name-template | |
301 "/tmp/jka-com" | |
302 "Prefix added to all temp files created by jka-compr. | |
7066 | 303 There should be no more than seven characters after the final `/'") |
6002 | 304 |
305 (defvar jka-compr-temp-name-table (make-vector 31 nil)) | |
306 | |
307 (defun jka-compr-make-temp-name (&optional local-copy) | |
308 "This routine will return the name of a new file." | |
309 (let* ((lastchar ?a) | |
310 (prevchar ?a) | |
311 (template (concat jka-compr-temp-name-template "aa")) | |
312 (lastpos (1- (length template))) | |
313 (not-done t) | |
314 file | |
315 entry) | |
316 | |
317 (while not-done | |
318 (aset template lastpos lastchar) | |
319 (setq file (concat (make-temp-name template) "#")) | |
320 (setq entry (intern file jka-compr-temp-name-table)) | |
321 (if (or (get entry 'active) | |
322 (file-exists-p file)) | |
323 | |
324 (progn | |
325 (setq lastchar (1+ lastchar)) | |
326 (if (> lastchar ?z) | |
327 (progn | |
328 (setq prevchar (1+ prevchar)) | |
329 (setq lastchar ?a) | |
330 (if (> prevchar ?z) | |
331 (error "Can't allocate temp file.") | |
332 (aset template (1- lastpos) prevchar))))) | |
333 | |
334 (put entry 'active (not local-copy)) | |
335 (setq not-done nil))) | |
336 | |
337 file)) | |
338 | |
339 | |
340 (defun jka-compr-delete-temp-file (temp) | |
341 | |
342 (put (intern temp jka-compr-temp-name-table) | |
343 'active nil) | |
344 | |
345 (condition-case () | |
346 (delete-file temp) | |
347 (error nil))) | |
348 | |
349 | |
350 (defun jka-compr-write-region (start end file &optional append visit) | |
351 (let* ((filename (expand-file-name file)) | |
352 (visit-file (if (stringp visit) (expand-file-name visit) filename)) | |
353 (info (jka-compr-get-compression-info visit-file))) | |
354 | |
355 (if info | |
356 | |
357 (let ((can-append (jka-compr-info-can-append info)) | |
358 (compress-program (jka-compr-info-compress-program info)) | |
359 (compress-message (jka-compr-info-compress-message info)) | |
360 (uncompress-program (jka-compr-info-uncompress-program info)) | |
361 (uncompress-message (jka-compr-info-uncompress-message info)) | |
362 (compress-args (jka-compr-info-compress-args info)) | |
363 (uncompress-args (jka-compr-info-uncompress-args info)) | |
364 (temp-file (jka-compr-make-temp-name)) | |
365 (base-name (file-name-nondirectory visit-file)) | |
366 cbuf temp-buffer) | |
367 | |
368 (setq cbuf (current-buffer) | |
369 temp-buffer (get-buffer-create " *jka-compr-temp*")) | |
370 (set-buffer temp-buffer) | |
371 (widen) (erase-buffer) | |
372 (set-buffer cbuf) | |
373 | |
374 (and append | |
375 (not can-append) | |
376 (file-exists-p filename) | |
377 (let* ((local-copy (file-local-copy filename)) | |
378 (local-file (or local-copy filename))) | |
379 | |
380 (unwind-protect | |
381 | |
382 (progn | |
383 | |
384 (and | |
385 uncompress-message | |
386 (message "%s %s..." uncompress-message base-name)) | |
387 | |
388 (jka-compr-call-process uncompress-program | |
389 (concat uncompress-message | |
390 " " base-name) | |
391 local-file | |
392 temp-file | |
393 temp-buffer | |
394 uncompress-args) | |
395 (and | |
396 uncompress-message | |
397 (message "%s %s...done" uncompress-message base-name))) | |
398 | |
399 (and | |
400 local-copy | |
401 (file-exists-p local-copy) | |
402 (delete-file local-copy))))) | |
403 | |
404 (and | |
405 compress-message | |
406 (message "%s %s..." compress-message base-name)) | |
407 | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
408 (jka-compr-run-real-handler 'write-region |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
409 (list start end temp-file t 'dont)) |
6002 | 410 |
411 (jka-compr-call-process compress-program | |
412 (concat compress-message | |
413 " " base-name) | |
414 temp-file | |
415 temp-buffer | |
416 nil | |
417 compress-args) | |
418 | |
419 (set-buffer temp-buffer) | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
420 (jka-compr-run-real-handler 'write-region |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
421 (list (point-min) (point-max) |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
422 filename |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
423 (and append can-append) 'dont)) |
6002 | 424 (erase-buffer) |
425 (set-buffer cbuf) | |
426 | |
427 (jka-compr-delete-temp-file temp-file) | |
428 | |
429 (and | |
430 compress-message | |
431 (message "%s %s...done" compress-message base-name)) | |
432 | |
433 (cond | |
434 ((eq visit t) | |
435 (setq buffer-file-name filename) | |
436 (set-visited-file-modtime)) | |
437 ((stringp visit) | |
438 (setq buffer-file-name visit) | |
439 (let ((buffer-file-name filename)) | |
440 (set-visited-file-modtime)))) | |
441 | |
442 (and (or (eq visit t) | |
443 (eq visit nil) | |
444 (stringp visit)) | |
445 (message "Wrote %s" visit-file)) | |
446 | |
447 nil) | |
448 | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
449 (jka-compr-run-real-handler 'write-region |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
450 (list start end filename append visit))))) |
6002 | 451 |
452 | |
6218
f4d5338c2142
(jka-compr-insert-file-contents): Handle 5th arg.
Richard M. Stallman <rms@gnu.org>
parents:
6041
diff
changeset
|
453 (defun jka-compr-insert-file-contents (file &optional visit beg end replace) |
6002 | 454 (barf-if-buffer-read-only) |
455 | |
456 (and (or beg end) | |
457 visit | |
458 (error "Attempt to visit less than an entire file")) | |
459 | |
460 (let* ((filename (expand-file-name file)) | |
461 (info (jka-compr-get-compression-info filename))) | |
462 | |
463 (if info | |
464 | |
465 (let ((uncompress-message (jka-compr-info-uncompress-message info)) | |
466 (uncompress-program (jka-compr-info-uncompress-program info)) | |
467 (uncompress-args (jka-compr-info-uncompress-args info)) | |
468 (base-name (file-name-nondirectory filename)) | |
469 (notfound nil) | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
470 (local-copy |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
471 (jka-compr-run-real-handler 'file-local-copy (list filename))) |
6002 | 472 local-file |
473 size start) | |
474 | |
475 (setq local-file (or local-copy filename)) | |
476 | |
477 (and | |
478 visit | |
479 (setq buffer-file-name filename)) | |
480 | |
481 (unwind-protect ; to make sure local-copy gets deleted | |
482 | |
483 (progn | |
484 | |
485 (and | |
486 uncompress-message | |
487 (message "%s %s..." uncompress-message base-name)) | |
488 | |
489 (condition-case error-code | |
490 | |
491 (progn | |
8774
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
492 (if replace |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
493 (goto-char (point-min))) |
6002 | 494 (setq start (point)) |
495 (if (or beg end) | |
496 (jka-compr-partial-uncompress uncompress-program | |
497 (concat uncompress-message | |
498 " " base-name) | |
499 uncompress-args | |
500 local-file | |
501 (or beg 0) | |
502 (if (and beg end) | |
503 (- end beg) | |
504 end)) | |
505 (jka-compr-call-process uncompress-program | |
506 (concat uncompress-message | |
507 " " base-name) | |
508 local-file | |
509 t | |
510 nil | |
511 uncompress-args)) | |
512 (setq size (- (point) start)) | |
8774
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
513 (if replace |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
514 (let* ((del-beg (point)) |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
515 (del-end (+ del-beg size))) |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
516 (delete-region del-beg |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
517 (min del-end (point-max))))) |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
518 (goto-char start)) |
6002 | 519 (error |
520 (if (and (eq (car error-code) 'file-error) | |
521 (eq (nth 3 error-code) local-file)) | |
522 (if visit | |
523 (setq notfound error-code) | |
524 (signal 'file-error | |
525 (cons "Opening input file" | |
526 (nthcdr 2 error-code)))) | |
527 (signal (car error-code) (cdr error-code)))))) | |
528 | |
529 (and | |
530 local-copy | |
531 (file-exists-p local-copy) | |
532 (delete-file local-copy))) | |
533 | |
534 (and | |
535 visit | |
536 (progn | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
537 (unlock-buffer) |
6002 | 538 (setq buffer-file-name filename) |
539 (set-visited-file-modtime))) | |
540 | |
541 (and | |
542 uncompress-message | |
543 (message "%s %s...done" uncompress-message base-name)) | |
544 | |
545 (and | |
546 visit | |
547 notfound | |
548 (signal 'file-error | |
549 (cons "Opening input file" (nth 2 notfound)))) | |
550 | |
8774
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
551 ;; Run the functions that insert-file-contents would. |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
552 (let ((p after-insert-file-functions) |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
553 (insval size)) |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
554 (while p |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
555 (setq insval (funcall (car p) size)) |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
556 (if insval |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
557 (progn |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
558 (or (integerp insval) |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
559 (signal 'wrong-type-argument |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
560 (list 'integerp insval))) |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
561 (setq size insval))) |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
562 (setq p (cdr p)))) |
ade4b542a74c
(jka-compr-compression-info-list): Expand regular
Richard M. Stallman <rms@gnu.org>
parents:
8593
diff
changeset
|
563 |
6002 | 564 (list filename size)) |
565 | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
566 (jka-compr-run-real-handler 'insert-file-contents |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
567 (list file visit beg end replace))))) |
6002 | 568 |
569 | |
570 (defun jka-compr-file-local-copy (file) | |
571 (let* ((filename (expand-file-name file)) | |
572 (info (jka-compr-get-compression-info filename))) | |
573 | |
574 (if info | |
575 | |
576 (let ((uncompress-message (jka-compr-info-uncompress-message info)) | |
577 (uncompress-program (jka-compr-info-uncompress-program info)) | |
578 (uncompress-args (jka-compr-info-uncompress-args info)) | |
579 (base-name (file-name-nondirectory filename)) | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
580 (local-copy |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
581 (jka-compr-run-real-handler 'file-local-copy (list filename))) |
6002 | 582 (temp-file (jka-compr-make-temp-name t)) |
583 (temp-buffer (get-buffer-create " *jka-compr-temp*")) | |
584 (notfound nil) | |
585 (cbuf (current-buffer)) | |
586 local-file) | |
587 | |
588 (setq local-file (or local-copy filename)) | |
589 | |
590 (unwind-protect | |
591 | |
592 (progn | |
593 | |
594 (and | |
595 uncompress-message | |
596 (message "%s %s..." uncompress-message base-name)) | |
597 | |
598 (set-buffer temp-buffer) | |
599 | |
600 (jka-compr-call-process uncompress-program | |
601 (concat uncompress-message | |
602 " " base-name) | |
603 local-file | |
604 t | |
605 nil | |
606 uncompress-args) | |
607 | |
608 (and | |
609 uncompress-message | |
610 (message "%s %s...done" uncompress-message base-name)) | |
611 | |
612 (write-region | |
613 (point-min) (point-max) temp-file nil 'dont)) | |
614 | |
615 (and | |
616 local-copy | |
617 (file-exists-p local-copy) | |
618 (delete-file local-copy)) | |
619 | |
620 (set-buffer cbuf) | |
621 (kill-buffer temp-buffer)) | |
622 | |
623 temp-file) | |
624 | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
625 (jka-compr-run-real-handler 'file-local-copy (list filename))))) |
6002 | 626 |
627 | |
628 ;;; Support for loading compressed files. | |
629 (defun jka-compr-load (file &optional noerror nomessage nosuffix) | |
630 "Documented as original." | |
631 | |
632 (let* ((local-copy (jka-compr-file-local-copy file)) | |
633 (load-file (or local-copy file))) | |
634 | |
635 (unwind-protect | |
636 | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
637 (let (inhibit-file-name-operation |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
638 inhibit-file-name-handlers) |
6002 | 639 (or nomessage |
640 (message "Loading %s..." file)) | |
641 | |
642 (load load-file noerror t t) | |
643 | |
644 (or nomessage | |
645 (message "Loading %s...done." file))) | |
646 | |
647 (jka-compr-delete-temp-file local-copy)) | |
648 | |
649 t)) | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
650 |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
651 (put 'write-region 'jka-compr 'jka-compr-write-region) |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
652 (put 'insert-file-contents 'jka-compr 'jka-compr-insert-file-contents) |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
653 (put 'file-local-copy 'jka-compr 'jka-compr-file-local-copy) |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
654 (put 'load 'jka-compr 'jka-compr-load) |
6002 | 655 |
656 (defun jka-compr-handler (operation &rest args) | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
657 (save-match-data |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
658 (let ((jka-op (get operation 'jka-compr))) |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
659 (if jka-op |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
660 (apply jka-op args) |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
661 (jka-compr-run-real-handler operation args))))) |
6002 | 662 |
7066 | 663 ;; If we are given an operation that we don't handle, |
664 ;; call the Emacs primitive for that operation, | |
665 ;; and manipulate the inhibit variables | |
666 ;; to prevent the primitive from calling our handler again. | |
667 (defun jka-compr-run-real-handler (operation args) | |
668 (let ((inhibit-file-name-handlers | |
669 (cons 'jka-compr-handler | |
670 (and (eq inhibit-file-name-operation operation) | |
671 inhibit-file-name-handlers))) | |
672 (inhibit-file-name-operation operation)) | |
673 (apply operation args))) | |
674 | |
6002 | 675 (defun toggle-auto-compression (arg) |
676 "Toggle automatic file compression and decompression. | |
677 With prefix argument ARG, turn auto compression on if positive, else off. | |
678 Returns the new status of auto compression (non-nil means on)." | |
679 (interactive "P") | |
680 (let* ((installed (jka-compr-installed-p)) | |
681 (flag (if (null arg) | |
682 (not installed) | |
683 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0)))))) | |
684 | |
685 (cond | |
686 ((and flag installed) t) ; already installed | |
687 | |
688 ((and (not flag) (not installed)) nil) ; already not installed | |
689 | |
690 (flag | |
691 (jka-compr-install)) | |
692 | |
693 (t | |
694 (jka-compr-uninstall))) | |
695 | |
696 | |
697 (and (interactive-p) | |
698 (if flag | |
699 (message "Automatic file (de)compression is now ON.") | |
700 (message "Automatic file (de)compression is now OFF."))) | |
701 | |
702 flag)) | |
703 | |
704 | |
705 (defun jka-compr-build-file-regexp () | |
706 (concat | |
707 "\\(" | |
708 (mapconcat | |
709 'jka-compr-info-regexp | |
710 jka-compr-compression-info-list | |
711 "\\)\\|\\(") | |
712 "\\)")) | |
713 | |
714 | |
715 (defun jka-compr-install () | |
716 "Install jka-compr. | |
7066 | 717 This adds entries to `file-name-handler-alist' and `auto-mode-alist'." |
6002 | 718 |
719 (setq jka-compr-file-name-handler-entry | |
720 (cons (jka-compr-build-file-regexp) 'jka-compr-handler)) | |
721 | |
722 (setq file-name-handler-alist (cons jka-compr-file-name-handler-entry | |
723 file-name-handler-alist)) | |
724 | |
7976
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
725 ;; Make entries in auto-mode-alist so that modes are chosen right |
b72b84744a85
Use plists to record handlers.
Richard M. Stallman <rms@gnu.org>
parents:
7617
diff
changeset
|
726 ;; according to the file names sans `.gz'. |
6002 | 727 (mapcar |
728 (function (lambda (x) | |
729 (and | |
730 (jka-compr-info-strip-extension x) | |
731 (setq auto-mode-alist (cons (list (jka-compr-info-regexp x) | |
732 nil 'jka-compr) | |
733 auto-mode-alist))))) | |
734 | |
9493
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
735 jka-compr-compression-info-list) |
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
736 (setq auto-mode-alist |
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
737 (append auto-mode-alist jka-compr-mode-alist-additions))) |
6002 | 738 |
739 | |
740 (defun jka-compr-uninstall () | |
741 "Uninstall jka-compr. | |
7066 | 742 This removes the entries in `file-name-handler-alist' and `auto-mode-alist' |
743 that were created by `jka-compr-installed'." | |
6002 | 744 |
745 (let* ((fnha (cons nil file-name-handler-alist)) | |
746 (last fnha)) | |
747 | |
748 (while (cdr last) | |
749 (if (eq (cdr (car (cdr last))) 'jka-compr-handler) | |
750 (setcdr last (cdr (cdr last))) | |
751 (setq last (cdr last)))) | |
752 | |
753 (setq file-name-handler-alist (cdr fnha))) | |
754 | |
755 (let* ((ama (cons nil auto-mode-alist)) | |
756 (last ama) | |
757 entry) | |
758 | |
759 (while (cdr last) | |
760 (setq entry (car (cdr last))) | |
9493
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
761 (if (or (member entry jka-compr-mode-alist-additions) |
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
762 (and (consp (cdr entry)) |
0160fca3dee1
(jka-compr-mode-compression-info-list): Add .tgz extension.
Richard M. Stallman <rms@gnu.org>
parents:
9084
diff
changeset
|
763 (eq (nth 2 entry) 'jka-compr))) |
6002 | 764 (setcdr last (cdr (cdr last))) |
765 (setq last (cdr last)))) | |
766 | |
767 (setq auto-mode-alist (cdr ama)))) | |
768 | |
769 | |
770 (defun jka-compr-installed-p () | |
771 "Return non-nil if jka-compr is installed. | |
7066 | 772 The return value is the entry in `file-name-handler-alist' for jka-compr." |
6002 | 773 |
774 (let ((fnha file-name-handler-alist) | |
775 (installed nil)) | |
776 | |
777 (while (and fnha (not installed)) | |
778 (and (eq (cdr (car fnha)) 'jka-compr-handler) | |
779 (setq installed (car fnha))) | |
780 (setq fnha (cdr fnha))) | |
781 | |
782 installed)) | |
783 | |
784 | |
785 ;;; Add the file I/O hook if it does not already exist. | |
786 ;;; Make sure that jka-compr-file-name-handler-entry is eq to the | |
787 ;;; entry for jka-compr in file-name-handler-alist. | |
788 (and (jka-compr-installed-p) | |
789 (jka-compr-uninstall)) | |
790 | |
791 (jka-compr-install) | |
792 | |
793 | |
794 (provide 'jka-compr) | |
795 | |
796 ;; jka-compr.el ends here. |