Commit | Line | Data |
---|---|---|
0fc37e7d ER |
1 | ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers |
2 | ||
6e24ad22 | 3 | ;; Copyright (C) 1992, 1994, 1997 Free Software Foundation, Inc. |
0fc37e7d ER |
4 | |
5 | ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
6 | ;; Maintainer: Eric S. Raymond <esr@snark.thyrsus.com> | |
7 | ;; Created: 14 Jul 1992 | |
0fc37e7d | 8 | ;; Keywords: docs |
1894df21 | 9 | ;; X-Bogus-Bureaucratic-Cruft: Gruad will get you if you don't watch out! |
0fc37e7d ER |
10 | |
11 | ;; This file is part of GNU Emacs. | |
12 | ||
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 | |
7c938215 | 15 | ;; the Free Software Foundation; either version 2, or (at your option) |
0fc37e7d ER |
16 | ;; any later version. |
17 | ||
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. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
d5eead69 | 24 | ;; along with GNU Emacs; see the file COPYING. If not, write to |
470c5afe EN |
25 | ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
26 | ;; Boston, MA 02111-1307, USA. | |
0fc37e7d ER |
27 | |
28 | ;;; Commentary: | |
29 | ||
30 | ;; This minor mode adds some services to Emacs-Lisp editing mode. | |
31 | ;; | |
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. | |
35 | ;; | |
36 | ;; Another entry point automatically addresses bug mail to a package's | |
37 | ;; maintainer or author. | |
38 | ||
39 | ;; This file can be loaded by your lisp-mode-hook. Have it (require 'lisp-mnt) | |
40 | ||
41 | ;; This file is an example of the header conventions. Note the following | |
42 | ;; features: | |
43 | ;; | |
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. | |
47 | ;; | |
48 | ;; Format is three semicolons, followed by the filename, followed by | |
49 | ;; three dashes, followed by the summary. All fields space-separated. | |
50 | ;; | |
51 | ;; * Author line --- contains the name and net address of at least | |
52 | ;; the principal author. | |
53 | ;; | |
68756f1f | 54 | ;; If there are multiple authors, they should be listed on continuation |
0fc37e7d ER |
55 | ;; lines led by ;;<TAB>, like this: |
56 | ;; | |
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> | |
64 | ;; | |
65 | ;; This field may have some special values; notably "FSF", meaning | |
66 | ;; "Free Software Foundation". | |
67 | ;; | |
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. | |
ca4bd734 | 72 | ;; The idea behind these two fields is to be able to write a Lisp function |
0fc37e7d ER |
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. | |
76 | ;; | |
77 | ;; * Created line --- optional, gives the original creation date of the | |
78 | ;; file. For historical interest, basically. | |
79 | ;; | |
80 | ;; * Version line --- intended to give the reader a clue if they're looking | |
68756f1f ER |
81 | ;; at a different version of the file than the one they're accustomed to. This |
82 | ;; may be an RCS or SCCS header. | |
0fc37e7d ER |
83 | ;; |
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.) | |
88 | ;; | |
89 | ;; * Keywords line --- used by the finder code (now under construction) | |
c0d79871 | 90 | ;; for finding Emacs Lisp code related to a topic. |
0fc37e7d | 91 | ;; |
1894df21 NF |
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. | |
0fc37e7d | 96 | ;; |
ca4bd734 | 97 | ;; * Commentary line --- enables Lisp code to find the developer's and |
0fc37e7d ER |
98 | ;; maintainers' explanations of the package internals. |
99 | ;; | |
100 | ;; * Change log line --- optional, exists to terminate the commentary | |
101 | ;; section and start a change-log part, if one exists. | |
102 | ;; | |
c0d79871 | 103 | ;; * Code line --- exists so Lisp can know where commentary and/or |
0fc37e7d ER |
104 | ;; change-log sections end. |
105 | ;; | |
106 | ;; * Footer line --- marks end-of-file so it can be distinguished from | |
107 | ;; an expanded formfeed or the results of truncation. | |
108 | ||
109 | ;;; Change Log: | |
110 | ||
111 | ;; Tue Jul 14 23:44:17 1992 ESR | |
112 | ;; * Created. | |
113 | ||
114 | ;;; Code: | |
115 | ||
68756f1f | 116 | (require 'emacsbug) |
0fc37e7d | 117 | |
d5eead69 RS |
118 | ;;; Variables: |
119 | ||
666b9413 SE |
120 | (defgroup lisp-mnt nil |
121 | "Minor mode for Emacs Lisp maintainers." | |
122 | :prefix "lm-" | |
123 | :group 'maint) | |
124 | ||
125 | (defcustom lm-header-prefix "^;;*[ \t]+\\(@\(#\)\\)?[ \t]*\\([\$]\\)?" | |
d5eead69 | 126 | "Prefix that is ignored before the tag. |
ca4bd734 RS |
127 | For example, you can write the 1st line synopsis string and headers like this |
128 | in your Lisp package: | |
d5eead69 RS |
129 | |
130 | ;; @(#) package.el -- pacakge description | |
131 | ;; | |
132 | ;; @(#) $Maintainer: Person Foo Bar $ | |
133 | ||
134 | The @(#) construct is used by unix what(1) and | |
666b9413 SE |
135 | then $identifier: doc string $ is used by GNU ident(1)" |
136 | :type 'regexp | |
137 | :group 'lisp-mnt) | |
138 | ||
139 | (defcustom lm-comment-column 16 | |
140 | "Column used for placing formatted output." | |
141 | :type 'integer | |
142 | :group 'lisp-mnt) | |
143 | ||
144 | (defcustom lm-commentary-header "Commentary\\|Documentation" | |
145 | "Regexp which matches start of documentation section." | |
146 | :type 'regexp | |
147 | :group 'lisp-mnt) | |
148 | ||
149 | (defcustom lm-history-header "Change Log\\|History" | |
150 | "Regexp which matches the start of code log section." | |
151 | :type 'regexp | |
152 | :group 'lisp-mnt) | |
d5eead69 RS |
153 | |
154 | ;;; Functions: | |
155 | ||
0fc37e7d ER |
156 | ;; These functions all parse the headers of the current buffer |
157 | ||
d5eead69 | 158 | (defsubst lm-get-header-re (header &optional mode) |
6e24ad22 | 159 | "Return regexp for matching HEADER. |
ca4bd734 RS |
160 | If called with optional MODE and with value `section', |
161 | return section regexp instead." | |
162 | (cond ((eq mode 'section) | |
163 | (concat "^;;;;* " header ":[ \t]*$")) | |
164 | (t | |
165 | (concat lm-header-prefix header ":[ \t]*")))) | |
d5eead69 RS |
166 | |
167 | (defsubst lm-get-package-name () | |
6e24ad22 | 168 | "Return package name by looking at the first line." |
d5eead69 RS |
169 | (save-excursion |
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 ]+\\)") | |
174 | (match-end 1))) | |
6e24ad22 | 175 | (buffer-substring-no-properties (match-beginning 1) (match-end 1)) |
d5eead69 RS |
176 | ))) |
177 | ||
178 | (defun lm-section-mark (header &optional after) | |
179 | "Return the buffer location of a given section start marker. | |
ca4bd734 RS |
180 | The HEADER is the section mark string to search for. |
181 | If AFTER is non-nil, return the location of the next line." | |
0fc37e7d ER |
182 | (save-excursion |
183 | (let ((case-fold-search t)) | |
184 | (goto-char (point-min)) | |
d5eead69 | 185 | (if (re-search-forward (lm-get-header-re header 'section) nil t) |
0fc37e7d ER |
186 | (progn |
187 | (beginning-of-line) | |
64e07c7b | 188 | (if after (forward-line 1)) |
0fc37e7d ER |
189 | (point)) |
190 | nil)))) | |
191 | ||
d5eead69 | 192 | (defsubst lm-code-mark () |
ca4bd734 | 193 | "Return the buffer location of the `Code' start marker." |
0fc37e7d ER |
194 | (lm-section-mark "Code")) |
195 | ||
d5eead69 | 196 | (defsubst lm-commentary-mark () |
ca4bd734 | 197 | "Return the buffer location of the `Commentary' start marker." |
d5eead69 RS |
198 | (lm-section-mark lm-commentary-header)) |
199 | ||
200 | (defsubst lm-history-mark () | |
ca4bd734 | 201 | "Return the buffer location of the `History' start marker." |
d5eead69 RS |
202 | (lm-section-mark lm-history-header)) |
203 | ||
204 | (defun lm-header (header) | |
ca4bd734 RS |
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]+\\)") | |
211 | (match-end 1)) | |
6e24ad22 | 212 | (buffer-substring-no-properties (match-beginning 1) (match-end 1)) |
ca4bd734 | 213 | nil))) |
0fc37e7d | 214 | |
d5eead69 | 215 | (defun lm-header-multiline (header) |
ca4bd734 | 216 | "Return the contents of the header named HEADER, with continuation lines. |
d5eead69 | 217 | The returned value is a list of strings, one per line." |
0fc37e7d ER |
218 | (save-excursion |
219 | (goto-char (point-min)) | |
d5eead69 RS |
220 | (let ((res (lm-header header))) |
221 | (cond | |
222 | (res | |
223 | (setq res (list res)) | |
224 | (forward-line 1) | |
225 | ||
226 | (while (and (looking-at (concat lm-header-prefix "[\t ]+")) | |
227 | (progn | |
228 | (goto-char (match-end 0)) | |
229 | (looking-at "\\(.*\\)")) | |
230 | (match-end 1)) | |
6e24ad22 | 231 | (setq res (cons (buffer-substring-no-properties |
d5eead69 RS |
232 | (match-beginning 1) |
233 | (match-end 1)) | |
234 | res)) | |
235 | (forward-line 1)) | |
236 | )) | |
237 | res | |
238 | ))) | |
0fc37e7d ER |
239 | |
240 | ;; These give us smart access to the header fields and commentary | |
241 | ||
242 | (defun lm-summary (&optional file) | |
ca4bd734 | 243 | "Return the one-line summary of file FILE, or current buffer if FILE is nil." |
0fc37e7d ER |
244 | (save-excursion |
245 | (if file | |
246 | (find-file file)) | |
247 | (goto-char (point-min)) | |
248 | (prog1 | |
d5eead69 RS |
249 | (if (and |
250 | (looking-at lm-header-prefix) | |
251 | (progn (goto-char (match-end 0)) | |
252 | (looking-at "[^ ]+[ \t]+--+[ \t]+\\(.*\\)"))) | |
6e24ad22 | 253 | (buffer-substring-no-properties (match-beginning 1) (match-end 1))) |
0fc37e7d ER |
254 | (if file |
255 | (kill-buffer (current-buffer))) | |
256 | ))) | |
257 | ||
68756f1f | 258 | (defun lm-crack-address (x) |
6e24ad22 | 259 | "Split up an email address X into full name and real email address. |
ca4bd734 | 260 | The value is a cons of the form (FULLNAME . ADDRESS)." |
68756f1f ER |
261 | (cond ((string-match "\\(.+\\) [(<]\\(\\S-+@\\S-+\\)[>)]" x) |
262 | (cons (substring x (match-beginning 1) (match-end 1)) | |
263 | (substring x (match-beginning 2) (match-end 2)))) | |
264 | ((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x) | |
265 | (cons (substring x (match-beginning 2) (match-end 2)) | |
266 | (substring x (match-beginning 1) (match-end 1)))) | |
267 | ((string-match "\\S-+@\\S-+" x) | |
268 | (cons nil x)) | |
269 | (t | |
270 | (cons x nil)))) | |
271 | ||
0fc37e7d | 272 | (defun lm-authors (&optional file) |
ca4bd734 RS |
273 | "Return the author list of file FILE, or current buffer if FILE is nil. |
274 | Each element of the list is a cons; the car is the full name, | |
275 | the cdr is an email address." | |
0fc37e7d ER |
276 | (save-excursion |
277 | (if file | |
278 | (find-file file)) | |
68756f1f ER |
279 | (let ((authorlist (lm-header-multiline "author"))) |
280 | (prog1 | |
281 | (mapcar 'lm-crack-address authorlist) | |
282 | (if file | |
283 | (kill-buffer (current-buffer))) | |
284 | )))) | |
0fc37e7d ER |
285 | |
286 | (defun lm-maintainer (&optional file) | |
ca4bd734 RS |
287 | "Return the maintainer of file FILE, or current buffer if FILE is nil. |
288 | The return value has the form (NAME . ADDRESS)." | |
0fc37e7d ER |
289 | (save-excursion |
290 | (if file | |
291 | (find-file file)) | |
292 | (prog1 | |
68756f1f ER |
293 | (let ((maint (lm-header "maintainer"))) |
294 | (if maint | |
295 | (lm-crack-address maint) | |
296 | (car (lm-authors)))) | |
0fc37e7d ER |
297 | (if file |
298 | (kill-buffer (current-buffer))) | |
299 | ))) | |
300 | ||
301 | (defun lm-creation-date (&optional file) | |
ca4bd734 | 302 | "Return the created date given in file FILE, or current buffer if FILE is nil." |
0fc37e7d ER |
303 | (save-excursion |
304 | (if file | |
305 | (find-file file)) | |
306 | (prog1 | |
307 | (lm-header "created") | |
308 | (if file | |
309 | (kill-buffer (current-buffer))) | |
310 | ))) | |
311 | ||
312 | ||
313 | (defun lm-last-modified-date (&optional file) | |
ca4bd734 | 314 | "Return the modify-date given in file FILE, or current buffer if FILE is nil." |
0fc37e7d ER |
315 | (save-excursion |
316 | (if file | |
317 | (find-file file)) | |
318 | (prog1 | |
68756f1f ER |
319 | (if (progn |
320 | (goto-char (point-min)) | |
321 | (re-search-forward | |
e555bfcb | 322 | "\\$[I]d: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) " |
68756f1f ER |
323 | (lm-code-mark) t)) |
324 | (format "%s %s %s" | |
325 | (buffer-substring (match-beginning 3) (match-end 3)) | |
326 | (nth (string-to-int | |
327 | (buffer-substring (match-beginning 2) (match-end 2))) | |
328 | '("" "Jan" "Feb" "Mar" "Apr" "May" "Jun" | |
329 | "Jul" "Aug" "Sep" "Oct" "Nov" "Dec")) | |
330 | (buffer-substring (match-beginning 1) (match-end 1)) | |
331 | )) | |
0fc37e7d ER |
332 | (if file |
333 | (kill-buffer (current-buffer))) | |
68756f1f | 334 | ))) |
0fc37e7d ER |
335 | |
336 | (defun lm-version (&optional file) | |
ca4bd734 RS |
337 | "Return the version listed in file FILE, or current buffer if FILE is nil. |
338 | This can befound in an RCS or SCCS header to crack it out of." | |
0fc37e7d ER |
339 | (save-excursion |
340 | (if file | |
341 | (find-file file)) | |
342 | (prog1 | |
343 | (or | |
344 | (lm-header "version") | |
345 | (let ((header-max (lm-code-mark))) | |
346 | (goto-char (point-min)) | |
347 | (cond | |
348 | ;; Look for an RCS header | |
e555bfcb | 349 | ((re-search-forward "\\$[I]d: [^ ]+ \\([^ ]+\\) " header-max t) |
6e24ad22 | 350 | (buffer-substring-no-properties (match-beginning 1) (match-end 1))) |
0fc37e7d ER |
351 | |
352 | ;; Look for an SCCS header | |
353 | ((re-search-forward | |
354 | (concat | |
355 | (regexp-quote "@(#)") | |
356 | (regexp-quote (file-name-nondirectory (buffer-file-name))) | |
357 | "\t\\([012345679.]*\\)") | |
358 | header-max t) | |
6e24ad22 | 359 | (buffer-substring-no-properties (match-beginning 1) (match-end 1))) |
0fc37e7d ER |
360 | |
361 | (t nil)))) | |
362 | (if file | |
363 | (kill-buffer (current-buffer))) | |
364 | ))) | |
365 | ||
366 | (defun lm-keywords (&optional file) | |
ca4bd734 | 367 | "Return the keywords given in file FILE, or current buffer if FILE is nil." |
0fc37e7d ER |
368 | (save-excursion |
369 | (if file | |
370 | (find-file file)) | |
371 | (prog1 | |
372 | (let ((keywords (lm-header "keywords"))) | |
373 | (and keywords (downcase keywords))) | |
374 | (if file | |
375 | (kill-buffer (current-buffer))) | |
376 | ))) | |
377 | ||
378 | (defun lm-adapted-by (&optional file) | |
ca4bd734 RS |
379 | "Return the adapted-by names in file FILE, or current buffer if FILE is nil. |
380 | This is the name of the person who cleaned up this package for | |
381 | distribution." | |
0fc37e7d ER |
382 | (save-excursion |
383 | (if file | |
384 | (find-file file)) | |
385 | (prog1 | |
386 | (lm-header "adapted-by") | |
387 | (if file | |
388 | (kill-buffer (current-buffer))) | |
389 | ))) | |
390 | ||
64e07c7b | 391 | (defun lm-commentary (&optional file) |
ca4bd734 RS |
392 | "Return the commentary in file FILE, or current buffer if FILE is nil. |
393 | The value is returned as a string. In the text, the commentary starts | |
394 | with tag `Commentary' and ends with tag `Change Log' or `History'." | |
0fc37e7d ER |
395 | (save-excursion |
396 | (if file | |
397 | (find-file file)) | |
398 | (prog1 | |
d5eead69 RS |
399 | (let ((commentary (lm-commentary-mark)) |
400 | (change-log (lm-history-mark)) | |
401 | (code (lm-code-mark)) | |
402 | ) | |
403 | (cond | |
404 | ((and commentary change-log) | |
6e24ad22 | 405 | (buffer-substring-no-properties commentary change-log)) |
d5eead69 | 406 | ((and commentary code) |
6e24ad22 | 407 | (buffer-substring-no-properties commentary code)) |
d5eead69 RS |
408 | (t |
409 | nil))) | |
0fc37e7d ER |
410 | (if file |
411 | (kill-buffer (current-buffer))) | |
412 | ))) | |
413 | ||
414 | ;;; Verification and synopses | |
415 | ||
d5eead69 | 416 | (defun lm-insert-at-column (col &rest strings) |
6e24ad22 | 417 | "Insert, at column COL, list of STRINGS." |
d5eead69 | 418 | (if (> (current-column) col) (insert "\n")) |
b4d73c71 | 419 | (move-to-column col t) |
d5eead69 | 420 | (apply 'insert strings)) |
0fc37e7d | 421 | |
d5eead69 | 422 | (defun lm-verify (&optional file showok &optional verb) |
0fc37e7d | 423 | "Check that the current buffer (or FILE if given) is in proper format. |
ca4bd734 | 424 | If FILE is a directory, recurse on its files and generate a report in |
0fc37e7d | 425 | a temporary buffer." |
d5eead69 RS |
426 | (interactive) |
427 | (let* ((verb (or verb (interactive-p))) | |
428 | ret | |
429 | name | |
430 | ) | |
431 | (if verb | |
432 | (setq ret "Ok.")) ;init value | |
433 | ||
434 | (if (and file (file-directory-p file)) | |
435 | (setq | |
436 | ret | |
437 | (progn | |
438 | (switch-to-buffer (get-buffer-create "*lm-verify*")) | |
439 | (erase-buffer) | |
440 | (mapcar | |
441 | '(lambda (f) | |
442 | (if (string-match ".*\\.el$" f) | |
443 | (let ((status (lm-verify f))) | |
444 | (if status | |
0fc37e7d ER |
445 | (progn |
446 | (insert f ":") | |
d5eead69 RS |
447 | (lm-insert-at-column lm-comment-column status "\n")) |
448 | (and showok | |
449 | (progn | |
450 | (insert f ":") | |
451 | (lm-insert-at-column lm-comment-column "OK\n"))))))) | |
452 | (directory-files file)) | |
453 | )) | |
454 | (save-excursion | |
455 | (if file | |
456 | (find-file file)) | |
457 | (setq name (lm-get-package-name)) | |
458 | ||
459 | (setq | |
460 | ret | |
461 | (prog1 | |
462 | (cond | |
463 | ((null name) | |
464 | "Can't find a package NAME") | |
465 | ||
466 | ((not (lm-authors)) | |
467 | "Author: tag missing.") | |
468 | ||
469 | ((not (lm-maintainer)) | |
470 | "Maintainer: tag missing.") | |
471 | ||
472 | ((not (lm-summary)) | |
473 | "Can't find a one-line 'Summary' description") | |
474 | ||
475 | ((not (lm-keywords)) | |
476 | "Keywords: tag missing.") | |
477 | ||
478 | ((not (lm-commentary-mark)) | |
479 | "Can't find a 'Commentary' section marker.") | |
480 | ||
481 | ((not (lm-history-mark)) | |
482 | "Can't find a 'History' section marker.") | |
483 | ||
484 | ((not (lm-code-mark)) | |
485 | "Can't find a 'Code' section marker") | |
486 | ||
487 | ((progn | |
488 | (goto-char (point-max)) | |
489 | (not | |
490 | (re-search-backward | |
491 | (concat "^;;;[ \t]+" name "[ \t]+ends here[ \t]*$" | |
492 | "\\|^;;;[ \t]+ End of file[ \t]+" name) | |
493 | nil t | |
494 | ))) | |
495 | (format "Can't find a footer line for [%s]" name)) | |
496 | (t | |
497 | ret)) | |
498 | (if file | |
499 | (kill-buffer (current-buffer))) | |
500 | )))) | |
501 | (if verb | |
502 | (message ret)) | |
503 | ret | |
504 | )) | |
0fc37e7d ER |
505 | |
506 | (defun lm-synopsis (&optional file showall) | |
507 | "Generate a synopsis listing for the buffer or the given FILE if given. | |
ca4bd734 RS |
508 | If FILE is a directory, recurse on its files and generate a report in |
509 | a temporary buffer. If SHOWALL is non-nil, also generate a line for files | |
0fc37e7d | 510 | which do not include a recognizable synopsis." |
d5eead69 RS |
511 | (interactive |
512 | (list | |
513 | (read-file-name "Synopsis for (file or dir): "))) | |
514 | ||
0fc37e7d ER |
515 | (if (and file (file-directory-p file)) |
516 | (progn | |
517 | (switch-to-buffer (get-buffer-create "*lm-verify*")) | |
518 | (erase-buffer) | |
519 | (mapcar | |
520 | '(lambda (f) | |
521 | (if (string-match ".*\\.el$" f) | |
522 | (let ((syn (lm-synopsis f))) | |
523 | (if syn | |
524 | (progn | |
525 | (insert f ":") | |
f9636fb2 | 526 | (lm-insert-at-column lm-comment-column syn "\n")) |
0fc37e7d ER |
527 | (and showall |
528 | (progn | |
529 | (insert f ":") | |
f9636fb2 | 530 | (lm-insert-at-column lm-comment-column "NA\n"))))))) |
0fc37e7d ER |
531 | (directory-files file)) |
532 | ) | |
533 | (save-excursion | |
534 | (if file | |
535 | (find-file file)) | |
536 | (prog1 | |
537 | (lm-summary) | |
538 | (if file | |
539 | (kill-buffer (current-buffer))) | |
540 | )))) | |
541 | ||
542 | (defun lm-report-bug (topic) | |
543 | "Report a bug in the package currently being visited to its maintainer. | |
6e24ad22 | 544 | Prompts for bug subject TOPIC. Leaves you in a mail buffer." |
68756f1f | 545 | (interactive "sBug Subject: ") |
d5eead69 RS |
546 | (let ((package (lm-get-package-name)) |
547 | (addr (lm-maintainer)) | |
548 | (version (lm-version))) | |
3082623d RS |
549 | (mail nil |
550 | (if addr | |
551 | (concat (car addr) " <" (cdr addr) ">") | |
552 | bug-gnu-emacs) | |
553 | topic) | |
0fc37e7d ER |
554 | (goto-char (point-max)) |
555 | (insert "\nIn " | |
556 | package | |
ef92f83b | 557 | (if version (concat " version " version) "") |
0fc37e7d | 558 | "\n\n") |
d5eead69 | 559 | (message |
0fc37e7d ER |
560 | (substitute-command-keys "Type \\[mail-send] to send bug report.")))) |
561 | ||
562 | (provide 'lisp-mnt) | |
563 | ||
564 | ;;; lisp-mnt.el ends here | |
d5eead69 | 565 |