Some fixes to follow coding conventions in files maintained by FSF.
[bpt/emacs.git] / lisp / jka-compr.el
index 7539ef9..1239fb3 100644 (file)
@@ -1,6 +1,6 @@
 ;;; jka-compr.el --- reading/writing/loading compressed files
 
-;; Copyright (C) 1993, 1994, 1995, 1997, 1999  Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1994, 1995, 1997, 1999, 2000  Free Software Foundation, Inc.
 
 ;; Author: jka@ece.cmu.edu (Jay K. Adams)
 ;; Maintainer: FSF
@@ -23,7 +23,7 @@
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
-;;; Commentary: 
+;;; Commentary:
 
 ;; This package implements low-level support for reading, writing,
 ;; and loading compressed files.  It hooks into the low-level file
 
 ;; INSTRUCTIONS:
 ;;
-;; To use jka-compr, simply load this package, and edit as usual.
-;; Its operation should be transparent to the user (except for
-;; messages appearing when a file is being compressed or
-;; uncompressed).
+;; 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).
 ;;
 ;; The variable, jka-compr-compression-info-list can be used to
 ;; customize jka-compr to work with other compression programs.
@@ -194,7 +194,8 @@ invoked."
                         (string :tag "Uncompress Program")
                         (repeat :tag "Uncompress Arguments" string)
                         (boolean :tag "Append")
-                        (boolean :tag "Auto Mode")))
+                        (boolean :tag "Strip Extension")
+                        (string :tag "Magic Bytes")))
   :group 'jka-compr)
 
 (defvar jka-compr-mode-alist-additions
@@ -290,7 +291,7 @@ to keep: LEN chars starting BEG chars from the beginning."
                             ;; dd seems to be unreliable about
                             ;; providing the last block.  So, always
                             ;; read one more than you think you need.
-                            (if count (concat "count=" (1+ count)) ""))))
+                            (if count (format "count=%d" (1+ count)) ""))))
 
     (unwind-protect
        (or (memq (call-process jka-compr-shell
@@ -755,71 +756,12 @@ It is not recommended to set this variable permanently to anything but nil.")
        (inhibit-file-name-operation operation))
     (apply operation args)))
 
-;;;###autoload
-(defcustom auto-compression-mode nil
-  "Toggle automatic file compression and uncompression.
-Setting this variable directly does not take effect;
-use either \\[customize] or the function `auto-compression-mode'."
-  :set (lambda (symbol value)
-        (auto-compression-mode (or value 0)))
-  :initialize 'custom-initialize-default
-  :group 'jka-compr
-  :version "21.1"
-  :type 'boolean
-  :require 'jka-compr)
-
-;;;###autoload(defun auto-compression-mode (&optional arg)
-;;;###autoload  "\
-;;;###autoloadToggle automatic file compression and uncompression.
-;;;###autoloadWith prefix argument ARG, turn auto compression on if positive, else off.
-;;;###autoloadReturns the new status of auto compression (non-nil means on)."
-;;;###autoload  (interactive "P")
-;;;###autoload  (if (not (fboundp 'jka-compr-installed-p))
-;;;###autoload      (progn
-;;;###autoload        (require 'jka-compr)
-;;;###autoload        ;; That turned the mode on, so make it initially off.
-;;;###autoload        (toggle-auto-compression)))
-;;;###autoload  (toggle-auto-compression arg t))
-
-(defun toggle-auto-compression (&optional arg message)
-  "Toggle automatic file compression and uncompression.
-With prefix argument ARG, turn auto compression on if positive, else off.
-Returns the new status of auto compression (non-nil means on).
-If the argument MESSAGE is non-nil, it means to print a message
-saying whether the mode is now on or off."
-  (interactive "P\np")
-  (let* ((installed (jka-compr-installed-p))
-        (flag (if (null arg)
-                  (not installed)
-                (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))))
-
-    (cond
-     ((and flag installed) t)          ; already installed
-
-     ((and (not flag) (not installed)) nil) ; already not installed
-
-     (flag
-      (jka-compr-install))
-
-     (t
-      (jka-compr-uninstall)))
-
-
-    (and message
-        (if flag
-            (message "Automatic file (de)compression is now ON.")
-          (message "Automatic file (de)compression is now OFF.")))
-
-    flag))
 
 (defun jka-compr-build-file-regexp ()
-  (concat
-   "\\("
-   (mapconcat
-    'jka-compr-info-regexp
-    jka-compr-compression-info-list
-    "\\)\\|\\(")
-   "\\)"))
+  (mapconcat
+   'jka-compr-info-regexp
+   jka-compr-compression-info-list
+   "\\|"))
 
 
 (defun jka-compr-install ()
@@ -938,9 +880,41 @@ The return value is the entry in `file-name-handler-alist' for jka-compr."
 (and (jka-compr-installed-p)
      (jka-compr-uninstall))
 
-(jka-compr-install)
+
+;;; Note this definition must be at the end of the file, because
+;;; `define-minor-mode' actually calls the mode-function if the
+;;; associated variable is non-nil, which requires that all needed
+;;; functions be already defined.  [This is arguably a bug in d-m-m]
+;;;###autoload
+(define-minor-mode auto-compression-mode
+  "Toggle automatic file compression and uncompression.
+With prefix argument ARG, turn auto compression on if positive, else off.
+Returns the new status of auto compression (non-nil means on)."
+  :global t :group 'jka-compr
+  (let* ((installed (jka-compr-installed-p))
+        (flag auto-compression-mode))
+    (cond
+     ((and flag installed) t)          ; already installed
+     ((and (not flag) (not installed)) nil) ; already not installed
+     (flag (jka-compr-install))
+     (t (jka-compr-uninstall)))))
+
+
+;;;###autoload
+(defmacro with-auto-compression-mode (&rest body)
+  "Evalute BODY with automatic file compression and uncompression enabled."
+  (let ((already-installed (make-symbol "already-installed")))
+    `(let ((,already-installed (jka-compr-installed-p)))
+       (unwind-protect
+          (progn
+            (unless ,already-installed
+              (jka-compr-install))
+            ,@body)
+        (unless ,already-installed
+          (jka-compr-uninstall))))))
+(put 'with-auto-compression-mode 'lisp-indent-function 0)
 
 
 (provide 'jka-compr)
 
-;; jka-compr.el ends here.
+;;; jka-compr.el ends here