Mercurial > emacs
annotate lisp/emacs-lisp/lisp-mnt.el @ 29649:43b4ecc0b133
*** empty log message ***
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Wed, 14 Jun 2000 13:12:14 +0000 |
parents | 38b2af227738 |
children | 0090ca919308 |
rev | line source |
---|---|
879 | 1 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers |
2 | |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
3 ;; Copyright (C) 1992, 1994, 1997, 2000 Free Software Foundation, Inc. |
879 | 4 |
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
6 ;; Maintainer: Eric S. Raymond <esr@snark.thyrsus.com> | |
7 ;; Created: 14 Jul 1992 | |
8 ;; Keywords: docs | |
5221
50e623c19fff
(Bogus-Bureaucratic-Cruft): Changed to `X-Bogus-Bureaucratic-Cruft'.
Noah Friedman <friedman@splode.com>
parents:
4291
diff
changeset
|
9 ;; X-Bogus-Bureaucratic-Cruft: Gruad will get you if you don't watch out! |
879 | 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 | |
12244 | 15 ;; the Free Software Foundation; either version 2, or (at your option) |
879 | 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 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
24 ;; along with GNU Emacs; see the file COPYING. If not, write to |
14505 | 25 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
26 ;; Boston, MA 02111-1307, USA. | |
879 | 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 ;; | |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
54 ;; If there are multiple authors, they should be listed on continuation |
879 | 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. | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
72 ;; The idea behind these two fields is to be able to write a Lisp function |
879 | 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 | |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
81 ;; at a different version of the file than the one they're accustomed to. This |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
82 ;; may be an RCS or SCCS header. |
879 | 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) | |
11035 | 90 ;; for finding Emacs Lisp code related to a topic. |
879 | 91 ;; |
5221
50e623c19fff
(Bogus-Bureaucratic-Cruft): Changed to `X-Bogus-Bureaucratic-Cruft'.
Noah Friedman <friedman@splode.com>
parents:
4291
diff
changeset
|
92 ;; * X-Bogus-Bureaucratic-Cruft line --- this is a joke and an example |
50e623c19fff
(Bogus-Bureaucratic-Cruft): Changed to `X-Bogus-Bureaucratic-Cruft'.
Noah Friedman <friedman@splode.com>
parents:
4291
diff
changeset
|
93 ;; of a comment header. Headers starting with `X-' should never be used |
50e623c19fff
(Bogus-Bureaucratic-Cruft): Changed to `X-Bogus-Bureaucratic-Cruft'.
Noah Friedman <friedman@splode.com>
parents:
4291
diff
changeset
|
94 ;; for any real purpose; this is the way to safely add random headers |
50e623c19fff
(Bogus-Bureaucratic-Cruft): Changed to `X-Bogus-Bureaucratic-Cruft'.
Noah Friedman <friedman@splode.com>
parents:
4291
diff
changeset
|
95 ;; without invoking the wrath of any program. |
879 | 96 ;; |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
97 ;; * Commentary line --- enables Lisp code to find the developer's and |
879 | 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 ;; | |
11035 | 103 ;; * Code line --- exists so Lisp can know where commentary and/or |
879 | 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 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
116 ;;; Variables: |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
117 |
21365 | 118 (defgroup lisp-mnt nil |
119 "Minor mode for Emacs Lisp maintainers." | |
120 :prefix "lm-" | |
121 :group 'maint) | |
122 | |
123 (defcustom lm-header-prefix "^;;*[ \t]+\\(@\(#\)\\)?[ \t]*\\([\$]\\)?" | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
124 "Prefix that is ignored before the tag. |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
125 For example, you can write the 1st line synopsis string and headers like this |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
126 in your Lisp package: |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
127 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
128 ;; @(#) package.el -- pacakge description |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
129 ;; |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
130 ;; @(#) $Maintainer: Person Foo Bar $ |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
131 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
132 The @(#) construct is used by unix what(1) and |
21365 | 133 then $identifier: doc string $ is used by GNU ident(1)" |
134 :type 'regexp | |
135 :group 'lisp-mnt) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
136 |
21365 | 137 (defcustom lm-comment-column 16 |
138 "Column used for placing formatted output." | |
139 :type 'integer | |
140 :group 'lisp-mnt) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
141 |
21365 | 142 (defcustom lm-commentary-header "Commentary\\|Documentation" |
143 "Regexp which matches start of documentation section." | |
144 :type 'regexp | |
145 :group 'lisp-mnt) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
146 |
21365 | 147 (defcustom lm-history-header "Change Log\\|History" |
148 "Regexp which matches the start of code log section." | |
149 :type 'regexp | |
150 :group 'lisp-mnt) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
151 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
152 ;;; Functions: |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
153 |
879 | 154 ;; These functions all parse the headers of the current buffer |
155 | |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
156 (defun lm-get-header-re (header &optional mode) |
20637 | 157 "Return regexp for matching HEADER. |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
158 If called with optional MODE and with value `section', |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
159 return section regexp instead." |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
160 (cond ((eq mode 'section) |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
161 (concat "^;;;;* " header ":[ \t]*$")) |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
162 (t |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
163 (concat lm-header-prefix header ":[ \t]*")))) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
164 |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
165 (defun lm-get-package-name () |
20637 | 166 "Return package name by looking at the first line." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
167 (save-excursion |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
168 (goto-char (point-min)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
169 (if (and (looking-at (concat lm-header-prefix)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
170 (progn (goto-char (match-end 0)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
171 (looking-at "\\([^\t ]+\\)") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
172 (match-end 1))) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
173 (match-string-no-properties 1)))) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
174 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
175 (defun lm-section-mark (header &optional after) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
176 "Return the buffer location of a given section start marker. |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
177 The HEADER is the section mark string to search for. |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
178 If AFTER is non-nil, return the location of the next line." |
879 | 179 (save-excursion |
180 (let ((case-fold-search t)) | |
181 (goto-char (point-min)) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
182 (if (re-search-forward (lm-get-header-re header 'section) nil t) |
879 | 183 (progn |
184 (beginning-of-line) | |
2528
df68ddbcc2f1
(lm-commentary-region): Gone.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2352
diff
changeset
|
185 (if after (forward-line 1)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
186 (point)))))) |
879 | 187 |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
188 (defsubst lm-code-mark () |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
189 "Return the buffer location of the `Code' start marker." |
879 | 190 (lm-section-mark "Code")) |
191 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
192 (defsubst lm-commentary-mark () |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
193 "Return the buffer location of the `Commentary' start marker." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
194 (lm-section-mark lm-commentary-header)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
195 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
196 (defsubst lm-history-mark () |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
197 "Return the buffer location of the `History' start marker." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
198 (lm-section-mark lm-history-header)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
199 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
200 (defun lm-header (header) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
201 "Return the contents of the header named HEADER." |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
202 (goto-char (point-min)) |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
203 (let ((case-fold-search t)) |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
204 (if (and (re-search-forward (lm-get-header-re header) (lm-code-mark) t) |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
205 ;; RCS ident likes format "$identifier: data$" |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
206 (looking-at "\\([^$\n]+\\)") |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
207 (match-end 1)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
208 (match-string-no-properties 1)))) |
879 | 209 |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
210 (defun lm-header-multiline (header) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
211 "Return the contents of the header named HEADER, with continuation lines. |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
212 The returned value is a list of strings, one per line." |
879 | 213 (save-excursion |
214 (goto-char (point-min)) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
215 (let ((res (lm-header header))) |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
216 (when res |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
217 (setq res (list res)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
218 (forward-line 1) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
219 (while (and (looking-at (concat lm-header-prefix "[\t ]+")) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
220 (progn |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
221 (goto-char (match-end 0)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
222 (looking-at "\\(.*\\)")) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
223 (match-end 1)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
224 (setq res (cons (match-string-no-properties 1) res)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
225 (forward-line 1))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
226 res))) |
879 | 227 |
228 ;; These give us smart access to the header fields and commentary | |
229 | |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
230 (defmacro lm-with-file (file &rest body) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
231 (let ((filesym (make-symbol "file"))) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
232 `(save-excursion |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
233 (let ((,filesym ,file)) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
234 (if ,filesym (set-buffer (find-file-noselect ,filesym))) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
235 (prog1 (progn ,@body) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
236 (if (and ,filesym (not (get-buffer-window (current-buffer) t))) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
237 (kill-buffer (current-buffer)))))))) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
238 (put 'lm-with-file 'lisp-indent-function 1) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
239 (put 'lm-with-file 'edebug-form-spec t) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
240 |
879 | 241 (defun lm-summary (&optional file) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
242 "Return the one-line summary of file FILE, or current buffer if FILE is nil." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
243 (lm-with-file file |
879 | 244 (goto-char (point-min)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
245 (if (and (looking-at lm-header-prefix) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
246 (progn (goto-char (match-end 0)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
247 (looking-at "[^ ]+[ \t]+--+[ \t]+\\(.*\\)"))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
248 (let ((summary (match-string-no-properties 1))) |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
249 ;; Strip off -*- specifications. |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
250 (if (string-match "[ \t]*-\\*-.*-\\*-" summary) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
251 (substring summary 0 (match-beginning 0)) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
252 summary))))) |
879 | 253 |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
254 (defun lm-crack-address (x) |
20637 | 255 "Split up an email address X into full name and real email address. |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
256 The value is a cons of the form (FULLNAME . ADDRESS)." |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
257 (cond ((string-match "\\(.+\\) [(<]\\(\\S-+@\\S-+\\)[>)]" x) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
258 (cons (match-string 1 x) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
259 (match-string 2 x))) |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
260 ((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
261 (cons (match-string 2 x) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
262 (match-string 1 x))) |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
263 ((string-match "\\S-+@\\S-+" x) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
264 (cons nil x)) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
265 (t |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
266 (cons x nil)))) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
267 |
879 | 268 (defun lm-authors (&optional file) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
269 "Return the author list of file FILE, or current buffer if FILE is nil. |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
270 Each element of the list is a cons; the car is the full name, |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
271 the cdr is an email address." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
272 (lm-with-file file |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
273 (let ((authorlist (lm-header-multiline "author"))) |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
274 (mapcar 'lm-crack-address authorlist)))) |
879 | 275 |
276 (defun lm-maintainer (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
277 "Return the maintainer of file FILE, or current buffer if FILE is nil. |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
278 The return value has the form (NAME . ADDRESS)." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
279 (lm-with-file file |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
280 (let ((maint (lm-header "maintainer"))) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
281 (if maint |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
282 (lm-crack-address maint) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
283 (car (lm-authors)))))) |
879 | 284 |
285 (defun lm-creation-date (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
286 "Return the created date given in file FILE, or current buffer if FILE is nil." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
287 (lm-with-file file |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
288 (lm-header "created"))) |
879 | 289 |
28376
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
290 (defun lm-last-modified-date (&optional file iso-date) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
291 "Return the modify-date given in file FILE, or current buffer if FILE is nil. |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
292 ISO-DATE non-nil means return the date in ISO 8601 format." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
293 (lm-with-file file |
28376
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
294 (when (progn (goto-char (point-min)) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
295 (re-search-forward |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
296 "\\$[I]d: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) " |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
297 (lm-code-mark) t)) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
298 (let ((dd (match-string 3)) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
299 (mm (match-string 2)) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
300 (yyyy (match-string 1))) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
301 (if iso-date |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
302 (format "%s-%s-%s" yyyy mm dd) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
303 (format "%s %s %s" |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
304 dd |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
305 (nth (string-to-int mm) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
306 '("" "Jan" "Feb" "Mar" "Apr" "May" "Jun" |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
307 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec")) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
308 yyyy)))))) |
879 | 309 |
310 (defun lm-version (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
311 "Return the version listed in file FILE, or current buffer if FILE is nil. |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
312 This can be found in an RCS or SCCS header." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
313 (lm-with-file file |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
314 (or (lm-header "version") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
315 (let ((header-max (lm-code-mark))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
316 (goto-char (point-min)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
317 (cond |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
318 ;; Look for an RCS header |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
319 ((re-search-forward "\\$[I]d: [^ ]+ \\([^ ]+\\) " header-max t) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
320 (match-string-no-properties 1)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
321 ((re-search-forward "\\$Revision: +\\([^ ]+\\) " header-max t) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
322 (match-string-no-properties 1)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
323 ;; Look for an SCCS header |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
324 ((re-search-forward |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
325 (concat |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
326 (regexp-quote "@(#)") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
327 (regexp-quote (file-name-nondirectory (buffer-file-name))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
328 "\t\\([012345679.]*\\)") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
329 header-max t) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
330 (match-string-no-properties 1))))))) |
879 | 331 |
332 (defun lm-keywords (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
333 "Return the keywords given in file FILE, or current buffer if FILE is nil." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
334 (lm-with-file file |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
335 (let ((keywords (lm-header "keywords"))) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
336 (and keywords (downcase keywords))))) |
879 | 337 |
338 (defun lm-adapted-by (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
339 "Return the adapted-by names in file FILE, or current buffer if FILE is nil. |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
340 This is the name of the person who cleaned up this package for |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
341 distribution." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
342 (lm-with-file file |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
343 (lm-header "adapted-by"))) |
879 | 344 |
2528
df68ddbcc2f1
(lm-commentary-region): Gone.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2352
diff
changeset
|
345 (defun lm-commentary (&optional file) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
346 "Return the commentary in file FILE, or current buffer if FILE is nil. |
24219 | 347 The value is returned as a string. In the file, the commentary starts |
348 with the tag `Commentary' or `Documentation' and ends with one of the | |
349 tags `Code', `Change Log' or `History'." | |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
350 (lm-with-file file |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
351 (let ((commentary (lm-commentary-mark)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
352 (change-log (lm-history-mark)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
353 (code (lm-code-mark))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
354 (cond |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
355 ((and commentary change-log) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
356 (buffer-substring-no-properties commentary change-log)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
357 ((and commentary code) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
358 (buffer-substring-no-properties commentary code)))))) |
879 | 359 |
360 ;;; Verification and synopses | |
361 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
362 (defun lm-insert-at-column (col &rest strings) |
20637 | 363 "Insert, at column COL, list of STRINGS." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
364 (if (> (current-column) col) (insert "\n")) |
20127 | 365 (move-to-column col t) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
366 (apply 'insert strings)) |
879 | 367 |
24219 | 368 (defun lm-verify (&optional file showok verb) |
879 | 369 "Check that the current buffer (or FILE if given) is in proper format. |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
370 If FILE is a directory, recurse on its files and generate a report in |
879 | 371 a temporary buffer." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
372 (interactive) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
373 (let* ((verb (or verb (interactive-p))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
374 (ret (and verb "Ok.")) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
375 name) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
376 (if (and file (file-directory-p file)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
377 (setq ret |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
378 (with-temp-buffer |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
379 (mapcar |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
380 (lambda (f) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
381 (if (string-match ".*\\.el\\'" f) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
382 (let ((status (lm-verify f))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
383 (insert f ":") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
384 (if status |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
385 (lm-insert-at-column lm-comment-column status |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
386 "\n") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
387 (if showok |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
388 (lm-insert-at-column lm-comment-column |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
389 "OK\n")))))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
390 (directory-files file)))) |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
391 (lm-with-file file |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
392 (setq name (lm-get-package-name)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
393 (setq ret |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
394 (cond |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
395 ((null name) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
396 "Can't find a package NAME") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
397 ((not (lm-authors)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
398 "Author: tag missing.") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
399 ((not (lm-maintainer)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
400 "Maintainer: tag missing.") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
401 ((not (lm-summary)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
402 "Can't find a one-line 'Summary' description") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
403 ((not (lm-keywords)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
404 "Keywords: tag missing.") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
405 ((not (lm-commentary-mark)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
406 "Can't find a 'Commentary' section marker.") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
407 ((not (lm-history-mark)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
408 "Can't find a 'History' section marker.") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
409 ((not (lm-code-mark)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
410 "Can't find a 'Code' section marker") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
411 ((progn |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
412 (goto-char (point-max)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
413 (not |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
414 (re-search-backward |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
415 (concat "^;;;[ \t]+" name "[ \t]+ends here[ \t]*$" |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
416 "\\|^;;;[ \t]+ End of file[ \t]+" name) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
417 nil t))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
418 (format "Can't find a footer line for [%s]" name)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
419 (t |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
420 ret))))) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
421 (if verb |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
422 (message ret)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
423 ret)) |
879 | 424 |
425 (defun lm-synopsis (&optional file showall) | |
426 "Generate a synopsis listing for the buffer or the given FILE if given. | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
427 If FILE is a directory, recurse on its files and generate a report in |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
428 a temporary buffer. If SHOWALL is non-nil, also generate a line for files |
879 | 429 which do not include a recognizable synopsis." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
430 (interactive |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
431 (list |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
432 (read-file-name "Synopsis for (file or dir): "))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
433 |
879 | 434 (if (and file (file-directory-p file)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
435 (with-temp-buffer |
879 | 436 (mapcar |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
437 (lambda (f) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
438 (if (string-match "\\.el\\'" f) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
439 (let ((syn (lm-synopsis f))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
440 (if syn |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
441 (progn |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
442 (insert f ":") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
443 (lm-insert-at-column lm-comment-column syn "\n")) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
444 (when showall |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
445 (insert f ":") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
446 (lm-insert-at-column lm-comment-column "NA\n")))))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
447 (directory-files file))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
448 (save-excursion |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
449 (if file |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
450 (find-file file)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
451 (prog1 |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
452 (lm-summary) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
453 (if file |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
454 (kill-buffer (current-buffer))))))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
455 |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
456 (eval-when-compile (defvar report-emacs-bug-address)) |
879 | 457 |
458 (defun lm-report-bug (topic) | |
459 "Report a bug in the package currently being visited to its maintainer. | |
20637 | 460 Prompts for bug subject TOPIC. Leaves you in a mail buffer." |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
461 (interactive "sBug Subject: ") |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
462 (require 'emacsbug) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
463 (let ((package (lm-get-package-name)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
464 (addr (lm-maintainer)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
465 (version (lm-version))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
466 (compose-mail (if addr |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
467 (concat (car addr) " <" (cdr addr) ">") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
468 report-emacs-bug-address) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
469 topic) |
879 | 470 (goto-char (point-max)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
471 (insert "\nIn " package) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
472 (if version |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
473 (insert " version " version)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
474 (newline 2) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
475 (message |
879 | 476 (substitute-command-keys "Type \\[mail-send] to send bug report.")))) |
477 | |
478 (provide 'lisp-mnt) | |
479 | |
480 ;;; lisp-mnt.el ends here |