install.el

   1 ;;; install.el --- Emacs Lisp package install utility
   2
   3 ;; Copyright (C) 1996,1997,1998,1999,2001 Free Software Foundation, Inc.
   4
   5 ;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
   6 ;; Created: 1996/08/18
   7 ;; Keywords: install, byte-compile, directory detection
   8
   9 ;; This file is part of APEL (A Portable Emacs Library).
  10
  11 ;; This program is free software; you can redistribute it and/or
  12 ;; modify it under the terms of the GNU General Public License as
  13 ;; published by the Free Software Foundation; either version 2, or (at
  14 ;; your option) any later version.
  15
  16 ;; This program is distributed in the hope that it will be useful, but
  17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19 ;; General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  23 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Code:
  27
  28 (require 'poe)                          ; make-directory for v18
  29 (require 'path-util)                    ; default-load-path
  30
  31
  32 ;;; @ compile Emacs Lisp files
  33 ;;;
  34
  35 (defun compile-elisp-module (module &optional path every-time)
  36   (setq module (expand-file-name (symbol-name module) path))
  37   (let ((el-file (concat module ".el"))
  38         (elc-file (concat module ".elc")))
  39     (if (or every-time
  40             (file-newer-than-file-p el-file elc-file))
  41         (byte-compile-file el-file))))
  42
  43 (defun compile-elisp-modules (modules &optional path every-time)
  44   (mapcar
  45    (function
  46     (lambda (module)
  47       (compile-elisp-module module path every-time)))
  48    modules))
  49
  50
  51 ;;; @ install files
  52 ;;;
  53
  54 (defvar install-overwritten-file-modes (+ (* 64 6)(* 8 4) 4)) ; 0644
  55
  56 (defun install-file (file src dest &optional move overwrite just-print)
  57   (if just-print
  58       (princ (format "%s -> %s\n" file dest))
  59     (let ((src-file (expand-file-name file src)))
  60       (if (file-exists-p src-file)
  61           (let ((full-path (expand-file-name file dest)))
  62             (if (and (file-exists-p full-path) overwrite)
  63                 (delete-file full-path))
  64             (copy-file src-file full-path t t)
  65             (set-file-modes full-path install-overwritten-file-modes)
  66             (if move
  67                 (catch 'tag
  68                   (while (and (file-exists-p src-file)
  69                               (file-writable-p src-file))
  70                     (condition-case err
  71                         (progn
  72                           (delete-file src-file)
  73                           (throw 'tag nil))
  74                       (error (princ (format "%s\n" (nth 1 err))))))))
  75             (princ (format "%s -> %s\n" file dest)))))))
  76
  77 (defun install-files (files src dest &optional move overwrite just-print)
  78   (or just-print
  79       (file-exists-p dest)
  80       (make-directory dest t))
  81   (mapcar
  82    (function
  83     (lambda (file)
  84       (install-file file src dest move overwrite just-print)))
  85    files))
  86
  87
  88 ;;; @@ install Emacs Lisp files
  89 ;;;
  90
  91 (defun install-elisp-module (module src dest &optional just-print del-elc)
  92   (let (el-file elc-file)
  93     (let ((name (symbol-name module)))
  94       (setq el-file (concat name ".el"))
  95       (setq elc-file (concat name ".elc")))
  96     (let ((src-file (expand-file-name el-file src)))
  97       (if (not (file-exists-p src-file))
  98           nil
  99         (if just-print
 100             (princ (format "%s -> %s\n" el-file dest))
 101           (let ((full-path (expand-file-name el-file dest)))
 102             (if (file-exists-p full-path)
 103                 (delete-file full-path))
 104             (copy-file src-file full-path t t)
 105             (set-file-modes full-path install-overwritten-file-modes)
 106             (princ (format "%s -> %s\n" el-file dest)))))
 107       (setq src-file (expand-file-name elc-file src))
 108       (if (not (file-exists-p src-file))
 109           (let ((full-path (expand-file-name elc-file dest)))
 110             (if (and del-elc (file-exists-p full-path))
 111                 (if just-print
 112                     (princ (format "%s -> to be deleted\n" full-path))
 113                   (delete-file full-path)
 114                   (princ (format "%s -> deleted\n" full-path)))))
 115         (if just-print
 116             (princ (format "%s -> %s\n" elc-file dest))
 117           (let ((full-path (expand-file-name elc-file dest)))
 118             (if (file-exists-p full-path)
 119                 (delete-file full-path))
 120             (copy-file src-file full-path t t)
 121             (set-file-modes full-path install-overwritten-file-modes)
 122             (catch 'tag
 123               (while (file-exists-p src-file)
 124                 (condition-case err
 125                     (progn
 126                       (delete-file src-file)
 127                       (throw 'tag nil))
 128                   (error (princ (format "%s\n" (nth 1 err)))))))
 129             (princ (format "%s -> %s\n" elc-file dest))))))))
 130
 131 (defun install-elisp-modules (modules src dest &optional just-print del-elc)
 132   (or just-print
 133       (file-exists-p dest)
 134       (make-directory dest t))
 135   (mapcar
 136    (function
 137     (lambda (module)
 138       (install-elisp-module module src dest just-print del-elc)))
 139    modules))
 140
 141
 142 ;;; @ detect install path
 143 ;;;
 144
 145 ;; install to shared directory (maybe "/usr/local")
 146 (defvar install-prefix
 147   (if (or (<= emacs-major-version 18)
 148           (featurep 'xemacs)
 149           (featurep 'meadow) ; for Meadow
 150           (and (eq system-type 'windows-nt) ; for NTEmacs
 151                (>= emacs-major-version 20)))
 152       (expand-file-name "../../.." exec-directory)
 153     (expand-file-name "../../../.." data-directory)))
 154
 155 (defvar install-elisp-prefix
 156   (if (>= emacs-major-version 19)
 157       "site-lisp"
 158     ;; v18 does not have standard site directory.
 159     "local.lisp"))
 160
 161 (defun install-detect-elisp-directory (&optional prefix elisp-prefix
 162                                                  allow-version-specific)
 163   (or prefix
 164       (setq prefix install-prefix))
 165   (or elisp-prefix
 166       (setq elisp-prefix install-elisp-prefix))
 167   (or (catch 'tag
 168         (let ((rest default-load-path)
 169               (regexp (concat "^"
 170                               (expand-file-name (concat ".*/" elisp-prefix)
 171                                                 prefix)
 172                               "/?$")))
 173           (while rest
 174             (if (string-match regexp (car rest))
 175                 (if (or allow-version-specific
 176                         (not (string-match (format "/%d\\.%d"
 177                                                    emacs-major-version
 178                                                    emacs-minor-version)
 179                                            (car rest))))
 180                     (throw 'tag (car rest))))
 181             (setq rest (cdr rest)))))
 182       (expand-file-name (concat (if (and (not (featurep 'xemacs))
 183                                          (or (>= emacs-major-version 20)
 184                                              (and (= emacs-major-version 19)
 185                                                   (> emacs-minor-version 28))))
 186                                     "share/"
 187                                   "lib/")
 188                                 (cond
 189                                  ((featurep 'xemacs)
 190                                   (if (featurep 'mule)
 191                                       "xmule/"
 192                                     "xemacs/"))
 193                                  ;; unfortunately, unofficial mule based on
 194                                  ;; 19.29 and later use "emacs/" by default.
 195                                  ((boundp 'MULE) "mule/")
 196                                  ((boundp 'NEMACS) "nemacs/")
 197                                  (t "emacs/"))
 198                                 elisp-prefix)
 199                         prefix)))
 200
 201 (defvar install-default-elisp-directory
 202   (install-detect-elisp-directory))
 203
 204
 205 ;;; @ for XEmacs package system
 206 ;;;
 207
 208 (defun install-update-package-files (package dir &optional just-print)
 209   (cond
 210    (just-print
 211     (princ (format "Updating autoloads in directory %s..\n\n" dir))
 212
 213     (princ (format "Processing %s\n" dir))
 214     (princ "Generating custom-load.el...\n\n")
 215
 216     (princ (format "Compiling %s...\n"
 217                    (expand-file-name "auto-autoloads.el" dir)))
 218     (princ (format "Wrote %s\n"
 219                    (expand-file-name "auto-autoloads.elc" dir)))
 220
 221     (princ (format "Compiling %s...\n"
 222                    (expand-file-name "custom-load.el" dir)))
 223     (princ (format "Wrote %s\n"
 224                    (expand-file-name "custom-load.elc" dir))))
 225    (t
 226     (setq autoload-package-name package)
 227
 228     (let ((command-line-args-left (list dir)))
 229       (batch-update-directory))
 230
 231     (let ((command-line-args-left (list dir)))
 232       (Custom-make-dependencies))
 233
 234     (byte-compile-file (expand-file-name "auto-autoloads.el" dir))
 235     (byte-compile-file (expand-file-name "custom-load.el" dir)))))
 236
 237
 238 ;;; @ Other Utilities
 239 ;;;
 240
 241 (defun install-just-print-p ()
 242   (let ((flag (getenv "MAKEFLAGS"))
 243         (case-fold-search nil))
 244     (princ (format "%s\n" flag))
 245     (if flag
 246         (string-match "^\\(\\(--[^ ]+ \\)+-\\|[^ =-]\\)*n" flag))))
 247
 248
 249 ;;; @ end
 250 ;;;
 251
 252 (require 'product)
 253 (product-provide (provide 'install) (require 'apel-ver))
 254
 255 ;;; install.el ends here