Mercurial > emacs
annotate lisp/emacs-lisp/lisp-mnt.el @ 26340:f1ae5b57d9db
Changed the mail addess of the maintainer.
author | Francesco Potortì <pot@gnu.org> |
---|---|
date | Wed, 03 Nov 1999 23:13:10 +0000 |
parents | 0bb9e5990c22 |
children | 1006a8324029 |
rev | line source |
---|---|
879 | 1 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers |
2 | |
20637 | 3 ;; Copyright (C) 1992, 1994, 1997 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 | |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
116 (require 'emacsbug) |
879 | 117 |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
118 ;;; Variables: |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
119 |
21365 | 120 (defgroup lisp-mnt nil |
121 "Minor mode for Emacs Lisp maintainers." | |
122 :prefix "lm-" | |
123 :group 'maint) | |
124 | |
125 (defcustom lm-header-prefix "^;;*[ \t]+\\(@\(#\)\\)?[ \t]*\\([\$]\\)?" | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
126 "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
|
127 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
|
128 in your Lisp package: |
14501
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 ;; @(#) package.el -- pacakge description |
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 ;; @(#) $Maintainer: Person Foo Bar $ |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
133 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
134 The @(#) construct is used by unix what(1) and |
21365 | 135 then $identifier: doc string $ is used by GNU ident(1)" |
136 :type 'regexp | |
137 :group 'lisp-mnt) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
138 |
21365 | 139 (defcustom lm-comment-column 16 |
140 "Column used for placing formatted output." | |
141 :type 'integer | |
142 :group 'lisp-mnt) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
143 |
21365 | 144 (defcustom lm-commentary-header "Commentary\\|Documentation" |
145 "Regexp which matches start of documentation section." | |
146 :type 'regexp | |
147 :group 'lisp-mnt) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
148 |
21365 | 149 (defcustom lm-history-header "Change Log\\|History" |
150 "Regexp which matches the start of code log section." | |
151 :type 'regexp | |
152 :group 'lisp-mnt) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
153 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
154 ;;; Functions: |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
155 |
879 | 156 ;; These functions all parse the headers of the current buffer |
157 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
158 (defsubst lm-get-header-re (header &optional mode) |
20637 | 159 "Return regexp for matching HEADER. |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
160 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
|
161 return section regexp instead." |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
162 (cond ((eq mode 'section) |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
163 (concat "^;;;;* " header ":[ \t]*$")) |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
164 (t |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
165 (concat lm-header-prefix header ":[ \t]*")))) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
166 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
167 (defsubst lm-get-package-name () |
20637 | 168 "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
|
169 (save-excursion |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
170 (goto-char (point-min)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
171 (if (and (looking-at (concat lm-header-prefix)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
172 (progn (goto-char (match-end 0)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
173 (looking-at "\\([^\t ]+\\)") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
174 (match-end 1))) |
20637 | 175 (buffer-substring-no-properties (match-beginning 1) (match-end 1)) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
176 ))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
177 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
178 (defun lm-section-mark (header &optional after) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
179 "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
|
180 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
|
181 If AFTER is non-nil, return the location of the next line." |
879 | 182 (save-excursion |
183 (let ((case-fold-search t)) | |
184 (goto-char (point-min)) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
185 (if (re-search-forward (lm-get-header-re header 'section) nil t) |
879 | 186 (progn |
187 (beginning-of-line) | |
2528
df68ddbcc2f1
(lm-commentary-region): Gone.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2352
diff
changeset
|
188 (if after (forward-line 1)) |
879 | 189 (point)) |
190 nil)))) | |
191 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
192 (defsubst lm-code-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 `Code' start marker." |
879 | 194 (lm-section-mark "Code")) |
195 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
196 (defsubst lm-commentary-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 `Commentary' start marker." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
198 (lm-section-mark lm-commentary-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 (defsubst lm-history-mark () |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
201 "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
|
202 (lm-section-mark lm-history-header)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
203 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
204 (defun lm-header (header) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
205 "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
|
206 (goto-char (point-min)) |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
207 (let ((case-fold-search t)) |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
208 (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
|
209 ;; RCS ident likes format "$identifier: data$" |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
210 (looking-at "\\([^$\n]+\\)") |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
211 (match-end 1)) |
20637 | 212 (buffer-substring-no-properties (match-beginning 1) (match-end 1)) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
213 nil))) |
879 | 214 |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
215 (defun lm-header-multiline (header) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
216 "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
|
217 The returned value is a list of strings, one per line." |
879 | 218 (save-excursion |
219 (goto-char (point-min)) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
220 (let ((res (lm-header header))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
221 (cond |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
222 (res |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
223 (setq res (list res)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
224 (forward-line 1) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
225 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
226 (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
|
227 (progn |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
228 (goto-char (match-end 0)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
229 (looking-at "\\(.*\\)")) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
230 (match-end 1)) |
20637 | 231 (setq res (cons (buffer-substring-no-properties |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
232 (match-beginning 1) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
233 (match-end 1)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
234 res)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
235 (forward-line 1)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
236 )) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
237 res |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
238 ))) |
879 | 239 |
240 ;; These give us smart access to the header fields and commentary | |
241 | |
242 (defun lm-summary (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
243 "Return the one-line summary of file FILE, or current buffer if FILE is nil." |
879 | 244 (save-excursion |
245 (if file | |
246 (find-file file)) | |
247 (goto-char (point-min)) | |
248 (prog1 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
249 (if (and |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
250 (looking-at lm-header-prefix) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
251 (progn (goto-char (match-end 0)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
252 (looking-at "[^ ]+[ \t]+--+[ \t]+\\(.*\\)"))) |
23813
198226daae3b
(lm-summary): Strip off -*-
Andreas Schwab <schwab@suse.de>
parents:
23585
diff
changeset
|
253 (let ((summary (buffer-substring-no-properties (match-beginning 1) |
198226daae3b
(lm-summary): Strip off -*-
Andreas Schwab <schwab@suse.de>
parents:
23585
diff
changeset
|
254 (match-end 1)))) |
198226daae3b
(lm-summary): Strip off -*-
Andreas Schwab <schwab@suse.de>
parents:
23585
diff
changeset
|
255 ;; Strip off -*- specifications. |
198226daae3b
(lm-summary): Strip off -*-
Andreas Schwab <schwab@suse.de>
parents:
23585
diff
changeset
|
256 (if (string-match "[ \t]*-\\*-.*-\\*-" summary) |
198226daae3b
(lm-summary): Strip off -*-
Andreas Schwab <schwab@suse.de>
parents:
23585
diff
changeset
|
257 (substring summary 0 (match-beginning 0)) |
198226daae3b
(lm-summary): Strip off -*-
Andreas Schwab <schwab@suse.de>
parents:
23585
diff
changeset
|
258 summary))) |
879 | 259 (if file |
260 (kill-buffer (current-buffer))) | |
261 ))) | |
262 | |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
263 (defun lm-crack-address (x) |
20637 | 264 "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
|
265 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
|
266 (cond ((string-match "\\(.+\\) [(<]\\(\\S-+@\\S-+\\)[>)]" x) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
267 (cons (substring x (match-beginning 1) (match-end 1)) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
268 (substring x (match-beginning 2) (match-end 2)))) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
269 ((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
270 (cons (substring x (match-beginning 2) (match-end 2)) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
271 (substring x (match-beginning 1) (match-end 1)))) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
272 ((string-match "\\S-+@\\S-+" x) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
273 (cons nil x)) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
274 (t |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
275 (cons x nil)))) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
276 |
879 | 277 (defun lm-authors (&optional file) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
278 "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
|
279 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
|
280 the cdr is an email address." |
879 | 281 (save-excursion |
282 (if file | |
283 (find-file file)) | |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
284 (let ((authorlist (lm-header-multiline "author"))) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
285 (prog1 |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
286 (mapcar 'lm-crack-address authorlist) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
287 (if file |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
288 (kill-buffer (current-buffer))) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
289 )))) |
879 | 290 |
291 (defun lm-maintainer (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
292 "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
|
293 The return value has the form (NAME . ADDRESS)." |
879 | 294 (save-excursion |
295 (if file | |
296 (find-file file)) | |
297 (prog1 | |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
298 (let ((maint (lm-header "maintainer"))) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
299 (if maint |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
300 (lm-crack-address maint) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
301 (car (lm-authors)))) |
879 | 302 (if file |
303 (kill-buffer (current-buffer))) | |
304 ))) | |
305 | |
306 (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
|
307 "Return the created date given in file FILE, or current buffer if FILE is nil." |
879 | 308 (save-excursion |
309 (if file | |
310 (find-file file)) | |
311 (prog1 | |
312 (lm-header "created") | |
313 (if file | |
314 (kill-buffer (current-buffer))) | |
315 ))) | |
316 | |
317 | |
318 (defun lm-last-modified-date (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
319 "Return the modify-date given in file FILE, or current buffer if FILE is nil." |
879 | 320 (save-excursion |
321 (if file | |
322 (find-file file)) | |
323 (prog1 | |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
324 (if (progn |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
325 (goto-char (point-min)) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
326 (re-search-forward |
18401
c3b46f285d54
(lm-version, lm-last-modified-date):
Richard M. Stallman <rms@gnu.org>
parents:
14512
diff
changeset
|
327 "\\$[I]d: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) " |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
328 (lm-code-mark) t)) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
329 (format "%s %s %s" |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
330 (buffer-substring (match-beginning 3) (match-end 3)) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
331 (nth (string-to-int |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
332 (buffer-substring (match-beginning 2) (match-end 2))) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
333 '("" "Jan" "Feb" "Mar" "Apr" "May" "Jun" |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
334 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec")) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
335 (buffer-substring (match-beginning 1) (match-end 1)) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
336 )) |
879 | 337 (if file |
338 (kill-buffer (current-buffer))) | |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
339 ))) |
879 | 340 |
341 (defun lm-version (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
342 "Return the version listed 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
|
343 This can befound in an RCS or SCCS header to crack it out of." |
879 | 344 (save-excursion |
345 (if file | |
346 (find-file file)) | |
347 (prog1 | |
348 (or | |
349 (lm-header "version") | |
350 (let ((header-max (lm-code-mark))) | |
351 (goto-char (point-min)) | |
352 (cond | |
353 ;; Look for an RCS header | |
18401
c3b46f285d54
(lm-version, lm-last-modified-date):
Richard M. Stallman <rms@gnu.org>
parents:
14512
diff
changeset
|
354 ((re-search-forward "\\$[I]d: [^ ]+ \\([^ ]+\\) " header-max t) |
20637 | 355 (buffer-substring-no-properties (match-beginning 1) (match-end 1))) |
879 | 356 |
357 ;; Look for an SCCS header | |
358 ((re-search-forward | |
359 (concat | |
360 (regexp-quote "@(#)") | |
361 (regexp-quote (file-name-nondirectory (buffer-file-name))) | |
362 "\t\\([012345679.]*\\)") | |
363 header-max t) | |
20637 | 364 (buffer-substring-no-properties (match-beginning 1) (match-end 1))) |
879 | 365 |
366 (t nil)))) | |
367 (if file | |
368 (kill-buffer (current-buffer))) | |
369 ))) | |
370 | |
371 (defun lm-keywords (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
372 "Return the keywords given in file FILE, or current buffer if FILE is nil." |
879 | 373 (save-excursion |
374 (if file | |
375 (find-file file)) | |
376 (prog1 | |
377 (let ((keywords (lm-header "keywords"))) | |
378 (and keywords (downcase keywords))) | |
379 (if file | |
380 (kill-buffer (current-buffer))) | |
381 ))) | |
382 | |
383 (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
|
384 "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
|
385 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
|
386 distribution." |
879 | 387 (save-excursion |
388 (if file | |
389 (find-file file)) | |
390 (prog1 | |
391 (lm-header "adapted-by") | |
392 (if file | |
393 (kill-buffer (current-buffer))) | |
394 ))) | |
395 | |
2528
df68ddbcc2f1
(lm-commentary-region): Gone.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2352
diff
changeset
|
396 (defun lm-commentary (&optional file) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
397 "Return the commentary in file FILE, or current buffer if FILE is nil. |
24219 | 398 The value is returned as a string. In the file, the commentary starts |
399 with the tag `Commentary' or `Documentation' and ends with one of the | |
400 tags `Code', `Change Log' or `History'." | |
879 | 401 (save-excursion |
402 (if file | |
403 (find-file file)) | |
404 (prog1 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
405 (let ((commentary (lm-commentary-mark)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
406 (change-log (lm-history-mark)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
407 (code (lm-code-mark)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
408 ) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
409 (cond |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
410 ((and commentary change-log) |
20637 | 411 (buffer-substring-no-properties commentary change-log)) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
412 ((and commentary code) |
20637 | 413 (buffer-substring-no-properties commentary code)) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
414 (t |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
415 nil))) |
879 | 416 (if file |
417 (kill-buffer (current-buffer))) | |
418 ))) | |
419 | |
420 ;;; Verification and synopses | |
421 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
422 (defun lm-insert-at-column (col &rest strings) |
20637 | 423 "Insert, at column COL, list of STRINGS." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
424 (if (> (current-column) col) (insert "\n")) |
20127 | 425 (move-to-column col t) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
426 (apply 'insert strings)) |
879 | 427 |
24219 | 428 (defun lm-verify (&optional file showok verb) |
879 | 429 "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
|
430 If FILE is a directory, recurse on its files and generate a report in |
879 | 431 a temporary buffer." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
432 (interactive) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
433 (let* ((verb (or verb (interactive-p))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
434 ret |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
435 name |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
436 ) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
437 (if verb |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
438 (setq ret "Ok.")) ;init value |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
439 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
440 (if (and file (file-directory-p file)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
441 (setq |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
442 ret |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
443 (progn |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
444 (switch-to-buffer (get-buffer-create "*lm-verify*")) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
445 (erase-buffer) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
446 (mapcar |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
447 '(lambda (f) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
448 (if (string-match ".*\\.el$" f) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
449 (let ((status (lm-verify f))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
450 (if status |
879 | 451 (progn |
452 (insert f ":") | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
453 (lm-insert-at-column lm-comment-column status "\n")) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
454 (and showok |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
455 (progn |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
456 (insert f ":") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
457 (lm-insert-at-column lm-comment-column "OK\n"))))))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
458 (directory-files file)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
459 )) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
460 (save-excursion |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
461 (if file |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
462 (find-file file)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
463 (setq name (lm-get-package-name)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
464 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
465 (setq |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
466 ret |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
467 (prog1 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
468 (cond |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
469 ((null name) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
470 "Can't find a package NAME") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
471 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
472 ((not (lm-authors)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
473 "Author: tag missing.") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
474 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
475 ((not (lm-maintainer)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
476 "Maintainer: tag missing.") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
477 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
478 ((not (lm-summary)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
479 "Can't find a one-line 'Summary' description") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
480 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
481 ((not (lm-keywords)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
482 "Keywords: tag missing.") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
483 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
484 ((not (lm-commentary-mark)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
485 "Can't find a 'Commentary' section marker.") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
486 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
487 ((not (lm-history-mark)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
488 "Can't find a 'History' section marker.") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
489 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
490 ((not (lm-code-mark)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
491 "Can't find a 'Code' section marker") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
492 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
493 ((progn |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
494 (goto-char (point-max)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
495 (not |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
496 (re-search-backward |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
497 (concat "^;;;[ \t]+" name "[ \t]+ends here[ \t]*$" |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
498 "\\|^;;;[ \t]+ End of file[ \t]+" name) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
499 nil t |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
500 ))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
501 (format "Can't find a footer line for [%s]" name)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
502 (t |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
503 ret)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
504 (if file |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
505 (kill-buffer (current-buffer))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
506 )))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
507 (if verb |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
508 (message ret)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
509 ret |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
510 )) |
879 | 511 |
512 (defun lm-synopsis (&optional file showall) | |
513 "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
|
514 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
|
515 a temporary buffer. If SHOWALL is non-nil, also generate a line for files |
879 | 516 which do not include a recognizable synopsis." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
517 (interactive |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
518 (list |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
519 (read-file-name "Synopsis for (file or dir): "))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
520 |
879 | 521 (if (and file (file-directory-p file)) |
522 (progn | |
523 (switch-to-buffer (get-buffer-create "*lm-verify*")) | |
524 (erase-buffer) | |
525 (mapcar | |
526 '(lambda (f) | |
527 (if (string-match ".*\\.el$" f) | |
528 (let ((syn (lm-synopsis f))) | |
529 (if syn | |
530 (progn | |
531 (insert f ":") | |
14492
0ebde55bb21d
(lm-insert-at-column): Renamed from insert-at-column.
Richard M. Stallman <rms@gnu.org>
parents:
14320
diff
changeset
|
532 (lm-insert-at-column lm-comment-column syn "\n")) |
879 | 533 (and showall |
534 (progn | |
535 (insert f ":") | |
14492
0ebde55bb21d
(lm-insert-at-column): Renamed from insert-at-column.
Richard M. Stallman <rms@gnu.org>
parents:
14320
diff
changeset
|
536 (lm-insert-at-column lm-comment-column "NA\n"))))))) |
879 | 537 (directory-files file)) |
538 ) | |
539 (save-excursion | |
540 (if file | |
541 (find-file file)) | |
542 (prog1 | |
543 (lm-summary) | |
544 (if file | |
545 (kill-buffer (current-buffer))) | |
546 )))) | |
547 | |
548 (defun lm-report-bug (topic) | |
549 "Report a bug in the package currently being visited to its maintainer. | |
20637 | 550 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
|
551 (interactive "sBug Subject: ") |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
552 (let ((package (lm-get-package-name)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
553 (addr (lm-maintainer)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
554 (version (lm-version))) |
5359
c87a767f137e
(lm-report-bug): lm-maintainer returns a cons; convert it to a string.
Richard M. Stallman <rms@gnu.org>
parents:
5358
diff
changeset
|
555 (mail nil |
c87a767f137e
(lm-report-bug): lm-maintainer returns a cons; convert it to a string.
Richard M. Stallman <rms@gnu.org>
parents:
5358
diff
changeset
|
556 (if addr |
c87a767f137e
(lm-report-bug): lm-maintainer returns a cons; convert it to a string.
Richard M. Stallman <rms@gnu.org>
parents:
5358
diff
changeset
|
557 (concat (car addr) " <" (cdr addr) ">") |
23585 | 558 report-emacs-bug-address) |
5359
c87a767f137e
(lm-report-bug): lm-maintainer returns a cons; convert it to a string.
Richard M. Stallman <rms@gnu.org>
parents:
5358
diff
changeset
|
559 topic) |
879 | 560 (goto-char (point-max)) |
561 (insert "\nIn " | |
562 package | |
5358
98efb3231d81
(lm-report-bug): Don't crash if version is nil.
Richard M. Stallman <rms@gnu.org>
parents:
5221
diff
changeset
|
563 (if version (concat " version " version) "") |
879 | 564 "\n\n") |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
565 (message |
879 | 566 (substitute-command-keys "Type \\[mail-send] to send bug report.")))) |
567 | |
568 (provide 'lisp-mnt) | |
569 | |
570 ;;; lisp-mnt.el ends here | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
571 |