Document Image Mode's new animation features.

[bpt/emacs.git] / lisp / loadhist.el

diff --git a/lisp/loadhist.el b/lisp/loadhist.el
index 84a8655..53fc67c 100644 (file)
--- a/lisp/loadhist.el
+++ b/lisp/loadhist.el
@@ -1,7 +1,6 @@
 ;;; loadhist.el --- lisp functions for working with feature groups
 
 ;;; loadhist.el --- lisp functions for working with feature groups
 

-;; Copyright (C) 1995, 1998, 2000, 2001, 2002, 2003, 2004,
-;;   2005, 2006, 2007 Free Software Foundation, Inc.
+;; Copyright (C) 1995, 1998, 2000-2014 Free Software Foundation, Inc.

 
 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
 ;; Maintainer: FSF
 
 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
 ;; Maintainer: FSF


@@ -9,10 +8,10 @@
 
 ;; This file is part of GNU Emacs.
 
 
 ;; This file is part of GNU Emacs.
 

-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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
 ;; 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.
+;; the Free Software Foundation, either version 3 of the License, 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
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of


@@ -20,9 +19,7 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
 ;; 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.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

 
 ;;; Commentary:
 
 
 ;;; Commentary:
 


@@ -32,18 +29,15 @@
 
 ;;; Code:
 
 
 ;;; 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)."
 (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))
+  (catch 'foundit
+    (let ((element (cons 'provide feature)))
+      (dolist (x load-history nil)
+       (when (member element (cdr x))
+         (throw 'foundit x))))))

 
 (defun feature-file (feature)
   "Return the file name from which a given FEATURE was loaded.
 
 (defun feature-file (feature)
   "Return the file name from which a given FEATURE was loaded.


@@ -72,32 +66,25 @@ A library name is equivalent to the file name that `load-library' would load."
   "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."
   "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))
+  (let (provides)
+    (dolist (x (file-loadhist-lookup file) provides)
+      (when (eq (car-safe x) 'provide)
+       (push (cdr x) 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."
 
 (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))
+  (let (requires)
+    (dolist (x (file-loadhist-lookup file) requires)
+      (when (eq (car-safe x) 'require)
+       (push (cdr x) requires)))))

 
 (defsubst file-set-intersect (p q)
   "Return the set intersection of two lists."
 
 (defsubst file-set-intersect (p q)
   "Return the set intersection of two lists."

-  (let ((ret nil))
+  (let (ret)

     (dolist (x p ret)
     (dolist (x p ret)

-      (if (memq x q) (setq ret (cons x ret))))
-    ret))
+      (when (memq x q) (push x ret)))))

 
 (defun file-dependents (file)
   "Return the list of loaded libraries that depend on FILE.
 
 (defun file-dependents (file)
   "Return the list of loaded libraries that depend on FILE.


@@ -107,62 +94,94 @@ 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)
   (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))
+      (when (file-set-intersect provides (file-requires (car x)))
+       (push (car x) dependents)))))

 
 (defun read-feature (prompt &optional loaded-p)
   "Read feature name from the minibuffer, prompting with string PROMPT.
 If optional second arg LOADED-P is non-nil, the feature must be loaded
 from a file."
 
 (defun read-feature (prompt &optional loaded-p)
   "Read feature name from the minibuffer, prompting with string PROMPT.
 If optional second arg LOADED-P is non-nil, the feature must be loaded
 from a file."

-  (intern
-   (completing-read prompt
-                   (cons nil features)
-                   (and loaded-p
-                        #'(lambda (f)
-                            (and f     ; ignore nil
-                                 (feature-file f))))
-                   loaded-p)))
+  (intern (completing-read prompt
+                          features
+                          (and loaded-p #'feature-file)
+                          loaded-p)))

 
 (defvaralias 'loadhist-hook-functions 'unload-feature-special-hooks)
 (defvar unload-feature-special-hooks
 
 (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)
+  '(after-change-functions after-insert-file-functions
+    after-make-frame-functions auto-coding-functions
+    auto-fill-function before-change-functions
+    blink-paren-function buffer-access-fontify-functions
+    choose-completion-string-functions
+    comint-output-filter-functions command-line-functions
+    comment-indent-function compilation-finish-functions
+    delete-frame-functions disabled-command-function
+    fill-nobreak-predicate find-directory-functions
+    find-file-not-found-functions
+    font-lock-beginning-of-syntax-function
+    font-lock-fontify-buffer-function
+    font-lock-fontify-region-function
+    font-lock-mark-block-function
+    font-lock-syntactic-face-function
+    font-lock-unfontify-buffer-function
+    font-lock-unfontify-region-function
+    kill-buffer-query-functions kill-emacs-query-functions
+    lisp-indent-function mouse-position-function
+    redisplay-end-trigger-functions suspend-tty-functions
+    temp-buffer-show-function window-scroll-functions
+    window-size-change-functions write-contents-functions
+    write-file-functions write-region-annotate-functions)

   "A list of special hooks from Info node `(elisp)Standard Hooks'.
 
   "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
+These are symbols with hooklike values whose names don't end in
+`-hook' or `-hooks', from which `unload-feature' should try to remove

 pertinent symbols.")
 
 pertinent symbols.")
 

-(defvar unload-hook-features-list nil
-  "List of features of the package being unloaded.
+(define-obsolete-variable-alias 'unload-hook-features-list
+    'unload-function-defs-list "22.2")
+(defvar unload-function-defs-list nil
+  "List of definitions in the Lisp library being unloaded.

 
 

-This is meant to be used by FEATURE-unload-hook hooks, see the
+This is meant to be used by `FEATURE-unload-function'; see the

 documentation of `unload-feature' for details.")
 
 documentation of `unload-feature' for details.")
 

+(defun unload--set-major-mode ()
+  (save-current-buffer
+    (dolist (buffer (buffer-list))
+      (set-buffer buffer)
+      (let ((proposed major-mode))
+        ;; Look for a predecessor mode not defined in the feature we're processing
+        (while (and proposed (rassq proposed unload-function-defs-list))
+          (setq proposed (get proposed 'derived-mode-parent)))
+        (unless (eq proposed major-mode)
+          ;; Two cases: either proposed is nil, and we want to switch to fundamental
+          ;; mode, or proposed is not nil and not major-mode, and so we use it.
+          (funcall (or proposed 'fundamental-mode)))))))
+

 ;;;###autoload
 (defun unload-feature (feature &optional force)
 ;;;###autoload
 (defun unload-feature (feature &optional force)

-  "Unload the library that provided FEATURE, restoring all its autoloads.
+  "Unload the library that provided FEATURE.

 If the feature is required by any other loaded code, and prefix arg FORCE
 is nil, raise an error.
 
 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."
+Standard unloading activities include restoring old autoloads for
+functions defined by the library, undoing any additions that the
+library has made to hook variables or to `auto-mode-alist', undoing
+ELP profiling of functions in that library, unproviding any features
+provided by the library, and canceling timers held in variables
+defined by the library.
+
+If a function `FEATURE-unload-function' is defined, this function
+calls it with no arguments, before doing anything else.  That function
+can do whatever is appropriate to undo the loading of the library.  If
+`FEATURE-unload-function' returns non-nil, that suppresses the
+standard unloading of the library.  Otherwise the standard unloading
+proceeds.
+
+`FEATURE-unload-function' has access to the package's list of
+definitions in the variable `unload-function-defs-list' and could
+remove symbols from it in the event that the package has done
+something strange, such as redefining an Emacs function."

   (interactive
    (list
     (read-feature "Unload feature: " t)
   (interactive
    (list
     (read-feature "Unload feature: " t)


@@ -175,86 +194,95 @@ such as redefining an Emacs function."
       (when dependents
        (error "Loaded libraries %s depend on %s"
               (prin1-to-string 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))
+  (let* ((unload-function-defs-list (feature-symbols feature))
+         (file (pop unload-function-defs-list))

         ;; If non-nil, this is a symbol for which we should
         ;; restore a previous autoload if possible.
         restore-autoload
         ;; If non-nil, this is a symbol for which we should
         ;; restore a previous autoload if possible.
         restore-autoload

-         (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))))
+        (name (symbol-name feature))
+         (unload-hook (intern-soft (concat name "-unload-hook")))
+        (unload-func (intern-soft (concat name "-unload-function"))))
+    ;; If FEATURE-unload-function is defined and returns non-nil,
+    ;; don't try to do anything more; otherwise proceed normally.
+    (unless (and (fboundp unload-func)
+                (funcall unload-func))
+      ;; 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.)
+      (if unload-hook
+         ;; First off, provide a clean way for package FOO to arrange
+         ;; this by adding hooks on the variable `FOO-unload-hook'.
+         ;; This is obsolete; FEATURE-unload-function should be used now.
+         (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-function-defs-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-function-defs-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)))))
+
+      ;; Change major mode in all buffers using one defined in the feature being unloaded.
+      (unload--set-major-mode)
+
+      (when (fboundp 'elp-restore-function) ; remove ELP stuff first
+       (dolist (elt unload-function-defs-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 autoload)
-           (let ((fun (cdr x)))
-             (when (fboundp fun)
-               (when (fboundp 'ad-unadvise)
-                 (ad-unadvise fun))
-               (let ((aload (get fun 'autoload)))
-                 (if (and aload (eq fun restore-autoload))
-                      (fset fun (cons 'autoload aload))
-                    (fmakunbound fun))))))
-          ;; (t . SYMBOL) comes before (defun . SYMBOL)
-          ;; and says we should restore SYMBOL's autoload
-          ;; when we undefine it.
-          ((t) (setq restore-autoload (cdr x)))
-           ((require defface) 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)))
+      (dolist (x unload-function-defs-list)
+       (if (consp x)
+           (pcase (car x)
+             ;; Remove any feature names that this file provided.
+             (`provide
+              (setq features (delq (cdr x) features)))
+             ((or `defun `autoload)
+              (let ((fun (cdr x)))
+                (when (fboundp fun)
+                  (when (fboundp 'ad-unadvise)
+                    (ad-unadvise fun))
+                  (let ((aload (get fun 'autoload)))
+                    (if (and aload (eq fun restore-autoload))
+                        (fset fun (cons 'autoload aload))
+                      (fmakunbound fun))))))
+             ;; (t . SYMBOL) comes before (defun . SYMBOL)
+             ;; and says we should restore SYMBOL's autoload
+             ;; when we undefine it.
+             (`t (setq restore-autoload (cdr x)))
+             ((or `require `defface) nil)
+             (_ (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))))

   ;; Don't return load-history, it is not useful.
   nil)
 
 (provide 'loadhist)
 
   ;; Don't return load-history, it is not useful.
   nil)
 
 (provide 'loadhist)
 

-;; arch-tag: 70bb846a-c413-4f01-bf88-78dba4ac0798

 ;;; loadhist.el ends here
 ;;; loadhist.el ends here