;; autoload.el --- maintain autoloads in loaddefs.el
;; Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 2001, 2002, 2003,
-;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Roland McGrath <roland@gnu.org>
;; Keywords: maint
;; 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
-;; the Free Software Foundation; either version 3, 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 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:
;;;###autoload
(put 'generated-autoload-file 'safe-local-variable 'stringp)
+(defvar generated-autoload-feature nil
+ "Feature for `generated-autoload-file' to provide.
+If nil, this defaults to `generated-autoload-file', sans extension.")
+;;;###autoload
+(put 'generated-autoload-feature 'safe-local-variable 'symbolp)
+
+(defvar generated-autoload-load-name nil
+ "Load name for `autoload' statements generated from autoload cookies.
+If nil, this defaults to the file name, sans extension.")
+;;;###autoload
+(put 'generated-autoload-load-name 'safe-local-variable 'stringp)
+
;; This feels like it should be a defconst, but MH-E sets it to
;; ";;;###mh-autoload" for the autoloads that are to go into mh-loaddefs.el.
(defvar generate-autoload-cookie ";;;###autoload"
read and an autoload made for it. If there is further text on the line,
that text will be copied verbatim to `generated-autoload-file'.")
+(defvar autoload-excludes nil
+ "If non-nil, list of absolute file names not to scan for autoloads.")
+
(defconst generate-autoload-section-header "\f\n;;;### "
"String that marks the form at the start of a new file's autoload section.")
easy-mmode-define-global-mode define-global-minor-mode
define-globalized-minor-mode
easy-mmode-define-minor-mode define-minor-mode
- defun* defmacro*))
+ defun* defmacro* define-overloadable-function))
(let* ((macrop (memq car '(defmacro defmacro*)))
(name (nth 1 form))
(args (case car
- ((defun defmacro defun* defmacro*) (nth 2 form))
+ ((defun defmacro defun* defmacro*
+ define-overloadable-function) (nth 2 form))
((define-skeleton) '(&optional str arg))
((define-generic-mode define-derived-mode
define-compilation-mode) nil)
(eq (car-safe (car body)) 'interactive))
(if macrop (list 'quote 'macro) nil))))
+ ;; For defclass forms, use `eieio-defclass-autoload'.
+ ((eq car 'defclass)
+ (let ((name (nth 1 form))
+ (superclasses (nth 2 form))
+ (doc (nth 4 form)))
+ (list 'eieio-defclass-autoload (list 'quote name)
+ (list 'quote superclasses) file doc)))
+
;; Convert defcustom to less space-consuming data.
((eq car 'defcustom)
(let ((varname (car-safe (cdr-safe form)))
(print-escape-nonascii t))
(print form outbuf)))))))
+(defun autoload-rubric (file &optional type)
+ "Return a string giving the appropriate autoload rubric for FILE.
+TYPE (default \"autoloads\") is a string stating the type of
+information contained in FILE."
+ (let ((basename (file-name-nondirectory file)))
+ (concat ";;; " basename
+ " --- automatically extracted " (or type "autoloads") "\n"
+ ";;\n"
+ ";;; Code:\n\n"
+ "\f\n"
+ "(provide '"
+ (if (and generated-autoload-feature
+ (symbolp generated-autoload-feature))
+ (format "%s" generated-autoload-feature)
+ (file-name-sans-extension basename))
+ ")\n"
+ ";; Local Variables:\n"
+ ";; version-control: never\n"
+ ";; no-byte-compile: t\n"
+ ";; no-update-autoloads: t\n"
+ ";; coding: utf-8\n"
+ ";; End:\n"
+ ";;; " basename
+ " ends here\n")))
+
(defun autoload-ensure-default-file (file)
"Make sure that the autoload file FILE exists and if not create it."
(unless (file-exists-p file)
- (write-region
- (concat ";;; " (file-name-nondirectory file)
- " --- automatically extracted autoloads\n"
- ";;\n"
- ";;; Code:\n\n"
- "\f\n;; Local Variables:\n"
- ";; version-control: never\n"
- ";; no-byte-compile: t\n"
- ";; no-update-autoloads: t\n"
- ";; End:\n"
- ";;; " (file-name-nondirectory file)
- " ends here\n")
- nil file))
+ (write-region (autoload-rubric file) nil file))
file)
(defun autoload-insert-section-header (outbuf autoloads load-name file time)
If OUTFILE is non-nil and FILE specifies a `generated-autoload-file'
different from OUTFILE, then OUTBUF is ignored.
-Return non-nil iff FILE adds no autoloads to OUTFILE
+Return non-nil if and only if FILE adds no autoloads to OUTFILE
\(or OUTBUF if OUTFILE is nil)."
(catch 'done
(let ((autoloads-done '())
- (load-name (autoload-file-load-name file))
+ load-name
(print-length nil)
+ (print-level nil)
(print-readably t) ; This does something in Lucid Emacs.
(float-output-format nil)
(visited (get-file-buffer file))
relfile
;; nil until we found a cookie.
output-start)
-
+ (if (member absfile autoload-excludes)
+ (message "Generating autoloads for %s...skipped" file)
(with-current-buffer (or visited
;; It is faster to avoid visiting the file.
(autoload-find-file file))
;; Obey the no-update-autoloads file local variable.
(unless no-update-autoloads
(message "Generating autoloads for %s..." file)
+ (setq load-name
+ (if (stringp generated-autoload-load-name)
+ generated-autoload-load-name
+ (autoload-file-load-name file)))
(save-excursion
(save-restriction
(widen)
(message "Generating autoloads for %s...done" file))
(or visited
;; We created this buffer, so we should kill it.
- (kill-buffer (current-buffer))))
+ (kill-buffer (current-buffer)))))
;; If the entries were added to some other buffer, then the file
;; doesn't add entries to OUTFILE.
(or (not output-start) otherbuf))))
(no-autoloads (autoload-generate-file-autoloads file)))
(if autoload-modified-buffers
(if save-after (autoload-save-buffers))
- (if (interactive-p)
+ (if (called-interactively-p 'interactive)
(message "Autoload section for %s is up to date." file)))
(if no-autoloads file)))
(existing-buffer (if buffer-file-name buf))
(found nil))
(with-current-buffer
- ;; We must read/write the file without any code conversion,
- ;; but still decode EOLs.
- (let ((coding-system-for-read 'raw-text))
- (find-file-noselect
- (autoload-ensure-default-file (autoload-generated-file))))
+ ;; We used to use `raw-text' to read this file, but this causes
+ ;; problems when the file contains non-ASCII characters.
+ (find-file-noselect
+ (autoload-ensure-default-file (autoload-generated-file)))
;; This is to make generated-autoload-file have Unix EOLs, so
;; that it is portable to all platforms.
- (setq buffer-file-coding-system 'raw-text-unix)
+ (unless (zerop (coding-system-eol-type buffer-file-coding-system))
+ (set-buffer-file-coding-system 'unix))
(or (> (buffer-size) 0)
(error "Autoloads file %s does not exist" buffer-file-name))
(or (file-writable-p buffer-file-name)
(define-obsolete-function-alias 'update-autoloads-from-directories
'update-directory-autoloads "22.1")
+(defvar autoload-make-program (or (getenv "MAKE") "make")
+ "Name of the make program in use during the Emacs build process.")
+
;;;###autoload
(defun batch-update-autoloads ()
"Update loaddefs.el autoloads in batch mode.
Calls `update-directory-autoloads' on the command line arguments."
+ ;; For use during the Emacs build process only.
+ (unless autoload-excludes
+ (let* ((ldir (file-name-directory generated-autoload-file))
+ (default-directory
+ (file-name-as-directory
+ (expand-file-name (if (eq system-type 'windows-nt)
+ "../lib-src"
+ "../src") ldir)))
+ (mfile "Makefile")
+ (tmpfile "echolisp.tmp")
+ lim)
+ ;; Windows uses the 'echolisp' approach because:
+ ;; i) It does not have $lisp as a single simple definition, so
+ ;; it would be harder to parse the Makefile.
+ ;; ii) It can, since it already has $lisp broken up into pieces
+ ;; that the command-line can handle.
+ ;; Non-Windows builds do not use the 'echolisp' approach because
+ ;; no-one knows (?) the maximum safe command-line length on all
+ ;; supported systems. $lisp is much longer there since it uses
+ ;; absolute paths, and it would seem a shame to split it just for this.
+ (when (file-readable-p mfile)
+ (if (eq system-type 'windows-nt)
+ (when (ignore-errors
+ (if (file-exists-p tmpfile) (delete-file tmpfile))
+ ;; FIXME call-process is better, if it works.
+ (shell-command (format "%s echolisp > %s"
+ autoload-make-program tmpfile))
+ (file-readable-p tmpfile))
+ (with-temp-buffer
+ (insert-file-contents tmpfile)
+ ;; FIXME could be a single while loop.
+ (while (not (eobp))
+ (setq lim (line-end-position))
+ (while (re-search-forward "\\([^ ]+\\.el\\)c?\\>" lim t)
+ (push (expand-file-name (match-string 1))
+ autoload-excludes))
+ (forward-line 1))))
+ (with-temp-buffer
+ (insert-file-contents mfile)
+ (when (re-search-forward "^lisp= " nil t)
+ (setq lim (line-end-position))
+ (while (re-search-forward "\\${lispsource}\\([^ ]+\\.el\\)c?\\>"
+ lim t)
+ (push (expand-file-name (match-string 1) ldir)
+ autoload-excludes))))))))
(let ((args command-line-args-left))
(setq command-line-args-left nil)
(apply 'update-directory-autoloads args)))