1 ;;; autoload.el --- maintain autoloads in loaddefs.el.
3 ;;; Copyright (C) 1991, 1992, 1993 Free Software Foundation, Inc.
5 ;; Author: Roland McGrath <roland@gnu.ai.mit.edu>
8 ;;; This program is free software; you can redistribute it and/or modify
9 ;;; it under the terms of the GNU General Public License as published by
10 ;;; the Free Software Foundation; either version 2, or (at your option)
11 ;;; any later version.
13 ;;; This program is distributed in the hope that it will be useful,
14 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;;; GNU General Public License for more details.
18 ;;; A copy of the GNU General Public License can be obtained from this
19 ;;; program's author (send electronic mail to roland@ai.mit.edu) or from
20 ;;; the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
26 ;; This code helps GNU Emacs maintainers keep the autoload.el file up to
27 ;; date. It interprets magic cookies of the form ";;;###autoload" in
28 ;; lisp source files in various useful ways. To learn more, read the
29 ;; source; if you're going to use this, you'd better be able to.
33 (defun make-autoload (form file)
34 "Turn FORM, a defun or defmacro, into an autoload for source file FILE.
35 Returns nil if FORM is not a defun or defmacro."
36 (let ((car (car-safe form)))
37 (if (or (eq car 'defun) (eq car 'defmacro))
38 (let (name doc macrop)
39 (setq macrop (eq car 'defmacro))
40 (setq form (cdr form))
41 (setq name (car form))
42 ;; Ignore the arguments.
43 (setq form (cdr (cdr form)))
46 (setq form (cdr form))
48 (list 'autoload (list 'quote name) file doc
49 (eq (car-safe (car form)) 'interactive)
50 (if macrop (list 'quote 'macro) nil)))
53 (defconst generate-autoload-cookie ";;;###autoload"
54 "Magic comment that tells \\[update-file-autoloads]
55 to make the following form into an autoload. This string should be
56 meaningless to Lisp (e.g., a comment).
61 \(defun function-to-be-autoloaded () ...)
63 If this string appears alone on a line, the following form will be
64 read and an autoload made for it. If there is further text on the line,
65 that text will be copied verbatim to `generated-autoload-file'.")
67 (defconst generate-autoload-section-header "\f\n;;;### "
68 "String inserted before the form identifying
69 the section of autoloads for a file.")
71 (defconst generate-autoload-section-trailer "\n;;;***\n"
72 "String which indicates the end of the section of autoloads for a file.")
74 ;;; Forms which have doc-strings which should be printed specially.
75 ;;; A doc-string-elt property of ELT says that (nth ELT FORM) is
76 ;;; the doc-string in FORM.
78 ;;; There used to be the following note here:
79 ;;; ;;; Note: defconst and defvar should NOT be marked in this way.
80 ;;; ;;; We don't want to produce defconsts and defvars that
81 ;;; ;;; make-docfile can grok, because then it would grok them twice,
82 ;;; ;;; once in foo.el (where they are given with ;;;###autoload) and
83 ;;; ;;; once in loaddefs.el.
85 ;;; Counter-note: Yes, they should be marked in this way.
86 ;;; make-docfile only processes those files that are loaded into the
87 ;;; dumped Emacs, and those files should never have anything
88 ;;; autoloaded here. The above-feared problem only occurs with files
89 ;;; which have autoloaded entries *and* are processed by make-docfile;
90 ;;; there should be no such files.
92 (put 'autoload 'doc-string-elt 3)
93 (put 'defun 'doc-string-elt 3)
94 (put 'defvar 'doc-string-elt 3)
95 (put 'defconst 'doc-string-elt 3)
96 (put 'defmacro 'doc-string-elt 3)
98 (defun generate-file-autoloads (file)
99 "Insert at point a loaddefs autoload section for FILE.
100 autoloads are generated for defuns and defmacros in FILE
101 marked by `generate-autoload-cookie' (which see).
102 If FILE is being visited in a buffer, the contents of the buffer
104 (interactive "fGenerate autoloads for file: ")
105 (let ((outbuf (current-buffer))
107 (load-name (let ((name (file-name-nondirectory file)))
108 (if (string-match "\\.elc?$" name)
109 (substring name 0 (match-beginning 0))
112 (floating-output-format "%20e")
114 (visited (get-file-buffer file))
117 ;; If the autoload section we create here uses an absolute
118 ;; pathname for FILE in its header, and then Emacs is installed
119 ;; under a different path on another system,
120 ;; `update-autoloads-here' won't be able to find the files to be
121 ;; autoloaded. So, if FILE is in the same directory or a
122 ;; subdirectory of the current buffer's directory, we'll make it
123 ;; relative to the current buffer's directory.
124 (setq file (expand-file-name file))
125 (if (and (< (length default-directory) (length file))
126 (string= default-directory
127 (substring file 0 (length default-directory))))
129 (setq file (substring file (length default-directory)))))
131 (message "Generating autoloads for %s..." file)
135 (set-buffer (find-file-noselect file))
139 (goto-char (point-min))
141 (skip-chars-forward " \t\n\f")
143 ((looking-at (regexp-quote generate-autoload-cookie))
144 (search-forward generate-autoload-cookie)
145 (skip-chars-forward " \t")
148 ;; Read the next form and make an autoload.
149 (let* ((form (prog1 (read (current-buffer))
151 (autoload (make-autoload form load-name))
152 (doc-string-elt (get (car-safe form)
155 (setq autoloads-done (cons (nth 1 form)
157 (setq autoload form))
158 (if (and doc-string-elt
159 (stringp (nth doc-string-elt autoload)))
160 ;; We need to hack the printing because the
161 ;; doc-string must be printed specially for
162 ;; make-docfile (sigh).
163 (let* ((p (nthcdr (1- doc-string-elt)
168 (mapcar (function (lambda (elt)
172 (princ "\"\\\n" outbuf)
174 (prin1-to-string (car elt)) 1)
180 (prin1-to-string (cdr elt))
184 (print autoload outbuf)))
185 ;; Copy the rest of the line to the output.
186 (let ((begin (point)))
188 (princ (buffer-substring begin (point)) outbuf))))
190 ;; Don't read the comment.
194 (forward-line 1)))))))
196 ;; We created this buffer, so we should kill it.
197 (kill-buffer (current-buffer)))
199 (setq output-end (point-marker))))
202 (insert generate-autoload-section-header)
203 (prin1 (list 'autoloads autoloads-done load-name file
204 (nth 5 (file-attributes file)))
207 (insert ";;; Generated autoloads from " file "\n")
208 (goto-char output-end)
209 (insert generate-autoload-section-trailer)))
210 (message "Generating autoloads for %s...done" file)))
212 (defconst generated-autoload-file "loaddefs.el"
213 "*File \\[update-file-autoloads] puts autoloads into.
214 A .el file can set this in its local variables section to make its
215 autoloads go somewhere else.")
218 (defun update-file-autoloads (file)
219 "Update the autoloads for FILE in `generated-autoload-file'
220 \(which FILE might bind in its local variables)."
221 (interactive "fUpdate autoloads for file: ")
222 (let ((load-name (let ((name (file-name-nondirectory file)))
223 (if (string-match "\\.elc?$" name)
224 (substring name 0 (match-beginning 0))
227 (existing-buffer (get-file-buffer file)))
229 ;; We want to get a value for generated-autoload-file from
230 ;; the local variables section if it's there.
231 (set-buffer (find-file-noselect file))
232 (set-buffer (find-file-noselect generated-autoload-file))
236 (goto-char (point-min))
237 (while (search-forward generate-autoload-section-header nil t)
238 (let ((form (condition-case ()
239 (read (current-buffer))
241 (if (string= (nth 2 form) load-name)
242 (let ((begin (match-beginning 0))
243 (last-time (nth 4 form))
244 (file-time (nth 5 (file-attributes file))))
245 (if (and (or (null existing-buffer)
246 (not (buffer-modified-p existing-buffer)))
247 (listp last-time) (= (length last-time) 2)
248 (or (> (car last-time) (car file-time))
249 (and (= (car last-time) (car file-time))
250 (>= (nth 1 last-time)
251 (nth 1 file-time)))))
252 (message "Autoload section for %s is up to date."
254 (search-forward generate-autoload-section-trailer)
255 (delete-region begin (point))
256 (generate-file-autoloads file))
260 ;; Have the user tell us where to put the section.
261 (save-window-excursion
262 (switch-to-buffer (current-buffer))
263 (with-output-to-temp-buffer "*Help*"
264 (princ (substitute-command-keys
266 Move point to where the autoload section
267 for %s should be inserted.
268 Then do \\[exit-recursive-edit]."
272 (generate-file-autoloads file)))
273 (if (interactive-p) (save-buffer))
274 (if (and (null existing-buffer)
275 (setq existing-buffer (get-file-buffer file)))
276 (kill-buffer existing-buffer)))))
279 (defun update-autoloads-here ()
280 "Update the sections of the current buffer generated by
281 \\[update-file-autoloads]."
283 (let ((generated-autoload-file (buffer-file-name)))
285 (goto-char (point-min))
286 (while (search-forward generate-autoload-section-header nil t)
287 (let* ((form (condition-case ()
288 (read (current-buffer))
291 (if (and (stringp file)
292 (or (get-file-buffer file)
293 (file-exists-p file)))
295 (setq file (if (y-or-n-p (format "Library \"%s\" (load \
296 file \"%s\") doesn't exist. Remove its autoload section? "
300 (read-file-name (format "Find \"%s\" load file: "
305 (let ((begin (match-beginning 0)))
306 (search-forward generate-autoload-section-trailer)
307 (delete-region begin (point))))
309 (generate-file-autoloads file)))))))
312 (defun update-directory-autoloads (dir)
313 "Run \\[update-file-autoloads] on each .el file in DIR."
314 (interactive "DUpdate autoloads for directory: ")
315 (mapcar 'update-file-autoloads
316 (directory-files dir nil "\\.el$"))
319 (set-buffer (find-file-noselect generated-autoload-file))
323 (defun batch-update-autoloads ()
324 "Update the autoloads for the files or directories on the command line.
325 Runs \\[update-file-autoloads] on files and \\[update-directory-autoloads]
326 on directories. Must be used only with -batch, and kills Emacs on completion.
327 Each file will be processed even if an error occurred previously.
328 For example, invoke \"emacs -batch -f batch-update-autoloads *.el\""
329 (if (not noninteractive)
330 (error "batch-update-file-autoloads is to be used only with -batch"))
332 (args command-line-args-left))
335 (condition-case lossage
336 (if (file-directory-p (expand-file-name (car args)))
337 (update-directory-autoloads (car args))
338 (update-file-autoloads (car args)))
339 (error (progn (message ">>Error processing %s: %s"
342 (throw 'file nil)))))
343 (setq args (cdr args)))
344 (save-some-buffers t)
346 (kill-emacs (if lost 1 0))))
350 ;;; autoload.el ends here