428
+ − 1 ;;; autoload.el --- maintain autoloads in loaddefs.el.
+ − 2
+ − 3 ;; Copyright (C) 1991, 1992, 1993, 1994, 1997 Free Software Foundation, Inc.
+ − 4 ;; Copyright (C) 1995 Tinker Systems and INS Engineering Corp.
778
+ − 5 ;; Copyright (C) 1996, 2000, 2002 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
613
+ − 31 ;; This code helps XEmacs maintainers keep the loaddefs.el file up to
428
+ − 32 ;; date. It interprets magic cookies of the form ";;;###autoload" in
+ − 33 ;; lisp source files in various useful ways. To learn more, read the
+ − 34 ;; source; if you're going to use this, you'd better be able to.
+ − 35
+ − 36 ;; ChangeLog:
+ − 37
996
+ − 38 ;; Jun-25-2002: Jerry James added code for processing C files, to
+ − 39 ;; support modularization
428
+ − 40 ;; Sep-26-1997: slb removed code dealing with customization.
+ − 41
+ − 42 ;;; Code:
+ − 43
+ − 44 (defun make-autoload (form file)
969
+ − 45 "Turn a definition generator FORM into an autoload for source file FILE.
+ − 46 Returns nil if FORM is not a defun, defun*, defmacro, defmacro*,
+ − 47 define-skeleton, or define-derived-mode."
428
+ − 48 (let ((car (car-safe form)))
778
+ − 49 (if (memq car '(defun defun* define-skeleton defmacro defmacro*
+ − 50 define-derived-mode))
+ − 51 (let ((macrop (memq car '(defmacro defmacro*)))
428
+ − 52 name doc)
+ − 53 (setq form (cdr form)
+ − 54 name (car form)
+ − 55 ;; Ignore the arguments.
646
+ − 56 form (cdr (cond ((eq car 'define-skeleton)
+ − 57 form)
+ − 58 ((eq car 'define-derived-mode)
+ − 59 (cddr form))
+ − 60 (t
+ − 61 (cdr form))))
428
+ − 62 doc (car form))
+ − 63 (if (stringp doc)
+ − 64 (setq form (cdr form))
+ − 65 (setq doc nil))
+ − 66 (list 'autoload (list 'quote name) file doc
+ − 67 (or (eq car 'define-skeleton)
646
+ − 68 (eq car 'define-derived-mode)
428
+ − 69 (eq (car-safe (car form)) 'interactive))
+ − 70 (if macrop (list 'quote 'macro) nil)))
+ − 71 nil)))
+ − 72
996
+ − 73 (defun make-c-autoload (module)
+ − 74 "Make an autoload list for the DEFUN at point in MODULE.
+ − 75 Returns nil if the DEFUN is malformed."
+ − 76 (and
+ − 77 ;; Match the DEFUN
+ − 78 (search-forward "DEFUN" nil t)
+ − 79 ;; Match the opening parenthesis
+ − 80 (progn
+ − 81 (skip-syntax-forward " ")
+ − 82 (eq (char-after) ?\())
+ − 83 ;; Match the opening quote of the Lisp function name
+ − 84 (progn
+ − 85 (forward-char)
+ − 86 (skip-syntax-forward " ")
+ − 87 (eq (char-after) ?\"))
+ − 88 ;; Extract the Lisp function name, interactive indicator, and docstring
+ − 89 (let* ((func-name (let ((begin (progn (forward-char) (point))))
+ − 90 (search-forward "\"" nil t)
+ − 91 (backward-char)
+ − 92 (intern (buffer-substring begin (point)))))
+ − 93 (interact (progn
+ − 94 (search-forward "," nil t 4)
+ − 95 (skip-syntax-forward " ")
+ − 96 (not (eq (char-after) ?0))))
+ − 97 (begin (progn
+ − 98 (search-forward "/*" nil t)
+ − 99 (forward-line 1)
+ − 100 (point))))
+ − 101 (search-forward "*/" nil t)
+ − 102 (goto-char (match-beginning 0))
+ − 103 (skip-chars-backward " \t\n\f")
+ − 104 (list 'autoload (list 'quote func-name) module
+ − 105 (buffer-substring begin (point)) interact nil))))
+ − 106
428
+ − 107 (defvar generate-autoload-cookie ";;;###autoload"
+ − 108 "Magic comment indicating the following form should be autoloaded.
+ − 109 Used by `update-file-autoloads'. This string should be
+ − 110 meaningless to Lisp (e.g., a comment).
+ − 111
+ − 112 This string is used:
+ − 113
+ − 114 ;;;###autoload
+ − 115 \(defun function-to-be-autoloaded () ...)
+ − 116
+ − 117 If this string appears alone on a line, the following form will be
+ − 118 read and an autoload made for it. If it is followed by the string
+ − 119 \"immediate\", then the form on the following line will be copied
+ − 120 verbatim. If there is further text on the line, that text will be
+ − 121 copied verbatim to `generated-autoload-file'.")
+ − 122
996
+ − 123 (defvar generate-c-autoload-cookie "/* ###autoload"
+ − 124 "Magic C comment indicating the following form should be autoloaded.
+ − 125 Used by `update-file-autoloads'. This string should be
+ − 126 meaningless to C (e.g., a comment).
+ − 127
+ − 128 This string is used:
+ − 129
+ − 130 /* ###autoload */
+ − 131 DEFUN (\"function-to-be-autoloaded\", ... )
+ − 132
+ − 133 If this string appears alone on a line, the following form will be
+ − 134 read and an autoload made for it. If there is further text on the line,
+ − 135 that text will be copied verbatim to `generated-autoload-file'.")
+ − 136
+ − 137 (defvar generate-c-autoload-module "/* ###module"
+ − 138 "Magic C comment indicating the module containing autoloaded functions.
+ − 139 Since a module can consist of multiple C files, the module name may not be
+ − 140 the same as the C source file base name. In that case, use this comment to
+ − 141 indicate the actual name of the module from which to autoload functions.")
+ − 142
428
+ − 143 (defvar generate-autoload-section-header "\f\n;;;### "
+ − 144 "String inserted before the form identifying
+ − 145 the section of autoloads for a file.")
+ − 146
+ − 147 (defvar generate-autoload-section-trailer "\n;;;***\n"
+ − 148 "String which indicates the end of the section of autoloads for a file.")
+ − 149
442
+ − 150 (defvar autoload-package-name nil)
+ − 151
428
+ − 152 ;;; Forms which have doc-strings which should be printed specially.
+ − 153 ;;; A doc-string-elt property of ELT says that (nth ELT FORM) is
+ − 154 ;;; the doc-string in FORM.
+ − 155 ;;;
+ − 156 ;;; There used to be the following note here:
+ − 157 ;;; ;;; Note: defconst and defvar should NOT be marked in this way.
+ − 158 ;;; ;;; We don't want to produce defconsts and defvars that
+ − 159 ;;; ;;; make-docfile can grok, because then it would grok them twice,
+ − 160 ;;; ;;; once in foo.el (where they are given with ;;;###autoload) and
+ − 161 ;;; ;;; once in loaddefs.el.
+ − 162 ;;;
+ − 163 ;;; Counter-note: Yes, they should be marked in this way.
+ − 164 ;;; make-docfile only processes those files that are loaded into the
+ − 165 ;;; dumped Emacs, and those files should never have anything
+ − 166 ;;; autoloaded here. The above-feared problem only occurs with files
+ − 167 ;;; which have autoloaded entries *and* are processed by make-docfile;
+ − 168 ;;; there should be no such files.
+ − 169
+ − 170 (put 'autoload 'doc-string-elt 3)
+ − 171 (put 'defun 'doc-string-elt 3)
778
+ − 172 (put 'defun* 'doc-string-elt 3)
428
+ − 173 (put 'defvar 'doc-string-elt 3)
+ − 174 (put 'defconst 'doc-string-elt 3)
+ − 175 (put 'defmacro 'doc-string-elt 3)
778
+ − 176 (put 'defmacro* 'doc-string-elt 3)
+ − 177 (put 'define-skeleton 'doc-string-elt 3)
969
+ − 178 (put 'define-derived-mode 'doc-string-elt 4)
428
+ − 179
+ − 180 (defun autoload-trim-file-name (file)
+ − 181 "Returns a relative pathname of FILE including the last directory."
+ − 182 (setq file (expand-file-name file))
442
+ − 183 (replace-in-string
+ − 184 (file-relative-name file (file-name-directory
+ − 185 (directory-file-name
+ − 186 (file-name-directory file))))
+ − 187 "\\\\" "/"))
428
+ − 188
+ − 189 ;;;###autoload
+ − 190 (defun generate-file-autoloads (file &optional funlist)
+ − 191 "Insert at point a loaddefs autoload section for FILE.
+ − 192 autoloads are generated for defuns and defmacros in FILE
+ − 193 marked by `generate-autoload-cookie' (which see).
+ − 194 If FILE is being visited in a buffer, the contents of the buffer
+ − 195 are used."
+ − 196 (interactive "fGenerate autoloads for file: ")
996
+ − 197 (if (string-match "\\.el$" file)
+ − 198 (generate-file-autoloads-1 file funlist)
+ − 199 (generate-c-file-autoloads-1 file funlist)))
428
+ − 200
+ − 201 (defun* generate-file-autoloads-1 (file funlist)
+ − 202 "Insert at point a loaddefs autoload section for FILE.
+ − 203 autoloads are generated for defuns and defmacros in FILE
+ − 204 marked by `generate-autoload-cookie' (which see).
+ − 205 If FILE is being visited in a buffer, the contents of the buffer
+ − 206 are used."
+ − 207 (let ((outbuf (current-buffer))
+ − 208 (autoloads-done '())
+ − 209 (load-name (replace-in-string (file-name-nondirectory file)
+ − 210 "\\.elc?$"
+ − 211 ""))
+ − 212 (trim-name (autoload-trim-file-name file))
+ − 213 (dofiles (not (null funlist)))
+ − 214 (print-length nil)
+ − 215 (print-readably t) ; XEmacs
+ − 216 (float-output-format nil)
+ − 217 ;; (done-any nil)
+ − 218 (visited (get-file-buffer file))
+ − 219 output-end)
+ − 220
+ − 221 ;; If the autoload section we create here uses an absolute
+ − 222 ;; pathname for FILE in its header, and then Emacs is installed
+ − 223 ;; under a different path on another system,
+ − 224 ;; `update-autoloads-here' won't be able to find the files to be
+ − 225 ;; autoloaded. So, if FILE is in the same directory or a
+ − 226 ;; subdirectory of the current buffer's directory, we'll make it
+ − 227 ;; relative to the current buffer's directory.
+ − 228 (setq file (expand-file-name file))
+ − 229
+ − 230 (save-excursion
+ − 231 (unwind-protect
+ − 232 (progn
+ − 233 (let ((find-file-hooks nil)
+ − 234 (enable-local-variables nil))
+ − 235 (set-buffer (or visited (find-file-noselect file)))
460
+ − 236 (set-syntax-table emacs-lisp-mode-syntax-table))
428
+ − 237 (save-excursion
+ − 238 (save-restriction
+ − 239 (widen)
+ − 240 (goto-char (point-min))
+ − 241 (unless (search-forward generate-autoload-cookie nil t)
+ − 242 (message "No autoloads found in %s" trim-name)
+ − 243 (return-from generate-file-autoloads-1))
+ − 244
+ − 245 (message "Generating autoloads for %s..." trim-name)
+ − 246 (goto-char (point-min))
+ − 247 (while (if dofiles funlist (not (eobp)))
+ − 248 (if (not dofiles)
+ − 249 (skip-chars-forward " \t\n\f")
+ − 250 (goto-char (point-min))
+ − 251 (re-search-forward
+ − 252 (concat "(def\\(un\\|var\\|const\\|macro\\) "
+ − 253 (regexp-quote (symbol-name (car funlist)))
+ − 254 "\\s "))
+ − 255 (goto-char (match-beginning 0)))
+ − 256 (cond
+ − 257 ((or dofiles
+ − 258 (looking-at (regexp-quote generate-autoload-cookie)))
+ − 259 (if dofiles
+ − 260 nil
+ − 261 (search-forward generate-autoload-cookie)
+ − 262 (skip-chars-forward " \t"))
+ − 263 ;; (setq done-any t)
+ − 264 (if (or dofiles (eolp))
+ − 265 ;; Read the next form and make an autoload.
+ − 266 (let* ((form (prog1 (read (current-buffer))
+ − 267 (or (bolp) (forward-line 1))))
+ − 268 (autoload (make-autoload form load-name))
+ − 269 (doc-string-elt (get (car-safe form)
+ − 270 'doc-string-elt)))
+ − 271 (if autoload
+ − 272 (setq autoloads-done (cons (nth 1 form)
+ − 273 autoloads-done))
+ − 274 (setq autoload form))
996
+ − 275 (print-autoload autoload doc-string-elt outbuf))
428
+ − 276 ;; Copy the rest of the line to the output.
+ − 277 (let ((begin (point)))
+ − 278 ;; (terpri outbuf)
+ − 279 (cond ((looking-at "immediate\\s *$") ; XEmacs
+ − 280 ;; This is here so that you can automatically
+ − 281 ;; have small hook functions copied to
+ − 282 ;; loaddefs.el so that it's not necessary to
+ − 283 ;; load a whole file just to get a two-line
+ − 284 ;; do-nothing find-file-hook... --Stig
+ − 285 (forward-line 1)
+ − 286 (setq begin (point))
+ − 287 (forward-sexp)
+ − 288 (forward-line 1))
+ − 289 (t
+ − 290 (forward-line 1)))
+ − 291 (princ (buffer-substring begin (point)) outbuf))))
+ − 292 ((looking-at ";")
+ − 293 ;; Don't read the comment.
+ − 294 (forward-line 1))
+ − 295 (t
+ − 296 (forward-sexp 1)
+ − 297 (forward-line 1)))
+ − 298 (if dofiles
+ − 299 (setq funlist (cdr funlist)))))))
+ − 300 (unless visited
+ − 301 ;; We created this buffer, so we should kill it.
+ − 302 (kill-buffer (current-buffer)))
+ − 303 (set-buffer outbuf)
+ − 304 (setq output-end (point-marker))))
+ − 305 (if t ;; done-any
+ − 306 ;; XEmacs -- always do this so that we cache the information
+ − 307 ;; that we've processed the file already.
+ − 308 (progn
+ − 309 (insert generate-autoload-section-header)
+ − 310 (prin1 (list 'autoloads autoloads-done load-name trim-name)
+ − 311 outbuf)
+ − 312 (terpri outbuf)
+ − 313 ;;;; (insert ";;; Generated autoloads from "
+ − 314 ;;;; (autoload-trim-file-name file) "\n")
+ − 315 ;; Warn if we put a line in loaddefs.el
+ − 316 ;; that is long enough to cause trouble.
+ − 317 (when (< output-end (point))
+ − 318 (setq output-end (point-marker)))
+ − 319 (while (< (point) output-end)
+ − 320 ;; (let ((beg (point)))
+ − 321 (end-of-line)
+ − 322 ;; Emacs -- I still haven't figured this one out.
+ − 323 ;; (if (> (- (point) beg) 900)
+ − 324 ;; (progn
+ − 325 ;; (message "A line is too long--over 900 characters")
+ − 326 ;; (sleep-for 2)
+ − 327 ;; (goto-char output-end)))
+ − 328 ;; )
+ − 329 (forward-line 1))
+ − 330 (goto-char output-end)
+ − 331 (insert generate-autoload-section-trailer)))
+ − 332 (or noninteractive ; XEmacs: only need one line in -batch mode.
+ − 333 (message "Generating autoloads for %s...done" file))))
+ − 334
996
+ − 335 (defun* generate-c-file-autoloads-1 (file funlist)
+ − 336 "Insert at point a loaddefs autoload section for the C file FILE.
+ − 337 autoloads are generated for Defuns and defmacros in FILE
+ − 338 marked by `generate-c-autoload-cookie' (which see).
+ − 339 If FILE is being visited in a buffer, the contents of the buffer
+ − 340 are used."
+ − 341 (let ((outbuf (current-buffer))
+ − 342 (autoloads-done '())
+ − 343 (load-name (replace-in-string (file-name-nondirectory file)
+ − 344 "\\.c?$"
+ − 345 ""))
+ − 346 (trim-name (autoload-trim-file-name file))
+ − 347 (print-length nil)
+ − 348 (print-readably t)
+ − 349 (float-output-format nil)
+ − 350 ;; (done-any nil)
+ − 351 (visited (get-file-buffer file))
+ − 352 output-end)
+ − 353
+ − 354 ;; If the autoload section we create here uses an absolute
+ − 355 ;; pathname for FILE in its header, and then Emacs is installed
+ − 356 ;; under a different path on another system,
+ − 357 ;; `update-autoloads-here' won't be able to find the files to be
+ − 358 ;; autoloaded. So, if FILE is in the same directory or a
+ − 359 ;; subdirectory of the current buffer's directory, we'll make it
+ − 360 ;; relative to the current buffer's directory.
+ − 361 (setq file (expand-file-name file))
+ − 362
+ − 363 (save-excursion
+ − 364 (unwind-protect
+ − 365 (progn
+ − 366 (let ((find-file-hooks nil)
+ − 367 (enable-local-variables nil))
+ − 368 (set-buffer (or visited (find-file-noselect file t t)))
+ − 369 ;; This doesn't look right, but it is. The only place we need
+ − 370 ;; the syntax table is when snarfing the Lisp function name.
+ − 371 (set-syntax-table emacs-lisp-mode-syntax-table))
+ − 372 (save-excursion
+ − 373 (save-restriction
+ − 374 (widen)
+ − 375 (goto-char (point-min))
+ − 376 ;; Is there a module name comment?
+ − 377 (when (search-forward generate-c-autoload-module nil t)
+ − 378 (skip-chars-forward " \t")
+ − 379 (let ((begin (point)))
+ − 380 (skip-chars-forward "^ \t\n\f")
+ − 381 (setq load-name (buffer-substring begin (point)))))
+ − 382 (if funlist
+ − 383 (progn
+ − 384 (message "Generating autoloads for %s..." trim-name)
+ − 385 (dolist (arg funlist)
+ − 386 (goto-char (point-min))
+ − 387 (re-search-forward
+ − 388 (concat "DEFUN (\""
+ − 389 (regexp-quote (symbol-name arg))
+ − 390 "\""))
+ − 391 (goto-char (match-beginning 0))
+ − 392 (let ((autoload (make-c-autoload load-name)))
+ − 393 (when autoload
+ − 394 (push (nth 1 (nth 1 autoload)) autoloads-done)
+ − 395 (print-autoload autoload 3 outbuf)))))
+ − 396 (goto-char (point-min))
+ − 397 (let ((match
+ − 398 (search-forward generate-c-autoload-cookie nil t)))
+ − 399 (unless match
+ − 400 (message "No autoloads found in %s" trim-name)
+ − 401 (return-from generate-c-file-autoloads-1))
+ − 402
+ − 403 (message "Generating autoloads for %s..." trim-name)
+ − 404 (while match
+ − 405 (forward-line 1)
+ − 406 (let ((autoload (make-c-autoload load-name)))
+ − 407 (when autoload
+ − 408 (push (nth 1 (nth 1 autoload)) autoloads-done)
+ − 409 (print-autoload autoload 3 outbuf)))
+ − 410 (setq match
+ − 411 (search-forward generate-c-autoload-cookie nil t))
+ − 412 ))))))
+ − 413 (unless visited
+ − 414 ;; We created this buffer, so we should kill it.
+ − 415 (kill-buffer (current-buffer)))
+ − 416 (set-buffer outbuf)
+ − 417 (setq output-end (point-marker))))
+ − 418 (insert generate-autoload-section-header)
+ − 419 (prin1 (list 'autoloads autoloads-done load-name trim-name) outbuf)
+ − 420 (terpri outbuf)
+ − 421 (when (< output-end (point))
+ − 422 (setq output-end (point-marker)))
+ − 423 (goto-char output-end)
+ − 424 (insert generate-autoload-section-trailer)
+ − 425 (or noninteractive ; XEmacs: only need one line in -batch mode.
+ − 426 (message "Generating autoloads for %s...done" trim-name))))
+ − 427
+ − 428 (defun print-autoload (autoload doc-string-elt outbuf)
+ − 429 "Print an autoload form, handling special characters.
+ − 430 In particular, print docstrings with escapes inserted before left parentheses
+ − 431 at the beginning of lines and ^L characters."
+ − 432 (if (and doc-string-elt (stringp (nth doc-string-elt autoload)))
+ − 433 ;; We need to hack the printing because the doc-string must be
+ − 434 ;; printed specially for make-docfile (sigh).
+ − 435 (let* ((p (nthcdr (1- doc-string-elt) autoload))
+ − 436 (elt (cdr p)))
+ − 437 (setcdr p nil)
+ − 438 (princ "\n(" outbuf)
+ − 439 ;; XEmacs change: don't let ^^L's get into
+ − 440 ;; the file or sorting is hard.
+ − 441 (let ((print-escape-newlines t)
+ − 442 (p (save-excursion
+ − 443 (set-buffer outbuf)
+ − 444 (point)))
+ − 445 p2)
+ − 446 (mapcar #'(lambda (elt)
+ − 447 (prin1 elt outbuf)
+ − 448 (princ " " outbuf))
+ − 449 autoload)
+ − 450 (save-excursion
+ − 451 (set-buffer outbuf)
+ − 452 (setq p2 (point-marker))
+ − 453 (goto-char p)
+ − 454 (save-match-data
+ − 455 (while (search-forward "\^L" p2 t)
+ − 456 (delete-char -1)
+ − 457 (insert "\\^L")))
+ − 458 (goto-char p2)))
+ − 459 (princ "\"\\\n" outbuf)
+ − 460 (let ((begin (save-excursion
+ − 461 (set-buffer outbuf)
+ − 462 (point))))
+ − 463 (princ (substring (prin1-to-string (car elt)) 1) outbuf)
+ − 464 ;; Insert a backslash before each ( that appears at the beginning
+ − 465 ;; of a line in the doc string.
+ − 466 (save-excursion
+ − 467 (set-buffer outbuf)
+ − 468 (save-excursion
+ − 469 (while (search-backward "\n(" begin t)
+ − 470 (forward-char 1)
+ − 471 (insert "\\"))))
+ − 472 (if (null (cdr elt))
+ − 473 (princ ")" outbuf)
+ − 474 (princ " " outbuf)
+ − 475 (princ (substring (prin1-to-string (cdr elt)) 1) outbuf))
+ − 476 (terpri outbuf)))
+ − 477 ;; XEmacs change: another ^L hack
+ − 478 (let ((p (save-excursion
+ − 479 (set-buffer outbuf)
+ − 480 (point)))
+ − 481 (print-escape-newlines t)
+ − 482 p2)
+ − 483 (print autoload outbuf)
+ − 484 (save-excursion
+ − 485 (set-buffer outbuf)
+ − 486 (setq p2 (point-marker))
+ − 487 (goto-char p)
+ − 488 (save-match-data
+ − 489 (while (search-forward "\^L" p2 t)
+ − 490 (delete-char -1)
+ − 491 (insert "\\^L")))
+ − 492 (goto-char p2)))))
+ − 493
428
+ − 494
+ − 495 (defconst autoload-file-name "auto-autoloads.el"
+ − 496 "Generic filename to put autoloads into.
+ − 497 Unless you are an XEmacs maintainer, it is probably unwise to change this.")
+ − 498
442
+ − 499 (defvar autoload-target-directory "../lisp/"
428
+ − 500 "Directory to put autoload declaration file into.
+ − 501 Unless you know what you're doing, don't mess with this.")
+ − 502
+ − 503 (defvar generated-autoload-file
+ − 504 (expand-file-name (concat autoload-target-directory
+ − 505 autoload-file-name)
+ − 506 data-directory)
+ − 507 "*File `update-file-autoloads' puts autoloads into.
+ − 508 A .el file can set this in its local variables section to make its
442
+ − 509 autoloads go somewhere else.
+ − 510
+ − 511 Note that `batch-update-directory' binds this variable to its own value,
+ − 512 generally the file named `autoload-file-name' in the directory being
+ − 513 updated.")
428
+ − 514
+ − 515 (defconst cusload-file-name "custom-load.el"
442
+ − 516 "Generic filename to put custom loads into.
+ − 517 Unless you are an XEmacs maintainer, it is probably unwise to change this.")
428
+ − 518
+ − 519 ;;;###autoload
+ − 520 (defun update-file-autoloads (file)
+ − 521 "Update the autoloads for FILE in `generated-autoload-file'
+ − 522 \(which FILE might bind in its local variables).
438
+ − 523 This function refuses to update autoloads files."
428
+ − 524 (interactive "fUpdate autoloads for file: ")
+ − 525 (setq file (expand-file-name file))
+ − 526 (when (and (file-newer-than-file-p file generated-autoload-file)
+ − 527 (not (member (file-name-nondirectory file)
+ − 528 (list autoload-file-name))))
+ − 529
+ − 530 (let ((load-name (replace-in-string (file-name-nondirectory file)
996
+ − 531 "\\.\\(elc?\\|c\\)$"
428
+ − 532 ""))
+ − 533 (trim-name (autoload-trim-file-name file))
+ − 534 section-begin form)
+ − 535 (save-excursion
+ − 536 (let ((find-file-hooks nil))
+ − 537 (set-buffer (or (get-file-buffer generated-autoload-file)
+ − 538 (find-file-noselect generated-autoload-file))))
+ − 539 ;; Make sure we can scribble in it.
+ − 540 (setq buffer-read-only nil)
+ − 541 ;; First delete all sections for this file.
+ − 542 (goto-char (point-min))
+ − 543 (while (search-forward generate-autoload-section-header nil t)
+ − 544 (setq section-begin (match-beginning 0))
+ − 545 (setq form (read (current-buffer)))
+ − 546 (when (string= (nth 2 form) load-name)
+ − 547 (search-forward generate-autoload-section-trailer)
+ − 548 (delete-region section-begin (point))))
+ − 549
+ − 550 ;; Now find insertion point for new section
+ − 551 (block find-insertion-point
+ − 552 (goto-char (point-min))
+ − 553 (while (search-forward generate-autoload-section-header nil t)
+ − 554 (setq form (read (current-buffer)))
+ − 555 (when (string< trim-name (nth 3 form))
+ − 556 ;; Found alphabetically correct insertion point
+ − 557 (goto-char (match-beginning 0))
+ − 558 (return-from find-insertion-point))
+ − 559 (search-forward generate-autoload-section-trailer))
+ − 560 (when (eq (point) (point-min)) ; No existing entries?
+ − 561 (goto-char (point-max)))) ; Append.
+ − 562
+ − 563 ;; Add in new sections for file
+ − 564 (generate-file-autoloads file))
+ − 565
+ − 566 (when (interactive-p) (save-buffer)))))
+ − 567
+ − 568 ;;;###autoload
+ − 569 (defun update-autoloads-here ()
+ − 570 "Update sections of the current buffer generated by `update-file-autoloads'."
+ − 571 (interactive)
+ − 572 (let ((generated-autoload-file (buffer-file-name)))
+ − 573 (save-excursion
+ − 574 (goto-char (point-min))
+ − 575 (while (search-forward generate-autoload-section-header nil t)
+ − 576 (let* ((form (condition-case ()
+ − 577 (read (current-buffer))
+ − 578 (end-of-file nil)))
+ − 579 (file (nth 3 form)))
+ − 580 ;; XEmacs change: if we can't find the file as specified, look
+ − 581 ;; around a bit more.
+ − 582 (cond ((and (stringp file)
+ − 583 (or (get-file-buffer file)
+ − 584 (file-exists-p file))))
+ − 585 ((and (stringp file)
+ − 586 (save-match-data
+ − 587 (let ((loc (locate-file (file-name-nondirectory file)
+ − 588 load-path)))
+ − 589 (if (null loc)
+ − 590 nil
+ − 591 (setq loc (expand-file-name
+ − 592 (autoload-trim-file-name loc)
+ − 593 ".."))
+ − 594 (if (or (get-file-buffer loc)
+ − 595 (file-exists-p loc))
+ − 596 (setq file loc)
+ − 597 nil))))))
+ − 598 (t
+ − 599 (setq file
+ − 600 (if (y-or-n-p
+ − 601 (format
+ − 602 "Can't find library `%s'; remove its autoloads? "
+ − 603 (nth 2 form) file))
+ − 604 t
+ − 605 (condition-case ()
+ − 606 (read-file-name
+ − 607 (format "Find `%s' load file: "
+ − 608 (nth 2 form))
+ − 609 nil nil t)
+ − 610 (quit nil))))))
+ − 611 (if file
+ − 612 (let ((begin (match-beginning 0)))
+ − 613 (search-forward generate-autoload-section-trailer)
+ − 614 (delete-region begin (point))))
+ − 615 (if (stringp file)
+ − 616 (generate-file-autoloads file)))))))
+ − 617
+ − 618 ;;;###autoload
+ − 619 (defun update-autoloads-from-directory (dir)
+ − 620 "Update `generated-autoload-file' with all the current autoloads from DIR.
996
+ − 621 This runs `update-file-autoloads' on each .el and .c file in DIR.
442
+ − 622 Obsolete autoload entries for files that no longer exist are deleted.
+ − 623 Note that, if this function is called from `batch-update-directory',
528
+ − 624 `generated-autoload-file' was rebound in that function.
+ − 625
+ − 626 You don't really want to be calling this function. Try using
+ − 627 `update-autoload-files' instead."
428
+ − 628 (interactive "DUpdate autoloads for directory: ")
+ − 629 (setq dir (expand-file-name dir))
+ − 630 (let ((simple-dir (file-name-as-directory
+ − 631 (file-name-nondirectory
+ − 632 (directory-file-name dir))))
+ − 633 (enable-local-eval nil))
+ − 634 (save-excursion
+ − 635 (let ((find-file-hooks nil))
+ − 636 (set-buffer (find-file-noselect generated-autoload-file)))
+ − 637 (goto-char (point-min))
+ − 638 (while (search-forward generate-autoload-section-header nil t)
+ − 639 (let* ((begin (match-beginning 0))
+ − 640 (form (condition-case ()
+ − 641 (read (current-buffer))
+ − 642 (end-of-file nil)))
+ − 643 (file (nth 3 form)))
+ − 644 (when (and (stringp file)
+ − 645 (string= (file-name-directory file) simple-dir)
+ − 646 (not (file-exists-p
+ − 647 (expand-file-name
+ − 648 (file-name-nondirectory file) dir))))
+ − 649 ;; Remove the obsolete section.
+ − 650 (search-forward generate-autoload-section-trailer)
+ − 651 (delete-region begin (point)))))
+ − 652 ;; Update or create autoload sections for existing files.
996
+ − 653 (mapcar 'update-file-autoloads
+ − 654 (directory-files dir t "^[^=].*\\.\\(el\\|c\\)$"))
428
+ − 655 (unless noninteractive
+ − 656 (save-buffer)))))
+ − 657
+ − 658 (defun fixup-autoload-buffer (sym)
+ − 659 (save-excursion
+ − 660 (set-buffer (find-file-noselect generated-autoload-file))
+ − 661 (goto-char (point-min))
+ − 662 (if (and (not (= (point-min) (point-max)))
+ − 663 (not (looking-at ";;; DO NOT MODIFY THIS FILE")))
+ − 664 (progn
+ − 665 (insert ";;; DO NOT MODIFY THIS FILE\n")
+ − 666 (insert "(if (featurep '" sym ")")
+ − 667 (insert " (error \"Already loaded\"))\n")
+ − 668 (goto-char (point-max))
+ − 669 (insert "\n(provide '" sym ")\n")))))
+ − 670
+ − 671 (defvar autoload-package-name nil)
+ − 672
528
+ − 673 ;;;###autoload
+ − 674 (defun update-autoload-files (files-or-dirs &optional all-into-one-file force)
+ − 675 "Update all the autoload files associated with FILES-OR-DIRS.
+ − 676 FILES-OR-DIRS should be a list of files or directories to be
+ − 677 processed. If ALL-INTO-ONE-FILE is not given, the appropriate
+ − 678 autoload file for each file or directory (located in that directory,
+ − 679 or in the directory of the specified file) will be updated with the
+ − 680 directory's or file's autoloads, some additional fixup text will be
+ − 681 added, and the files will be saved. If ALL-INTO-ONE-FILE is given,
+ − 682 `generated-autoload-file' should be set to the name of the autoload
+ − 683 file into which the autoloads will be generated, and the autoloads
+ − 684 for all files and directories will go into that same file.
+ − 685
+ − 686 If FORCE is non-nil, always save out the autoload files even if unchanged."
645
+ − 687 (let ((defdir (directory-file-name default-directory))
528
+ − 688 (enable-local-eval nil)) ; Don't query in batch mode.
+ − 689 ;; (message "Updating autoloads in %s..." generated-autoload-file)
+ − 690 (dolist (arg files-or-dirs)
+ − 691 (setq arg (expand-file-name arg defdir))
+ − 692 (let ((generated-autoload-file
+ − 693 (if all-into-one-file generated-autoload-file
+ − 694 (expand-file-name autoload-file-name
+ − 695 (if (file-directory-p arg) arg
+ − 696 (file-name-directory arg))))))
+ − 697 (cond
+ − 698 ((file-directory-p arg)
+ − 699 (message "Updating autoloads for directory %s..." arg)
+ − 700 (update-autoloads-from-directory arg))
+ − 701 ((file-exists-p arg)
+ − 702 (update-file-autoloads arg))
+ − 703 (t (error "No such file or directory: %s" arg)))
+ − 704 (when (not all-into-one-file)
+ − 705 (fixup-autoload-buffer (concat (if autoload-package-name
+ − 706 autoload-package-name
+ − 707 (file-name-nondirectory defdir))
+ − 708 "-autoloads"))
+ − 709 (if force (set-buffer-modified-p
+ − 710 t (find-file-noselect generated-autoload-file))))))
+ − 711 (when all-into-one-file
+ − 712 (fixup-autoload-buffer (concat (if autoload-package-name
+ − 713 autoload-package-name
+ − 714 (file-name-nondirectory defdir))
+ − 715 "-autoloads"))
+ − 716 (if force (set-buffer-modified-p
+ − 717 t (find-file-noselect generated-autoload-file))))
+ − 718 (save-some-buffers t)
+ − 719 ;; (message "Done")
+ − 720 ))
+ − 721
+ − 722 ;; #### these entry points below are a big mess, especially the
+ − 723 ;; first two. there don't seem to be very many packages that use the
+ − 724 ;; first one (the "all-into-one-file" variety), and do they actually
+ − 725 ;; rely on this functionality? --ben
+ − 726
+ − 727 ;;;###autoload
+ − 728 (defun batch-update-autoloads ()
+ − 729 "Update the autoloads for the files or directories on the command line.
+ − 730 Runs `update-file-autoloads' on files and `update-directory-autoloads'
+ − 731 on directories. Must be used only with -batch, and kills Emacs on completion.
+ − 732 Each file will be processed even if an error occurred previously.
+ − 733 For example, invoke `xemacs -batch -f batch-update-autoloads *.el'.
+ − 734 The directory to which the auto-autoloads.el file must be the first parameter
+ − 735 on the command line."
+ − 736 (unless noninteractive
+ − 737 (error "batch-update-autoloads is to be used only with -batch"))
+ − 738 (update-autoload-files command-line-args-left t)
+ − 739 (kill-emacs 0))
442
+ − 740
428
+ − 741 ;;;###autoload
+ − 742 (defun batch-update-directory ()
442
+ − 743 "Update the autoloads for the directories on the command line.
+ − 744 Runs `update-file-autoloads' on each file in the given directory, and must
+ − 745 be used only with -batch."
428
+ − 746 (unless noninteractive
+ − 747 (error "batch-update-directory is to be used only with -batch"))
528
+ − 748 (update-autoload-files command-line-args-left)
+ − 749 ;; (kill-emacs 0)
+ − 750 (setq command-line-args-left nil))
442
+ − 751
+ − 752 ;;;###autoload
+ − 753 (defun batch-update-one-directory ()
+ − 754 "Update the autoloads for a single directory on the command line.
+ − 755 Runs `update-file-autoloads' on each file in the given directory, and must
+ − 756 be used only with -batch."
+ − 757 (unless noninteractive
+ − 758 (error "batch-update-directory is to be used only with -batch"))
528
+ − 759 (let ((arg (car command-line-args-left)))
+ − 760 (setq command-line-args-left (cdr command-line-args-left))
+ − 761 (update-autoload-files (list arg))))
+ − 762
+ − 763 ;;;###autoload
+ − 764 (defun batch-force-update-one-directory ()
+ − 765 "Update the autoloads for a single directory on the command line.
+ − 766 Runs `update-file-autoloads' on each file in the given directory, and must
+ − 767 be used only with -batch. Always rewrite the autoloads file, even if
+ − 768 unchanged."
+ − 769 (unless noninteractive
+ − 770 (error "batch-update-directory is to be used only with -batch"))
+ − 771 (let ((arg (car command-line-args-left)))
+ − 772 (setq command-line-args-left (cdr command-line-args-left))
546
+ − 773 (update-autoload-files (list arg) nil t)))
442
+ − 774
428
+ − 775 (provide 'autoload)
+ − 776
+ − 777 ;;; autoload.el ends here
