(ps-print-color-p): Fix minor error.
[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/"))
bbf5eb28
RS
342There should be no more than seven characters after the final `/'."
343 :type 'string
344 :group 'jka-compr)
acd622cc
RS
345
346(defvar jka-compr-temp-name-table (make-vector 31 nil))
347
348(defun jka-compr-make-temp-name (&optional local-copy)
349 "This routine will return the name of a new file."
350 (let* ((lastchar ?a)
351 (prevchar ?a)
352 (template (concat jka-compr-temp-name-template "aa"))
353 (lastpos (1- (length template)))
354 (not-done t)
355 file
356 entry)
357
358 (while not-done
359 (aset template lastpos lastchar)
360 (setq file (concat (make-temp-name template) "#"))
361 (setq entry (intern file jka-compr-temp-name-table))
362 (if (or (get entry 'active)
363 (file-exists-p file))
364
365 (progn
366 (setq lastchar (1+ lastchar))
367 (if (> lastchar ?z)
368 (progn
369 (setq prevchar (1+ prevchar))
370 (setq lastchar ?a)
371 (if (> prevchar ?z)
372 (error "Can't allocate temp file.")
373 (aset template (1- lastpos) prevchar)))))
374
375 (put entry 'active (not local-copy))
376 (setq not-done nil)))
377
378 file))
379
380
381(defun jka-compr-delete-temp-file (temp)
382
383 (put (intern temp jka-compr-temp-name-table)
384 'active nil)
385
386 (condition-case ()
387 (delete-file temp)
388 (error nil)))
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))
394 (info (jka-compr-get-compression-info visit-file)))
395
396 (if info
397
398 (let ((can-append (jka-compr-info-can-append info))
399 (compress-program (jka-compr-info-compress-program info))
400 (compress-message (jka-compr-info-compress-message info))
401 (uncompress-program (jka-compr-info-uncompress-program info))
402 (uncompress-message (jka-compr-info-uncompress-message info))
403 (compress-args (jka-compr-info-compress-args info))
404 (uncompress-args (jka-compr-info-uncompress-args info))
acd622cc 405 (base-name (file-name-nondirectory visit-file))
75e9c107 406 temp-file temp-buffer)
acd622cc 407
75e9c107
RS
408 (setq temp-buffer (get-buffer-create " *jka-compr-wr-temp*"))
409 (with-current-buffer temp-buffer
410 (widen) (erase-buffer))
acd622cc 411
30c78e11
RS
412 (if (and append
413 (not can-append)
414 (file-exists-p filename))
415
416 (let* ((local-copy (file-local-copy filename))
417 (local-file (or local-copy filename)))
418
419 (setq temp-file local-file))
420
421 (setq temp-file (jka-compr-make-temp-name)))
acd622cc
RS
422
423 (and
424 compress-message
425 (message "%s %s..." compress-message base-name))
30c78e11 426
8fb1a583
RS
427 (jka-compr-run-real-handler 'write-region
428 (list start end temp-file t 'dont))
acd622cc
RS
429
430 (jka-compr-call-process compress-program
431 (concat compress-message
432 " " base-name)
433 temp-file
434 temp-buffer
435 nil
436 compress-args)
437
75e9c107
RS
438 (with-current-buffer temp-buffer
439 (jka-compr-run-real-handler 'write-region
440 (list (point-min) (point-max)
441 filename
442 (and append can-append) 'dont))
443 (erase-buffer))
acd622cc
RS
444
445 (jka-compr-delete-temp-file temp-file)
446
447 (and
448 compress-message
449 (message "%s %s...done" compress-message base-name))
450
451 (cond
452 ((eq visit t)
453 (setq buffer-file-name filename)
454 (set-visited-file-modtime))
455 ((stringp visit)
456 (setq buffer-file-name visit)
457 (let ((buffer-file-name filename))
458 (set-visited-file-modtime))))
459
460 (and (or (eq visit t)
461 (eq visit nil)
462 (stringp visit))
463 (message "Wrote %s" visit-file))
464
465 nil)
466
8fb1a583
RS
467 (jka-compr-run-real-handler 'write-region
468 (list start end filename append visit)))))
acd622cc
RS
469
470
54b2aa5c 471(defun jka-compr-insert-file-contents (file &optional visit beg end replace)
acd622cc
RS
472 (barf-if-buffer-read-only)
473
474 (and (or beg end)
475 visit
476 (error "Attempt to visit less than an entire file"))
477
478 (let* ((filename (expand-file-name file))
479 (info (jka-compr-get-compression-info filename)))
480
481 (if info
482
483 (let ((uncompress-message (jka-compr-info-uncompress-message info))
484 (uncompress-program (jka-compr-info-uncompress-program info))
485 (uncompress-args (jka-compr-info-uncompress-args info))
486 (base-name (file-name-nondirectory filename))
487 (notfound nil)
8fb1a583
RS
488 (local-copy
489 (jka-compr-run-real-handler 'file-local-copy (list filename)))
acd622cc
RS
490 local-file
491 size start)
492
493 (setq local-file (or local-copy filename))
494
495 (and
496 visit
497 (setq buffer-file-name filename))
498
499 (unwind-protect ; to make sure local-copy gets deleted
500
501 (progn
502
503 (and
504 uncompress-message
505 (message "%s %s..." uncompress-message base-name))
506
507 (condition-case error-code
508
509 (progn
094cf604
RS
510 (if replace
511 (goto-char (point-min)))
acd622cc
RS
512 (setq start (point))
513 (if (or beg end)
514 (jka-compr-partial-uncompress uncompress-program
515 (concat uncompress-message
516 " " base-name)
517 uncompress-args
518 local-file
519 (or beg 0)
520 (if (and beg end)
521 (- end beg)
522 end))
ae849784
RS
523 ;; If visiting, bind off buffer-file-name so that
524 ;; file-locking will not ask whether we should
525 ;; really edit the buffer.
526 (let ((buffer-file-name
527 (if visit nil buffer-file-name)))
528 (jka-compr-call-process uncompress-program
529 (concat uncompress-message
530 " " base-name)
531 local-file
532 t
533 nil
534 uncompress-args)))
acd622cc 535 (setq size (- (point) start))
094cf604
RS
536 (if replace
537 (let* ((del-beg (point))
538 (del-end (+ del-beg size)))
539 (delete-region del-beg
540 (min del-end (point-max)))))
541 (goto-char start))
acd622cc
RS
542 (error
543 (if (and (eq (car error-code) 'file-error)
544 (eq (nth 3 error-code) local-file))
545 (if visit
546 (setq notfound error-code)
547 (signal 'file-error
548 (cons "Opening input file"
549 (nthcdr 2 error-code))))
550 (signal (car error-code) (cdr error-code))))))
551
552 (and
553 local-copy
554 (file-exists-p local-copy)
555 (delete-file local-copy)))
556
557 (and
558 visit
559 (progn
8fb1a583 560 (unlock-buffer)
acd622cc
RS
561 (setq buffer-file-name filename)
562 (set-visited-file-modtime)))
563
564 (and
565 uncompress-message
566 (message "%s %s...done" uncompress-message base-name))
567
568 (and
569 visit
570 notfound
571 (signal 'file-error
572 (cons "Opening input file" (nth 2 notfound))))
573
094cf604
RS
574 ;; Run the functions that insert-file-contents would.
575 (let ((p after-insert-file-functions)
576 (insval size))
577 (while p
578 (setq insval (funcall (car p) size))
579 (if insval
580 (progn
581 (or (integerp insval)
582 (signal 'wrong-type-argument
583 (list 'integerp insval)))
584 (setq size insval)))
585 (setq p (cdr p))))
586
acd622cc
RS
587 (list filename size))
588
8fb1a583
RS
589 (jka-compr-run-real-handler 'insert-file-contents
590 (list file visit beg end replace)))))
acd622cc
RS
591
592
593(defun jka-compr-file-local-copy (file)
acd622cc
RS
594 (let* ((filename (expand-file-name file))
595 (info (jka-compr-get-compression-info filename)))
596
597 (if info
598
599 (let ((uncompress-message (jka-compr-info-uncompress-message info))
600 (uncompress-program (jka-compr-info-uncompress-program info))
601 (uncompress-args (jka-compr-info-uncompress-args info))
602 (base-name (file-name-nondirectory filename))
8fb1a583
RS
603 (local-copy
604 (jka-compr-run-real-handler 'file-local-copy (list filename)))
acd622cc 605 (temp-file (jka-compr-make-temp-name t))
30c78e11 606 (temp-buffer (get-buffer-create " *jka-compr-flc-temp*"))
acd622cc 607 (notfound nil)
acd622cc
RS
608 local-file)
609
610 (setq local-file (or local-copy filename))
611
612 (unwind-protect
613
75e9c107 614 (with-current-buffer temp-buffer
acd622cc
RS
615
616 (and
617 uncompress-message
618 (message "%s %s..." uncompress-message base-name))
acd622cc
RS
619
620 (jka-compr-call-process uncompress-program
621 (concat uncompress-message
622 " " base-name)
623 local-file
624 t
625 nil
626 uncompress-args)
627
628 (and
629 uncompress-message
630 (message "%s %s...done" uncompress-message base-name))
631
632 (write-region
633 (point-min) (point-max) temp-file nil 'dont))
634
635 (and
636 local-copy
637 (file-exists-p local-copy)
638 (delete-file local-copy))
639
acd622cc
RS
640 (kill-buffer temp-buffer))
641
642 temp-file)
643
8fb1a583 644 (jka-compr-run-real-handler 'file-local-copy (list filename)))))
acd622cc
RS
645
646
647;;; Support for loading compressed files.
648(defun jka-compr-load (file &optional noerror nomessage nosuffix)
649 "Documented as original."
650
651 (let* ((local-copy (jka-compr-file-local-copy file))
652 (load-file (or local-copy file)))
653
654 (unwind-protect
655
8fb1a583
RS
656 (let (inhibit-file-name-operation
657 inhibit-file-name-handlers)
acd622cc
RS
658 (or nomessage
659 (message "Loading %s..." file))
660
9b37d8a9
RS
661 (let ((load-force-doc-strings t))
662 (load load-file noerror t t))
acd622cc
RS
663
664 (or nomessage
665 (message "Loading %s...done." file)))
666
acd622cc
RS
667 (jka-compr-delete-temp-file local-copy))
668
669 t))
3068998d
RS
670
671(defun jka-compr-byte-compiler-base-file-name (file)
672 (let ((info (jka-compr-get-compression-info file)))
673 (if (and info (jka-compr-info-strip-extension info))
674 (save-match-data
675 (substring file 0 (string-match (jka-compr-info-regexp info) file)))
676 file)))
8fb1a583
RS
677\f
678(put 'write-region 'jka-compr 'jka-compr-write-region)
679(put 'insert-file-contents 'jka-compr 'jka-compr-insert-file-contents)
680(put 'file-local-copy 'jka-compr 'jka-compr-file-local-copy)
681(put 'load 'jka-compr 'jka-compr-load)
3068998d
RS
682(put 'byte-compiler-base-file-name 'jka-compr
683 'jka-compr-byte-compiler-base-file-name)
acd622cc 684
acd622cc 685(defun jka-compr-handler (operation &rest args)
8fb1a583
RS
686 (save-match-data
687 (let ((jka-op (get operation 'jka-compr)))
688 (if jka-op
689 (apply jka-op args)
690 (jka-compr-run-real-handler operation args)))))
acd622cc 691
99bee6a4
RS
692;; If we are given an operation that we don't handle,
693;; call the Emacs primitive for that operation,
694;; and manipulate the inhibit variables
695;; to prevent the primitive from calling our handler again.
696(defun jka-compr-run-real-handler (operation args)
697 (let ((inhibit-file-name-handlers
698 (cons 'jka-compr-handler
699 (and (eq inhibit-file-name-operation operation)
700 inhibit-file-name-handlers)))
701 (inhibit-file-name-operation operation))
702 (apply operation args)))
703
b6dca218 704;;;###autoload(defun auto-compression-mode (&optional arg)
e5220563
RS
705;;;###autoload "\
706;;;###autoloadToggle automatic file compression and uncompression.
b6dca218
RS
707;;;###autoloadWith prefix argument ARG, turn auto compression on if positive, else off.
708;;;###autoloadReturns the new status of auto compression (non-nil means on)."
e5220563 709;;;###autoload (interactive "P")
b6dca218
RS
710;;;###autoload (if (not (fboundp 'jka-compr-installed-p))
711;;;###autoload (progn
712;;;###autoload (require 'jka-compr)
713;;;###autoload ;; That turned the mode on, so make it initially off.
714;;;###autoload (toggle-auto-compression)))
e5220563 715;;;###autoload (toggle-auto-compression arg t))
b6dca218 716
e5220563 717(defun toggle-auto-compression (&optional arg message)
61793fbf 718 "Toggle automatic file compression and uncompression.
acd622cc 719With prefix argument ARG, turn auto compression on if positive, else off.
e5220563
RS
720Returns the new status of auto compression (non-nil means on).
721If the argument MESSAGE is non-nil, it means to print a message
722saying whether the mode is now on or off."
723 (interactive "P\np")
acd622cc
RS
724 (let* ((installed (jka-compr-installed-p))
725 (flag (if (null arg)
726 (not installed)
727 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))))
728
729 (cond
730 ((and flag installed) t) ; already installed
731
732 ((and (not flag) (not installed)) nil) ; already not installed
733
734 (flag
735 (jka-compr-install))
736
737 (t
738 (jka-compr-uninstall)))
739
740
e5220563 741 (and message
acd622cc
RS
742 (if flag
743 (message "Automatic file (de)compression is now ON.")
744 (message "Automatic file (de)compression is now OFF.")))
745
746 flag))
acd622cc
RS
747
748(defun jka-compr-build-file-regexp ()
749 (concat
750 "\\("
751 (mapconcat
752 'jka-compr-info-regexp
753 jka-compr-compression-info-list
754 "\\)\\|\\(")
755 "\\)"))
756
757
758(defun jka-compr-install ()
759 "Install jka-compr.
919a07bb
RS
760This adds entries to `file-name-handler-alist' and `auto-mode-alist'
761and `inhibit-first-line-modes-suffixes'."
acd622cc
RS
762
763 (setq jka-compr-file-name-handler-entry
764 (cons (jka-compr-build-file-regexp) 'jka-compr-handler))
765
766 (setq file-name-handler-alist (cons jka-compr-file-name-handler-entry
767 file-name-handler-alist))
768
769 (mapcar
770 (function (lambda (x)
469f4e8c
RS
771 (and (jka-compr-info-strip-extension x)
772 ;; Make entries in auto-mode-alist so that modes
773 ;; are chosen right according to the file names
774 ;; sans `.gz'.
775 (setq auto-mode-alist
776 (cons (list (jka-compr-info-regexp x)
777 nil 'jka-compr)
778 auto-mode-alist))
779 ;; Also add these regexps to
780 ;; inhibit-first-line-modes-suffixes, so that a
781 ;; -*- line in the first file of a compressed tar
782 ;; file doesn't override tar-mode.
783 (setq inhibit-first-line-modes-suffixes
784 (cons (jka-compr-info-regexp x)
785 inhibit-first-line-modes-suffixes)))))
74b2c737
RS
786 jka-compr-compression-info-list)
787 (setq auto-mode-alist
788 (append auto-mode-alist jka-compr-mode-alist-additions)))
acd622cc
RS
789
790
791(defun jka-compr-uninstall ()
792 "Uninstall jka-compr.
99bee6a4 793This removes the entries in `file-name-handler-alist' and `auto-mode-alist'
919a07bb
RS
794and `inhibit-first-line-modes-suffixes' that were added
795by `jka-compr-installed'."
796 ;; Delete from inhibit-first-line-modes-suffixes
797 ;; what jka-compr-install added.
798 (mapcar
799 (function (lambda (x)
800 (and (jka-compr-info-strip-extension x)
801 (setq inhibit-first-line-modes-suffixes
802 (delete (jka-compr-info-regexp x)
803 inhibit-first-line-modes-suffixes)))))
804 jka-compr-compression-info-list)
acd622cc
RS
805
806 (let* ((fnha (cons nil file-name-handler-alist))
807 (last fnha))
808
809 (while (cdr last)
810 (if (eq (cdr (car (cdr last))) 'jka-compr-handler)
811 (setcdr last (cdr (cdr last)))
812 (setq last (cdr last))))
813
814 (setq file-name-handler-alist (cdr fnha)))
815
816 (let* ((ama (cons nil auto-mode-alist))
817 (last ama)
818 entry)
819
820 (while (cdr last)
821 (setq entry (car (cdr last)))
74b2c737
RS
822 (if (or (member entry jka-compr-mode-alist-additions)
823 (and (consp (cdr entry))
824 (eq (nth 2 entry) 'jka-compr)))
acd622cc
RS
825 (setcdr last (cdr (cdr last)))
826 (setq last (cdr last))))
827
828 (setq auto-mode-alist (cdr ama))))
829
830
831(defun jka-compr-installed-p ()
832 "Return non-nil if jka-compr is installed.
99bee6a4 833The return value is the entry in `file-name-handler-alist' for jka-compr."
acd622cc
RS
834
835 (let ((fnha file-name-handler-alist)
836 (installed nil))
837
838 (while (and fnha (not installed))
839 (and (eq (cdr (car fnha)) 'jka-compr-handler)
840 (setq installed (car fnha)))
841 (setq fnha (cdr fnha)))
842
843 installed))
844
845
846;;; Add the file I/O hook if it does not already exist.
847;;; Make sure that jka-compr-file-name-handler-entry is eq to the
848;;; entry for jka-compr in file-name-handler-alist.
849(and (jka-compr-installed-p)
850 (jka-compr-uninstall))
851
852(jka-compr-install)
853
854
855(provide 'jka-compr)
856
857;; jka-compr.el ends here.