1 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers
3 ;; Copyright (C) 1992, 1994, 1997 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
120 (defgroup lisp-mnt nil
121 "Minor mode for Emacs Lisp maintainers."
125 (defcustom lm-header-prefix
"^;;*[ \t]+\\(@\(#\)\\)?[ \t]*\\([\$]\\)?"
126 "Prefix that is ignored before the tag.
127 For example, you can write the 1st line synopsis string and headers like this
128 in your Lisp package:
130 ;; @(#) package.el -- pacakge description
132 ;; @(#) $Maintainer: Person Foo Bar $
134 The @(#) construct is used by unix what(1) and
135 then $identifier: doc string $ is used by GNU ident(1)"
139 (defcustom lm-comment-column
16
140 "Column used for placing formatted output."
144 (defcustom lm-commentary-header
"Commentary\\|Documentation"
145 "Regexp which matches start of documentation section."
149 (defcustom lm-history-header
"Change Log\\|History"
150 "Regexp which matches the start of code log section."
156 ;; These functions all parse the headers of the current buffer
158 (defsubst lm-get-header-re
(header &optional mode
)
159 "Return regexp for matching HEADER.
160 If called with optional MODE and with value `section',
161 return section regexp instead."
162 (cond ((eq mode
'section
)
163 (concat "^;;;;* " header
":[ \t]*$"))
165 (concat lm-header-prefix header
":[ \t]*"))))
167 (defsubst lm-get-package-name
()
168 "Return package name by looking at the first line."
170 (goto-char (point-min))
171 (if (and (looking-at (concat lm-header-prefix
))
172 (progn (goto-char (match-end 0))
173 (looking-at "\\([^\t ]+\\)")
175 (buffer-substring-no-properties (match-beginning 1) (match-end 1))
178 (defun lm-section-mark (header &optional after
)
179 "Return the buffer location of a given section start marker.
180 The HEADER is the section mark string to search for.
181 If AFTER is non-nil, return the location of the next line."
183 (let ((case-fold-search t
))
184 (goto-char (point-min))
185 (if (re-search-forward (lm-get-header-re header
'section
) nil t
)
188 (if after
(forward-line 1))
192 (defsubst lm-code-mark
()
193 "Return the buffer location of the `Code' start marker."
194 (lm-section-mark "Code"))
196 (defsubst lm-commentary-mark
()
197 "Return the buffer location of the `Commentary' start marker."
198 (lm-section-mark lm-commentary-header
))
200 (defsubst lm-history-mark
()
201 "Return the buffer location of the `History' start marker."
202 (lm-section-mark lm-history-header
))
204 (defun lm-header (header)
205 "Return the contents of the header named HEADER."
206 (goto-char (point-min))
207 (let ((case-fold-search t
))
208 (if (and (re-search-forward (lm-get-header-re header
) (lm-code-mark) t
)
209 ;; RCS ident likes format "$identifier: data$"
210 (looking-at "\\([^$\n]+\\)")
212 (buffer-substring-no-properties (match-beginning 1) (match-end 1))
215 (defun lm-header-multiline (header)
216 "Return the contents of the header named HEADER, with continuation lines.
217 The returned value is a list of strings, one per line."
219 (goto-char (point-min))
220 (let ((res (lm-header header
)))
222 (setq res
(list res
))
225 (while (and (looking-at (concat lm-header-prefix
"[\t ]+"))
227 (goto-char (match-end 0))
228 (looking-at "\\(.*\\)"))
230 (setq res
(cons (buffer-substring-no-properties
239 ;; These give us smart access to the header fields and commentary
241 (defmacro lm-with-file
(file &rest body
)
242 (let ((filesym (make-symbol "file")))
244 (let ((,filesym
,file
))
245 (if ,filesym
(set-buffer (find-file-noselect ,filesym
)))
246 (prog1 (progn ,@body
)
247 (if (and ,filesym
(not (get-buffer-window (current-buffer) t
)))
248 (kill-buffer (current-buffer))))))))
249 (put 'lm-with-file
'lisp-indent-function
1)
250 (put 'lm-with-file
'edebug-form-spec t
)
252 (defun lm-summary (&optional file
)
253 "Return the one-line summary of file FILE, or current buffer if FILE is nil."
255 (goto-char (point-min))
257 (looking-at lm-header-prefix
)
258 (progn (goto-char (match-end 0))
259 (looking-at "[^ ]+[ \t]+--+[ \t]+\\(.*\\)")))
260 (let ((summary (buffer-substring-no-properties (match-beginning 1)
262 ;; Strip off -*- specifications.
263 (if (string-match "[ \t]*-\\*-.*-\\*-" summary
)
264 (substring summary
0 (match-beginning 0))
267 (defun lm-crack-address (x)
268 "Split up an email address X into full name and real email address.
269 The value is a cons of the form (FULLNAME . ADDRESS)."
270 (cond ((string-match "\\(.+\\) [(<]\\(\\S-+@\\S-+\\)[>)]" x
)
271 (cons (substring x
(match-beginning 1) (match-end 1))
272 (substring x
(match-beginning 2) (match-end 2))))
273 ((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x
)
274 (cons (substring x
(match-beginning 2) (match-end 2))
275 (substring x
(match-beginning 1) (match-end 1))))
276 ((string-match "\\S-+@\\S-+" x
)
281 (defun lm-authors (&optional file
)
282 "Return the author list of file FILE, or current buffer if FILE is nil.
283 Each element of the list is a cons; the car is the full name,
284 the cdr is an email address."
286 (let ((authorlist (lm-header-multiline "author")))
287 (mapcar 'lm-crack-address authorlist
))))
289 (defun lm-maintainer (&optional file
)
290 "Return the maintainer of file FILE, or current buffer if FILE is nil.
291 The return value has the form (NAME . ADDRESS)."
293 (let ((maint (lm-header "maintainer")))
295 (lm-crack-address maint
)
296 (car (lm-authors))))))
298 (defun lm-creation-date (&optional file
)
299 "Return the created date given in file FILE, or current buffer if FILE is nil."
301 (lm-header "created")))
304 (defun lm-last-modified-date (&optional file
)
305 "Return the modify-date given in file FILE, or current buffer if FILE is nil."
307 (goto-char (point-min))
308 (when (re-search-forward
309 "\\$[I]d: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) "
312 (buffer-substring (match-beginning 3) (match-end 3))
314 (buffer-substring (match-beginning 2) (match-end 2)))
315 '("" "Jan" "Feb" "Mar" "Apr" "May" "Jun"
316 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec"))
317 (buffer-substring (match-beginning 1) (match-end 1))))))
319 (defun lm-version (&optional file
)
320 "Return the version listed in file FILE, or current buffer if FILE is nil.
321 This can befound in an RCS or SCCS header to crack it out of."
324 (lm-header "version")
325 (let ((header-max (lm-code-mark)))
326 (goto-char (point-min))
328 ;; Look for an RCS header
329 ((re-search-forward "\\$[I]d: [^ ]+ \\([^ ]+\\) " header-max t
)
330 (buffer-substring-no-properties (match-beginning 1) (match-end 1)))
332 ;; Look for an SCCS header
335 (regexp-quote "@(#)")
336 (regexp-quote (file-name-nondirectory (buffer-file-name)))
337 "\t\\([012345679.]*\\)")
339 (buffer-substring-no-properties (match-beginning 1) (match-end 1)))
343 (defun lm-keywords (&optional file
)
344 "Return the keywords given in file FILE, or current buffer if FILE is nil."
346 (let ((keywords (lm-header "keywords")))
347 (and keywords
(downcase keywords
)))))
349 (defun lm-adapted-by (&optional file
)
350 "Return the adapted-by names in file FILE, or current buffer if FILE is nil.
351 This is the name of the person who cleaned up this package for
354 (lm-header "adapted-by")))
356 (defun lm-commentary (&optional file
)
357 "Return the commentary in file FILE, or current buffer if FILE is nil.
358 The value is returned as a string. In the file, the commentary starts
359 with the tag `Commentary' or `Documentation' and ends with one of the
360 tags `Code', `Change Log' or `History'."
362 (let ((commentary (lm-commentary-mark))
363 (change-log (lm-history-mark))
364 (code (lm-code-mark)))
365 (when (and commentary
(or change-log code
))
366 (buffer-substring-no-properties
367 commentary
(min (or code
(point-max)) (or change-log
(point-max))))))))
369 ;;; Verification and synopses
371 (defun lm-insert-at-column (col &rest strings
)
372 "Insert, at column COL, list of STRINGS."
373 (if (> (current-column) col
) (insert "\n"))
374 (move-to-column col t
)
375 (apply 'insert strings
))
377 (defun lm-verify (&optional file showok verb
)
378 "Check that the current buffer (or FILE if given) is in proper format.
379 If FILE is a directory, recurse on its files and generate a report in
382 (let* ((verb (or verb
(interactive-p)))
387 (setq ret
"Ok.")) ;init value
389 (if (and file
(file-directory-p file
))
393 (switch-to-buffer (get-buffer-create "*lm-verify*"))
397 (if (string-match ".*\\.el$" f
)
398 (let ((status (lm-verify f
)))
402 (lm-insert-at-column lm-comment-column status
"\n"))
406 (lm-insert-at-column lm-comment-column
"OK\n")))))))
407 (directory-files file
))
410 (setq name
(lm-get-package-name))
416 "Can't find a package NAME")
419 "Author: tag missing.")
421 ((not (lm-maintainer))
422 "Maintainer: tag missing.")
425 "Can't find a one-line 'Summary' description")
428 "Keywords: tag missing.")
430 ((not (lm-commentary-mark))
431 "Can't find a 'Commentary' section marker.")
433 ((not (lm-history-mark))
434 "Can't find a 'History' section marker.")
436 ((not (lm-code-mark))
437 "Can't find a 'Code' section marker")
440 (goto-char (point-max))
443 (concat "^;;;[ \t]+" name
"[ \t]+ends here[ \t]*$"
444 "\\|^;;;[ \t]+ End of file[ \t]+" name
)
447 (format "Can't find a footer line for [%s]" name
))
456 (defun lm-synopsis (&optional file showall
)
457 "Generate a synopsis listing for the buffer or the given FILE if given.
458 If FILE is a directory, recurse on its files and generate a report in
459 a temporary buffer. If SHOWALL is non-nil, also generate a line for files
460 which do not include a recognizable synopsis."
463 (read-file-name "Synopsis for (file or dir): ")))
465 (if (and file
(file-directory-p file
))
467 (switch-to-buffer (get-buffer-create "*lm-verify*"))
471 (if (string-match ".*\\.el$" f
)
472 (let ((syn (lm-synopsis f
)))
476 (lm-insert-at-column lm-comment-column syn
"\n"))
480 (lm-insert-at-column lm-comment-column
"NA\n")))))))
481 (directory-files file
))
486 (defun lm-report-bug (topic)
487 "Report a bug in the package currently being visited to its maintainer.
488 Prompts for bug subject TOPIC. Leaves you in a mail buffer."
489 (interactive "sBug Subject: ")
490 (let ((package (lm-get-package-name))
491 (addr (lm-maintainer))
492 (version (lm-version)))
495 (concat (car addr
) " <" (cdr addr
) ">")
496 report-emacs-bug-address
)
498 (goto-char (point-max))
501 (if version
(concat " version " version
) "")
504 (substitute-command-keys "Type \\[mail-send] to send bug report."))))
508 ;;; lisp-mnt.el ends here