Commit | Line | Data |
---|---|---|
c7dff41d | 1 | ;;; lisp-mnt.el --- utility functions for Emacs Lisp maintainers |
0fc37e7d | 2 | |
c7dff41d | 3 | ;; Copyright (C) 1992, 1994, 1997, 2000, 2001, 2003 Free Software Foundation, Inc. |
0fc37e7d ER |
4 | |
5 | ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
877d5b39 | 6 | ;; Maintainer: FSF |
0fc37e7d | 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 | ||
c7dff41d | 30 | ;; This library adds some services to Emacs-Lisp editing mode. |
0fc37e7d ER |
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. | |
a1506d29 | 35 | ;; |
0fc37e7d ER |
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: | |
a1506d29 | 43 | ;; |
0fc37e7d ER |
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. | |
a1506d29 | 47 | ;; |
0fc37e7d ER |
48 | ;; Format is three semicolons, followed by the filename, followed by |
49 | ;; three dashes, followed by the summary. All fields space-separated. | |
179e152a RS |
50 | ;; |
51 | ;; * A blank line | |
52 | ;; | |
53 | ;; * Copyright line, which looks more or less like this: | |
54 | ;; | |
55 | ;; ;; Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc. | |
56 | ;; | |
57 | ;; * A blank line | |
a1506d29 | 58 | ;; |
0fc37e7d ER |
59 | ;; * Author line --- contains the name and net address of at least |
60 | ;; the principal author. | |
a1506d29 | 61 | ;; |
68756f1f | 62 | ;; If there are multiple authors, they should be listed on continuation |
0fc37e7d | 63 | ;; lines led by ;;<TAB>, like this: |
a1506d29 | 64 | ;; |
0fc37e7d ER |
65 | ;; ;; Author: Ashwin Ram <Ram-Ashwin@cs.yale.edu> |
66 | ;; ;; Dave Sill <de5@ornl.gov> | |
67 | ;; ;; David Lawrence <tale@pawl.rpi.edu> | |
68 | ;; ;; Noah Friedman <friedman@ai.mit.edu> | |
69 | ;; ;; Joe Wells <jbw@maverick.uswest.com> | |
70 | ;; ;; Dave Brennan <brennan@hal.com> | |
71 | ;; ;; Eric Raymond <esr@snark.thyrsus.com> | |
a1506d29 | 72 | ;; |
0fc37e7d ER |
73 | ;; This field may have some special values; notably "FSF", meaning |
74 | ;; "Free Software Foundation". | |
a1506d29 | 75 | ;; |
0fc37e7d ER |
76 | ;; * Maintainer line --- should be a single name/address as in the Author |
77 | ;; line, or an address only, or the string "FSF". If there is no maintainer | |
78 | ;; line, the person(s) in the Author field are presumed to be it. The example | |
79 | ;; in this file is mildly bogus because the maintainer line is redundant. | |
ca4bd734 | 80 | ;; The idea behind these two fields is to be able to write a Lisp function |
0fc37e7d | 81 | ;; that does "send mail to the author" without having to mine the name out by |
c7dff41d | 82 | ;; hand. Please be careful about surrounding the network address with <> if |
0fc37e7d | 83 | ;; there's also a name in the field. |
a1506d29 | 84 | ;; |
0fc37e7d ER |
85 | ;; * Created line --- optional, gives the original creation date of the |
86 | ;; file. For historical interest, basically. | |
a1506d29 | 87 | ;; |
0fc37e7d | 88 | ;; * Version line --- intended to give the reader a clue if they're looking |
68756f1f ER |
89 | ;; at a different version of the file than the one they're accustomed to. This |
90 | ;; may be an RCS or SCCS header. | |
a1506d29 | 91 | ;; |
0fc37e7d ER |
92 | ;; * Adapted-By line --- this is for FSF's internal use. The person named |
93 | ;; in this field was the one responsible for installing and adapting the | |
94 | ;; package for the distribution. (This file doesn't have one because the | |
95 | ;; author *is* one of the maintainers.) | |
a1506d29 | 96 | ;; |
0fc37e7d | 97 | ;; * Keywords line --- used by the finder code (now under construction) |
c0d79871 | 98 | ;; for finding Emacs Lisp code related to a topic. |
0fc37e7d | 99 | ;; |
1894df21 NF |
100 | ;; * X-Bogus-Bureaucratic-Cruft line --- this is a joke and an example |
101 | ;; of a comment header. Headers starting with `X-' should never be used | |
102 | ;; for any real purpose; this is the way to safely add random headers | |
103 | ;; without invoking the wrath of any program. | |
0fc37e7d | 104 | ;; |
ca4bd734 | 105 | ;; * Commentary line --- enables Lisp code to find the developer's and |
0fc37e7d | 106 | ;; maintainers' explanations of the package internals. |
a1506d29 | 107 | ;; |
0fc37e7d ER |
108 | ;; * Change log line --- optional, exists to terminate the commentary |
109 | ;; section and start a change-log part, if one exists. | |
a1506d29 | 110 | ;; |
c0d79871 | 111 | ;; * Code line --- exists so Lisp can know where commentary and/or |
0fc37e7d | 112 | ;; change-log sections end. |
a1506d29 | 113 | ;; |
0fc37e7d ER |
114 | ;; * Footer line --- marks end-of-file so it can be distinguished from |
115 | ;; an expanded formfeed or the results of truncation. | |
116 | ||
117 | ;;; Change Log: | |
118 | ||
119 | ;; Tue Jul 14 23:44:17 1992 ESR | |
120 | ;; * Created. | |
121 | ||
122 | ;;; Code: | |
123 | ||
d5eead69 RS |
124 | ;;; Variables: |
125 | ||
666b9413 | 126 | (defgroup lisp-mnt nil |
c7dff41d | 127 | "Utility functions for Emacs Lisp maintainers." |
666b9413 SE |
128 | :prefix "lm-" |
129 | :group 'maint) | |
130 | ||
af95e0d1 DL |
131 | ;; At least some of these defcustoms should probably be defconsts, |
132 | ;; since they define, or are defined by, the header format. -- fx | |
133 | ||
438cdcde | 134 | (defcustom lm-header-prefix "^;+[ \t]+\\(@(#)\\)?[ \t]*\\$?" |
d5eead69 | 135 | "Prefix that is ignored before the tag. |
ca4bd734 RS |
136 | For example, you can write the 1st line synopsis string and headers like this |
137 | in your Lisp package: | |
d5eead69 | 138 | |
7a3ee510 | 139 | ;; @(#) package.el -- package description |
d5eead69 RS |
140 | ;; |
141 | ;; @(#) $Maintainer: Person Foo Bar $ | |
142 | ||
143 | The @(#) construct is used by unix what(1) and | |
666b9413 SE |
144 | then $identifier: doc string $ is used by GNU ident(1)" |
145 | :type 'regexp | |
146 | :group 'lisp-mnt) | |
147 | ||
af95e0d1 DL |
148 | (defcustom lm-copyright-prefix "^\\(;+[ \t]\\)+Copyright (C) " |
149 | "Prefix that is ignored before the dates in a copyright. | |
150 | Leading comment characters and whitespace should be in regexp group 1." | |
13c40e2f GM |
151 | :type 'regexp |
152 | :group 'lisp-mnt) | |
153 | ||
666b9413 SE |
154 | (defcustom lm-comment-column 16 |
155 | "Column used for placing formatted output." | |
156 | :type 'integer | |
157 | :group 'lisp-mnt) | |
158 | ||
c7dff41d LK |
159 | (defcustom lm-any-header ".*" |
160 | "Regexp which matches start of any section." | |
161 | :type 'regexp | |
162 | :group 'lisp-mnt) | |
163 | ||
666b9413 SE |
164 | (defcustom lm-commentary-header "Commentary\\|Documentation" |
165 | "Regexp which matches start of documentation section." | |
166 | :type 'regexp | |
167 | :group 'lisp-mnt) | |
168 | ||
3d1b88f6 | 169 | (defcustom lm-history-header "Change ?Log\\|History" |
666b9413 SE |
170 | "Regexp which matches the start of code log section." |
171 | :type 'regexp | |
172 | :group 'lisp-mnt) | |
d5eead69 RS |
173 | |
174 | ;;; Functions: | |
175 | ||
0fc37e7d ER |
176 | ;; These functions all parse the headers of the current buffer |
177 | ||
2505742b | 178 | (defun lm-get-header-re (header &optional mode) |
6e24ad22 | 179 | "Return regexp for matching HEADER. |
ca4bd734 RS |
180 | If called with optional MODE and with value `section', |
181 | return section regexp instead." | |
438cdcde SM |
182 | (if (eq mode 'section) |
183 | (concat "^;;;;* " header ":[ \t]*$") | |
184 | (concat lm-header-prefix header "[ \t]*:[ \t]*"))) | |
d5eead69 | 185 | |
2505742b | 186 | (defun lm-get-package-name () |
6e24ad22 | 187 | "Return package name by looking at the first line." |
d5eead69 RS |
188 | (save-excursion |
189 | (goto-char (point-min)) | |
190 | (if (and (looking-at (concat lm-header-prefix)) | |
191 | (progn (goto-char (match-end 0)) | |
192 | (looking-at "\\([^\t ]+\\)") | |
193 | (match-end 1))) | |
2505742b | 194 | (match-string-no-properties 1)))) |
d5eead69 | 195 | |
c7dff41d | 196 | (defun lm-section-start (header &optional after) |
d5eead69 | 197 | "Return the buffer location of a given section start marker. |
ca4bd734 | 198 | The HEADER is the section mark string to search for. |
c7dff41d LK |
199 | If AFTER is non-nil, return the location of the next line. |
200 | If the given section does not exist, return nil." | |
0fc37e7d ER |
201 | (save-excursion |
202 | (let ((case-fold-search t)) | |
203 | (goto-char (point-min)) | |
d5eead69 | 204 | (if (re-search-forward (lm-get-header-re header 'section) nil t) |
c7dff41d LK |
205 | (line-beginning-position (if after 2)))))) |
206 | (defalias 'lm-section-mark 'lm-section-start) | |
207 | ||
208 | (defun lm-section-end (header) | |
209 | "Return the buffer location of the end of a given section. | |
210 | The HEADER is the section string marking the beginning of the | |
211 | section. If the given section does not exist, return nil. | |
212 | ||
213 | The end of the section is defined as the beginning of the next | |
214 | section of the same level or lower. The function | |
215 | `lisp-outline-level' is used to compute the level of a section. | |
216 | If no such section exists, return the end of the buffer." | |
217 | (let ((start (lm-section-start header))) | |
218 | (when start | |
219 | (save-excursion | |
220 | (goto-char start) | |
221 | (let ((level (lisp-outline-level)) | |
222 | (case-fold-search t) | |
223 | next-section-found) | |
224 | (beginning-of-line 2) | |
225 | (while (and (setq next-section-found | |
226 | (re-search-forward | |
227 | (lm-get-header-re lm-any-header 'section) | |
228 | nil t)) | |
229 | (> (save-excursion | |
230 | (beginning-of-line) | |
231 | (lisp-outline-level)) | |
232 | level))) | |
233 | (if next-section-found | |
234 | (line-beginning-position) | |
235 | (point-max))))))) | |
236 | ||
237 | (defsubst lm-code-start () | |
ca4bd734 | 238 | "Return the buffer location of the `Code' start marker." |
c7dff41d LK |
239 | (lm-section-start "Code")) |
240 | (defalias 'lm-code-mark 'lm-code-start) | |
0fc37e7d | 241 | |
c7dff41d | 242 | (defsubst lm-commentary-start () |
ca4bd734 | 243 | "Return the buffer location of the `Commentary' start marker." |
c7dff41d LK |
244 | (lm-section-start lm-commentary-header)) |
245 | (defalias 'lm-commentary-mark 'lm-commentary-start) | |
246 | ||
247 | (defsubst lm-commentary-end () | |
248 | "Return the buffer location of the `Commentary' section end." | |
249 | (lm-section-end lm-commentary-header)) | |
d5eead69 | 250 | |
c7dff41d | 251 | (defsubst lm-history-start () |
ca4bd734 | 252 | "Return the buffer location of the `History' start marker." |
c7dff41d LK |
253 | (lm-section-start lm-history-header)) |
254 | (defalias 'lm-history-mark 'lm-history-start) | |
d5eead69 | 255 | |
13c40e2f GM |
256 | (defsubst lm-copyright-mark () |
257 | "Return the buffer location of the `Copyright' line." | |
258 | (save-excursion | |
259 | (let ((case-fold-search t)) | |
260 | (goto-char (point-min)) | |
261 | (if (re-search-forward lm-copyright-prefix nil t) | |
c7dff41d | 262 | (point))))) |
13c40e2f | 263 | |
d5eead69 | 264 | (defun lm-header (header) |
ca4bd734 RS |
265 | "Return the contents of the header named HEADER." |
266 | (goto-char (point-min)) | |
267 | (let ((case-fold-search t)) | |
438cdcde SM |
268 | (when (and (re-search-forward (lm-get-header-re header) (lm-code-mark) t) |
269 | ;; RCS ident likes format "$identifier: data$" | |
270 | (looking-at | |
271 | (if (save-excursion | |
272 | (skip-chars-backward "^$" (match-beginning 0)) | |
273 | (= (point) (match-beginning 0))) | |
274 | "[^\n]+" "[^$\n]+"))) | |
275 | (match-string-no-properties 0)))) | |
0fc37e7d | 276 | |
d5eead69 | 277 | (defun lm-header-multiline (header) |
ca4bd734 | 278 | "Return the contents of the header named HEADER, with continuation lines. |
d5eead69 | 279 | The returned value is a list of strings, one per line." |
0fc37e7d ER |
280 | (save-excursion |
281 | (goto-char (point-min)) | |
d5eead69 | 282 | (let ((res (lm-header header))) |
be961cd5 | 283 | (when res |
d5eead69 RS |
284 | (setq res (list res)) |
285 | (forward-line 1) | |
438cdcde SM |
286 | (while (and (or (looking-at (concat lm-header-prefix "[\t ]+")) |
287 | (and (not (looking-at | |
288 | (lm-get-header-re "\\sw\\(\\sw\\|\\s_\\)*"))) | |
289 | (looking-at lm-header-prefix))) | |
290 | (goto-char (match-end 0)) | |
291 | (looking-at ".+")) | |
292 | (setq res (cons (match-string-no-properties 0) res)) | |
2505742b | 293 | (forward-line 1))) |
438cdcde | 294 | (nreverse res)))) |
0fc37e7d ER |
295 | |
296 | ;; These give us smart access to the header fields and commentary | |
297 | ||
be961cd5 | 298 | (defmacro lm-with-file (file &rest body) |
13c40e2f GM |
299 | "Make a buffer with FILE current, and execute BODY. |
300 | If FILE isn't in a buffer, load it in, and kill it after BODY is executed." | |
be961cd5 SM |
301 | (let ((filesym (make-symbol "file"))) |
302 | `(save-excursion | |
303 | (let ((,filesym ,file)) | |
304 | (if ,filesym (set-buffer (find-file-noselect ,filesym))) | |
305 | (prog1 (progn ,@body) | |
306 | (if (and ,filesym (not (get-buffer-window (current-buffer) t))) | |
307 | (kill-buffer (current-buffer)))))))) | |
308 | (put 'lm-with-file 'lisp-indent-function 1) | |
309 | (put 'lm-with-file 'edebug-form-spec t) | |
310 | ||
af95e0d1 DL |
311 | ;; Fixme: Probably this should be amalgamated with copyright.el; also |
312 | ;; we need a check for ranges in copyright years. | |
313 | ||
13c40e2f GM |
314 | (defun lm-crack-copyright (&optional file) |
315 | "Return the copyright holder, and a list of copyright years. | |
316 | Use the current buffer if FILE is nil. | |
317 | Return argument is of the form (\"HOLDER\" \"YEAR1\" ... \"YEARN\")" | |
318 | (lm-with-file file | |
319 | (goto-char (lm-copyright-mark)) | |
320 | (let ((holder nil) | |
321 | (years nil) | |
af95e0d1 | 322 | (start (point)) |
13c40e2f | 323 | (end (line-end-position))) |
af95e0d1 DL |
324 | ;; Cope with multi-line copyright `lines'. Assume the second |
325 | ;; line is indented (with the same commenting style). | |
326 | (save-excursion | |
327 | (beginning-of-line 2) | |
328 | (let ((str (concat (match-string-no-properties 1) "[ \t]+"))) | |
329 | (beginning-of-line) | |
330 | (while (looking-at str) | |
331 | (setq end (line-end-position)) | |
332 | (beginning-of-line 2)))) | |
333 | ;; Make a single line and parse that. | |
334 | (let ((buff (current-buffer))) | |
335 | (with-temp-buffer | |
336 | (insert-buffer-substring buff start end) | |
337 | (goto-char (point-min)) | |
338 | (while (re-search-forward "^;+[ \t]+" nil t) | |
339 | (replace-match "")) | |
340 | (goto-char (point-min)) | |
341 | (while (re-search-forward " *\n" nil t) | |
342 | (replace-match " ")) | |
343 | (goto-char (point-min)) | |
344 | (while (re-search-forward "\\([0-9]+\\),? +" nil t) | |
345 | (setq years (cons (match-string-no-properties 1) years))) | |
346 | (if (looking-at ".*$") | |
347 | (setq holder (match-string-no-properties 0))))) | |
348 | (cons holder (nreverse years))))) | |
13c40e2f | 349 | |
0fc37e7d | 350 | (defun lm-summary (&optional file) |
ca4bd734 | 351 | "Return the one-line summary of file FILE, or current buffer if FILE is nil." |
be961cd5 | 352 | (lm-with-file file |
0fc37e7d | 353 | (goto-char (point-min)) |
2505742b DL |
354 | (if (and (looking-at lm-header-prefix) |
355 | (progn (goto-char (match-end 0)) | |
356 | (looking-at "[^ ]+[ \t]+--+[ \t]+\\(.*\\)"))) | |
357 | (let ((summary (match-string-no-properties 1))) | |
be961cd5 SM |
358 | ;; Strip off -*- specifications. |
359 | (if (string-match "[ \t]*-\\*-.*-\\*-" summary) | |
360 | (substring summary 0 (match-beginning 0)) | |
361 | summary))))) | |
0fc37e7d | 362 | |
68756f1f | 363 | (defun lm-crack-address (x) |
6e24ad22 | 364 | "Split up an email address X into full name and real email address. |
ca4bd734 | 365 | The value is a cons of the form (FULLNAME . ADDRESS)." |
68756f1f | 366 | (cond ((string-match "\\(.+\\) [(<]\\(\\S-+@\\S-+\\)[>)]" x) |
2505742b DL |
367 | (cons (match-string 1 x) |
368 | (match-string 2 x))) | |
68756f1f | 369 | ((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x) |
2505742b DL |
370 | (cons (match-string 2 x) |
371 | (match-string 1 x))) | |
68756f1f ER |
372 | ((string-match "\\S-+@\\S-+" x) |
373 | (cons nil x)) | |
374 | (t | |
375 | (cons x nil)))) | |
376 | ||
0fc37e7d | 377 | (defun lm-authors (&optional file) |
ca4bd734 RS |
378 | "Return the author list of file FILE, or current buffer if FILE is nil. |
379 | Each element of the list is a cons; the car is the full name, | |
380 | the cdr is an email address." | |
be961cd5 | 381 | (lm-with-file file |
68756f1f | 382 | (let ((authorlist (lm-header-multiline "author"))) |
be961cd5 | 383 | (mapcar 'lm-crack-address authorlist)))) |
0fc37e7d ER |
384 | |
385 | (defun lm-maintainer (&optional file) | |
ca4bd734 RS |
386 | "Return the maintainer of file FILE, or current buffer if FILE is nil. |
387 | The return value has the form (NAME . ADDRESS)." | |
be961cd5 SM |
388 | (lm-with-file file |
389 | (let ((maint (lm-header "maintainer"))) | |
390 | (if maint | |
391 | (lm-crack-address maint) | |
392 | (car (lm-authors)))))) | |
0fc37e7d ER |
393 | |
394 | (defun lm-creation-date (&optional file) | |
ca4bd734 | 395 | "Return the created date given in file FILE, or current buffer if FILE is nil." |
be961cd5 SM |
396 | (lm-with-file file |
397 | (lm-header "created"))) | |
0fc37e7d | 398 | |
07d505c1 GM |
399 | (defun lm-last-modified-date (&optional file iso-date) |
400 | "Return the modify-date given in file FILE, or current buffer if FILE is nil. | |
401 | ISO-DATE non-nil means return the date in ISO 8601 format." | |
be961cd5 | 402 | (lm-with-file file |
07d505c1 GM |
403 | (when (progn (goto-char (point-min)) |
404 | (re-search-forward | |
405 | "\\$[I]d: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) " | |
406 | (lm-code-mark) t)) | |
407 | (let ((dd (match-string 3)) | |
408 | (mm (match-string 2)) | |
409 | (yyyy (match-string 1))) | |
410 | (if iso-date | |
411 | (format "%s-%s-%s" yyyy mm dd) | |
412 | (format "%s %s %s" | |
413 | dd | |
414 | (nth (string-to-int mm) | |
415 | '("" "Jan" "Feb" "Mar" "Apr" "May" "Jun" | |
416 | "Jul" "Aug" "Sep" "Oct" "Nov" "Dec")) | |
417 | yyyy)))))) | |
0fc37e7d ER |
418 | |
419 | (defun lm-version (&optional file) | |
ca4bd734 | 420 | "Return the version listed in file FILE, or current buffer if FILE is nil. |
2505742b | 421 | This can be found in an RCS or SCCS header." |
be961cd5 | 422 | (lm-with-file file |
2505742b DL |
423 | (or (lm-header "version") |
424 | (let ((header-max (lm-code-mark))) | |
425 | (goto-char (point-min)) | |
426 | (cond | |
427 | ;; Look for an RCS header | |
428 | ((re-search-forward "\\$[I]d: [^ ]+ \\([^ ]+\\) " header-max t) | |
429 | (match-string-no-properties 1)) | |
430 | ((re-search-forward "\\$Revision: +\\([^ ]+\\) " header-max t) | |
431 | (match-string-no-properties 1)) | |
432 | ;; Look for an SCCS header | |
433 | ((re-search-forward | |
434 | (concat | |
435 | (regexp-quote "@(#)") | |
436 | (regexp-quote (file-name-nondirectory (buffer-file-name))) | |
437 | "\t\\([012345679.]*\\)") | |
438 | header-max t) | |
439 | (match-string-no-properties 1))))))) | |
0fc37e7d ER |
440 | |
441 | (defun lm-keywords (&optional file) | |
ca4bd734 | 442 | "Return the keywords given in file FILE, or current buffer if FILE is nil." |
be961cd5 SM |
443 | (lm-with-file file |
444 | (let ((keywords (lm-header "keywords"))) | |
445 | (and keywords (downcase keywords))))) | |
0fc37e7d | 446 | |
5efa6032 GM |
447 | (defun lm-keywords-list (&optional file) |
448 | "Return list of keywords given in file FILE." | |
449 | (let ((keywords (lm-keywords file))) | |
450 | (if keywords | |
451 | (split-string keywords ",?[ \t]")))) | |
452 | ||
453 | (defun lm-keywords-finder-p (&optional file) | |
454 | "Return non-nil if any keywords in FILE are known to finder." | |
455 | (require 'finder) | |
456 | (let ((keys (lm-keywords-list file))) | |
457 | (catch 'keyword-found | |
458 | (while keys | |
459 | (if (assoc (intern (car keys)) finder-known-keywords) | |
460 | (throw 'keyword-found t)) | |
461 | (setq keys (cdr keys))) | |
462 | nil))) | |
463 | ||
0fc37e7d | 464 | (defun lm-adapted-by (&optional file) |
ca4bd734 RS |
465 | "Return the adapted-by names in file FILE, or current buffer if FILE is nil. |
466 | This is the name of the person who cleaned up this package for | |
467 | distribution." | |
be961cd5 SM |
468 | (lm-with-file file |
469 | (lm-header "adapted-by"))) | |
0fc37e7d | 470 | |
64e07c7b | 471 | (defun lm-commentary (&optional file) |
ca4bd734 | 472 | "Return the commentary in file FILE, or current buffer if FILE is nil. |
c7dff41d LK |
473 | Return the value as a string. In the file, the commentary |
474 | section starts with the tag `Commentary' or `Documentation' and | |
475 | ends just before the next section. If the commentary section is | |
476 | absent, return nil." | |
be961cd5 | 477 | (lm-with-file file |
c7dff41d LK |
478 | (let ((start (lm-commentary-start))) |
479 | (when start | |
480 | (buffer-substring-no-properties start (lm-commentary-end)))))) | |
0fc37e7d ER |
481 | |
482 | ;;; Verification and synopses | |
483 | ||
d5eead69 | 484 | (defun lm-insert-at-column (col &rest strings) |
6e24ad22 | 485 | "Insert, at column COL, list of STRINGS." |
d5eead69 | 486 | (if (> (current-column) col) (insert "\n")) |
b4d73c71 | 487 | (move-to-column col t) |
d5eead69 | 488 | (apply 'insert strings)) |
0fc37e7d | 489 | |
179e152a | 490 | (defun lm-verify (&optional file showok verbose non-fsf-ok) |
0fc37e7d | 491 | "Check that the current buffer (or FILE if given) is in proper format. |
13c40e2f | 492 | If FILE is a directory, recurse on its files and generate a report in a |
179e152a RS |
493 | temporary buffer. In that case, the optional argument SHOWOK |
494 | says display \"OK\" in temp buffer for files that have no problems. | |
495 | ||
496 | Optional argument VERBOSE specifies verbosity level. | |
497 | Optional argument NON-FSF-OK if non-nil means a non-FSF | |
498 | copyright notice is allowed." | |
499 | (interactive (list nil nil t)) | |
500 | (let* ((ret (and verbose "Ok")) | |
2505742b | 501 | name) |
d5eead69 | 502 | (if (and file (file-directory-p file)) |
2505742b DL |
503 | (setq ret |
504 | (with-temp-buffer | |
505 | (mapcar | |
506 | (lambda (f) | |
507 | (if (string-match ".*\\.el\\'" f) | |
508 | (let ((status (lm-verify f))) | |
509 | (insert f ":") | |
510 | (if status | |
511 | (lm-insert-at-column lm-comment-column status | |
512 | "\n") | |
513 | (if showok | |
514 | (lm-insert-at-column lm-comment-column | |
515 | "OK\n")))))) | |
516 | (directory-files file)))) | |
be961cd5 | 517 | (lm-with-file file |
d5eead69 | 518 | (setq name (lm-get-package-name)) |
2505742b DL |
519 | (setq ret |
520 | (cond | |
521 | ((null name) | |
179e152a | 522 | (format "Package %s does not exist")) |
2505742b | 523 | ((not (lm-authors)) |
179e152a | 524 | "`Author:' tag missing") |
2505742b | 525 | ((not (lm-maintainer)) |
179e152a | 526 | "`Maintainer:' tag missing") |
2505742b | 527 | ((not (lm-summary)) |
179e152a | 528 | "Can't find the one-line summary description") |
2505742b | 529 | ((not (lm-keywords)) |
179e152a | 530 | "`Keywords:' tag missing") |
5efa6032 | 531 | ((not (lm-keywords-finder-p)) |
179e152a | 532 | "`Keywords:' has no valid finder keywords (see `finder-known-keywords')") |
2505742b | 533 | ((not (lm-commentary-mark)) |
179e152a | 534 | "Can't find a 'Commentary' section marker") |
2505742b | 535 | ((not (lm-history-mark)) |
179e152a | 536 | "Can't find a 'History' section marker") |
2505742b DL |
537 | ((not (lm-code-mark)) |
538 | "Can't find a 'Code' section marker") | |
539 | ((progn | |
540 | (goto-char (point-max)) | |
541 | (not | |
542 | (re-search-backward | |
543 | (concat "^;;;[ \t]+" name "[ \t]+ends here[ \t]*$" | |
544 | "\\|^;;;[ \t]+ End of file[ \t]+" name) | |
545 | nil t))) | |
5e18d632 | 546 | (format "Can't find the footer line")) |
13c40e2f | 547 | ((not (and (lm-copyright-mark) (lm-crack-copyright))) |
179e152a RS |
548 | "Can't find a valid copyright notice") |
549 | ((not (or non-fsf-ok | |
550 | (string-match "Free Software Foundation" | |
551 | (car (lm-crack-copyright))))) | |
552 | "Copyright holder is not the Free Software Foundation") | |
2505742b DL |
553 | (t |
554 | ret))))) | |
179e152a | 555 | (if verbose |
d5eead69 | 556 | (message ret)) |
2505742b | 557 | ret)) |
0fc37e7d ER |
558 | |
559 | (defun lm-synopsis (&optional file showall) | |
560 | "Generate a synopsis listing for the buffer or the given FILE if given. | |
ca4bd734 RS |
561 | If FILE is a directory, recurse on its files and generate a report in |
562 | a temporary buffer. If SHOWALL is non-nil, also generate a line for files | |
0fc37e7d | 563 | which do not include a recognizable synopsis." |
d5eead69 RS |
564 | (interactive |
565 | (list | |
566 | (read-file-name "Synopsis for (file or dir): "))) | |
567 | ||
0fc37e7d | 568 | (if (and file (file-directory-p file)) |
2505742b | 569 | (with-temp-buffer |
0fc37e7d | 570 | (mapcar |
2505742b DL |
571 | (lambda (f) |
572 | (if (string-match "\\.el\\'" f) | |
573 | (let ((syn (lm-synopsis f))) | |
574 | (if syn | |
575 | (progn | |
576 | (insert f ":") | |
577 | (lm-insert-at-column lm-comment-column syn "\n")) | |
578 | (when showall | |
579 | (insert f ":") | |
580 | (lm-insert-at-column lm-comment-column "NA\n")))))) | |
581 | (directory-files file))) | |
582 | (save-excursion | |
583 | (if file | |
584 | (find-file file)) | |
585 | (prog1 | |
586 | (lm-summary) | |
587 | (if file | |
588 | (kill-buffer (current-buffer))))))) | |
589 | ||
590 | (eval-when-compile (defvar report-emacs-bug-address)) | |
0fc37e7d ER |
591 | |
592 | (defun lm-report-bug (topic) | |
593 | "Report a bug in the package currently being visited to its maintainer. | |
6e24ad22 | 594 | Prompts for bug subject TOPIC. Leaves you in a mail buffer." |
68756f1f | 595 | (interactive "sBug Subject: ") |
2505742b DL |
596 | (require 'emacsbug) |
597 | (let ((package (lm-get-package-name)) | |
598 | (addr (lm-maintainer)) | |
599 | (version (lm-version))) | |
600 | (compose-mail (if addr | |
601 | (concat (car addr) " <" (cdr addr) ">") | |
602 | report-emacs-bug-address) | |
603 | topic) | |
0fc37e7d | 604 | (goto-char (point-max)) |
2505742b DL |
605 | (insert "\nIn " package) |
606 | (if version | |
607 | (insert " version " version)) | |
608 | (newline 2) | |
d5eead69 | 609 | (message |
0fc37e7d ER |
610 | (substitute-command-keys "Type \\[mail-send] to send bug report.")))) |
611 | ||
612 | (provide 'lisp-mnt) | |
613 | ||
614 | ;;; lisp-mnt.el ends here |