1 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers
3 ;; Copyright (C) 1992, 1994 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
8 ;; Version: $Id: lisp-mnt.el,v 1.9 1994/06/17 19:59:09 rms Exp rms $
10 ;; X-Bogus-Bureaucratic-Cruft: Gruad will get you if you don't watch out!
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 1, or (at your option)
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to
26 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, 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
116 (require 'picture) ; provides move-to-column-force
119 ;; These functions all parse the headers of the current buffer
121 (defun lm-section-mark (hd &optional after)
122 ;; Return the buffer location of a given section start marker
124 (let ((case-fold-search t))
125 (goto-char (point-min))
126 (if (re-search-forward (concat "^;;;;* " hd ":[ \t]*$") nil t)
129 (if after (forward-line 1))
133 (defun lm-code-mark ()
134 ;; Return the buffer location of the code start marker
135 (lm-section-mark "Code"))
137 (defun lm-header (hd)
138 ;; Return the contents of a named header
139 (goto-char (point-min))
140 (let ((case-fold-search t))
141 (if (re-search-forward
142 (concat "^;; " hd ": \\(.*\\)") (lm-code-mark) t)
143 (buffer-substring (match-beginning 1) (match-end 1))
146 (defun lm-header-multiline (hd)
147 ;; Return the contents of a named header, with possible continuation lines.
148 ;; Note -- the returned value is a list of strings, one per line.
150 (goto-char (point-min))
151 (let ((res (save-excursion (lm-header hd))))
155 (setq res (list res))
156 (while (looking-at "^;;\t\\(.*\\)")
157 (setq res (cons (buffer-substring
165 ;; These give us smart access to the header fields and commentary
167 (defun lm-summary (&optional file)
168 ;; Return the buffer's or FILE's one-line summary.
172 (goto-char (point-min))
174 (if (looking-at "^;;; [^ ]+ --- \\(.*\\)")
175 (buffer-substring (match-beginning 1) (match-end 1)))
177 (kill-buffer (current-buffer)))
181 (defun lm-crack-address (x)
182 ;; Given a string containing a human and email address, parse it
183 ;; into a cons pair (name . address).
184 (cond ((string-match "\\(.+\\) [(<]\\(\\S-+@\\S-+\\)[>)]" x)
185 (cons (substring x (match-beginning 1) (match-end 1))
186 (substring x (match-beginning 2) (match-end 2))))
187 ((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x)
188 (cons (substring x (match-beginning 2) (match-end 2))
189 (substring x (match-beginning 1) (match-end 1))))
190 ((string-match "\\S-+@\\S-+" x)
195 (defun lm-authors (&optional file)
196 ;; Return the buffer's or FILE's author list. Each element of the
197 ;; list is a cons; the car is a name-aming-humans, the cdr an email
202 (let ((authorlist (lm-header-multiline "author")))
204 (mapcar 'lm-crack-address authorlist)
206 (kill-buffer (current-buffer)))
209 (defun lm-maintainer (&optional file)
210 ;; Get a package's bug-report & maintenance address. Parse it out of FILE,
211 ;; or the current buffer if FILE is nil.
212 ;; The return value is a (name . address) cons.
217 (let ((maint (lm-header "maintainer")))
219 (lm-crack-address maint)
222 (kill-buffer (current-buffer)))
225 (defun lm-creation-date (&optional file)
226 ;; Return a package's creation date, if any. Parse it out of FILE,
227 ;; or the current buffer if FILE is nil.
232 (lm-header "created")
234 (kill-buffer (current-buffer)))
238 (defun lm-last-modified-date (&optional file)
239 ;; Return a package's last-modified date, if you can find one.
245 (goto-char (point-min))
247 "\\$Id: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) "
250 (buffer-substring (match-beginning 3) (match-end 3))
252 (buffer-substring (match-beginning 2) (match-end 2)))
253 '("" "Jan" "Feb" "Mar" "Apr" "May" "Jun"
254 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec"))
255 (buffer-substring (match-beginning 1) (match-end 1))
258 (kill-buffer (current-buffer)))
261 (defun lm-version (&optional file)
262 ;; Return the package's version field.
263 ;; If none, look for an RCS or SCCS header to crack it out of.
269 (lm-header "version")
270 (let ((header-max (lm-code-mark)))
271 (goto-char (point-min))
273 ;; Look for an RCS header
274 ((re-search-forward "\\$Id: [^ ]+ \\([^ ]+\\) " header-max t)
275 (buffer-substring (match-beginning 1) (match-end 1)))
277 ;; Look for an SCCS header
280 (regexp-quote "@(#)")
281 (regexp-quote (file-name-nondirectory (buffer-file-name)))
282 "\t\\([012345679.]*\\)")
284 (buffer-substring (match-beginning 1) (match-end 1)))
288 (kill-buffer (current-buffer)))
291 (defun lm-keywords (&optional file)
292 ;; Return the header containing the package's topic keywords.
293 ;; Parse them out of FILE, or the current buffer if FILE is nil.
298 (let ((keywords (lm-header "keywords")))
299 (and keywords (downcase keywords)))
301 (kill-buffer (current-buffer)))
304 (defun lm-adapted-by (&optional file)
305 ;; Return the name or code of the person who cleaned up this package
306 ;; for distribution. Parse it out of FILE, or the current buffer if
312 (lm-header "adapted-by")
314 (kill-buffer (current-buffer)))
317 (defun lm-commentary (&optional file)
318 ;; Return the commentary region of a file, as a string.
323 (let ((commentary (lm-section-mark "Commentary" t))
324 (change-log (lm-section-mark "Change Log"))
325 (code (lm-section-mark "Code")))
328 (buffer-substring commentary change-log)
329 (buffer-substring commentary code)))
332 (kill-buffer (current-buffer)))
335 ;;; Verification and synopses
337 (defun insert-at-column (col &rest pieces)
338 (if (> (current-column) col) (insert "\n"))
339 (move-to-column-force col)
340 (apply 'insert pieces))
342 (defconst lm-comment-column 16)
344 (defun lm-verify (&optional file showok)
345 "Check that the current buffer (or FILE if given) is in proper format.
346 If FILE is a directory, recurse on its files and generate a report into
348 (if (and file (file-directory-p file))
350 (switch-to-buffer (get-buffer-create "*lm-verify*"))
354 (if (string-match ".*\\.el$" f)
355 (let ((status (lm-verify f)))
359 (insert-at-column lm-comment-column status "\n"))
363 (insert-at-column lm-comment-column "OK\n")))))))
364 (directory-files file))
372 "Can't find a package summary")
373 ((not (lm-code-mark))
374 "Can't find a code section marker")
376 (goto-char (point-max))
378 (looking-at (concat ";;; " file "ends here")))
379 "Can't find a footer line")
382 (kill-buffer (current-buffer)))
385 (defun lm-synopsis (&optional file showall)
386 "Generate a synopsis listing for the buffer or the given FILE if given.
387 If FILE is a directory, recurse on its files and generate a report into
388 a temporary buffer. If SHOWALL is on, also generate a line for files
389 which do not include a recognizable synopsis."
390 (if (and file (file-directory-p file))
392 (switch-to-buffer (get-buffer-create "*lm-verify*"))
396 (if (string-match ".*\\.el$" f)
397 (let ((syn (lm-synopsis f)))
401 (insert-at-column lm-comment-column syn "\n"))
405 (insert-at-column lm-comment-column "NA\n")))))))
406 (directory-files file))
414 (kill-buffer (current-buffer)))
417 (defun lm-report-bug (topic)
418 "Report a bug in the package currently being visited to its maintainer.
419 Prompts for bug subject. Leaves you in a mail buffer."
420 (interactive "sBug Subject: ")
421 (let ((package (buffer-name))
422 (addr (lm-maintainer))
423 (version (lm-version)))
426 (concat (car addr) " <" (cdr addr) ">")
429 (goto-char (point-max))
432 (if version (concat " version " version) "")
435 (substitute-command-keys "Type \\[mail-send] to send bug report."))))
439 ;;; lisp-mnt.el ends here