1 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers
3 ;; Copyright (C) 1992, 1994, 1997, 2000 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Maintainer: Eric S. Raymond <esr@snark.thyrsus.com>
7 ;; Created: 14 Jul 1992
9 ;; X-Bogus-Bureaucratic-Cruft: Gruad will get you if you don't watch out!
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to
25 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; This minor mode adds some services to Emacs-Lisp editing mode.
32 ;; First, it knows about the header conventions for library packages.
33 ;; One entry point supports generating synopses from a library directory.
34 ;; Another can be used to check for missing headers in library files.
36 ;; Another entry point automatically addresses bug mail to a package's
37 ;; maintainer or author.
39 ;; This file can be loaded by your lisp-mode-hook. Have it (require 'lisp-mnt)
41 ;; This file is an example of the header conventions. Note the following
44 ;; * Header line --- makes it possible to extract a one-line summary of
45 ;; the package's uses automatically for use in library synopses, KWIC
46 ;; indexes and the like.
48 ;; Format is three semicolons, followed by the filename, followed by
49 ;; three dashes, followed by the summary. All fields space-separated.
51 ;; * Author line --- contains the name and net address of at least
52 ;; the principal author.
54 ;; If there are multiple authors, they should be listed on continuation
55 ;; lines led by ;;<TAB>, like this:
57 ;; ;; Author: Ashwin Ram <Ram-Ashwin@cs.yale.edu>
58 ;; ;; Dave Sill <de5@ornl.gov>
59 ;; ;; David Lawrence <tale@pawl.rpi.edu>
60 ;; ;; Noah Friedman <friedman@ai.mit.edu>
61 ;; ;; Joe Wells <jbw@maverick.uswest.com>
62 ;; ;; Dave Brennan <brennan@hal.com>
63 ;; ;; Eric Raymond <esr@snark.thyrsus.com>
65 ;; This field may have some special values; notably "FSF", meaning
66 ;; "Free Software Foundation".
68 ;; * Maintainer line --- should be a single name/address as in the Author
69 ;; line, or an address only, or the string "FSF". If there is no maintainer
70 ;; line, the person(s) in the Author field are presumed to be it. The example
71 ;; in this file is mildly bogus because the maintainer line is redundant.
72 ;; The idea behind these two fields is to be able to write a Lisp function
73 ;; that does "send mail to the author" without having to mine the name out by
74 ;; hand. Please be careful about surrounding the network address with <> if
75 ;; there's also a name in the field.
77 ;; * Created line --- optional, gives the original creation date of the
78 ;; file. For historical interest, basically.
80 ;; * Version line --- intended to give the reader a clue if they're looking
81 ;; at a different version of the file than the one they're accustomed to. This
82 ;; may be an RCS or SCCS header.
84 ;; * Adapted-By line --- this is for FSF's internal use. The person named
85 ;; in this field was the one responsible for installing and adapting the
86 ;; package for the distribution. (This file doesn't have one because the
87 ;; author *is* one of the maintainers.)
89 ;; * Keywords line --- used by the finder code (now under construction)
90 ;; for finding Emacs Lisp code related to a topic.
92 ;; * X-Bogus-Bureaucratic-Cruft line --- this is a joke and an example
93 ;; of a comment header. Headers starting with `X-' should never be used
94 ;; for any real purpose; this is the way to safely add random headers
95 ;; without invoking the wrath of any program.
97 ;; * Commentary line --- enables Lisp code to find the developer's and
98 ;; maintainers' explanations of the package internals.
100 ;; * Change log line --- optional, exists to terminate the commentary
101 ;; section and start a change-log part, if one exists.
103 ;; * Code line --- exists so Lisp can know where commentary and/or
104 ;; change-log sections end.
106 ;; * Footer line --- marks end-of-file so it can be distinguished from
107 ;; an expanded formfeed or the results of truncation.
111 ;; Tue Jul 14 23:44:17 1992 ESR
118 (defgroup lisp-mnt nil
119 "Minor mode for Emacs Lisp maintainers."
123 (defcustom lm-header-prefix
"^;+[ \t]+\\(@(#)\\)?[ \t]*\\$?"
124 "Prefix that is ignored before the tag.
125 For example, you can write the 1st line synopsis string and headers like this
126 in your Lisp package:
128 ;; @(#) package.el -- pacakge description
130 ;; @(#) $Maintainer: Person Foo Bar $
132 The @(#) construct is used by unix what(1) and
133 then $identifier: doc string $ is used by GNU ident(1)"
137 (defcustom lm-comment-column
16
138 "Column used for placing formatted output."
142 (defcustom lm-commentary-header
"Commentary\\|Documentation"
143 "Regexp which matches start of documentation section."
147 (defcustom lm-history-header
"Change Log\\|History"
148 "Regexp which matches the start of code log section."
154 ;; These functions all parse the headers of the current buffer
156 (defun lm-get-header-re (header &optional mode
)
157 "Return regexp for matching HEADER.
158 If called with optional MODE and with value `section',
159 return section regexp instead."
160 (if (eq mode
'section
)
161 (concat "^;;;;* " header
":[ \t]*$")
162 (concat lm-header-prefix header
"[ \t]*:[ \t]*")))
164 (defun lm-get-package-name ()
165 "Return package name by looking at the first line."
167 (goto-char (point-min))
168 (if (and (looking-at (concat lm-header-prefix
))
169 (progn (goto-char (match-end 0))
170 (looking-at "\\([^\t ]+\\)")
172 (match-string-no-properties 1))))
174 (defun lm-section-mark (header &optional after
)
175 "Return the buffer location of a given section start marker.
176 The HEADER is the section mark string to search for.
177 If AFTER is non-nil, return the location of the next line."
179 (let ((case-fold-search t
))
180 (goto-char (point-min))
181 (if (re-search-forward (lm-get-header-re header
'section
) nil t
)
184 (if after
(forward-line 1))
187 (defsubst lm-code-mark
()
188 "Return the buffer location of the `Code' start marker."
189 (lm-section-mark "Code"))
191 (defsubst lm-commentary-mark
()
192 "Return the buffer location of the `Commentary' start marker."
193 (lm-section-mark lm-commentary-header
))
195 (defsubst lm-history-mark
()
196 "Return the buffer location of the `History' start marker."
197 (lm-section-mark lm-history-header
))
199 (defun lm-header (header)
200 "Return the contents of the header named HEADER."
201 (goto-char (point-min))
202 (let ((case-fold-search t
))
203 (when (and (re-search-forward (lm-get-header-re header
) (lm-code-mark) t
)
204 ;; RCS ident likes format "$identifier: data$"
207 (skip-chars-backward "^$" (match-beginning 0))
208 (= (point) (match-beginning 0)))
209 "[^\n]+" "[^$\n]+")))
210 (match-string-no-properties 0))))
212 (defun lm-header-multiline (header)
213 "Return the contents of the header named HEADER, with continuation lines.
214 The returned value is a list of strings, one per line."
216 (goto-char (point-min))
217 (let ((res (lm-header header
)))
219 (setq res
(list res
))
221 (while (and (or (looking-at (concat lm-header-prefix
"[\t ]+"))
222 (and (not (looking-at
223 (lm-get-header-re "\\sw\\(\\sw\\|\\s_\\)*")))
224 (looking-at lm-header-prefix
)))
225 (goto-char (match-end 0))
227 (setq res
(cons (match-string-no-properties 0) res
))
231 ;; These give us smart access to the header fields and commentary
233 (defmacro lm-with-file
(file &rest body
)
234 (let ((filesym (make-symbol "file")))
236 (let ((,filesym
,file
))
237 (if ,filesym
(set-buffer (find-file-noselect ,filesym
)))
238 (prog1 (progn ,@body
)
239 (if (and ,filesym
(not (get-buffer-window (current-buffer) t
)))
240 (kill-buffer (current-buffer))))))))
241 (put 'lm-with-file
'lisp-indent-function
1)
242 (put 'lm-with-file
'edebug-form-spec t
)
244 (defun lm-summary (&optional file
)
245 "Return the one-line summary of file FILE, or current buffer if FILE is nil."
247 (goto-char (point-min))
248 (if (and (looking-at lm-header-prefix
)
249 (progn (goto-char (match-end 0))
250 (looking-at "[^ ]+[ \t]+--+[ \t]+\\(.*\\)")))
251 (let ((summary (match-string-no-properties 1)))
252 ;; Strip off -*- specifications.
253 (if (string-match "[ \t]*-\\*-.*-\\*-" summary
)
254 (substring summary
0 (match-beginning 0))
257 (defun lm-crack-address (x)
258 "Split up an email address X into full name and real email address.
259 The value is a cons of the form (FULLNAME . ADDRESS)."
260 (cond ((string-match "\\(.+\\) [(<]\\(\\S-+@\\S-+\\)[>)]" x
)
261 (cons (match-string 1 x
)
263 ((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x
)
264 (cons (match-string 2 x
)
266 ((string-match "\\S-+@\\S-+" x
)
271 (defun lm-authors (&optional file
)
272 "Return the author list of file FILE, or current buffer if FILE is nil.
273 Each element of the list is a cons; the car is the full name,
274 the cdr is an email address."
276 (let ((authorlist (lm-header-multiline "author")))
277 (mapcar 'lm-crack-address authorlist
))))
279 (defun lm-maintainer (&optional file
)
280 "Return the maintainer of file FILE, or current buffer if FILE is nil.
281 The return value has the form (NAME . ADDRESS)."
283 (let ((maint (lm-header "maintainer")))
285 (lm-crack-address maint
)
286 (car (lm-authors))))))
288 (defun lm-creation-date (&optional file
)
289 "Return the created date given in file FILE, or current buffer if FILE is nil."
291 (lm-header "created")))
293 (defun lm-last-modified-date (&optional file iso-date
)
294 "Return the modify-date given in file FILE, or current buffer if FILE is nil.
295 ISO-DATE non-nil means return the date in ISO 8601 format."
297 (when (progn (goto-char (point-min))
299 "\\$[I]d: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) "
301 (let ((dd (match-string 3))
302 (mm (match-string 2))
303 (yyyy (match-string 1)))
305 (format "%s-%s-%s" yyyy mm dd
)
308 (nth (string-to-int mm
)
309 '("" "Jan" "Feb" "Mar" "Apr" "May" "Jun"
310 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec"))
313 (defun lm-version (&optional file
)
314 "Return the version listed in file FILE, or current buffer if FILE is nil.
315 This can be found in an RCS or SCCS header."
317 (or (lm-header "version")
318 (let ((header-max (lm-code-mark)))
319 (goto-char (point-min))
321 ;; Look for an RCS header
322 ((re-search-forward "\\$[I]d: [^ ]+ \\([^ ]+\\) " header-max t
)
323 (match-string-no-properties 1))
324 ((re-search-forward "\\$Revision: +\\([^ ]+\\) " header-max t
)
325 (match-string-no-properties 1))
326 ;; Look for an SCCS header
329 (regexp-quote "@(#)")
330 (regexp-quote (file-name-nondirectory (buffer-file-name)))
331 "\t\\([012345679.]*\\)")
333 (match-string-no-properties 1)))))))
335 (defun lm-keywords (&optional file
)
336 "Return the keywords given in file FILE, or current buffer if FILE is nil."
338 (let ((keywords (lm-header "keywords")))
339 (and keywords
(downcase keywords
)))))
341 (defun lm-adapted-by (&optional file
)
342 "Return the adapted-by names in file FILE, or current buffer if FILE is nil.
343 This is the name of the person who cleaned up this package for
346 (lm-header "adapted-by")))
348 (defun lm-commentary (&optional file
)
349 "Return the commentary in file FILE, or current buffer if FILE is nil.
350 The value is returned as a string. In the file, the commentary starts
351 with the tag `Commentary' or `Documentation' and ends with one of the
352 tags `Code', `Change Log' or `History'."
354 (let ((commentary (lm-commentary-mark))
355 (change-log (lm-history-mark))
356 (code (lm-code-mark)))
358 ((and commentary change-log
)
359 (buffer-substring-no-properties commentary change-log
))
360 ((and commentary code
)
361 (buffer-substring-no-properties commentary code
))))))
363 ;;; Verification and synopses
365 (defun lm-insert-at-column (col &rest strings
)
366 "Insert, at column COL, list of STRINGS."
367 (if (> (current-column) col
) (insert "\n"))
368 (move-to-column col t
)
369 (apply 'insert strings
))
371 (defun lm-verify (&optional file showok verb
)
372 "Check that the current buffer (or FILE if given) is in proper format.
373 If FILE is a directory, recurse on its files and generate a report in
376 (let* ((verb (or verb
(interactive-p)))
377 (ret (and verb
"Ok."))
379 (if (and file
(file-directory-p file
))
384 (if (string-match ".*\\.el\\'" f
)
385 (let ((status (lm-verify f
)))
388 (lm-insert-at-column lm-comment-column status
391 (lm-insert-at-column lm-comment-column
393 (directory-files file
))))
395 (setq name
(lm-get-package-name))
399 "Can't find a package NAME")
401 "Author: tag missing.")
402 ((not (lm-maintainer))
403 "Maintainer: tag missing.")
405 "Can't find a one-line 'Summary' description")
407 "Keywords: tag missing.")
408 ((not (lm-commentary-mark))
409 "Can't find a 'Commentary' section marker.")
410 ((not (lm-history-mark))
411 "Can't find a 'History' section marker.")
412 ((not (lm-code-mark))
413 "Can't find a 'Code' section marker")
415 (goto-char (point-max))
418 (concat "^;;;[ \t]+" name
"[ \t]+ends here[ \t]*$"
419 "\\|^;;;[ \t]+ End of file[ \t]+" name
)
421 (format "Can't find a footer line for [%s]" name
))
428 (defun lm-synopsis (&optional file showall
)
429 "Generate a synopsis listing for the buffer or the given FILE if given.
430 If FILE is a directory, recurse on its files and generate a report in
431 a temporary buffer. If SHOWALL is non-nil, also generate a line for files
432 which do not include a recognizable synopsis."
435 (read-file-name "Synopsis for (file or dir): ")))
437 (if (and file
(file-directory-p file
))
441 (if (string-match "\\.el\\'" f
)
442 (let ((syn (lm-synopsis f
)))
446 (lm-insert-at-column lm-comment-column syn
"\n"))
449 (lm-insert-at-column lm-comment-column
"NA\n"))))))
450 (directory-files file
)))
457 (kill-buffer (current-buffer)))))))
459 (eval-when-compile (defvar report-emacs-bug-address
))
461 (defun lm-report-bug (topic)
462 "Report a bug in the package currently being visited to its maintainer.
463 Prompts for bug subject TOPIC. Leaves you in a mail buffer."
464 (interactive "sBug Subject: ")
466 (let ((package (lm-get-package-name))
467 (addr (lm-maintainer))
468 (version (lm-version)))
469 (compose-mail (if addr
470 (concat (car addr
) " <" (cdr addr
) ">")
471 report-emacs-bug-address
)
473 (goto-char (point-max))
474 (insert "\nIn " package
)
476 (insert " version " version
))
479 (substitute-command-keys "Type \\[mail-send] to send bug report."))))
483 ;;; lisp-mnt.el ends here