]> code.delx.au - gnu-emacs/blobdiff - lisp/emacs-lisp/autoload.el
(function*, case, ecase, typecase, etypecase, progv, lexical-let, lexical-let*,
[gnu-emacs] / lisp / emacs-lisp / autoload.el
index 0503d908fdd27b86fe3b1d2e67af2967d9ec8841..68d1287d98c8f0061fff70993446f29325f4341c 100644 (file)
@@ -1,6 +1,6 @@
-;;; autoload.el --- maintain autoloads in loaddefs.el
+;; autoload.el --- maintain autoloads in loaddefs.el
 
-;; Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 2001
+;; Copyright (C) 1991,92,93,94,95,96,97, 2001,02,03,04
 ;;   Free Software Foundation, Inc.
 
 ;; Author: Roland McGrath <roland@gnu.org>
@@ -34,6 +34,7 @@
 
 (require 'lisp-mode)                   ;for `doc-string-elt' properties.
 (require 'help-fns)                    ;for help-add-fundoc-usage.
+(eval-when-compile (require 'cl))
 
 (defvar generated-autoload-file "loaddefs.el"
    "*File \\[update-file-autoloads] puts autoloads into.
@@ -71,7 +72,7 @@ or macro definition or a defcustom)."
   (let ((car (car-safe form)) expand)
     (cond
      ;; For complex cases, try again on the macro-expansion.
-     ((and (memq car '(easy-mmode-define-global-mode
+     ((and (memq car '(easy-mmode-define-global-mode define-global-minor-mode
                       easy-mmode-define-minor-mode define-minor-mode))
           (setq expand (let ((load-file-name file)) (macroexpand form)))
           (eq (car expand) 'progn)
@@ -85,13 +86,18 @@ or macro definition or a defcustom)."
 
      ;; For special function-like operators, use the `autoload' function.
      ((memq car '(defun define-skeleton defmacro define-derived-mode
+                   define-compilation-mode
                   define-generic-mode easy-mmode-define-minor-mode
                   easy-mmode-define-global-mode
                   define-minor-mode defun* defmacro*))
       (let* ((macrop (memq car '(defmacro defmacro*)))
             (name (nth 1 form))
-            (args (if (memq car '(defun defmacro defun* defmacro*))
-                      (nth 2 form) t))
+            (args (case car
+                   ((defun defmacro defun* defmacro*) (nth 2 form))
+                   ((define-skeleton) '(&optional str arg))
+                   ((define-generic-mode define-derived-mode
+                       define-compilation-mode) nil)
+                   (t)))
             (body (nthcdr (get car 'doc-string-elt) form))
             (doc (if (stringp (car body)) (pop body))))
        (when (listp args)
@@ -108,21 +114,16 @@ or macro definition or a defcustom)."
                  (eq (car-safe (car body)) 'interactive))
              (if macrop (list 'quote 'macro) nil))))
 
-     ;; Convert defcustom to a simpler (and less space-consuming) defvar,
-     ;; but add some extra stuff if it uses :require.
+     ;; Convert defcustom to less space-consuming data.
      ((eq car 'defcustom)
       (let ((varname (car-safe (cdr-safe form)))
            (init (car-safe (cdr-safe (cdr-safe form))))
            (doc (car-safe (cdr-safe (cdr-safe (cdr-safe form)))))
-           (rest (cdr-safe (cdr-safe (cdr-safe (cdr-safe form))))))
-       (if (not (plist-get rest :require))
-           `(defvar ,varname ,init ,doc)
-         `(progn
-            (defvar ,varname ,init ,doc)
-            (custom-add-to-group ,(plist-get rest :group)
-                                 ',varname 'custom-variable)
-            (custom-add-load ',varname
-                             ,(plist-get rest :require))))))
+           ;; (rest (cdr-safe (cdr-safe (cdr-safe (cdr-safe form)))))
+           )
+       `(progn
+          (defvar ,varname ,init ,doc)
+          (custom-autoload ',varname ,file))))
 
      ;; nil here indicates that this is not a special autoload form.
      (t nil))))
@@ -134,7 +135,7 @@ or macro definition or a defcustom)."
 
 
 (defun autoload-trim-file-name (file)
-  ;; Returns a relative pathname of FILE
+  ;; Returns a relative file path for FILE
   ;; starting from the directory that loaddefs.el is in.
   ;; That is normally a directory in load-path,
   ;; which means Emacs will be able to find FILE when it looks.
@@ -164,16 +165,20 @@ markers before we call `read'."
        (goto-char (point-min))
        (read (current-buffer))))))
 
-;; !! Requires OUTBUF to be bound !!
+(defvar autoload-print-form-outbuf)
+
 (defun autoload-print-form (form)
-  "Print FORM such that make-docfile will find the docstrings."
+  "Print FORM such that `make-docfile' will find the docstrings.
+The variable `autoload-print-form-outbuf' specifies the buffer to
+put the output in."
   (cond
    ;; If the form is a sequence, recurse.
    ((eq (car form) 'progn) (mapcar 'autoload-print-form (cdr form)))
    ;; Symbols at the toplevel are meaningless.
    ((symbolp form) nil)
    (t
-    (let ((doc-string-elt (get (car-safe form) 'doc-string-elt)))
+    (let ((doc-string-elt (get (car-safe form) 'doc-string-elt))
+         (outbuf autoload-print-form-outbuf))
       (if (and doc-string-elt (stringp (nth doc-string-elt form)))
          ;; We need to hack the printing because the
          ;; doc-string must be printed specially for
@@ -223,7 +228,7 @@ markers before we call `read'."
             ";; no-update-autoloads: t\n"
             ";; End:\n"
             ";;; " (file-name-nondirectory file)
-            "ends here\n")
+            " ends here\n")
      nil file))
   file)
 
@@ -268,7 +273,7 @@ are used."
        output-end)
 
     ;; If the autoload section we create here uses an absolute
-    ;; pathname for FILE in its header, and then Emacs is installed
+    ;; file name for FILE in its header, and then Emacs is installed
     ;; under a different path on another system,
     ;; `update-autoloads-here' won't be able to find the files to be
     ;; autoloaded.  So, if FILE is in the same directory or a
@@ -317,8 +322,9 @@ are used."
                              (setq autoloads-done (cons (nth 1 form)
                                                         autoloads-done))
                            (setq autoload form))
-                         (autoload-print-form autoload))
-        
+                         (let ((autoload-print-form-outbuf outbuf))
+                           (autoload-print-form autoload)))
+
                      ;; Copy the rest of the line to the output.
                      (princ (buffer-substring
                              (progn
@@ -354,11 +360,14 @@ are used."
     (message "Generating autoloads for %s...done" file)))
 \f
 ;;;###autoload
-(defun update-file-autoloads (file)
+(defun update-file-autoloads (file &optional save-after)
   "Update the autoloads for FILE in `generated-autoload-file'
 \(which FILE might bind in its local variables).
-Return FILE if there was no autoload cookie in it."
-  (interactive "fUpdate autoloads for file: ")
+If SAVE-AFTER is non-nil (which is always, when called interactively),
+save the buffer too.
+
+Return FILE if there was no autoload cookie in it, else nil."
+  (interactive "fUpdate autoloads for file: \np")
   (let ((load-name (let ((name (file-name-nondirectory file)))
                     (if (string-match "\\.elc?\\(\\.\\|$\\)" name)
                         (substring name 0 (match-beginning 0))
@@ -403,7 +412,7 @@ Return FILE if there was no autoload cookie in it."
                       (if (and (or (null existing-buffer)
                                    (not (buffer-modified-p existing-buffer)))
                                (listp last-time) (= (length last-time) 2)
-                               (not (autoload-before-p last-time file-time)))
+                               (not (time-less-p last-time file-time)))
                           (progn
                             (if (interactive-p)
                                 (message "\
@@ -458,27 +467,28 @@ Autoload section for %s is up to date."
                           (or existing-buffer
                               (kill-buffer (current-buffer))))))))
              (generate-file-autoloads file))))
-      (and (interactive-p)
+      (and save-after
           (buffer-modified-p)
           (save-buffer))
 
       (if no-autoloads file))))
 
-(defun autoload-before-p (time1 time2)
-  (or (< (car time1) (car time2))
-      (and (= (car time1) (car time2))
-          (< (nth 1 time1) (nth 1 time2)))))
-
 (defun autoload-remove-section (begin)
   (goto-char begin)
   (search-forward generate-autoload-section-trailer)
   (delete-region begin (point)))
 
 ;;;###autoload
-(defun update-autoloads-from-directories (&rest dirs)
+(defun update-directory-autoloads (&rest dirs)
   "\
 Update loaddefs.el with all the current autoloads from DIRS, and no old ones.
-This uses `update-file-autoloads' (which see) do its work."
+This uses `update-file-autoloads' (which see) do its work.
+In an interactive call, you must give one argument, the name
+of a single directory.  In a call from Lisp, you can supply multiple
+directories as separate arguments, but this usage is discouraged.
+
+The function does NOT recursively descend into subdirectories of the
+directory or directories specified."
   (interactive "DUpdate autoloads from directory: ")
   (let* ((files-re (let ((tmp nil))
                     (dolist (suf load-suffixes
@@ -517,8 +527,7 @@ This uses `update-file-autoloads' (which see) do its work."
                     (dolist (file file)
                       (let ((file-time (nth 5 (file-attributes file))))
                         (when (and file-time
-                                   (not (autoload-before-p last-time
-                                                           file-time)))
+                                   (not (time-less-p last-time file-time)))
                           ;; file unchanged
                           (push file no-autoloads)
                           (setq files (delete file files)))))))
@@ -537,6 +546,8 @@ This uses `update-file-autoloads' (which see) do its work."
            (append no-autoloads
                    (delq nil (mapcar 'update-file-autoloads files))))
       (when no-autoloads
+       ;; Sort them for better readability.
+       (setq no-autoloads (sort no-autoloads 'string<))
        ;; Add the `no-autoloads' section.
        (goto-char (point-max))
        (search-backward "\f" nil t)
@@ -549,10 +560,11 @@ This uses `update-file-autoloads' (which see) do its work."
 ;;;###autoload
 (defun batch-update-autoloads ()
   "Update loaddefs.el autoloads in batch mode.
-Calls `update-autoloads-from-directories' on the command line arguments."
-  (apply 'update-autoloads-from-directories command-line-args-left)
+Calls `update-directory-autoloads' on the command line arguments."
+  (apply 'update-directory-autoloads command-line-args-left)
   (setq command-line-args-left nil))
 
 (provide 'autoload)
 
+;;; arch-tag: 00244766-98f4-4767-bf42-8a22103441c6
 ;;; autoload.el ends here