;;; Code:
+(require 'lisp-mode) ;for `doc-string-elt' properties.
+(require 'help-fns) ;for help-add-fundoc-usage.
+
(defvar generated-autoload-file "loaddefs.el"
"*File \\[update-file-autoloads] puts autoloads into.
A `.el' file can set this in its local variables section to make its
((memq car '(defun define-skeleton defmacro define-derived-mode
define-generic-mode easy-mmode-define-minor-mode
easy-mmode-define-global-mode
- define-minor-mode defun*))
- (let* ((macrop (eq car 'defmacro))
+ define-minor-mode defun* defmacro*))
+ (let* ((macrop (memq car '(defmacro defmacro*)))
(name (nth 1 form))
+ (args (if (memq car '(defun defmacro defun* defmacro*))
+ (nth 2 form) t))
(body (nthcdr (get car 'doc-string-elt) form))
(doc (if (stringp (car body)) (pop body))))
+ (when (listp args)
+ ;; Add the usage form at the end where describe-function-1
+ ;; can recover it.
+ (setq doc (help-add-fundoc-usage doc args)))
;; `define-generic-mode' quotes the name, so take care of that
(list 'autoload (if (listp name) name (list 'quote name)) file doc
(or (and (memq car '(define-skeleton define-derived-mode
(eq (car-safe (car body)) 'interactive))
(if macrop (list 'quote 'macro) nil))))
- ;; Convert defcustom to a simpler (and less space-consuming) defvar,
- ;; but add some extra stuff if it uses :require.
+ ;; Convert defcustom to less space-consuming data.
((eq car 'defcustom)
(let ((varname (car-safe (cdr-safe form)))
(init (car-safe (cdr-safe (cdr-safe form))))
(doc (car-safe (cdr-safe (cdr-safe (cdr-safe form)))))
- (rest (cdr-safe (cdr-safe (cdr-safe (cdr-safe form))))))
- (if (not (plist-get rest :require))
- `(defvar ,varname ,init ,doc)
- `(progn
- (defvar ,varname ,init ,doc)
- (custom-add-to-group ,(plist-get rest :group)
- ',varname 'custom-variable)
- (custom-add-load ',varname
- ,(plist-get rest :require))))))
+ ;; (rest (cdr-safe (cdr-safe (cdr-safe (cdr-safe form)))))
+ )
+ `(progn
+ (defvar ,varname ,init ,doc)
+ (custom-autoload ',varname ,file))))
;; nil here indicates that this is not a special autoload form.
(t nil))))
-;;; Forms which have doc-strings which should be printed specially.
-;;; A doc-string-elt property of ELT says that (nth ELT FORM) is
-;;; the doc-string in FORM.
-;;;
-;;; There used to be the following note here:
-;;; ;;; Note: defconst and defvar should NOT be marked in this way.
-;;; ;;; We don't want to produce defconsts and defvars that
-;;; ;;; make-docfile can grok, because then it would grok them twice,
-;;; ;;; once in foo.el (where they are given with ;;;###autoload) and
-;;; ;;; once in loaddefs.el.
-;;;
-;;; Counter-note: Yes, they should be marked in this way.
-;;; make-docfile only processes those files that are loaded into the
-;;; dumped Emacs, and those files should never have anything
-;;; autoloaded here. The above-feared problem only occurs with files
-;;; which have autoloaded entries *and* are processed by make-docfile;
-;;; there should be no such files.
-
-(put 'autoload 'doc-string-elt 3)
-(put 'defun 'doc-string-elt 3)
-(put 'defun* 'doc-string-elt 3)
-(put 'defvar 'doc-string-elt 3)
-(put 'defcustom 'doc-string-elt 3)
-(put 'defconst 'doc-string-elt 3)
-(put 'defmacro 'doc-string-elt 3)
-(put 'defsubst 'doc-string-elt 3)
-(put 'define-skeleton 'doc-string-elt 2)
-(put 'define-derived-mode 'doc-string-elt 4)
-(put 'easy-mmode-define-minor-mode 'doc-string-elt 2)
-(put 'define-minor-mode 'doc-string-elt 2)
-(put 'define-generic-mode 'doc-string-elt 7)
-;; defin-global-mode has no explicit docstring.
-(put 'easy-mmode-define-global-mode 'doc-string-elt 1000)
+;; Forms which have doc-strings which should be printed specially.
+;; A doc-string-elt property of ELT says that (nth ELT FORM) is
+;; the doc-string in FORM.
+;; Those properties are now set in lisp-mode.el.
(defun autoload-trim-file-name (file)
(goto-char (point-min))
(read (current-buffer))))))
-;; !! Requires OUTBUF to be bound !!
+(defvar autoload-print-form-outbuf)
+
(defun autoload-print-form (form)
- "Print FORM such that make-docfile will find the docstrings."
+ "Print FORM such that `make-docfile' will find the docstrings.
+The variable `autoload-print-form-outbuf' specifies the buffer to
+put the output in."
(cond
;; If the form is a sequence, recurse.
((eq (car form) 'progn) (mapcar 'autoload-print-form (cdr form)))
;; Symbols at the toplevel are meaningless.
((symbolp form) nil)
(t
- (let ((doc-string-elt (get (car-safe form) 'doc-string-elt)))
+ (let ((doc-string-elt (get (car-safe form) 'doc-string-elt))
+ (outbuf autoload-print-form-outbuf))
(if (and doc-string-elt (stringp (nth doc-string-elt form)))
;; We need to hack the printing because the
;; doc-string must be printed specially for
(princ "\n(" outbuf)
(let ((print-escape-newlines t)
(print-escape-nonascii t))
- (mapcar (lambda (elt)
- (prin1 elt outbuf)
- (princ " " outbuf))
- form))
+ (dolist (elt form)
+ (prin1 elt outbuf)
+ (princ " " outbuf)))
(princ "\"\\\n" outbuf)
(let ((begin (with-current-buffer outbuf (point))))
(princ (substring (prin1-to-string (car elt)) 1)
;; the doc string.
(with-current-buffer outbuf
(save-excursion
- (while (search-backward "\n(" begin t)
+ (while (re-search-backward "\n[[(]" begin t)
(forward-char 1)
(insert "\\"))))
(if (null (cdr elt))
";; no-update-autoloads: t\n"
";; End:\n"
";;; " (file-name-nondirectory file)
- "ends here\n")
+ " ends here\n")
nil file))
file)
(let ((outbuf (current-buffer))
(autoloads-done '())
(load-name (let ((name (file-name-nondirectory file)))
- (if (string-match "\\.elc?$" name)
+ (if (string-match "\\.elc?\\(\\.\\|$\\)" name)
(substring name 0 (match-beginning 0))
name)))
(print-length nil)
(setq autoloads-done (cons (nth 1 form)
autoloads-done))
(setq autoload form))
- (autoload-print-form autoload))
-
+ (let ((autoload-print-form-outbuf outbuf))
+ (autoload-print-form autoload)))
+
;; Copy the rest of the line to the output.
(princ (buffer-substring
(progn
Return FILE if there was no autoload cookie in it."
(interactive "fUpdate autoloads for file: ")
(let ((load-name (let ((name (file-name-nondirectory file)))
- (if (string-match "\\.elc?$" name)
+ (if (string-match "\\.elc?\\(\\.\\|$\\)" name)
(substring name 0 (match-beginning 0))
name)))
(found nil)
Update loaddefs.el with all the current autoloads from DIRS, and no old ones.
This uses `update-file-autoloads' (which see) do its work."
(interactive "DUpdate autoloads from directory: ")
- (let* ((files (apply 'nconc
+ (let* ((files-re (let ((tmp nil))
+ (dolist (suf load-suffixes
+ (concat "^[^=.].*" (regexp-opt tmp t) "\\'"))
+ (unless (string-match "\\.elc" suf) (push suf tmp)))))
+ (files (apply 'nconc
(mapcar (lambda (dir)
(directory-files (expand-file-name dir)
- ;; FIXME: add .gz etc...
- t "^[^=.].*\\.el\\'"))
+ t files-re))
dirs)))
(this-time (current-time))
(no-autoloads nil) ;files with no autoload cookies.
(append no-autoloads
(delq nil (mapcar 'update-file-autoloads files))))
(when no-autoloads
+ ;; Sort them for better readability.
+ (setq no-autoloads (sort no-autoloads 'string<))
;; Add the `no-autoloads' section.
(goto-char (point-max))
(search-backward "\f" nil t)
HCoop / bpt / emacs.git / blobdiff