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

3
;; Copyright (C) 1993-1995, 1997, 1999-2011 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5

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

9 10
;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
15 16 17 18 19 20 21

;; 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
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
23

24
;;; Commentary:
Richard M. Stallman's avatar
Richard M. Stallman committed
25

Erik Naggum's avatar
Erik Naggum committed
26 27 28 29 30 31 32 33 34 35 36
;; 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
37 38 39 40
;; 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
41 42 43 44 45 46 47
;;
;; 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 don't want messages about compressing and decompressing
48 49
;; to show up in the echo area, you can set the compress-msg and
;; decompress-msg fields of the jka-compr-compression-info-list to
Erik Naggum's avatar
Erik Naggum committed
50 51 52 53 54 55
;; nil.


;; APPLICATION NOTES:
;;
;; crypt++
Eli Zaretskii's avatar
Eli Zaretskii committed
56
;;   jka-compr can coexist with crypt++ if you take all the decompression
Erik Naggum's avatar
Erik Naggum committed
57 58 59 60 61 62 63 64 65 66 67 68
;;   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
69
;;
Erik Naggum's avatar
Erik Naggum committed
70
;; jka-compr is a V19 adaptation of jka-compr for V18 of Emacs.  Many people
71
;; have made helpful suggestions, reported bugs, and even fixed bugs in
Erik Naggum's avatar
Erik Naggum committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
;; 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
89 90 91

;;; Code:

Stefan Monnier's avatar
Stefan Monnier committed
92 93
(require 'jka-cmpr-hook)

94
(defcustom jka-compr-shell "sh"
Lute Kamstra's avatar
Lute Kamstra committed
95
  "Shell to be used for calling compression programs.
96
NOTE: Not used in MS-DOS and Windows systems."
97 98
  :type 'string
  :group 'jka-compr)
Richard M. Stallman's avatar
Richard M. Stallman committed
99

100 101 102 103 104
(defcustom jka-compr-verbose t
  "If non-nil, output messages whenever compressing or uncompressing files."
  :type 'boolean
  :group 'jka-compr)

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

108
(defvar jka-compr-really-do-compress nil
109 110 111 112
  "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)
113
(put 'jka-compr-really-do-compress 'permanent-local t)
114

Richard M. Stallman's avatar
Richard M. Stallman committed
115 116 117 118

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


119
(defvar jka-compr-acceptable-retval-list '(0 2 141))
Richard M. Stallman's avatar
Richard M. Stallman committed
120 121 122 123


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

Stefan Monnier's avatar
Stefan Monnier committed
124
  (let ((errbuf (get-buffer-create " *jka-compr-error*")))
125 126 127 128 129 130 131 132 133
    (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
134 135
     (display-buffer errbuf))

136 137
  (signal 'compression-error
	  (list "Opening input file" (format "error %s" message) infile)))
138 139


140 141 142 143
(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
144 145


146
(defvar jka-compr-dd-blocksize 256)
Richard M. Stallman's avatar
Richard M. Stallman committed
147 148 149 150 151


(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
152
to keep: LEN chars starting BEG chars from the beginning."
153 154 155 156 157 158 159
  (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))
160 161 162 163 164 165
	      ;; call-process barfs if default-directory is inaccessible.
	      (default-directory
		(if (and default-directory
			 (file-accessible-directory-p default-directory))
		    default-directory
		  (file-name-directory infile)))
166 167 168 169 170 171 172
	      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"
Glenn Morris's avatar
Glenn Morris committed
173 174 175
			 ;; Windows shells need the program file name
			 ;; after the pipe symbol be quoted if they use
			 ;; forward slashes as directory separators.
176
			 (format
Glenn Morris's avatar
Glenn Morris committed
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
			jka-compr-acceptable-retval-list)
		  (jka-compr-error prog args infile message err-file))
191
	    (delete-file err-file)))
192

193 194 195
      ;; 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
196

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

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


(defun jka-compr-call-process (prog message infile output temp args)
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
  ;; call-process barfs if default-directory is inaccessible.
  (let ((default-directory
	  (if (and default-directory
		   (file-accessible-directory-p default-directory))
	      default-directory
	    (file-name-directory infile))))
    (if jka-compr-use-shell
	(let ((err-file (jka-compr-make-temp-name))
	      (coding-system-for-read (or coding-system-for-read 'undecided))
	      (coding-system-for-write 'no-conversion))
	  (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))
233
	    (delete-file err-file)))
234 235 236 237 238 239 240 241 242
      (or (eq 0
	      (apply 'call-process
		     prog infile (if (stringp output) temp output)
		     nil args))
	  (jka-compr-error prog args infile message))
      (and (stringp output)
	   (with-current-buffer temp
	     (write-region (point-min) (point-max) output)
	     (erase-buffer))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
243 244


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

248
(defcustom jka-compr-temp-name-template
249
  (expand-file-name "jka-com" temporary-file-directory)
250
  "Prefix added to all temp files created by jka-compr.
251 252 253
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
254

255
(defun jka-compr-make-temp-name (&optional _local-copy)
Richard M. Stallman's avatar
Richard M. Stallman committed
256
  "This routine will return the name of a new file."
Stefan Monnier's avatar
Stefan Monnier committed
257 258
  (make-temp-file jka-compr-temp-name-template))

Richard M. Stallman's avatar
Richard M. Stallman committed
259 260 261
(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))
262 263 264 265 266 267 268
	 (info (jka-compr-get-compression-info visit-file))
	 (magic (and info (jka-compr-info-file-magic-bytes info))))

    ;; 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
269 270
             (or (null start)
                 (= (- end start) (buffer-size))))
271 272 273 274 275 276 277 278 279 280
	(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)))
281 282 283
                                (let* ((from (or start (point-min)))
                                       (to (min (or end (point-max))
                                                (+ from (length magic)))))
284
                                  (buffer-substring from to)))
285 286 287 288 289 290 291 292 293 294 295 296
			      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))

297 298 299
          (or compress-program
              (error "No compression program defined"))

300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
	  (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)))

315
	  (and
316
	   compress-message
317
	   jka-compr-verbose
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
	   (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)) )

346
	  (delete-file temp-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
347

348 349
	  (and
	   compress-message
350
	   jka-compr-verbose
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
	   (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)
372

373 374
      (jka-compr-run-real-handler 'write-region
				  (list start end filename append visit)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
375 376


377
(defun jka-compr-insert-file-contents (file &optional visit beg end replace)
Richard M. Stallman's avatar
Richard M. Stallman committed
378 379 380 381 382 383 384 385 386
  (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)))

387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
    (if (not info)

	(jka-compr-run-real-handler 'insert-file-contents
                                    (list file visit beg end replace))

      (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)
            (local-copy
             (jka-compr-run-real-handler 'file-local-copy (list filename)))
            local-file
            size start)

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

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

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

            (progn

              (and
               uncompress-message
414
	       jka-compr-verbose
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
               (message "%s %s..." uncompress-message base-name))

              (condition-case error-code

                  (let ((coding-system-for-read 'no-conversion))
                    (if replace
                        (goto-char (point-min)))
                    (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))
                      ;; 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)))
                    (setq size (- (point) start))
                    (if replace
                        (delete-region (point) (point-max)))
                    (goto-char start))
                (error
                 ;; 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.
                 (if (and (eq (car error-code) 'file-error)
                          (eq (nth 3 error-code) local-file))
                     (if visit
                         (setq notfound error-code)
                       (signal 'file-error
                               (cons "Opening input file"
                                     (nthcdr 2 error-code))))
                   ;; 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)))
                   (signal (car error-code) (cdr error-code))))))

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

        (unless notfound
          (decode-coding-inserted-region
           (point) (+ (point) size)
           (jka-compr-byte-compiler-base-file-name file)
           visit beg end replace))

        (and
         visit
         (progn
           (unlock-buffer)
           (setq buffer-file-name filename)
           (setq jka-compr-really-do-compress t)
           (set-visited-file-modtime)))

        (and
         uncompress-message
490
	 jka-compr-verbose
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
         (message "%s %s...done" uncompress-message base-name))

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

        ;; 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))))

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

        (list filename size)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
520 521 522 523 524 525 526 527 528 529 530 531


(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))
532 533
	      (local-copy
	       (jka-compr-run-real-handler 'file-local-copy (list filename)))
Richard M. Stallman's avatar
Richard M. Stallman committed
534
	      (temp-file (jka-compr-make-temp-name t))
535
	      (temp-buffer (get-buffer-create " *jka-compr-flc-temp*"))
Richard M. Stallman's avatar
Richard M. Stallman committed
536 537 538 539 540 541
	      local-file)

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

	  (unwind-protect

542
	      (with-current-buffer temp-buffer
543

Richard M. Stallman's avatar
Richard M. Stallman committed
544 545
		(and
		 uncompress-message
546
		 jka-compr-verbose
Richard M. Stallman's avatar
Richard M. Stallman committed
547
		 (message "%s %s..." uncompress-message base-name))
548

Kenichi Handa's avatar
Kenichi Handa committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
		;; 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
567
		   jka-compr-verbose
Kenichi Handa's avatar
Kenichi Handa committed
568 569 570 571
		   (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
572 573 574 575 576 577 578 579 580

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

	    (kill-buffer temp-buffer))

	  temp-file)
581

582
      (jka-compr-run-real-handler 'file-local-copy (list filename)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
583 584


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

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

    (unwind-protect

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

599 600
	  (let ((load-force-doc-strings t))
	    (load load-file noerror t t))
Richard M. Stallman's avatar
Richard M. Stallman committed
601
	  (or nomessage
602 603
	      (message "Loading %s...done." file))
	  ;; Fix up the load history to point at the right library.
604 605 606 607 608 609 610 611
	  (let ((l (or (assoc load-file load-history)
		       ;; On MS-Windows, if load-file is in
		       ;; temporary-file-directory, it will look like
		       ;; "c:/DOCUME~1/USER/LOCALS~1/foo", whereas
		       ;; readevalloop will record its truename in
		       ;; load-history.  Therefore try truename if the
		       ;; original name is not in load-history.
		       (assoc (file-truename load-file) load-history))))
612 613 614 615
	    ;; 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
616

617
      (delete-file local-copy))
Richard M. Stallman's avatar
Richard M. Stallman committed
618 619

    t))
620 621 622 623 624 625 626

(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)))
627 628 629 630 631

(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)
632 633
(put 'byte-compiler-base-file-name 'jka-compr
     'jka-compr-byte-compiler-base-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
634

635
;;;###autoload
636 637 638 639 640
(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.")

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

Richard M. Stallman's avatar
Richard M. Stallman committed
649 650 651 652 653 654 655 656 657 658 659 660
;; 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)))

661
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
662 663
(defun jka-compr-uninstall ()
  "Uninstall jka-compr.
Richard M. Stallman's avatar
Richard M. Stallman committed
664
This removes the entries in `file-name-handler-alist' and `auto-mode-alist'
665 666 667 668
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.
669
  (mapc
670 671 672 673 674
     (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)))))
675
     jka-compr-compression-info-list--internal)
Richard M. Stallman's avatar
Richard M. Stallman committed
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692

  (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)))
693
      (if (or (member entry jka-compr-mode-alist-additions--internal)
694 695
	      (and (consp (cdr entry))
		   (eq (nth 2 entry) 'jka-compr)))
Richard M. Stallman's avatar
Richard M. Stallman committed
696 697
	  (setcdr last (cdr (cdr last)))
	(setq last (cdr last))))
698

699 700
    (setq auto-mode-alist (cdr ama)))

Stefan Monnier's avatar
Stefan Monnier committed
701 702 703 704 705
  (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)))
706 707

  ;; Remove the suffixes that were added by jka-compr.
708 709 710 711 712 713
  (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
714 715 716

(provide 'jka-compr)

717
;;; jka-compr.el ends here