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