;; Applied patch from Yuuichi Teranishi <teranisi@gohome.org>.
[elisp/apel.git] / install.el
index 1aa56a3..c961fe3 100644 (file)
@@ -1,8 +1,9 @@
 ;;; install.el --- Emacs Lisp package install utility
 
-;; Copyright (C) 1996,1997,1998,1999 Free Software Foundation, Inc.
+;; Copyright (C) 1996,97,98,99,2001  Free Software Foundation, Inc.
 
 ;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
+;;     Shuhei KOBAYASHI <shuhei@aqua.ocn.ne.jp>
 ;; Created: 1996/08/18
 ;; Keywords: install, byte-compile, directory detection
 
 
 ;;; Code:
 
-;; for historical reason, we do (require 'emu) in this file.
-;; but you should do (require 'emu) explicitly if you use functions and/or
-;; variables defined in emu module.
-;;(require 'emu)
-(require 'poe)         ; emacs-major-version, emacs-minor-version
-(require 'path-util)   ; default-load-path
-
-;; verbatim copy of `defun-maybe' from poe.el, and
-;; `make-directory-internal' and `make-directory' from poe-18.el
-(defmacro defun-maybe (name &rest everything-else)
-  "Define NAME as a function if NAME is not defined.
-See also the function `defun'."
-  (or (and (fboundp name)
-          (not (get name 'defun-maybe)))
-      (` (or (fboundp (quote (, name)))
-            (prog1
-                (defun (, name) (,@ everything-else))
-              (put (quote (, name)) 'defun-maybe t))))))
-
-(defun-maybe make-directory-internal (dirname)
-  "Create a directory. One argument, a file name string."
-  (let ((dir (expand-file-name dirname)))
-    (if (file-exists-p dir)
-       (error "Creating directory: %s is already exist" dir)
-      (call-process "mkdir" nil nil nil dir))))
-
-(defun-maybe make-directory (dir &optional parents)
-  "Create the directory DIR and any nonexistent parent dirs.
-The second (optional) argument PARENTS says whether
-to create parent directories if they don't exist."
-  (let ((len (length dir))
-       (p 0) p1 path)
-    (catch 'tag
-      (while (and (< p len) (string-match "[^/]*/?" dir p))
-       (setq p1 (match-end 0))
-       (if (= p1 len)
-           (throw 'tag nil))
-       (setq path (substring dir 0 p1))
-       (if (not (file-directory-p path))
-           (cond ((file-exists-p path)
-                  (error "Creating directory: %s is not directory" path))
-                 ((null parents)
-                  (error "Creating directory: %s is not exist" path))
-                 (t
-                  (make-directory-internal path))))
-       (setq p p1)))
-    (make-directory-internal dir)))
+(require 'poe)                         ; make-directory for v18
+(require 'path-util)                   ; default-load-path
 
 
 ;;; @ compile Emacs Lisp files
 ;;;
 
-(defun compile-elisp-module (module &optional path every-time)
-  (setq module (expand-file-name (symbol-name module) path))
+(defun compile-elisp-module (module &optional dir force)
+  "Byte-compile MODULE.
+MODULE is a symbol of emacs-lisp source file name without suffix.
+Optional 2nd argument DIR is a directory where MODULE resides in.
+Unless optional 3rd argument FORCE is non-nil, MODULE is byte-compiled
+only when MODULE is newer than compiled file."
+  (setq module (expand-file-name (symbol-name module) dir))
   (let ((el-file (concat module ".el"))
        (elc-file (concat module ".elc")))
-    (if (or every-time
-           (file-newer-than-file-p el-file elc-file))
+    (if (or force (file-newer-than-file-p el-file elc-file))
        (byte-compile-file el-file))))
 
-(defun compile-elisp-modules (modules &optional path every-time)
-  (mapcar (function
-          (lambda (module)
-            (compile-elisp-module module path every-time)))
-         modules))
+(defun compile-elisp-modules (modules &optional dir force)
+  "Byte-compile MODULES.
+See `compile-elisp-module' for more information."
+  (while modules
+    (compile-elisp-module (car modules) dir force)
+    (setq modules (cdr modules))))
 
 
 ;;; @ install files
 ;;;
 
-(defvar install-overwritten-file-modes (+ (* 64 6)(* 8 4) 4))
-
-(defun install-file (file src dest &optional move overwrite just-print)
-  (if just-print
-      (princ (format "%s -> %s\n" file dest))
-    (let ((src-file (expand-file-name file src)))
+(defvar install-overwritten-file-modes (+ (* 64 6)(* 8 4) 4) ; 0644
+  "Default file modes for files installed by `install-file'.")
+
+(defun install-file (file src dst &optional move overwrite dry-run)
+  "Install FILE in SRC directory to DST directory.
+If optional 4th argument MOVE is non-nil, remove SRC/FILE.
+If optional 5th argument OVERWRITE is non-nil, remove DST/FILE first.
+If optional 6th argument DRY-RUN is non-nil, just show what would have
+been installed."
+  (if dry-run
+      (princ (format "%s -> %s\n" file dst))
+    (let ((src-file (expand-file-name file src))
+         (dst-file (expand-file-name file dst)))
       (if (file-exists-p src-file)
-         (let ((full-path (expand-file-name file dest)))
-           (if (and (file-exists-p full-path) overwrite)
-               (delete-file full-path))
-           (copy-file src-file full-path t t)
-           (if move
-               (catch 'tag
-                 (while (and (file-exists-p src-file)
-                             (file-writable-p src-file))
-                   (condition-case err
-                       (progn
-                         (delete-file src-file)
-                         (throw 'tag nil))
-                     (error (princ (format "%s\n" (nth 1 err))))))))
-           (princ (format "%s -> %s\n" file dest)))))))
-
-(defun install-files (files src dest &optional move overwrite just-print)
-  (or (file-exists-p dest)
-      (make-directory dest t))
-  (mapcar (function
-          (lambda (file)
-            (install-file file src dest move overwrite just-print)))
-         files))
+         (let ((current-file-modes (default-file-modes)))
+           (unwind-protect
+               (condition-case err
+                   (progn
+                     (set-default-file-modes install-overwritten-file-modes)
+                     (if move
+                         (progn
+                           (rename-file src-file dst-file overwrite)
+                           (set-file-modes dst-file
+                                           install-overwritten-file-modes))
+                       (copy-file src-file dst-file overwrite t))
+                     (princ (format "%s -> %s\n" file dst)))
+                 (error
+                  (princ (format "%s: %s\n" file (nth 1 err)))))
+             (set-default-file-modes current-file-modes)))
+       (princ (format "%s: No such file or directory\n" src-file))))))
+
+(defun install-files (files src dst &optional move overwrite dry-run)
+  "Install FILES.
+See `install-file' for more information."
+  (or dry-run
+      (file-exists-p dst)
+      (make-directory dst t))
+  (while files
+    (install-file (car files) src dst move overwrite dry-run)
+    (setq files (cdr files))))
 
 
 ;;; @@ install Emacs Lisp files
 ;;;
 
-(defun install-elisp-module (module src dest &optional just-print)
-  (let (el-file elc-file)
-    (let ((name (symbol-name module)))
-      (setq el-file (concat name ".el"))
-      (setq elc-file (concat name ".elc")))
-    (let ((src-file (expand-file-name el-file src)))
-      (if (not (file-exists-p src-file))
-         nil 
-       (if just-print
-           (princ (format "%s -> %s\n" el-file dest))
-         (let ((full-path (expand-file-name el-file dest)))
-           (if (file-exists-p full-path)
-               (delete-file full-path))
-           (copy-file src-file full-path t t)
-           (princ (format "%s -> %s\n" el-file dest)))))
-      (setq src-file (expand-file-name elc-file src))
-      (if (not (file-exists-p src-file))
-         nil 
-       (if just-print
-           (princ (format "%s -> %s\n" elc-file dest))
-         (let ((full-path (expand-file-name elc-file dest)))
-            (if (file-exists-p full-path)
-                (delete-file full-path))
-           (copy-file src-file full-path t t)
-           (catch 'tag
-             (while (file-exists-p src-file)
-               (condition-case err
-                   (progn
-                     (delete-file src-file)
-                     (throw 'tag nil))
-                 (error (princ (format "%s\n" (nth 1 err)))))))
-           (princ (format "%s -> %s\n" elc-file dest))))))))
-
-(defun install-elisp-modules (modules src dest &optional just-print)
-  (or (file-exists-p dest)
-      (make-directory dest t))
-  (mapcar (function
-          (lambda (module)
-            (install-elisp-module module src dest just-print)))
-         modules))
+(defun install-elisp-module (module src dst &optional dry-run)
+  "Install MODULE.
+MODULE is a symbol of emacs-lisp source file name without suffix.
+See `install-file' for information of the rest of arguments."
+  (let* ((name (symbol-name module))
+        (el-file (concat name ".el"))
+        (elc-file (concat name ".elc")))
+    (install-file el-file  src dst nil   'overwrite dry-run)
+    (install-file elc-file src dst 'move 'overwrite dry-run)))
+
+(defun install-elisp-modules (modules src dst &optional dry-run)
+  "Install MODULES.
+See `install-elisp-modules' for more information."
+  (or dry-run
+      (file-exists-p dst)
+      (make-directory dst t))
+  (while modules
+    (install-elisp-module (car modules) src dst dry-run)
+    (setq modules (cdr modules))))
 
 
 ;;; @ detect install path
 ;;;
 
-;; install to shared directory (maybe "/usr/local")
 (defvar install-prefix
-  (if (or (<= emacs-major-version 18)  ; running-emacs-18
-         (featurep 'xemacs)            ; running-xemacs
-         (and (boundp 'system-configuration-options) ; 19.29 or later
-              (string= system-configuration-options "NT"))) ; for Meadow
-      (expand-file-name "../../.." exec-directory)
+  (cond
+   ((<= emacs-major-version 18)
+    ;; The default of `exec-directory' is "/usr/local/emacs/etc".
+    ;; (See src/paths.h-dist)
+    (expand-file-name "../.." exec-directory))
+   ((featurep 'meadow)
+    ;; I have no idea, sorry.
+    (expand-file-name "../../.." data-directory))
+   ((featurep 'xemacs)
+    ;; The default of 'data-directory' is
+    ;; "/usr/local/lib/xemacs-$VERSION/etc".
+    (expand-file-name "../../.." data-directory))
+   (t
+    ;; The default of 'data-directory' is
+    ;; "/usr/local/lib/emacs/$VERSION/etc" (19.28 and earlier), or
+    ;; "/usr/local/share/emacs/$VERSION/etc" (19.29 and later).
     (expand-file-name "../../../.." data-directory)))
+  "Install prefix, normally \"/usr/local\".")
 
-(defvar install-elisp-prefix
-  (if (>= emacs-major-version 19)
-      "site-lisp"
-    "local.lisp"))
+;; v18 does not have the default, please set explicitly.
+(defvar install-elisp-prefix "site-lisp"
+  "Prefix for local lisp directory, normally \"site-lisp\".")
 
 (defun install-detect-elisp-directory (&optional prefix elisp-prefix
                                                 allow-version-specific)
@@ -194,43 +155,89 @@ to create parent directories if they don't exist."
       (setq prefix install-prefix))
   (or elisp-prefix
       (setq elisp-prefix install-elisp-prefix))
-  (or
-   (catch 'tag
-     (let ((rest default-load-path)
-          (pat (concat "^"
-                       (expand-file-name (concat ".*/" elisp-prefix) prefix)
-                       "/?$")))
-       (while rest
-        (if (string-match pat (car rest))
-            (if (or allow-version-specific
-                    (not (string-match (format "/%d\\.%d"
-                                               emacs-major-version
-                                               emacs-minor-version)
-                                       (car rest))))
-                (throw 'tag (car rest))))
-        (setq rest (cdr rest)))))
-   (expand-file-name (concat
-                     (if (and          ; running-emacs-19_29-or-later
-                          (not (featurep 'xemacs))
-                          (or (>= emacs-major-version 20)
-                              (and (= emacs-major-version 19)
-                                   (>= emacs-minor-version 29))))
-                         "share/"
-                       "lib/")
-                     (cond ((boundp 'NEMACS) "nemacs/")
-                           ((boundp 'MULE)   "mule/")
-                           ((featurep 'xemacs) ; running-xemacs
-                            (if (featurep 'mule)
-                                "xmule/"
-                              "xemacs/"))
-                           (t "emacs/"))
-                     elisp-prefix)
-                    prefix)))
+  (or (let ((rest default-load-path)
+           (regexp (concat "^"
+                           (expand-file-name (concat ".*/" elisp-prefix)
+                                             prefix)
+                           "/?$"))
+           (found nil))
+       (while (and rest (not found))
+         (if (string-match regexp (car rest))
+             (if (or allow-version-specific
+                     (not (string-match (format "/%d\\.%d"
+                                                emacs-major-version
+                                                emacs-minor-version)
+                                        (car rest))))
+                 (setq found (car rest))))
+         (setq rest (cdr rest)))
+       found)
+      ;; we couldn't find appropriate directory from `load-path'.
+      ;; use the default directory for each emacsen.
+      (expand-file-name (concat (if (and (not (featurep 'xemacs))
+                                        (or (>= emacs-major-version 20)
+                                            (and (= emacs-major-version 19)
+                                                 (> emacs-minor-version 28))))
+                                   "share/"
+                                 "lib/")
+                               (cond
+                                ((featurep 'xemacs) "xemacs/")
+                                ;; unfortunately, unofficial mule based on
+                                ;; 19.29 and later use "emacs/" by default.
+                                ((boundp 'MULE) "mule/")
+                                ((boundp 'NEMACS) "nemacs/")
+                                (t "emacs/"))
+                               elisp-prefix)
+                       prefix)))
 
 (defvar install-default-elisp-directory
   (install-detect-elisp-directory))
 
 
+;;; @ for XEmacs package system
+;;;
+
+(defun install-update-package-files (package dir &optional dry-run)
+  (cond
+   (dry-run
+    (princ (format "Updating autoloads in directory %s..\n\n" dir))
+
+    (princ (format "Processing %s\n" dir))
+    (princ "Generating custom-load.el...\n\n")
+
+    (princ (format "Compiling %s...\n"
+                  (expand-file-name "auto-autoloads.el" dir)))
+    (princ (format "Wrote %s\n"
+                  (expand-file-name "auto-autoloads.elc" dir)))
+
+    (princ (format "Compiling %s...\n"
+                  (expand-file-name "custom-load.el" dir)))
+    (princ (format "Wrote %s\n"
+                  (expand-file-name "custom-load.elc" dir))))
+   (t
+    (setq autoload-package-name package)
+
+    (let ((command-line-args-left (list dir)))
+      (batch-update-directory))
+
+    (let ((command-line-args-left (list dir)))
+      (Custom-make-dependencies))
+
+    (byte-compile-file (expand-file-name "auto-autoloads.el" dir))
+    (byte-compile-file (expand-file-name "custom-load.el" dir)))))
+
+
+;;; @ Other Utilities
+;;;
+
+(defun install-just-print-p ()
+  (let ((flag (getenv "MAKEFLAGS"))
+       (case-fold-search nil))
+    (princ (format "MAKEFLAGS=%s\n" (or flag "")))
+    (if flag
+       ;; Check whether MAKEFLAGS contain "n" option or not.
+       (string-match "^\\(\\(--[^ ]+ \\)+-\\|[^ =-]\\)*n" flag))))
+
+
 ;;; @ end
 ;;;