|
1232
|
1 ;;; autoload.el --- maintain autoloads in auto-autoloads files.
|
|
428
|
2
|
|
1753
|
3 ;; Copyright (C) 1991-1994, 1997, 2003 Free Software Foundation, Inc.
|
|
428
|
4 ;; Copyright (C) 1995 Tinker Systems and INS Engineering Corp.
|
|
1298
|
5 ;; Copyright (C) 1996, 2000, 2002, 2003 Ben Wing.
|
|
428
|
6
|
|
|
7 ;; Author: Roland McGrath <roland@gnu.ai.mit.edu>
|
|
|
8 ;; Keywords: maint
|
|
|
9
|
|
|
10 ;; This file is part of XEmacs.
|
|
|
11
|
|
|
12 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
13 ;; under the terms of the GNU General Public License as published by
|
|
|
14 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
15 ;; any later version.
|
|
|
16
|
|
|
17 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
20 ;; General Public License for more details.
|
|
|
21
|
|
|
22 ;; You should have received a copy of the GNU General Public License
|
|
|
23 ;; along with XEmacs; see the file COPYING. If not, write to the Free
|
|
|
24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
|
25 ;; 02111-1307, USA.
|
|
|
26
|
|
|
27 ;;; Synched up with: Not synched with FSF.
|
|
|
28
|
|
|
29 ;;; Commentary:
|
|
|
30
|
|
1232
|
31 ;; This code keeps auto-autoloads.el files up to date. It interprets
|
|
|
32 ;; magic cookies (of the form ";;;###autoload" in Lisp source files
|
|
|
33 ;; and "/* ###autoload */" in C source files) in various useful ways.
|
|
|
34
|
|
|
35 ;; Usage
|
|
|
36 ;; =====
|
|
|
37
|
|
|
38 ;; Recommended usage for this library, as implemented in the core
|
|
|
39 ;; build process, is
|
|
|
40
|
|
|
41 ;; xemacs -no-packages -batch \
|
|
|
42 ;; -eval "(setq generated-autoload-file \"PATH\")" \
|
|
|
43 ;; -l autoload -f autoload-update-directory-autoloads PREFIX DIRECTORY
|
|
|
44
|
|
|
45 ;; which causes XEmacs to update the file named by PATH from the .el
|
|
|
46 ;; files in DIRECTORY (but not recursing into subdirectories) and (if
|
|
|
47 ;; the autoload file is not already protected with a feature test) add
|
|
|
48 ;; a check and provide for 'PREFIX-autoloads. Currently there is no
|
|
|
49 ;; sanity check for the provided feature; it is recommended that you
|
|
|
50 ;; nuke any existing auto-autoloads.el before running the command.
|
|
|
51
|
|
|
52 ;; There is not yet a recommended API for updating multiple directories
|
|
|
53 ;; into a single auto-autoloads file. Using the recipe above for each
|
|
|
54 ;; DIRECTORY with the same PATH should work but has not been tested.
|
|
|
55 ;; There is no API for recursing into subdirectories. There probably
|
|
|
56 ;; won't be; given the wide variety of ways that existing Lisp packages
|
|
|
57 ;; arrange their files, and the fact that source packages and installed
|
|
|
58 ;; packages have a somewhat different directory structure, this seems far
|
|
|
59 ;; too risky. Use a script or a Lisp library with an explicit list of
|
|
|
60 ;; PATHs; see update-elc.el for how to do this without recursive invocation
|
|
|
61 ;; of XEmacs).
|
|
|
62
|
|
|
63 ;; The probable next step is to fix up the packages to use the
|
|
|
64 ;; `autoload-update-directory-autoloads' API. However, for backward
|
|
|
65 ;; compatibility with XEmacs 21.4 and 21.1, this can't be done quickly.
|
|
|
66
|
|
|
67 ;; For now the API used in update-elc-2.el:
|
|
|
68
|
|
|
69 ;; (let* ((dir "DIRECTORY")
|
|
|
70 ;; (generated-autoload-file (expand-file-name "auto-autoloads.el" dir))
|
|
|
71 ;; (autoload-package-name "PREFIX"))
|
|
|
72 ;; (update-autoload-files (list muledir))
|
|
|
73 ;; (byte-recompile-file generated-autoload-file 0))
|
|
|
74
|
|
|
75 ;; is available, but this ugly kludge is deprecated. It will be removed
|
|
|
76 ;; in favor of using proper arguments instead of special variables.
|
|
|
77
|
|
|
78 ;; For backward compatibility the API used in the packages/XEmacs.rules:
|
|
|
79
|
|
|
80 ;; xemacs -vanilla -batch -eval "$(AUTOLOAD_PACKAGE_NAME)" \
|
|
|
81 ;; -l autoload -f batch-update-directory $(AUTOLOAD_PATH)
|
|
|
82
|
|
|
83 ;; is supported, and the implementation is unchanged. However,
|
|
|
84 ;; revision of the API (in a backward compatible way) and the
|
|
|
85 ;; implementation are planned, and until those stabilize it is too
|
|
|
86 ;; risky to use this version of XEmacs for package releases.
|
|
|
87
|
|
|
88 ;; Implementation:
|
|
|
89 ;; ===============
|
|
|
90
|
|
|
91 ;; #### This section should be moved to the Internals manual, or
|
|
|
92 ;; (maybe) the Lispref, and integrated with the information above.
|
|
|
93 ;; Don't believe anything written here; the code is still a mess, and
|
|
|
94 ;; this is a lot of guesswork.
|
|
|
95
|
|
|
96 ;; Autoloads are used in a number of contexts, including core Lisp,
|
|
|
97 ;; packaged Lisp, and ELLs (dynamically loadable compiled objects
|
|
|
98 ;; providing Lisp functionality). There two general strategies for
|
|
|
99 ;; collecting autoloads. The first is to put autoloads for a package
|
|
|
100 ;; in a package-specific auto-autoloads file. This is easy to
|
|
|
101 ;; implement, and allows packages to be distributed with prebuilt
|
|
|
102 ;; auto-autoloads files. The second is to collect all the autoloads
|
|
|
103 ;; in a single global auto-autoloads file. This is alleged to speed
|
|
|
104 ;; up initialization significantly, but requires care to ensure that
|
|
|
105 ;; auto-autoloads files remain synchronized with the libraries.
|
|
|
106
|
|
|
107 ;; The traditional logic for determining where to put autoload
|
|
|
108 ;; definitions is complex and is now deprecated. The special variable
|
|
|
109 ;; `generated-autoload-file' is used to hold the path to the file, and
|
|
|
110 ;; is initialized to the traditional (well, it's a new tradition with
|
|
|
111 ;; XEmacs 20) $blddir/lisp/auto-autoloads.el. However, this variable
|
|
|
112 ;; may be bound by calling code, or may be generated at collect time
|
|
|
113 ;; and I'm not even sure the initialized value was ever used any more.
|
|
|
114
|
|
|
115 ;; Because there may be multiple auto-autoloads files in use (in XEmacs
|
|
|
116 ;; 21.x with a full complement of packages there are dozens), and they may
|
|
|
117 ;; contain initializations that would be dangerous to reexecute, each is
|
|
|
118 ;; protected by a feature test. By convention, the feature symbol is of
|
|
|
119 ;; the form "NAME-autoloads". For packages, the special variable
|
|
|
120 ;; `autoload-package-name' is used to determine NAME. In the core,
|
|
|
121 ;; autoloads are defined in the modules (all of which are collected in a
|
|
|
122 ;; single auto-autoloads file), using NAME=modules, in the lisp directory
|
|
|
123 ;; using NAME=lisp, and in the lisp/mule directory, using NAME=mule, for
|
|
|
124 ;; the autoloads feature. These latter are computed by the autoloads
|
|
|
125 ;; function at collect time.
|
|
428
|
126
|
|
|
127 ;; ChangeLog:
|
|
|
128
|
|
1232
|
129 ;; See ./ChangeLog.
|
|
428
|
130
|
|
|
131 ;;; Code:
|
|
|
132
|
|
1232
|
133 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
134 ;; Standard file and directory names
|
|
|
135
|
|
|
136 ;; `autoload-file-name' is defvar'd and initialized in packages.el,
|
|
|
137 ;; which is loaded (and dumped) very early. If you find it isn't, you
|
|
|
138 ;; know what you're doing.
|
|
|
139
|
|
|
140 (defconst autoload-target-directory "../lisp/"
|
|
|
141 "Standard directory containing autoload declaration file.
|
|
|
142
|
|
|
143 Use `generated-autoload-file' (q.v.) to change its installation location.")
|
|
|
144
|
|
|
145 ;; Dynamic variables for communication among functions
|
|
|
146
|
|
|
147 (defvar generated-autoload-file
|
|
|
148 (expand-file-name autoload-file-name lisp-directory)
|
|
|
149 "*File `update-file-autoloads' puts autoloads into.
|
|
|
150 A .el file can set this in its local variables section to make its
|
|
|
151 autoloads go somewhere else.
|
|
|
152
|
|
|
153 Note that `batch-update-directory' binds this variable to its own value,
|
|
|
154 generally the file named by `autoload-file-name' in the directory being
|
|
|
155 updated. XEmacs.rules setq's this variable for package autoloads.")
|
|
|
156
|
|
|
157 (define-obsolete-variable-alias 'autoload-package-name
|
|
|
158 'autoload-feature-prefix)
|
|
|
159 (defvar autoload-feature-prefix nil
|
|
|
160 "If non-nil, use this string to prefix the autoload feature name.
|
|
|
161
|
|
|
162 Usually a package name (from AUTOLOAD_PACKAGE_NAME, defined in XEmacs.rules
|
|
|
163 in the top of the package hierarchy), or \"auto\" (reserved for the core Lisp
|
|
|
164 auto-autoloads file). Highest priority candidate except for an explicit
|
|
|
165 argument to `autoload-make-feature-name' (q.v.).")
|
|
|
166
|
|
|
167 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
168 ;; Magic strings in source files
|
|
|
169
|
|
|
170 (defconst generate-autoload-cookie ";;;###autoload"
|
|
|
171 "Magic comment indicating the following form should be autoloaded.
|
|
|
172 Used by `update-file-autoloads'. This string should be
|
|
|
173 meaningless to Lisp (e.g., a comment).
|
|
|
174
|
|
|
175 This string is used:
|
|
|
176
|
|
|
177 ;;;###autoload
|
|
|
178 \(defun function-to-be-autoloaded () ...)
|
|
|
179
|
|
|
180 If this string appears alone on a line, the following form will be
|
|
|
181 read and an autoload made for it. If it is followed by the string
|
|
|
182 \"immediate\", then the form on the following line will be copied
|
|
|
183 verbatim. If there is further text on the line, that text will be
|
|
|
184 copied verbatim to `generated-autoload-file'.")
|
|
|
185
|
|
|
186 (defconst generate-c-autoload-cookie "/* ###autoload"
|
|
|
187 "Magic C comment indicating the following form should be autoloaded.
|
|
|
188 Used by `update-file-autoloads'. This string should be
|
|
|
189 meaningless to C (e.g., a comment).
|
|
|
190
|
|
|
191 This string is used:
|
|
|
192
|
|
|
193 /* ###autoload */
|
|
|
194 DEFUN (\"function-to-be-autoloaded\", ... )
|
|
|
195
|
|
|
196 If this string appears alone on a line, the following form will be
|
|
|
197 read and an autoload made for it. If there is further text on the line,
|
|
|
198 that text will be copied verbatim to `generated-autoload-file'.")
|
|
|
199
|
|
|
200 (defconst generate-c-autoload-module "/* ###module"
|
|
|
201 "Magic C comment indicating the module containing autoloaded functions.
|
|
|
202 Since a module can consist of multiple C files, the module name may not be
|
|
|
203 the same as the C source file base name. In that case, use this comment to
|
|
|
204 indicate the actual name of the module from which to autoload functions.")
|
|
|
205
|
|
|
206 (defconst generate-autoload-section-header "\f\n;;;### "
|
|
|
207 "String inserted before the form identifying
|
|
|
208 the section of autoloads for a file.")
|
|
|
209
|
|
|
210 (defconst generate-autoload-section-trailer "\n;;;***\n"
|
|
|
211 "String which indicates the end of the section of autoloads for a file.")
|
|
|
212
|
|
|
213 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
214 ;; Parsing the source file text.
|
|
|
215 ;; Autoloads in C source differ from those in Lisp source. For historical
|
|
|
216 ;; reasons, functions handling only Lisp don't have "lisp" in their names;
|
|
|
217 ;; maybe this should be changed.
|
|
|
218
|
|
428
|
219 (defun make-autoload (form file)
|
|
969
|
220 "Turn a definition generator FORM into an autoload for source file FILE.
|
|
|
221 Returns nil if FORM is not a defun, defun*, defmacro, defmacro*,
|
|
|
222 define-skeleton, or define-derived-mode."
|
|
428
|
223 (let ((car (car-safe form)))
|
|
778
|
224 (if (memq car '(defun defun* define-skeleton defmacro defmacro*
|
|
|
225 define-derived-mode))
|
|
|
226 (let ((macrop (memq car '(defmacro defmacro*)))
|
|
428
|
227 name doc)
|
|
|
228 (setq form (cdr form)
|
|
|
229 name (car form)
|
|
|
230 ;; Ignore the arguments.
|
|
646
|
231 form (cdr (cond ((eq car 'define-skeleton)
|
|
|
232 form)
|
|
|
233 ((eq car 'define-derived-mode)
|
|
|
234 (cddr form))
|
|
|
235 (t
|
|
|
236 (cdr form))))
|
|
428
|
237 doc (car form))
|
|
|
238 (if (stringp doc)
|
|
|
239 (setq form (cdr form))
|
|
|
240 (setq doc nil))
|
|
|
241 (list 'autoload (list 'quote name) file doc
|
|
|
242 (or (eq car 'define-skeleton)
|
|
646
|
243 (eq car 'define-derived-mode)
|
|
428
|
244 (eq (car-safe (car form)) 'interactive))
|
|
|
245 (if macrop (list 'quote 'macro) nil)))
|
|
|
246 nil)))
|
|
|
247
|
|
996
|
248 (defun make-c-autoload (module)
|
|
|
249 "Make an autoload list for the DEFUN at point in MODULE.
|
|
|
250 Returns nil if the DEFUN is malformed."
|
|
|
251 (and
|
|
|
252 ;; Match the DEFUN
|
|
|
253 (search-forward "DEFUN" nil t)
|
|
|
254 ;; Match the opening parenthesis
|
|
|
255 (progn
|
|
|
256 (skip-syntax-forward " ")
|
|
|
257 (eq (char-after) ?\())
|
|
|
258 ;; Match the opening quote of the Lisp function name
|
|
|
259 (progn
|
|
|
260 (forward-char)
|
|
|
261 (skip-syntax-forward " ")
|
|
|
262 (eq (char-after) ?\"))
|
|
|
263 ;; Extract the Lisp function name, interactive indicator, and docstring
|
|
|
264 (let* ((func-name (let ((begin (progn (forward-char) (point))))
|
|
|
265 (search-forward "\"" nil t)
|
|
|
266 (backward-char)
|
|
|
267 (intern (buffer-substring begin (point)))))
|
|
|
268 (interact (progn
|
|
|
269 (search-forward "," nil t 4)
|
|
|
270 (skip-syntax-forward " ")
|
|
|
271 (not (eq (char-after) ?0))))
|
|
|
272 (begin (progn
|
|
|
273 (search-forward "/*" nil t)
|
|
|
274 (forward-line 1)
|
|
|
275 (point))))
|
|
|
276 (search-forward "*/" nil t)
|
|
|
277 (goto-char (match-beginning 0))
|
|
|
278 (skip-chars-backward " \t\n\f")
|
|
|
279 (list 'autoload (list 'quote func-name) module
|
|
|
280 (buffer-substring begin (point)) interact nil))))
|
|
|
281
|
|
1232
|
282 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
283 ;; Generating autoloads for a single file
|
|
428
|
284
|
|
|
285 ;;;###autoload
|
|
|
286 (defun generate-file-autoloads (file &optional funlist)
|
|
1232
|
287 "Insert at point an autoload section for FILE.
|
|
428
|
288 autoloads are generated for defuns and defmacros in FILE
|
|
|
289 marked by `generate-autoload-cookie' (which see).
|
|
|
290 If FILE is being visited in a buffer, the contents of the buffer
|
|
|
291 are used."
|
|
|
292 (interactive "fGenerate autoloads for file: ")
|
|
1232
|
293 (cond ((string-match "\\.el$" file)
|
|
1298
|
294 (generate-autoload-ish-1
|
|
|
295 file
|
|
|
296 (replace-in-string (file-name-nondirectory file) "\\.elc?$" "")
|
|
|
297 nil #'generate-file-autoloads-1
|
|
|
298 funlist))
|
|
1232
|
299 ;; #### jj, are C++ modules possible?
|
|
|
300 ((string-match "\\.c$" file)
|
|
1298
|
301 (generate-autoload-ish-1
|
|
|
302 file
|
|
|
303 (replace-in-string (file-name-nondirectory file) "\\.c$" "")
|
|
1302
|
304 t #'generate-c-file-autoloads-1
|
|
|
305 funlist))
|
|
1232
|
306 (t
|
|
|
307 (error 'wrong-type-argument file "not a C or Elisp source file"))))
|
|
428
|
308
|
|
1298
|
309 (defun* generate-autoload-ish-1 (file load-name literal fun-to-call &rest args)
|
|
|
310 "Insert at point an autoload-type section for FILE.
|
|
|
311 If LITERAL, open the file literally, without decoding.
|
|
|
312 Calls FUN-TO-CALL to compute the autoloads, passing it OUTBUF, LOAD-NAME,
|
|
|
313 TRIM-NAME, and ARGS."
|
|
428
|
314 (let ((outbuf (current-buffer))
|
|
1298
|
315 (trim-name (autoload-trim-file-name file))
|
|
428
|
316 (autoloads-done '())
|
|
|
317 (print-length nil)
|
|
|
318 (print-readably t) ; XEmacs
|
|
|
319 (float-output-format nil)
|
|
1298
|
320 (visited (get-file-buffer file))
|
|
428
|
321 ;; (done-any nil)
|
|
|
322 output-end)
|
|
|
323
|
|
|
324 ;; If the autoload section we create here uses an absolute
|
|
|
325 ;; pathname for FILE in its header, and then Emacs is installed
|
|
|
326 ;; under a different path on another system,
|
|
|
327 ;; `update-autoloads-here' won't be able to find the files to be
|
|
|
328 ;; autoloaded. So, if FILE is in the same directory or a
|
|
|
329 ;; subdirectory of the current buffer's directory, we'll make it
|
|
|
330 ;; relative to the current buffer's directory.
|
|
|
331 (setq file (expand-file-name file))
|
|
|
332
|
|
|
333 (save-excursion
|
|
|
334 (unwind-protect
|
|
|
335 (progn
|
|
|
336 (let ((find-file-hooks nil)
|
|
|
337 (enable-local-variables nil))
|
|
1298
|
338 (set-buffer (or visited (find-file-noselect file literal literal
|
|
|
339 )))
|
|
|
340 ;; This doesn't look right for C files, but it is. The only
|
|
|
341 ;; place we need the syntax table is when snarfing the Lisp
|
|
|
342 ;; function name.
|
|
460
|
343 (set-syntax-table emacs-lisp-mode-syntax-table))
|
|
1298
|
344 (unless (setq autoloads-done
|
|
|
345 (apply fun-to-call outbuf load-name trim-name args))
|
|
|
346 (return-from generate-autoload-ish-1))
|
|
|
347 )
|
|
428
|
348 (unless visited
|
|
1298
|
349 ;; We created this buffer, so we should kill it.
|
|
|
350 (kill-buffer (current-buffer)))
|
|
428
|
351 (set-buffer outbuf)
|
|
|
352 (setq output-end (point-marker))))
|
|
|
353 (if t ;; done-any
|
|
|
354 ;; XEmacs -- always do this so that we cache the information
|
|
|
355 ;; that we've processed the file already.
|
|
|
356 (progn
|
|
|
357 (insert generate-autoload-section-header)
|
|
|
358 (prin1 (list 'autoloads autoloads-done load-name trim-name)
|
|
|
359 outbuf)
|
|
|
360 (terpri outbuf)
|
|
|
361 ;;;; (insert ";;; Generated autoloads from "
|
|
|
362 ;;;; (autoload-trim-file-name file) "\n")
|
|
1232
|
363 ;; Warn if we put a line in auto-autoloads.el
|
|
428
|
364 ;; that is long enough to cause trouble.
|
|
|
365 (when (< output-end (point))
|
|
|
366 (setq output-end (point-marker)))
|
|
|
367 (while (< (point) output-end)
|
|
|
368 ;; (let ((beg (point)))
|
|
|
369 (end-of-line)
|
|
|
370 ;; Emacs -- I still haven't figured this one out.
|
|
|
371 ;; (if (> (- (point) beg) 900)
|
|
|
372 ;; (progn
|
|
|
373 ;; (message "A line is too long--over 900 characters")
|
|
|
374 ;; (sleep-for 2)
|
|
|
375 ;; (goto-char output-end)))
|
|
|
376 ;; )
|
|
|
377 (forward-line 1))
|
|
|
378 (goto-char output-end)
|
|
|
379 (insert generate-autoload-section-trailer)))
|
|
|
380 (or noninteractive ; XEmacs: only need one line in -batch mode.
|
|
|
381 (message "Generating autoloads for %s...done" file))))
|
|
|
382
|
|
1298
|
383 (defun* generate-file-autoloads-1 (outbuf load-name trim-name funlist)
|
|
|
384 "Insert at point an autoload section for FILE.
|
|
|
385 autoloads are generated for defuns and defmacros in FILE
|
|
|
386 marked by `generate-autoload-cookie' (which see).
|
|
|
387 If FILE is being visited in a buffer, the contents of the buffer
|
|
|
388 are used."
|
|
|
389 (let ((autoloads-done '())
|
|
|
390 (dofiles (not (null funlist)))
|
|
|
391 )
|
|
|
392
|
|
|
393 (save-excursion
|
|
|
394 (save-restriction
|
|
|
395 (widen)
|
|
|
396 (goto-char (point-min))
|
|
|
397 (unless (search-forward generate-autoload-cookie nil t)
|
|
|
398 (message "No autoloads found in %s" trim-name)
|
|
|
399 (return-from generate-file-autoloads-1 nil))
|
|
|
400
|
|
|
401 (message "Generating autoloads for %s..." trim-name)
|
|
|
402 (goto-char (point-min))
|
|
|
403 (while (if dofiles funlist (not (eobp)))
|
|
|
404 (if (not dofiles)
|
|
|
405 (skip-chars-forward " \t\n\f")
|
|
|
406 (goto-char (point-min))
|
|
|
407 (re-search-forward
|
|
|
408 (concat "(def\\(un\\|var\\|const\\|macro\\) "
|
|
|
409 (regexp-quote (symbol-name (car funlist)))
|
|
|
410 "\\s "))
|
|
|
411 (goto-char (match-beginning 0)))
|
|
|
412 (cond
|
|
|
413 ((or dofiles
|
|
|
414 (looking-at (regexp-quote generate-autoload-cookie)))
|
|
|
415 (if dofiles
|
|
|
416 nil
|
|
|
417 (search-forward generate-autoload-cookie)
|
|
|
418 (skip-chars-forward " \t"))
|
|
|
419 ;; (setq done-any t)
|
|
|
420 (if (or dofiles (eolp))
|
|
|
421 ;; Read the next form and make an autoload.
|
|
|
422 (let* ((form (prog1 (read (current-buffer))
|
|
|
423 (or (bolp) (forward-line 1))))
|
|
|
424 (autoload (make-autoload form load-name))
|
|
|
425 (doc-string-elt (get (car-safe form)
|
|
|
426 'doc-string-elt)))
|
|
|
427 (if autoload
|
|
|
428 (setq autoloads-done (cons (nth 1 form)
|
|
|
429 autoloads-done))
|
|
|
430 (setq autoload form))
|
|
|
431 (print-autoload autoload doc-string-elt outbuf ""))
|
|
|
432 ;; Copy the rest of the line to the output.
|
|
|
433 (let ((begin (point)))
|
|
|
434 ;; (terpri outbuf)
|
|
|
435 (cond ((looking-at "immediate\\s *$") ; XEmacs
|
|
|
436 ;; This is here so that you can automatically
|
|
|
437 ;; have small hook functions copied to
|
|
|
438 ;; auto-autoloads.el so that it's not necessary
|
|
|
439 ;; to load a whole file just to get a two-line
|
|
|
440 ;; do-nothing find-file-hook... --Stig
|
|
|
441 (forward-line 1)
|
|
|
442 (setq begin (point))
|
|
|
443 (forward-sexp)
|
|
|
444 (forward-line 1))
|
|
|
445 (t
|
|
|
446 (forward-line 1)))
|
|
|
447 (princ (buffer-substring begin (point)) outbuf))))
|
|
|
448 ((looking-at ";")
|
|
|
449 ;; Don't read the comment.
|
|
|
450 (forward-line 1))
|
|
|
451 (t
|
|
|
452 (forward-sexp 1)
|
|
|
453 (forward-line 1)))
|
|
|
454 (if dofiles
|
|
|
455 (setq funlist (cdr funlist))))))
|
|
|
456 autoloads-done))
|
|
|
457
|
|
|
458 (defun* generate-c-file-autoloads-1 (outbuf load-name trim-name funlist)
|
|
1232
|
459 "Insert at point an autoload section for the C file FILE.
|
|
1048
|
460 autoloads are generated for defuns and defmacros in FILE
|
|
996
|
461 marked by `generate-c-autoload-cookie' (which see).
|
|
|
462 If FILE is being visited in a buffer, the contents of the buffer
|
|
|
463 are used."
|
|
1733
|
464 (let ((exists-p-format
|
|
|
465 "(when (locate-file \"%s\" module-load-path module-extensions)\n")
|
|
|
466 autoloads-done)
|
|
996
|
467 (save-excursion
|
|
1298
|
468 (save-restriction
|
|
|
469 (widen)
|
|
|
470 (goto-char (point-min))
|
|
|
471 ;; Is there a module name comment?
|
|
|
472 (when (search-forward generate-c-autoload-module nil t)
|
|
|
473 (skip-chars-forward " \t")
|
|
|
474 (let ((begin (point)))
|
|
|
475 (skip-chars-forward "^ \t\n\f")
|
|
|
476 (setq load-name (buffer-substring begin (point)))))
|
|
|
477 (if funlist
|
|
|
478 (progn
|
|
|
479 (message "Generating autoloads for %s..." trim-name)
|
|
1733
|
480 (princ (format exists-p-format load-name) outbuf)
|
|
1298
|
481 (dolist (arg funlist)
|
|
996
|
482 (goto-char (point-min))
|
|
1298
|
483 (re-search-forward
|
|
|
484 (concat "DEFUN (\""
|
|
|
485 (regexp-quote (symbol-name arg))
|
|
|
486 "\""))
|
|
|
487 (goto-char (match-beginning 0))
|
|
|
488 (let ((autoload (make-c-autoload load-name)))
|
|
|
489 (when autoload
|
|
|
490 (push (nth 1 (nth 1 autoload)) autoloads-done)
|
|
|
491 (print-autoload autoload 3 outbuf " "))))
|
|
|
492 ;; close the princ'd `when' form
|
|
|
493 (princ ")" outbuf))
|
|
|
494 (goto-char (point-min))
|
|
|
495 (let ((match
|
|
|
496 (search-forward generate-c-autoload-cookie nil t)))
|
|
|
497 (unless match
|
|
|
498 (message "No autoloads found in %s" trim-name)
|
|
|
499 (return-from generate-c-file-autoloads-1 nil))
|
|
|
500
|
|
|
501 (message "Generating autoloads for %s..." trim-name)
|
|
1733
|
502 (princ (format exists-p-format load-name) outbuf)
|
|
1298
|
503 (while match
|
|
|
504 (forward-line 1)
|
|
|
505 (let ((autoload (make-c-autoload load-name)))
|
|
|
506 (when autoload
|
|
|
507 (push (nth 1 (nth 1 autoload)) autoloads-done)
|
|
|
508 (print-autoload autoload 3 outbuf " ")))
|
|
|
509 (setq match
|
|
|
510 (search-forward generate-c-autoload-cookie nil t)))
|
|
|
511 ;; close the princ'd `when' form
|
|
|
512 (princ ")" outbuf)))))
|
|
|
513 autoloads-done))
|
|
996
|
514
|
|
1232
|
515 ;; Assorted utilities for generating autoloads and pieces thereof
|
|
|
516
|
|
1048
|
517 (defun print-autoload (autoload doc-string-elt outbuf margin)
|
|
996
|
518 "Print an autoload form, handling special characters.
|
|
|
519 In particular, print docstrings with escapes inserted before left parentheses
|
|
|
520 at the beginning of lines and ^L characters."
|
|
|
521 (if (and doc-string-elt (stringp (nth doc-string-elt autoload)))
|
|
|
522 ;; We need to hack the printing because the doc-string must be
|
|
|
523 ;; printed specially for make-docfile (sigh).
|
|
|
524 (let* ((p (nthcdr (1- doc-string-elt) autoload))
|
|
1048
|
525 (elt (cdr p))
|
|
|
526 (start-string (format "\n%s(" margin)))
|
|
996
|
527 (setcdr p nil)
|
|
1048
|
528 (princ start-string outbuf)
|
|
996
|
529 ;; XEmacs change: don't let ^^L's get into
|
|
|
530 ;; the file or sorting is hard.
|
|
|
531 (let ((print-escape-newlines t)
|
|
|
532 (p (save-excursion
|
|
|
533 (set-buffer outbuf)
|
|
|
534 (point)))
|
|
|
535 p2)
|
|
|
536 (mapcar #'(lambda (elt)
|
|
|
537 (prin1 elt outbuf)
|
|
|
538 (princ " " outbuf))
|
|
|
539 autoload)
|
|
|
540 (save-excursion
|
|
|
541 (set-buffer outbuf)
|
|
|
542 (setq p2 (point-marker))
|
|
|
543 (goto-char p)
|
|
|
544 (save-match-data
|
|
|
545 (while (search-forward "\^L" p2 t)
|
|
|
546 (delete-char -1)
|
|
|
547 (insert "\\^L")))
|
|
|
548 (goto-char p2)))
|
|
|
549 (princ "\"\\\n" outbuf)
|
|
|
550 (let ((begin (save-excursion
|
|
|
551 (set-buffer outbuf)
|
|
|
552 (point))))
|
|
|
553 (princ (substring (prin1-to-string (car elt)) 1) outbuf)
|
|
|
554 ;; Insert a backslash before each ( that appears at the beginning
|
|
|
555 ;; of a line in the doc string.
|
|
|
556 (save-excursion
|
|
|
557 (set-buffer outbuf)
|
|
|
558 (save-excursion
|
|
1048
|
559 (while (search-backward start-string begin t)
|
|
996
|
560 (forward-char 1)
|
|
|
561 (insert "\\"))))
|
|
|
562 (if (null (cdr elt))
|
|
|
563 (princ ")" outbuf)
|
|
|
564 (princ " " outbuf)
|
|
|
565 (princ (substring (prin1-to-string (cdr elt)) 1) outbuf))
|
|
1048
|
566 (terpri outbuf)
|
|
|
567 (princ margin outbuf)))
|
|
996
|
568 ;; XEmacs change: another ^L hack
|
|
|
569 (let ((p (save-excursion
|
|
|
570 (set-buffer outbuf)
|
|
|
571 (point)))
|
|
|
572 (print-escape-newlines t)
|
|
|
573 p2)
|
|
|
574 (print autoload outbuf)
|
|
|
575 (save-excursion
|
|
|
576 (set-buffer outbuf)
|
|
|
577 (setq p2 (point-marker))
|
|
|
578 (goto-char p)
|
|
|
579 (save-match-data
|
|
|
580 (while (search-forward "\^L" p2 t)
|
|
|
581 (delete-char -1)
|
|
|
582 (insert "\\^L")))
|
|
|
583 (goto-char p2)))))
|
|
|
584
|
|
1232
|
585 ;;; Forms which have doc-strings which should be printed specially.
|
|
|
586 ;;; A doc-string-elt property of ELT says that (nth ELT FORM) is
|
|
|
587 ;;; the doc-string in FORM.
|
|
|
588 ;;;
|
|
|
589 ;;; defvar and defconst should be also be marked in this way. There is
|
|
|
590 ;;; no interference from make-docfile, which only processes those files
|
|
|
591 ;;; that are loaded into the dumped Emacs, and those files should
|
|
|
592 ;;; never have anything autoloaded here. Problems only occur with files
|
|
|
593 ;;; which have autoloaded entries *and* are processed by make-docfile;
|
|
|
594 ;;; there should be no such files.
|
|
428
|
595
|
|
1232
|
596 (put 'autoload 'doc-string-elt 3)
|
|
|
597 (put 'defun 'doc-string-elt 3)
|
|
|
598 (put 'defun* 'doc-string-elt 3)
|
|
|
599 (put 'defvar 'doc-string-elt 3)
|
|
|
600 (put 'defconst 'doc-string-elt 3)
|
|
|
601 (put 'defmacro 'doc-string-elt 3)
|
|
|
602 (put 'defmacro* 'doc-string-elt 3)
|
|
|
603 (put 'define-skeleton 'doc-string-elt 3)
|
|
|
604 (put 'define-derived-mode 'doc-string-elt 4)
|
|
442
|
605
|
|
1232
|
606 (defun autoload-trim-file-name (file)
|
|
|
607 "Returns relative pathname of FILE including the last directory.
|
|
428
|
608
|
|
1232
|
609 Hard-codes the directory separator as a forward slash."
|
|
|
610 (setq file (expand-file-name file))
|
|
|
611 (replace-in-string
|
|
|
612 (file-relative-name file (file-name-directory
|
|
|
613 (directory-file-name
|
|
|
614 (file-name-directory file))))
|
|
|
615 ;; #### is this a good idea?
|
|
|
616 "\\\\" "/"))
|
|
428
|
617
|
|
|
618 ;;;###autoload
|
|
|
619 (defun update-file-autoloads (file)
|
|
|
620 "Update the autoloads for FILE in `generated-autoload-file'
|
|
|
621 \(which FILE might bind in its local variables).
|
|
1232
|
622 This function is a no-op for an autoloads file (ie, a file whose name is
|
|
|
623 equal to `autoload-file-name')."
|
|
428
|
624 (interactive "fUpdate autoloads for file: ")
|
|
|
625 (setq file (expand-file-name file))
|
|
|
626 (when (and (file-newer-than-file-p file generated-autoload-file)
|
|
|
627 (not (member (file-name-nondirectory file)
|
|
|
628 (list autoload-file-name))))
|
|
|
629
|
|
|
630 (let ((load-name (replace-in-string (file-name-nondirectory file)
|
|
996
|
631 "\\.\\(elc?\\|c\\)$"
|
|
428
|
632 ""))
|
|
|
633 (trim-name (autoload-trim-file-name file))
|
|
|
634 section-begin form)
|
|
|
635 (save-excursion
|
|
|
636 (let ((find-file-hooks nil))
|
|
|
637 (set-buffer (or (get-file-buffer generated-autoload-file)
|
|
|
638 (find-file-noselect generated-autoload-file))))
|
|
|
639 ;; Make sure we can scribble in it.
|
|
|
640 (setq buffer-read-only nil)
|
|
|
641 ;; First delete all sections for this file.
|
|
|
642 (goto-char (point-min))
|
|
|
643 (while (search-forward generate-autoload-section-header nil t)
|
|
|
644 (setq section-begin (match-beginning 0))
|
|
|
645 (setq form (read (current-buffer)))
|
|
|
646 (when (string= (nth 2 form) load-name)
|
|
|
647 (search-forward generate-autoload-section-trailer)
|
|
|
648 (delete-region section-begin (point))))
|
|
|
649
|
|
|
650 ;; Now find insertion point for new section
|
|
|
651 (block find-insertion-point
|
|
|
652 (goto-char (point-min))
|
|
|
653 (while (search-forward generate-autoload-section-header nil t)
|
|
|
654 (setq form (read (current-buffer)))
|
|
|
655 (when (string< trim-name (nth 3 form))
|
|
|
656 ;; Found alphabetically correct insertion point
|
|
|
657 (goto-char (match-beginning 0))
|
|
|
658 (return-from find-insertion-point))
|
|
|
659 (search-forward generate-autoload-section-trailer))
|
|
|
660 (when (eq (point) (point-min)) ; No existing entries?
|
|
|
661 (goto-char (point-max)))) ; Append.
|
|
|
662
|
|
|
663 ;; Add in new sections for file
|
|
|
664 (generate-file-autoloads file))
|
|
|
665
|
|
|
666 (when (interactive-p) (save-buffer)))))
|
|
|
667
|
|
|
668 ;;;###autoload
|
|
|
669 (defun update-autoloads-here ()
|
|
|
670 "Update sections of the current buffer generated by `update-file-autoloads'."
|
|
|
671 (interactive)
|
|
|
672 (let ((generated-autoload-file (buffer-file-name)))
|
|
|
673 (save-excursion
|
|
|
674 (goto-char (point-min))
|
|
|
675 (while (search-forward generate-autoload-section-header nil t)
|
|
|
676 (let* ((form (condition-case ()
|
|
|
677 (read (current-buffer))
|
|
|
678 (end-of-file nil)))
|
|
|
679 (file (nth 3 form)))
|
|
|
680 ;; XEmacs change: if we can't find the file as specified, look
|
|
|
681 ;; around a bit more.
|
|
|
682 (cond ((and (stringp file)
|
|
|
683 (or (get-file-buffer file)
|
|
|
684 (file-exists-p file))))
|
|
|
685 ((and (stringp file)
|
|
|
686 (save-match-data
|
|
|
687 (let ((loc (locate-file (file-name-nondirectory file)
|
|
|
688 load-path)))
|
|
|
689 (if (null loc)
|
|
|
690 nil
|
|
|
691 (setq loc (expand-file-name
|
|
|
692 (autoload-trim-file-name loc)
|
|
|
693 ".."))
|
|
|
694 (if (or (get-file-buffer loc)
|
|
|
695 (file-exists-p loc))
|
|
|
696 (setq file loc)
|
|
|
697 nil))))))
|
|
|
698 (t
|
|
|
699 (setq file
|
|
|
700 (if (y-or-n-p
|
|
|
701 (format
|
|
|
702 "Can't find library `%s'; remove its autoloads? "
|
|
|
703 (nth 2 form) file))
|
|
|
704 t
|
|
|
705 (condition-case ()
|
|
|
706 (read-file-name
|
|
|
707 (format "Find `%s' load file: "
|
|
|
708 (nth 2 form))
|
|
|
709 nil nil t)
|
|
|
710 (quit nil))))))
|
|
|
711 (if file
|
|
|
712 (let ((begin (match-beginning 0)))
|
|
|
713 (search-forward generate-autoload-section-trailer)
|
|
|
714 (delete-region begin (point))))
|
|
|
715 (if (stringp file)
|
|
|
716 (generate-file-autoloads file)))))))
|
|
|
717
|
|
1232
|
718 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
719 ;; Utilities for batch updates
|
|
|
720
|
|
|
721 ;;;###autoload
|
|
|
722 (defun autoload-update-directory-autoloads ()
|
|
|
723 "Update the autoloads for a directory, using a specified feature prefix.
|
|
|
724 Must be used only with -batch. The feature prefix and directory to update
|
|
|
725 are taken from the first and second elements of `command-line-args-left',
|
|
|
726 respectively, and they are then removed from `command-line-args-left'.
|
|
|
727
|
|
|
728 Runs `update-file-autoloads' on each file in the given directory. Always
|
|
|
729 rewrites the autoloads file, even if unchanged. Makes a feature name by
|
|
|
730 applying `autoload-make-feature-name' to the specified feature prefix.
|
|
|
731
|
|
|
732 #### The API and semantics of this function are subject to change."
|
|
|
733 (unless noninteractive
|
|
|
734 (error "autoload-batch-update-autoloads: may be used only with -batch"))
|
|
|
735 (let* ((autoload-feature-prefix (car command-line-args-left))
|
|
|
736 (dir (cadr command-line-args-left))
|
|
|
737 (generated-autoload-file (expand-file-name autoload-file-name dir)))
|
|
|
738 (update-autoload-files (list dir) t t)
|
|
|
739 (setq command-line-args-left (cddr command-line-args-left))))
|
|
|
740
|
|
|
741 ;;;###autoload
|
|
|
742 (defun update-autoload-files (files-or-dirs &optional all-into-one-file force)
|
|
|
743 "Update all the autoload files associated with FILES-OR-DIRS.
|
|
|
744 FILES-OR-DIRS is a list of files and/or directories to be processed.
|
|
|
745
|
|
|
746 An appropriate autoload file is chosen and a feature constructed for
|
|
|
747 each element of FILES-OR-DIRS. Fixup code testing for the autoload file's
|
|
|
748 feature and to provide the feature is added.
|
|
|
749
|
|
|
750 If optional ALL-INTO-ONE-FILE is non-`nil', `generated-autoload-file'
|
|
|
751 should be set to the name of an autoload file and all autoloads will be
|
|
|
752 placed in that file. `autoload-feature-prefix' should be set to an
|
|
|
753 appropriate prefix which will be concatenated with \"-autoloads\" to
|
|
|
754 produce the feature name. Otherwise the appropriate autoload file for
|
|
|
755 each file or directory (located in that directory, or in the directory of
|
|
|
756 the specified file) will be updated with the directory's or file's
|
|
|
757 autoloads and the protective forms will be added, and the files will be
|
|
|
758 saved. Use of the default here is unreliable, and therefore deprecated.
|
|
|
759
|
|
|
760 Note that if some of FILES-OR-DIRS are directories, recursion goes only
|
|
|
761 one level deep.
|
|
|
762
|
|
|
763 If FORCE is non-nil, always save out the autoload files even if unchanged."
|
|
|
764 (let ((defdir (directory-file-name default-directory))
|
|
|
765 ;; value for all-into-one-file
|
|
|
766 (autoload-feature-name (autoload-make-feature-name))
|
|
|
767 (enable-local-eval nil)) ; Don't query in batch mode.
|
|
|
768 (dolist (arg files-or-dirs)
|
|
|
769 (setq arg (expand-file-name arg defdir))
|
|
|
770 (cond
|
|
|
771 ((file-directory-p arg)
|
|
|
772 (message "Updating autoloads for directory %s..." arg)
|
|
|
773 (update-autoloads-from-directory arg))
|
|
|
774 ((file-exists-p arg)
|
|
|
775 (update-file-autoloads arg))
|
|
|
776 (t (error "No such file or directory: %s" arg)))
|
|
|
777 (when (not all-into-one-file)
|
|
|
778 (autoload-featurep-protect-autoloads
|
|
|
779 (autoload-make-feature-name
|
|
|
780 (file-name-nondirectory (directory-file-name arg))))
|
|
|
781 (if force (set-buffer-modified-p
|
|
|
782 t (find-file-noselect generated-autoload-file)))))
|
|
|
783 (when all-into-one-file
|
|
|
784 (autoload-featurep-protect-autoloads autoload-feature-name)
|
|
|
785 (if force (set-buffer-modified-p
|
|
|
786 t (find-file-noselect generated-autoload-file))))
|
|
|
787 (save-some-buffers t)
|
|
|
788 ))
|
|
|
789
|
|
428
|
790 ;;;###autoload
|
|
|
791 (defun update-autoloads-from-directory (dir)
|
|
|
792 "Update `generated-autoload-file' with all the current autoloads from DIR.
|
|
996
|
793 This runs `update-file-autoloads' on each .el and .c file in DIR.
|
|
442
|
794 Obsolete autoload entries for files that no longer exist are deleted.
|
|
|
795 Note that, if this function is called from `batch-update-directory',
|
|
528
|
796 `generated-autoload-file' was rebound in that function.
|
|
|
797
|
|
|
798 You don't really want to be calling this function. Try using
|
|
|
799 `update-autoload-files' instead."
|
|
428
|
800 (interactive "DUpdate autoloads for directory: ")
|
|
|
801 (setq dir (expand-file-name dir))
|
|
|
802 (let ((simple-dir (file-name-as-directory
|
|
|
803 (file-name-nondirectory
|
|
1232
|
804 (directory-file-name dir))))
|
|
428
|
805 (enable-local-eval nil))
|
|
|
806 (save-excursion
|
|
|
807 (let ((find-file-hooks nil))
|
|
|
808 (set-buffer (find-file-noselect generated-autoload-file)))
|
|
|
809 (goto-char (point-min))
|
|
|
810 (while (search-forward generate-autoload-section-header nil t)
|
|
|
811 (let* ((begin (match-beginning 0))
|
|
|
812 (form (condition-case ()
|
|
|
813 (read (current-buffer))
|
|
|
814 (end-of-file nil)))
|
|
|
815 (file (nth 3 form)))
|
|
|
816 (when (and (stringp file)
|
|
|
817 (string= (file-name-directory file) simple-dir)
|
|
|
818 (not (file-exists-p
|
|
|
819 (expand-file-name
|
|
|
820 (file-name-nondirectory file) dir))))
|
|
|
821 ;; Remove the obsolete section.
|
|
|
822 (search-forward generate-autoload-section-trailer)
|
|
|
823 (delete-region begin (point)))))
|
|
|
824 ;; Update or create autoload sections for existing files.
|
|
996
|
825 (mapcar 'update-file-autoloads
|
|
|
826 (directory-files dir t "^[^=].*\\.\\(el\\|c\\)$"))
|
|
428
|
827 (unless noninteractive
|
|
|
828 (save-buffer)))))
|
|
|
829
|
|
1232
|
830 (defun autoload-featurep-protect-autoloads (sym)
|
|
428
|
831 (save-excursion
|
|
|
832 (set-buffer (find-file-noselect generated-autoload-file))
|
|
|
833 (goto-char (point-min))
|
|
|
834 (if (and (not (= (point-min) (point-max)))
|
|
|
835 (not (looking-at ";;; DO NOT MODIFY THIS FILE")))
|
|
|
836 (progn
|
|
|
837 (insert ";;; DO NOT MODIFY THIS FILE\n")
|
|
|
838 (insert "(if (featurep '" sym ")")
|
|
1495
|
839 (insert " (error \"Feature " sym " already loaded\"))\n")
|
|
428
|
840 (goto-char (point-max))
|
|
|
841 (insert "\n(provide '" sym ")\n")))))
|
|
|
842
|
|
1232
|
843 (defun autoload-make-feature-name (&optional prefix)
|
|
|
844 "Generate the feature name to protect this auto-autoloads file from PREFIX.
|
|
428
|
845
|
|
1232
|
846 If PREFIX is nil, it defaults to the value of `autoload-feature-prefix' if
|
|
|
847 that is non-nil.
|
|
|
848
|
|
|
849 The feature name must be globally unique for this version of XEmacs,
|
|
|
850 including packages.
|
|
528
|
851
|
|
1232
|
852 For backward compatibility, if PREFIX and `autoload-feature-prefix' are both
|
|
|
853 `nil', PREFIX is computed as the last directory component of
|
|
|
854 `generated-autoload-file'. This is likely to result in non-uniqueness, so
|
|
|
855 do not use this feature."
|
|
|
856 (concat
|
|
|
857 (cond (prefix)
|
|
|
858 (autoload-feature-prefix)
|
|
|
859 ((stringp generated-autoload-file)
|
|
|
860 (message "Warning: autoload computing feature prefix.
|
|
|
861 You should specify it as an argument to `autoload-make-feature-name'.")
|
|
|
862 (file-name-nondirectory
|
|
|
863 (directory-file-name
|
|
|
864 (file-name-directory generated-autoload-file))))
|
|
|
865 (t (error 'invalid-argument
|
|
|
866 "Could not compute a feature name")))
|
|
|
867 "-autoloads"))
|
|
|
868
|
|
|
869 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
870 ;; Deprecated entry points
|
|
|
871
|
|
|
872 ;; A grep of the core and packages shows use of `batch-update-autoloads'
|
|
|
873 ;; by XEmacs.rules, pcomplete, eshell, oort-gnus; `batch-update-directory'
|
|
|
874 ;; by liece.
|
|
528
|
875
|
|
|
876 ;; #### these entry points below are a big mess, especially the
|
|
|
877 ;; first two. there don't seem to be very many packages that use the
|
|
|
878 ;; first one (the "all-into-one-file" variety), and do they actually
|
|
|
879 ;; rely on this functionality? --ben
|
|
1232
|
880 ;; but XEmacs.rules does, though maybe it doesn't "rely" on it, and
|
|
|
881 ;; modules do now, and that relies on it. --sjt
|
|
528
|
882
|
|
|
883 ;;;###autoload
|
|
|
884 (defun batch-update-autoloads ()
|
|
|
885 "Update the autoloads for the files or directories on the command line.
|
|
|
886 Runs `update-file-autoloads' on files and `update-directory-autoloads'
|
|
|
887 on directories. Must be used only with -batch, and kills Emacs on completion.
|
|
|
888 Each file will be processed even if an error occurred previously.
|
|
|
889 For example, invoke `xemacs -batch -f batch-update-autoloads *.el'.
|
|
|
890 The directory to which the auto-autoloads.el file must be the first parameter
|
|
|
891 on the command line."
|
|
|
892 (unless noninteractive
|
|
|
893 (error "batch-update-autoloads is to be used only with -batch"))
|
|
|
894 (update-autoload-files command-line-args-left t)
|
|
|
895 (kill-emacs 0))
|
|
442
|
896
|
|
428
|
897 ;;;###autoload
|
|
|
898 (defun batch-update-directory ()
|
|
442
|
899 "Update the autoloads for the directories on the command line.
|
|
|
900 Runs `update-file-autoloads' on each file in the given directory, and must
|
|
1232
|
901 be used only with -batch.
|
|
|
902
|
|
|
903 Uses and removes the first element of `command-line-args-left'."
|
|
428
|
904 (unless noninteractive
|
|
|
905 (error "batch-update-directory is to be used only with -batch"))
|
|
528
|
906 (update-autoload-files command-line-args-left)
|
|
|
907 ;; (kill-emacs 0)
|
|
|
908 (setq command-line-args-left nil))
|
|
442
|
909
|
|
|
910 ;;;###autoload
|
|
|
911 (defun batch-update-one-directory ()
|
|
|
912 "Update the autoloads for a single directory on the command line.
|
|
|
913 Runs `update-file-autoloads' on each file in the given directory, and must
|
|
|
914 be used only with -batch."
|
|
|
915 (unless noninteractive
|
|
1232
|
916 (error "batch-update-one-directory is to be used only with -batch"))
|
|
528
|
917 (let ((arg (car command-line-args-left)))
|
|
|
918 (setq command-line-args-left (cdr command-line-args-left))
|
|
|
919 (update-autoload-files (list arg))))
|
|
|
920
|
|
|
921 ;;;###autoload
|
|
|
922 (defun batch-force-update-one-directory ()
|
|
|
923 "Update the autoloads for a single directory on the command line.
|
|
|
924 Runs `update-file-autoloads' on each file in the given directory, and must
|
|
1232
|
925 be used only with -batch. Always rewrites the autoloads file, even if
|
|
|
926 unchanged.
|
|
|
927
|
|
|
928 Uses and removes the first element of `command-line-args-left'."
|
|
528
|
929 (unless noninteractive
|
|
1232
|
930 (error "batch-force-update-directory is to be used only with -batch"))
|
|
528
|
931 (let ((arg (car command-line-args-left)))
|
|
|
932 (setq command-line-args-left (cdr command-line-args-left))
|
|
546
|
933 (update-autoload-files (list arg) nil t)))
|
|
442
|
934
|
|
1232
|
935 ;; Declare obsolescence
|
|
|
936
|
|
|
937 (make-obsolete-variable 'autoload-target-directory
|
|
|
938 "Don't use this. Bind `generated-autoload-file' to an absolute path.")
|
|
|
939 (make-obsolete 'batch-update-autoloads
|
|
|
940 'autoload-update-directory-autoloads)
|
|
|
941 (make-obsolete 'batch-update-directory
|
|
|
942 'autoload-update-directory-autoloads)
|
|
|
943 (make-obsolete 'batch-update-one-directory
|
|
|
944 'autoload-update-directory-autoloads)
|
|
|
945 (make-obsolete 'batch-force-update-one-directory
|
|
|
946 'autoload-update-directory-autoloads)
|
|
|
947
|
|
428
|
948 (provide 'autoload)
|
|
|
949
|
|
|
950 ;;; autoload.el ends here
|
