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