annotate lisp/loadhist.el @ 83542:2d56e13fd23d

Merged from [e-mail] Patches applied: * [e-mail]/emacs--devo--0--patch-413 Update from CVS * [e-mail]/emacs--devo--0--patch-414 Update from CVS * [e-mail]/emacs--devo--0--patch-415 Update from CVS * [e-mail]/emacs--devo--0--patch-416 Update from CVS * [e-mail]/emacs--devo--0--patch-417 Update from CVS * [e-mail]/emacs--devo--0--patch-418 Merge from gnus--rel--5.10 * [e-mail]/emacs--devo--0--patch-419 Update from CVS * [e-mail]/emacs--devo--0--patch-420 Update from CVS * [e-mail]/emacs--devo--0--patch-421 Merge from gnus--rel--5.10 * [e-mail]/emacs--devo--0--patch-422 Update from CVS * [e-mail]/emacs--devo--0--patch-423 Update from CVS * [e-mail]/emacs--devo--0--patch-424 Merge from gnus--rel--5.10 * [e-mail]/emacs--devo--0--patch-425 Update from CVS * [e-mail]/emacs--devo--0--patch-426 Update from CVS * [e-mail]/emacs--devo--0--patch-427 Update from CVS * [e-mail]/emacs--devo--0--patch-428 Merge from gnus--rel--5.10 * [e-mail]/emacs--devo--0--patch-429 Update from CVS * [e-mail]/emacs--devo--0--patch-430 Update from CVS * [e-mail]/emacs--devo--0--patch-431 Merge from gnus--rel--5.10 * [e-mail]/emacs--devo--0--patch-432 Update from CVS * [e-mail]/emacs--devo--0--patch-433 Update from CVS * [e-mail]/emacs--devo--0--patch-434 Update from CVS * [e-mail]/emacs--devo--0--patch-435 Update from CVS * [e-mail]/emacs--devo--0--patch-436 Update from CVS * [e-mail]/emacs--devo--0--patch-437 Update from CVS * [e-mail]/emacs--devo--0--patch-438 Update from CVS * [e-mail]/emacs--devo--0--patch-439 Update from CVS * [e-mail]/emacs--devo--0--patch-440 Update from CVS * [e-mail]/emacs--devo--0--patch-441 lisp/url/url-methods.el: Fix format error when http_proxy is empty string * [e-mail]/emacs--devo--0--patch-442 Update from CVS * [e-mail]/emacs--devo--0--patch-443 Update from CVS * [e-mail]/emacs--devo--0--patch-444 Update from CVS * [e-mail]/emacs--devo--0--patch-445 Update from CVS * [e-mail]/emacs--devo--0--patch-446 Merge from gnus--rel--5.10 * [e-mail]/emacs--devo--0--patch-447 Update from CVS * [e-mail]/emacs--devo--0--patch-448 Update from CVS * [e-mail]/emacs--devo--0--patch-449 Update from CVS * [e-mail]/emacs--devo--0--patch-450 Update from CVS * [e-mail]/emacs--devo--0--patch-451 Update from CVS * [e-mail]/emacs--devo--0--patch-452 Update from CVS * [e-mail]/emacs--devo--0--patch-453 Update from CVS * [e-mail]/emacs--devo--0--patch-454 Update from CVS * [e-mail]/emacs--devo--0--patch-455 Update from CVS * [e-mail]/emacs--devo--0--patch-456 Update from CVS * [e-mail]/emacs--devo--0--patch-457 Update from CVS * [e-mail]/emacs--devo--0--patch-458 Update from CVS * [e-mail]/emacs--devo--0--patch-459 Merge from gnus--rel--5.10 * [e-mail]/emacs--devo--0--patch-460 Update from CVS * [e-mail]/emacs--devo--0--patch-461 Update from CVS * [e-mail]/emacs--devo--0--patch-462 Update from CVS * [e-mail]/emacs--devo--0--patch-463 Update from CVS * [e-mail]/emacs--devo--0--patch-464 Update from CVS * [e-mail]/emacs--devo--0--patch-465 Update from CVS * [e-mail]/emacs--devo--0--patch-466 Merge from gnus--rel--5.10 * [e-mail]/emacs--devo--0--patch-467 Update from CVS * [e-mail]/emacs--devo--0--patch-468 Merge from gnus--rel--5.10 * [e-mail]/emacs--devo--0--patch-469 Update from CVS * [e-mail]/emacs--devo--0--patch-470 Update from CVS * [e-mail]/emacs--devo--0--patch-471 Update from CVS * [e-mail]/emacs--devo--0--patch-472 Update from CVS * [e-mail]/emacs--devo--0--patch-473 Update from CVS * [e-mail]/gnus--rel--5.10--patch-128 Update from CVS * [e-mail]/gnus--rel--5.10--patch-129 Merge from emacs--devo--0 * [e-mail]/gnus--rel--5.10--patch-130 Update from CVS * [e-mail]/gnus--rel--5.10--patch-131 Update from CVS * [e-mail]/gnus--rel--5.10--patch-132 Update from CVS * [e-mail]/gnus--rel--5.10--patch-133 Update from CVS * [e-mail]/gnus--rel--5.10--patch-134 Merge from emacs--devo--0 * [e-mail]/gnus--rel--5.10--patch-135 Update from CVS * [e-mail]/gnus--rel--5.10--patch-136 Update from CVS * [e-mail]/gnus--rel--5.10--patch-137 Update from CVS * [e-mail]/gnus--rel--5.10--patch-138 Update from CVS * [e-mail]/gnus--rel--5.10--patch-139 Update from CVS * [e-mail]/gnus--rel--5.10--patch-140 Update from CVS * [e-mail]/gnus--rel--5.10--patch-141 Merge from emacs--devo--0 * [e-mail]/gnus--rel--5.10--patch-142 Update from CVS * [e-mail]/gnus--rel--5.10--patch-143 Update from CVS * [e-mail]/gnus--rel--5.10--patch-144 Update from CVS * [e-mail]/gnus--rel--5.10--patch-145 Merge from emacs--devo--0 * [e-mail]/gnus--rel--5.10--patch-146 Update from CVS * [e-mail]/gnus--rel--5.10--patch-147 Update from CVS * [e-mail]/gnus--rel--5.10--patch-148 Update from CVS * [e-mail]/gnus--rel--5.10--patch-149 Update from CVS git-archimport-id: [e-mail]--2004/emacs--multi-tty--0--patch-582

;;; loadhist.el --- lisp functions for working with feature groups

;; Copyright (C) 1995, 1998, 2000, 2002, 2003, 2004,
;;   2005, 2006 Free Software Foundation, Inc.

;; Author: Eric S. Raymond <[e-mail]>
;; Maintainer: FSF
;; Keywords: internal

;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;; These functions exploit the load-history system variable.
;; Entry points include `unload-feature', `symbol-file', and
;; `feature-file', documented in the Emacs Lisp manual.

;;; Code:

(eval-when-compile (require 'cl))

(defun feature-symbols (feature)
  "Return the file and list of definitions associated with FEATURE.
The value is actually the element of `load-history'
for the file that did (provide FEATURE)."
   (catch 'foundit
     (mapc (lambda (x)
	     (if (member (cons 'provide feature) (cdr x))
		 (throw 'foundit x)))
	   load-history)
     nil))

(defun feature-file (feature)
  "Return the file name from which a given FEATURE was loaded.
Actually, return the load argument, if any; this is sometimes the name of a
Lisp file without an extension.  If the feature came from an `eval-buffer' on
a buffer with no associated file, or an `eval-region', return nil."
  (if (not (featurep feature))
      (error "%S is not a currently loaded feature" feature)
    (car (feature-symbols feature))))

(defun file-loadhist-lookup (file)
  "Return the `load-history' element for FILE.
FILE can be a file name, or a library name.
A library name is equivalent to the file name that `load-library' would load."
  ;; First look for FILE as given.
  (let ((symbols (assoc file load-history)))
    ;; Try converting a library name to an absolute file name.
    (and (null symbols)
	 (let ((absname
		(locate-file file load-path (get-load-suffixes))))
	   (and absname (not (equal absname file))
		(setq symbols (cdr (assoc absname load-history))))))
    symbols))

(defun file-provides (file)
  "Return the list of features provided by FILE as it was loaded.
FILE can be a file name, or a library name.
A library name is equivalent to the file name that `load-library' would load."
  (let ((symbols (file-loadhist-lookup file))
	provides)
    (mapc (lambda (x)
	    (if (and (consp x) (eq (car x) 'provide))
		(setq provides (cons (cdr x) provides))))
	  symbols)
    provides))

(defun file-requires (file)
  "Return the list of features required by FILE as it was loaded.
FILE can be a file name, or a library name.
A library name is equivalent to the file name that `load-library' would load."
  (let ((symbols (file-loadhist-lookup file))
	requires)
    (mapc (lambda (x)
	    (if (and (consp x) (eq (car x) 'require))
		(setq requires (cons (cdr x) requires))))
	  symbols)
    requires))

(defsubst file-set-intersect (p q)
  "Return the set intersection of two lists."
  (let ((ret nil))
    (dolist (x p ret)
      (if (memq x q) (setq ret (cons x ret))))
    ret))

(defun file-dependents (file)
  "Return the list of loaded libraries that depend on FILE.
This can include FILE itself.
FILE can be a file name, or a library name.
A library name is equivalent to the file name that `load-library' would load."
  (let ((provides (file-provides file))
	(dependents nil))
    (dolist (x load-history dependents)
      (if (file-set-intersect provides (file-requires (car x)))
	  (setq dependents (cons (car x) dependents))))
    dependents))

(defun read-feature (prompt)
  "Read a feature name \(string\) from the minibuffer.
Prompt with PROMPT and completing from `features', and
return the feature \(symbol\)."
  (intern (completing-read prompt
			   (mapcar (lambda (feature)
				     (list (symbol-name feature)))
				   features)
			   nil t)))

(defvaralias 'loadhist-hook-functions 'unload-feature-special-hooks)
(defvar unload-feature-special-hooks
  '(after-change-functions
    after-insert-file-functions auto-fill-function
    before-change-functions blink-paren-function
    buffer-access-fontify-functions command-line-functions
    comment-indent-function kill-buffer-query-functions
    kill-emacs-query-functions lisp-indent-function
    mouse-position-function
    redisplay-end-trigger-functions temp-buffer-show-function
    window-scroll-functions window-size-change-functions
    write-region-annotate-functions)
  "A list of special hooks from Info node `(elisp)Standard Hooks'.

These are symbols with hook-type values whose names don't end in
`-hook' or `-hooks', from which `unload-feature' tries to remove
pertinent symbols.")

(defvar unload-hook-features-list nil
  "List of features of the package being unloaded.

This is meant to be used by FEATURE-unload-hook hooks, see the
documentation of `unload-feature' for details.")

;;;###autoload
(defun unload-feature (feature &optional force)
  "Unload the library that provided FEATURE, restoring all its autoloads.
If the feature is required by any other loaded code, and prefix arg FORCE
is nil, raise an error.

This function tries to undo modifications made by the package to
hooks.  Packages may define a hook FEATURE-unload-hook that is called
instead of the normal heuristics for doing this.  Such a hook should
undo all the relevant global state changes that may have been made by
loading the package or executing functions in it.  It has access to
the package's feature list (before anything is unbound) in the
variable `unload-hook-features-list' and could remove features from it
in the event that the package has done something normally-ill-advised,
such as redefining an Emacs function."
  (interactive (list (read-feature "Feature: ") current-prefix-arg))
  (unless (featurep feature)
    (error "%s is not a currently loaded feature" (symbol-name feature)))
  (unless force
    (let* ((file (feature-file feature))
	   (dependents (delete file (copy-sequence (file-dependents file)))))
      (when dependents
	(error "Loaded libraries %s depend on %s"
	       (prin1-to-string dependents) file))))
  (let* ((unload-hook-features-list (feature-symbols feature))
         (file (pop unload-hook-features-list))
         (unload-hook (intern-soft (concat (symbol-name feature)
                                           "-unload-hook"))))
    ;; Try to avoid losing badly when hooks installed in critical
    ;; places go away.  (Some packages install things on
    ;; `kill-buffer-hook', `activate-menubar-hook' and the like.)
    ;; First off, provide a clean way for package FOO to arrange
    ;; this by adding hooks on the variable `FOO-unload-hook'.
    (if unload-hook
        (run-hooks unload-hook)
      ;; Otherwise, do our best.  Look through the obarray for symbols
      ;; which seem to be hook variables or special hook functions and
      ;; remove anything from them which matches the feature-symbols
      ;; about to get zapped.  Obviously this won't get anonymous
      ;; functions which the package might just have installed, and
      ;; there might be other important state, but this tactic
      ;; normally works.
      (mapatoms
       (lambda (x)
         (when (and (boundp x)
		    (or (and (consp (symbol-value x)) ; Random hooks.
			     (string-match "-hooks?\\'" (symbol-name x)))
			(memq x unload-feature-special-hooks)))	; Known abnormal hooks etc.
	   (dolist (y unload-hook-features-list)
	     (when (and (eq (car-safe y) 'defun)
			(not (get (cdr y) 'autoload)))
	       (remove-hook x (cdr y)))))))
      ;; Remove any feature-symbols from auto-mode-alist as well.
      (dolist (y unload-hook-features-list)
	(when (and (eq (car-safe y) 'defun)
		   (not (get (cdr y) 'autoload)))
	  (setq auto-mode-alist
		(rassq-delete-all (cdr y) auto-mode-alist)))))
    (when (fboundp 'elp-restore-function) ; remove ELP stuff first
      (dolist (elt unload-hook-features-list)
	(when (symbolp elt)
	  (elp-restore-function elt))))
    (dolist (x unload-hook-features-list)
      (if (consp x)
	  (case (car x)
	   ;; Remove any feature names that this file provided.
	   (provide
	    (setq features (delq (cdr x) features)))
	   (defun
	    (let ((fun (cdr x)))
	      (when (fboundp fun)
		(when (fboundp 'ad-unadvise)
		  (ad-unadvise fun))
		(let ((aload (get fun 'autoload)))
		  (if aload
                      (fset fun (cons 'autoload aload))
                    (fmakunbound fun))))))
           ((t require) nil)
	   (t (message "Unexpected element %s in load-history" x)))
	;; Kill local values as much as possible.
	(dolist (buf (buffer-list))
	  (with-current-buffer buf
            (if (and (boundp x) (timerp (symbol-value x)))
                (cancel-timer (symbol-value x)))
	    (kill-local-variable x)))
        (if (and (boundp x) (timerp (symbol-value x)))
            (cancel-timer (symbol-value x)))
	;; Get rid of the default binding if we can.
	(unless (local-variable-if-set-p x)
	  (makunbound x))))
    ;; Delete the load-history element for this file.
    (setq load-history (delq (assoc file load-history) load-history))))

(provide 'loadhist)

;; arch-tag: 70bb846a-c413-4f01-bf88-78dba4ac0798
;;; loadhist.el ends here