jka-compr.el 22.4 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
;;; jka-compr.el --- reading/writing/loading compressed files

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1993, 1994, 1995, 1997, 1999, 2000, 2001, 2002, 2003,
4
;;   2004, 2005, 2006 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5 6

;; Author: jka@ece.cmu.edu (Jay K. Adams)
Richard M. Stallman's avatar
Richard M. Stallman committed
7
;; Maintainer: FSF
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9
;; Keywords: data

10 11 12 13 14 15 16 17 18 19 20 21 22
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
26

27
;;; Commentary:
Richard M. Stallman's avatar
Richard M. Stallman committed
28

Erik Naggum's avatar
Erik Naggum committed
29 30 31 32 33 34 35 36 37 38 39
;; This package implements low-level support for reading, writing,
;; and loading compressed files.  It hooks into the low-level file
;; I/O functions (including write-region and insert-file-contents) so
;; that they automatically compress or uncompress a file if the file
;; appears to need it (based on the extension of the file name).
;; Packages like Rmail, VM, GNUS, and Info should be able to work
;; with compressed files without modification.


;; INSTRUCTIONS:
;;
Miles Bader's avatar
Miles Bader committed
40 41 42 43
;; To use jka-compr, invoke the command `auto-compression-mode' (which
;; see), or customize the variable of the same name.  Its operation
;; should be transparent to the user (except for messages appearing when
;; a file is being compressed or uncompressed).
Erik Naggum's avatar
Erik Naggum committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
;;
;; The variable, jka-compr-compression-info-list can be used to
;; customize jka-compr to work with other compression programs.
;; The default value of this variable allows jka-compr to work with
;; Unix compress and gzip.
;;
;; If you are concerned about the stderr output of gzip and other
;; compression/decompression programs showing up in your buffers, you
;; should set the discard-error flag in the compression-info-list.
;; This will cause the stderr of all programs to be discarded.
;; However, it also causes emacs to call compression/uncompression
;; programs through a shell (which is specified by jka-compr-shell).
;; This may be a drag if, on your system, starting up a shell is
;; slow.
;;
;; If you don't want messages about compressing and decompressing
;; to show up in the echo area, you can set the compress-name and
;; decompress-name fields of the jka-compr-compression-info-list to
;; nil.


;; APPLICATION NOTES:
;;
;; crypt++
Eli Zaretskii's avatar
Eli Zaretskii committed
68
;;   jka-compr can coexist with crypt++ if you take all the decompression
Erik Naggum's avatar
Erik Naggum committed
69 70 71 72 73 74 75 76 77 78 79 80
;;   entries out of the crypt-encoding-list.  Clearly problems will arise if
;;   you have two programs trying to compress/decompress files.  jka-compr
;;   will not "work with" crypt++ in the following sense: you won't be able to
;;   decode encrypted compressed files--that is, files that have been
;;   compressed then encrypted (in that order).  Theoretically, crypt++ and
;;   jka-compr could properly handle a file that has been encrypted then
;;   compressed, but there is little point in trying to compress an encrypted
;;   file.
;;


;; ACKNOWLEDGMENTS
81
;;
Erik Naggum's avatar
Erik Naggum committed
82
;; jka-compr is a V19 adaptation of jka-compr for V18 of Emacs.  Many people
83
;; have made helpful suggestions, reported bugs, and even fixed bugs in
Erik Naggum's avatar
Erik Naggum committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
;; jka-compr.  I recall the following people as being particularly helpful.
;;
;;   Jean-loup Gailly
;;   David Hughes
;;   Richard Pieri
;;   Daniel Quinlan
;;   Chris P. Ross
;;   Rick Sladkey
;;
;; Andy Norman's ange-ftp was the inspiration for the original jka-compr for
;; Version 18 of Emacs.
;;
;; After I had made progress on the original jka-compr for V18, I learned of a
;; package written by Kazushi Jam Marukawa, called jam-zcat, that did exactly
;; what I was trying to do.  I looked over the jam-zcat source code and
;; probably got some ideas from it.
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
101 102 103

;;; Code:

Stefan Monnier's avatar
Stefan Monnier committed
104 105
(require 'jka-cmpr-hook)

106
(defcustom jka-compr-shell "sh"
Richard M. Stallman's avatar
Richard M. Stallman committed
107 108 109
  "*Shell to be used for calling compression programs.
The value of this variable only matters if you want to discard the
stderr of a compression/decompression program (see the documentation
110 111 112
for `jka-compr-compression-info-list')."
  :type 'string
  :group 'jka-compr)
Richard M. Stallman's avatar
Richard M. Stallman committed
113

114
(defvar jka-compr-use-shell
115
  (not (memq system-type '(ms-dos windows-nt))))
Richard M. Stallman's avatar
Richard M. Stallman committed
116

117
(defvar jka-compr-really-do-compress nil
118 119 120 121
  "Non-nil in a buffer whose visited file was uncompressed on visiting it.
This means compress the data on writing the file, even if the
data appears to be compressed already.")
(make-variable-buffer-local 'jka-compr-really-do-compress)
122
(put 'jka-compr-really-do-compress 'permanent-local t)
123

Richard M. Stallman's avatar
Richard M. Stallman committed
124 125 126 127

(put 'compression-error 'error-conditions '(compression-error file-error error))


128
(defvar jka-compr-acceptable-retval-list '(0 2 141))
Richard M. Stallman's avatar
Richard M. Stallman committed
129 130 131 132


(defun jka-compr-error (prog args infile message &optional errfile)

Stefan Monnier's avatar
Stefan Monnier committed
133
  (let ((errbuf (get-buffer-create " *jka-compr-error*")))
134 135 136 137 138 139 140 141 142
    (with-current-buffer errbuf
      (widen) (erase-buffer)
      (insert (format "Error while executing \"%s %s < %s\"\n\n"
		      prog
		      (mapconcat 'identity args " ")
		      infile))

      (and errfile
	   (insert-file-contents errfile)))
Richard M. Stallman's avatar
Richard M. Stallman committed
143 144
     (display-buffer errbuf))

145 146
  (signal 'compression-error
	  (list "Opening input file" (format "error %s" message) infile)))
147 148


149 150 151 152
(defcustom jka-compr-dd-program "/bin/dd"
  "How to invoke `dd'."
  :type 'string
  :group 'jka-compr)
Richard M. Stallman's avatar
Richard M. Stallman committed
153 154


155
(defvar jka-compr-dd-blocksize 256)
Richard M. Stallman's avatar
Richard M. Stallman committed
156 157 158 159 160


(defun jka-compr-partial-uncompress (prog message args infile beg len)
  "Call program PROG with ARGS args taking input from INFILE.
Fourth and fifth args, BEG and LEN, specify which part of the output
161
to keep: LEN chars starting BEG chars from the beginning."
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
  (let ((start (point))
	(prefix beg))
    (if (and jka-compr-use-shell jka-compr-dd-program)
	;; Put the uncompression output through dd
	;; to discard the part we don't want.
	(let ((skip (/ beg jka-compr-dd-blocksize))
	      (err-file (jka-compr-make-temp-name))
	      count)
	  ;; Update PREFIX based on the text that we won't read in.
	  (setq prefix (- beg (* skip jka-compr-dd-blocksize))
		count (and len (1+ (/ (+ len prefix) jka-compr-dd-blocksize))))
	  (unwind-protect
	      (or (memq (call-process
			 jka-compr-shell infile t nil "-c"
			 (format
177
			  "%s %s 2> %s | %s bs=%d skip=%d %s 2> %s"
178 179 180 181 182 183 184 185 186
			  prog
			  (mapconcat 'identity args " ")
			  err-file
			  jka-compr-dd-program
			  jka-compr-dd-blocksize
			  skip
			  ;; dd seems to be unreliable about
			  ;; providing the last block.  So, always
			  ;; read one more than you think you need.
187 188
			  (if count (format "count=%d" (1+ count)) "")
			  null-device))
189 190 191 192 193 194
			jka-compr-acceptable-retval-list)
		  (jka-compr-error prog args infile message err-file))
	    (jka-compr-delete-temp-file err-file)))
      ;; Run the uncompression program directly.
      ;; We get the whole file and must delete what we don't want.
      (jka-compr-call-process prog message infile t nil args))
Richard M. Stallman's avatar
Richard M. Stallman committed
195

196
    ;; Delete the stuff after what we want, if there is any.
Richard M. Stallman's avatar
Richard M. Stallman committed
197
    (and
198
     len
199
     (< (+ start prefix len) (point))
200
     (delete-region (+ start prefix len) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
201

202
    ;; Delete the stuff before what we want.
Richard M. Stallman's avatar
Richard M. Stallman committed
203 204 205 206 207 208
    (delete-region start (+ start prefix))))


(defun jka-compr-call-process (prog message infile output temp args)
  (if jka-compr-use-shell

209
      (let ((err-file (jka-compr-make-temp-name))
Kenichi Handa's avatar
Kenichi Handa committed
210
	    (coding-system-for-read (or coding-system-for-read 'undecided))
Karl Heuer's avatar
Karl Heuer committed
211
            (coding-system-for-write 'no-conversion))
212

Richard M. Stallman's avatar
Richard M. Stallman committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
	(unwind-protect

	    (or (memq
		 (call-process jka-compr-shell infile
			       (if (stringp output) nil output)
			       nil
			       "-c"
			       (format "%s %s 2> %s %s"
				       prog
				       (mapconcat 'identity args " ")
				       err-file
				       (if (stringp output)
					   (concat "> " output)
					 "")))
		 jka-compr-acceptable-retval-list)

		(jka-compr-error prog args infile message err-file))

	  (jka-compr-delete-temp-file err-file)))

233
    (or (eq 0
Richard M. Stallman's avatar
Richard M. Stallman committed
234 235 236 237 238 239 240 241 242
	 (apply 'call-process
		prog
		infile
		(if (stringp output) temp output)
		nil
		args))
	(jka-compr-error prog args infile message))

    (and (stringp output)
243
	 (with-current-buffer temp
Richard M. Stallman's avatar
Richard M. Stallman committed
244
	   (write-region (point-min) (point-max) output)
245
	   (erase-buffer)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
246 247


Stefan Monnier's avatar
Stefan Monnier committed
248 249
;; Support for temp files.  Much of this was inspired if not lifted
;; from ange-ftp.
Richard M. Stallman's avatar
Richard M. Stallman committed
250

251
(defcustom jka-compr-temp-name-template
252
  (expand-file-name "jka-com" temporary-file-directory)
253
  "Prefix added to all temp files created by jka-compr.
254 255 256
There should be no more than seven characters after the final `/'."
  :type 'string
  :group 'jka-compr)
Richard M. Stallman's avatar
Richard M. Stallman committed
257 258 259

(defun jka-compr-make-temp-name (&optional local-copy)
  "This routine will return the name of a new file."
Stefan Monnier's avatar
Stefan Monnier committed
260 261 262
  (make-temp-file jka-compr-temp-name-template))

(defalias 'jka-compr-delete-temp-file 'delete-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
263 264 265 266 267


(defun jka-compr-write-region (start end file &optional append visit)
  (let* ((filename (expand-file-name file))
	 (visit-file (if (stringp visit) (expand-file-name visit) filename))
268 269 270
	 (info (jka-compr-get-compression-info visit-file))
	 (magic (and info (jka-compr-info-file-magic-bytes info))))

271 272 273 274
    ;; If START is nil, use the whole buffer.
    (if (null start)
	(setq start 1 end (1+ (buffer-size))))

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
    ;; If we uncompressed this file when visiting it,
    ;; then recompress it when writing it
    ;; even if the contents look compressed already.
    (if (and jka-compr-really-do-compress
	     (eq start 1)
	     (eq end (1+ (buffer-size))))
	(setq magic nil))

    (if (and info
	     ;; If the contents to be written out
	     ;; are properly compressed already,
	     ;; don't try to compress them over again.
	     (not (and magic
		       (equal (if (stringp start)
				  (substring start 0 (min (length start)
							  (length magic)))
				(buffer-substring start
						  (min end
						       (+ start (length magic)))))
			      magic))))
	(let ((can-append (jka-compr-info-can-append info))
	      (compress-program (jka-compr-info-compress-program info))
	      (compress-message (jka-compr-info-compress-message info))
	      (compress-args (jka-compr-info-compress-args info))
	      (base-name (file-name-nondirectory visit-file))
	      temp-file temp-buffer
	      ;; we need to leave `last-coding-system-used' set to its
	      ;; value after calling write-region the first time, so
	      ;; that `basic-save-buffer' sees the right value.
	      (coding-system-used last-coding-system-used))

306 307 308
          (or compress-program
              (error "No compression program defined"))

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
	  (setq temp-buffer (get-buffer-create " *jka-compr-wr-temp*"))
	  (with-current-buffer temp-buffer
	    (widen) (erase-buffer))

	  (if (and append
		   (not can-append)
		   (file-exists-p filename))

	      (let* ((local-copy (file-local-copy filename))
		     (local-file (or local-copy filename)))

		(setq temp-file local-file))

	    (setq temp-file (jka-compr-make-temp-name)))

324
	  (and
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
	   compress-message
	   (message "%s %s..." compress-message base-name))

	  (jka-compr-run-real-handler 'write-region
				      (list start end temp-file t 'dont))
	  ;; save value used by the real write-region
	  (setq coding-system-used last-coding-system-used)

	  ;; Here we must read the output of compress program as is
	  ;; without any code conversion.
	  (let ((coding-system-for-read 'no-conversion))
	    (jka-compr-call-process compress-program
				    (concat compress-message
					    " " base-name)
				    temp-file
				    temp-buffer
				    nil
				    compress-args))

	  (with-current-buffer temp-buffer
	    (let ((coding-system-for-write 'no-conversion))
	      (if (memq system-type '(ms-dos windows-nt))
		  (setq buffer-file-type t) )
	      (jka-compr-run-real-handler 'write-region
					  (list (point-min) (point-max)
						filename
						(and append can-append) 'dont))
	      (erase-buffer)) )

	  (jka-compr-delete-temp-file temp-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
355

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
	  (and
	   compress-message
	   (message "%s %s...done" compress-message base-name))

	  (cond
	   ((eq visit t)
	    (setq buffer-file-name filename)
	    (setq jka-compr-really-do-compress t)
	    (set-visited-file-modtime))
	   ((stringp visit)
	    (setq buffer-file-name visit)
	    (let ((buffer-file-name filename))
	      (set-visited-file-modtime))))

	  (and (or (eq visit t)
		   (eq visit nil)
		   (stringp visit))
	       (message "Wrote %s" visit-file))

	  ;; ensure `last-coding-system-used' has an appropriate value
	  (setq last-coding-system-used coding-system-used)

	  nil)
379

380 381
      (jka-compr-run-real-handler 'write-region
				  (list start end filename append visit)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
382 383


384
(defun jka-compr-insert-file-contents (file &optional visit beg end replace)
Richard M. Stallman's avatar
Richard M. Stallman committed
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
  (barf-if-buffer-read-only)

  (and (or beg end)
       visit
       (error "Attempt to visit less than an entire file"))

  (let* ((filename (expand-file-name file))
	 (info (jka-compr-get-compression-info filename)))

    (if info

	(let ((uncompress-message (jka-compr-info-uncompress-message info))
	      (uncompress-program (jka-compr-info-uncompress-program info))
	      (uncompress-args (jka-compr-info-uncompress-args info))
	      (base-name (file-name-nondirectory filename))
	      (notfound nil)
401 402
	      (local-copy
	       (jka-compr-run-real-handler 'file-local-copy (list filename)))
Richard M. Stallman's avatar
Richard M. Stallman committed
403
	      local-file
404
	      size start)
Richard M. Stallman's avatar
Richard M. Stallman committed
405 406 407 408 409 410 411 412 413 414

	  (setq local-file (or local-copy filename))

	  (and
	   visit
	   (setq buffer-file-name filename))

	  (unwind-protect		; to make sure local-copy gets deleted

	      (progn
415

Richard M. Stallman's avatar
Richard M. Stallman committed
416 417 418 419 420 421
		(and
		 uncompress-message
		 (message "%s %s..." uncompress-message base-name))

		(condition-case error-code

422
		    (let ((coding-system-for-read 'no-conversion))
423 424
		      (if replace
			  (goto-char (point-min)))
Richard M. Stallman's avatar
Richard M. Stallman committed
425 426 427 428 429 430 431 432 433 434 435
		      (setq start (point))
		      (if (or beg end)
			  (jka-compr-partial-uncompress uncompress-program
							(concat uncompress-message
								" " base-name)
							uncompress-args
							local-file
							(or beg 0)
							(if (and beg end)
							    (- end beg)
							  end))
436 437 438 439 440 441 442 443 444 445 446 447
			;; If visiting, bind off buffer-file-name so that
			;; file-locking will not ask whether we should
			;; really edit the buffer.
			(let ((buffer-file-name
			       (if visit nil buffer-file-name)))
			  (jka-compr-call-process uncompress-program
						  (concat uncompress-message
							  " " base-name)
						  local-file
						  t
						  nil
						  uncompress-args)))
Richard M. Stallman's avatar
Richard M. Stallman committed
448
		      (setq size (- (point) start))
449
		      (if replace
450
			  (delete-region (point) (point-max)))
451
		      (goto-char start))
Richard M. Stallman's avatar
Richard M. Stallman committed
452
		  (error
453 454 455
		   ;; If the file we wanted to uncompress does not exist,
		   ;; handle that according to VISIT as `insert-file-contents'
		   ;; would, maybe signaling the same error it normally would.
Richard M. Stallman's avatar
Richard M. Stallman committed
456 457 458 459
		   (if (and (eq (car error-code) 'file-error)
			    (eq (nth 3 error-code) local-file))
		       (if visit
			   (setq notfound error-code)
460
			 (signal 'file-error
Richard M. Stallman's avatar
Richard M. Stallman committed
461 462
				 (cons "Opening input file"
				       (nthcdr 2 error-code))))
463 464 465 466 467 468 469
		     ;; If the uncompression program can't be found,
		     ;; signal that as a non-file error
		     ;; so that find-file-noselect-1 won't handle it.
		     (if (and (eq (car error-code) 'file-error)
			      (equal (cadr error-code) "Searching for program"))
			 (error "Uncompression program `%s' not found"
				(nth 3 error-code)))
Richard M. Stallman's avatar
Richard M. Stallman committed
470 471 472 473 474 475 476
		     (signal (car error-code) (cdr error-code))))))

	    (and
	     local-copy
	     (file-exists-p local-copy)
	     (delete-file local-copy)))

477 478 479 480 481
	  (unless notfound
	    (decode-coding-inserted-region
	     (point) (+ (point) size)
	     (jka-compr-byte-compiler-base-file-name file)
	     visit beg end replace))
482

Richard M. Stallman's avatar
Richard M. Stallman committed
483 484 485
	  (and
	   visit
	   (progn
486
	     (unlock-buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
487
	     (setq buffer-file-name filename)
488
	     (setq jka-compr-really-do-compress t)
Richard M. Stallman's avatar
Richard M. Stallman committed
489
	     (set-visited-file-modtime)))
490

Richard M. Stallman's avatar
Richard M. Stallman committed
491 492 493 494 495 496 497 498 499 500
	  (and
	   uncompress-message
	   (message "%s %s...done" uncompress-message base-name))

	  (and
	   visit
	   notfound
	   (signal 'file-error
		   (cons "Opening input file" (nth 2 notfound))))

501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
	  ;; This is done in insert-file-contents after we return.
	  ;; That is a little weird, but better to go along with it now
	  ;; than to change it now.

;;;	  ;; Run the functions that insert-file-contents would.
;;; 	  (let ((p after-insert-file-functions)
;;; 		(insval size))
;;; 	    (while p
;;; 	      (setq insval (funcall (car p) size))
;;; 	      (if insval
;;; 		  (progn
;;; 		    (or (integerp insval)
;;; 			(signal 'wrong-type-argument
;;; 				(list 'integerp insval)))
;;; 		    (setq size insval)))
;;; 	      (setq p (cdr p))))
517

518 519 520
          (or (jka-compr-info-compress-program info)
              (message "You can't save this buffer because compression program is not defined"))

Richard M. Stallman's avatar
Richard M. Stallman committed
521 522
	  (list filename size))

523 524
      (jka-compr-run-real-handler 'insert-file-contents
				  (list file visit beg end replace)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
525 526 527 528 529 530 531 532 533 534 535 536


(defun jka-compr-file-local-copy (file)
  (let* ((filename (expand-file-name file))
	 (info (jka-compr-get-compression-info filename)))

    (if info

	(let ((uncompress-message (jka-compr-info-uncompress-message info))
	      (uncompress-program (jka-compr-info-uncompress-program info))
	      (uncompress-args (jka-compr-info-uncompress-args info))
	      (base-name (file-name-nondirectory filename))
537 538
	      (local-copy
	       (jka-compr-run-real-handler 'file-local-copy (list filename)))
Richard M. Stallman's avatar
Richard M. Stallman committed
539
	      (temp-file (jka-compr-make-temp-name t))
540
	      (temp-buffer (get-buffer-create " *jka-compr-flc-temp*"))
Richard M. Stallman's avatar
Richard M. Stallman committed
541 542 543 544 545 546
	      local-file)

	  (setq local-file (or local-copy filename))

	  (unwind-protect

547
	      (with-current-buffer temp-buffer
548

Richard M. Stallman's avatar
Richard M. Stallman committed
549 550 551
		(and
		 uncompress-message
		 (message "%s %s..." uncompress-message base-name))
552

Kenichi Handa's avatar
Kenichi Handa committed
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
		;; Here we must read the output of uncompress program
		;; and write it to TEMP-FILE without any code
		;; conversion.  An appropriate code conversion (if
		;; necessary) is done by the later I/O operation
		;; (e.g. load).
		(let ((coding-system-for-read 'no-conversion)
		      (coding-system-for-write 'no-conversion))

		  (jka-compr-call-process uncompress-program
					  (concat uncompress-message
						  " " base-name)
					  local-file
					  t
					  nil
					  uncompress-args)

		  (and
		   uncompress-message
		   (message "%s %s...done" uncompress-message base-name))

		  (write-region
		   (point-min) (point-max) temp-file nil 'dont)))
Richard M. Stallman's avatar
Richard M. Stallman committed
575 576 577 578 579 580 581 582 583

	    (and
	     local-copy
	     (file-exists-p local-copy)
	     (delete-file local-copy))

	    (kill-buffer temp-buffer))

	  temp-file)
584

585
      (jka-compr-run-real-handler 'file-local-copy (list filename)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
586 587


Stefan Monnier's avatar
Stefan Monnier committed
588
;; Support for loading compressed files.
Richard M. Stallman's avatar
Richard M. Stallman committed
589 590 591 592 593 594 595 596
(defun jka-compr-load (file &optional noerror nomessage nosuffix)
  "Documented as original."

  (let* ((local-copy (jka-compr-file-local-copy file))
	 (load-file (or local-copy file)))

    (unwind-protect

597 598
	(let (inhibit-file-name-operation
	      inhibit-file-name-handlers)
Richard M. Stallman's avatar
Richard M. Stallman committed
599 600 601
	  (or nomessage
	      (message "Loading %s..." file))

602 603
	  (let ((load-force-doc-strings t))
	    (load load-file noerror t t))
Richard M. Stallman's avatar
Richard M. Stallman committed
604
	  (or nomessage
605 606 607 608 609 610 611
	      (message "Loading %s...done." file))
	  ;; Fix up the load history to point at the right library.
	  (let ((l (assoc load-file load-history)))
	    ;; Remove .gz and .elc?.
	    (while (file-name-extension file)
	      (setq file (file-name-sans-extension file)))
	    (setcar l file)))
Richard M. Stallman's avatar
Richard M. Stallman committed
612 613 614 615

      (jka-compr-delete-temp-file local-copy))

    t))
616 617 618 619 620 621 622

(defun jka-compr-byte-compiler-base-file-name (file)
  (let ((info (jka-compr-get-compression-info file)))
    (if (and info (jka-compr-info-strip-extension info))
	(save-match-data
	  (substring file 0 (string-match (jka-compr-info-regexp info) file)))
      file)))
623 624 625 626 627

(put 'write-region 'jka-compr 'jka-compr-write-region)
(put 'insert-file-contents 'jka-compr 'jka-compr-insert-file-contents)
(put 'file-local-copy 'jka-compr 'jka-compr-file-local-copy)
(put 'load 'jka-compr 'jka-compr-load)
628 629
(put 'byte-compiler-base-file-name 'jka-compr
     'jka-compr-byte-compiler-base-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
630

631
;;;###autoload
632 633 634 635 636
(defvar jka-compr-inhibit nil
  "Non-nil means inhibit automatic uncompression temporarily.
Lisp programs can bind this to t to do that.
It is not recommended to set this variable permanently to anything but nil.")

637
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
638
(defun jka-compr-handler (operation &rest args)
639 640
  (save-match-data
    (let ((jka-op (get operation 'jka-compr)))
641
      (if (and jka-op (not jka-compr-inhibit))
642 643
	  (apply jka-op args)
	(jka-compr-run-real-handler operation args)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
644

Richard M. Stallman's avatar
Richard M. Stallman committed
645 646 647 648 649 650 651 652 653 654 655 656
;; If we are given an operation that we don't handle,
;; call the Emacs primitive for that operation,
;; and manipulate the inhibit variables
;; to prevent the primitive from calling our handler again.
(defun jka-compr-run-real-handler (operation args)
  (let ((inhibit-file-name-handlers
	 (cons 'jka-compr-handler
	       (and (eq inhibit-file-name-operation operation)
		    inhibit-file-name-handlers)))
	(inhibit-file-name-operation operation))
    (apply operation args)))

657
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
658 659
(defun jka-compr-uninstall ()
  "Uninstall jka-compr.
Richard M. Stallman's avatar
Richard M. Stallman committed
660
This removes the entries in `file-name-handler-alist' and `auto-mode-alist'
661 662 663 664
and `inhibit-first-line-modes-suffixes' that were added
by `jka-compr-installed'."
  ;; Delete from inhibit-first-line-modes-suffixes
  ;; what jka-compr-install added.
665
  (mapc
666 667 668 669 670
     (function (lambda (x)
		 (and (jka-compr-info-strip-extension x)
		      (setq inhibit-first-line-modes-suffixes
			    (delete (jka-compr-info-regexp x)
				    inhibit-first-line-modes-suffixes)))))
671
     jka-compr-compression-info-list--internal)
Richard M. Stallman's avatar
Richard M. Stallman committed
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688

  (let* ((fnha (cons nil file-name-handler-alist))
	 (last fnha))

    (while (cdr last)
      (if (eq (cdr (car (cdr last))) 'jka-compr-handler)
	  (setcdr last (cdr (cdr last)))
	(setq last (cdr last))))

    (setq file-name-handler-alist (cdr fnha)))

  (let* ((ama (cons nil auto-mode-alist))
	 (last ama)
	 entry)

    (while (cdr last)
      (setq entry (car (cdr last)))
689
      (if (or (member entry jka-compr-mode-alist-additions--internal)
690 691
	      (and (consp (cdr entry))
		   (eq (nth 2 entry) 'jka-compr)))
Richard M. Stallman's avatar
Richard M. Stallman committed
692 693
	  (setcdr last (cdr (cdr last)))
	(setq last (cdr last))))
694

695 696
    (setq auto-mode-alist (cdr ama)))

Stefan Monnier's avatar
Stefan Monnier committed
697 698 699 700 701
  (while jka-compr-added-to-file-coding-system-alist
    (setq file-coding-system-alist
          (delq (car (member (pop jka-compr-added-to-file-coding-system-alist)
                             file-coding-system-alist))
                file-coding-system-alist)))
702 703

  ;; Remove the suffixes that were added by jka-compr.
704 705 706 707 708 709
  (dolist (suff jka-compr-load-suffixes--internal)
    (setq load-file-rep-suffixes (delete suff load-file-rep-suffixes)))

  (setq jka-compr-compression-info-list--internal nil
	jka-compr-mode-alist-additions--internal nil
	jka-compr-load-suffixes--internal nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
710 711 712

(provide 'jka-compr)

Stefan Monnier's avatar
Stefan Monnier committed
713
;; arch-tag: 3f15b630-e9a7-46c4-a22a-94afdde86ebc
714
;;; jka-compr.el ends here