Mercurial > emacs
annotate lisp/emacs-lisp/lisp-mnt.el @ 67892:e188efbb47ee
(Using Customize): New node.
author | Romain Francoise <romain@orebokech.com> |
---|---|
date | Thu, 29 Dec 2005 14:08:09 +0000 |
parents | c45ae2a74f0f |
children | 067115a6e738 fa0da9b57058 |
rev | line source |
---|---|
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
1 ;;; lisp-mnt.el --- utility functions for Emacs Lisp maintainers |
879 | 2 |
64751
5b1a238fcbb4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64085
diff
changeset
|
3 ;; Copyright (C) 1992, 1994, 1997, 2000, 2001, 2002, 2003, 2004, |
5b1a238fcbb4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64085
diff
changeset
|
4 ;; 2005 Free Software Foundation, Inc. |
879 | 5 |
6 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
34567 | 7 ;; Maintainer: FSF |
879 | 8 ;; Created: 14 Jul 1992 |
9 ;; Keywords: docs | |
5221
50e623c19fff
(Bogus-Bureaucratic-Cruft): Changed to `X-Bogus-Bureaucratic-Cruft'.
Noah Friedman <friedman@splode.com>
parents:
4291
diff
changeset
|
10 ;; X-Bogus-Bureaucratic-Cruft: Gruad will get you if you don't watch out! |
879 | 11 |
12 ;; This file is part of GNU Emacs. | |
13 | |
14 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
15 ;; it under the terms of the GNU General Public License as published by | |
12244 | 16 ;; the Free Software Foundation; either version 2, or (at your option) |
879 | 17 ;; any later version. |
18 | |
19 ;; GNU Emacs is distributed in the hope that it will be useful, | |
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
22 ;; GNU General Public License for more details. | |
23 | |
24 ;; You should have received a copy of the GNU General Public License | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
25 ;; along with GNU Emacs; see the file COPYING. If not, write to |
64085 | 26 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
27 ;; Boston, MA 02110-1301, USA. | |
879 | 28 |
29 ;;; Commentary: | |
30 | |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
31 ;; This library adds some services to Emacs-Lisp editing mode. |
879 | 32 ;; |
33 ;; First, it knows about the header conventions for library packages. | |
34 ;; One entry point supports generating synopses from a library directory. | |
35 ;; Another can be used to check for missing headers in library files. | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
36 ;; |
879 | 37 ;; Another entry point automatically addresses bug mail to a package's |
38 ;; maintainer or author. | |
39 | |
40 ;; This file can be loaded by your lisp-mode-hook. Have it (require 'lisp-mnt) | |
41 | |
42 ;; This file is an example of the header conventions. Note the following | |
43 ;; features: | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
44 ;; |
879 | 45 ;; * Header line --- makes it possible to extract a one-line summary of |
46 ;; the package's uses automatically for use in library synopses, KWIC | |
47 ;; indexes and the like. | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
48 ;; |
879 | 49 ;; Format is three semicolons, followed by the filename, followed by |
50 ;; three dashes, followed by the summary. All fields space-separated. | |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
51 ;; |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
52 ;; * A blank line |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
53 ;; |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
54 ;; * Copyright line, which looks more or less like this: |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
55 ;; |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
56 ;; ;; Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc. |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
57 ;; |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
58 ;; * A blank line |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
59 ;; |
879 | 60 ;; * Author line --- contains the name and net address of at least |
61 ;; the principal author. | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
62 ;; |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
63 ;; If there are multiple authors, they should be listed on continuation |
879 | 64 ;; lines led by ;;<TAB>, like this: |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
65 ;; |
879 | 66 ;; ;; Author: Ashwin Ram <Ram-Ashwin@cs.yale.edu> |
67 ;; ;; Dave Sill <de5@ornl.gov> | |
68 ;; ;; David Lawrence <tale@pawl.rpi.edu> | |
69 ;; ;; Noah Friedman <friedman@ai.mit.edu> | |
70 ;; ;; Joe Wells <jbw@maverick.uswest.com> | |
71 ;; ;; Dave Brennan <brennan@hal.com> | |
72 ;; ;; Eric Raymond <esr@snark.thyrsus.com> | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
73 ;; |
879 | 74 ;; This field may have some special values; notably "FSF", meaning |
75 ;; "Free Software Foundation". | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
76 ;; |
879 | 77 ;; * Maintainer line --- should be a single name/address as in the Author |
78 ;; line, or an address only, or the string "FSF". If there is no maintainer | |
79 ;; line, the person(s) in the Author field are presumed to be it. The example | |
80 ;; 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
|
81 ;; The idea behind these two fields is to be able to write a Lisp function |
879 | 82 ;; that does "send mail to the author" without having to mine the name out by |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
83 ;; hand. Please be careful about surrounding the network address with <> if |
879 | 84 ;; there's also a name in the field. |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
85 ;; |
879 | 86 ;; * Created line --- optional, gives the original creation date of the |
87 ;; file. For historical interest, basically. | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
88 ;; |
879 | 89 ;; * 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
|
90 ;; 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
|
91 ;; may be an RCS or SCCS header. |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
92 ;; |
879 | 93 ;; * Adapted-By line --- this is for FSF's internal use. The person named |
94 ;; in this field was the one responsible for installing and adapting the | |
95 ;; package for the distribution. (This file doesn't have one because the | |
96 ;; author *is* one of the maintainers.) | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
97 ;; |
879 | 98 ;; * Keywords line --- used by the finder code (now under construction) |
11035 | 99 ;; for finding Emacs Lisp code related to a topic. |
879 | 100 ;; |
5221
50e623c19fff
(Bogus-Bureaucratic-Cruft): Changed to `X-Bogus-Bureaucratic-Cruft'.
Noah Friedman <friedman@splode.com>
parents:
4291
diff
changeset
|
101 ;; * 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
|
102 ;; 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
|
103 ;; 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
|
104 ;; without invoking the wrath of any program. |
879 | 105 ;; |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
106 ;; * Commentary line --- enables Lisp code to find the developer's and |
879 | 107 ;; maintainers' explanations of the package internals. |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
108 ;; |
879 | 109 ;; * Change log line --- optional, exists to terminate the commentary |
110 ;; section and start a change-log part, if one exists. | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
111 ;; |
11035 | 112 ;; * Code line --- exists so Lisp can know where commentary and/or |
879 | 113 ;; change-log sections end. |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
42139
diff
changeset
|
114 ;; |
879 | 115 ;; * Footer line --- marks end-of-file so it can be distinguished from |
116 ;; an expanded formfeed or the results of truncation. | |
117 | |
118 ;;; Change Log: | |
119 | |
120 ;; Tue Jul 14 23:44:17 1992 ESR | |
121 ;; * Created. | |
122 | |
123 ;;; Code: | |
124 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
125 ;;; Variables: |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
126 |
21365 | 127 (defgroup lisp-mnt nil |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
128 "Utility functions for Emacs Lisp maintainers." |
21365 | 129 :prefix "lm-" |
130 :group 'maint) | |
131 | |
42139
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
132 ;; At least some of these defcustoms should probably be defconsts, |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
133 ;; since they define, or are defined by, the header format. -- fx |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
134 |
31656
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
135 (defcustom lm-header-prefix "^;+[ \t]+\\(@(#)\\)?[ \t]*\\$?" |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
136 "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
|
137 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
|
138 in your Lisp package: |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
139 |
38248
569b72179168
(lm-header-prefix): Doc fix. From Pavel Janik <Pavel@Janik.cz>.
Eli Zaretskii <eliz@gnu.org>
parents:
37182
diff
changeset
|
140 ;; @(#) package.el -- package description |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
141 ;; |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
142 ;; @(#) $Maintainer: Person Foo Bar $ |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
143 |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
144 The @(#) construct is used by unix what(1) and |
21365 | 145 then $identifier: doc string $ is used by GNU ident(1)" |
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 |
42139
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
149 (defcustom lm-copyright-prefix "^\\(;+[ \t]\\)+Copyright (C) " |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
150 "Prefix that is ignored before the dates in a copyright. |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
151 Leading comment characters and whitespace should be in regexp group 1." |
34945
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
152 :type 'regexp |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
153 :group 'lisp-mnt) |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
154 |
21365 | 155 (defcustom lm-comment-column 16 |
156 "Column used for placing formatted output." | |
157 :type 'integer | |
158 :group 'lisp-mnt) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
159 |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
160 (defcustom lm-any-header ".*" |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
161 "Regexp which matches start of any section." |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
162 :type 'regexp |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
163 :group 'lisp-mnt) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
164 |
21365 | 165 (defcustom lm-commentary-header "Commentary\\|Documentation" |
166 "Regexp which matches start of documentation section." | |
167 :type 'regexp | |
168 :group 'lisp-mnt) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
169 |
39563
925776635a57
(lm-history-header): Accept `ChangeLog'.
Gerd Moellmann <gerd@gnu.org>
parents:
38248
diff
changeset
|
170 (defcustom lm-history-header "Change ?Log\\|History" |
21365 | 171 "Regexp which matches the start of code log section." |
172 :type 'regexp | |
173 :group 'lisp-mnt) | |
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 ;;; Functions: |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
176 |
879 | 177 ;; These functions all parse the headers of the current buffer |
178 | |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
179 (defun lm-get-header-re (header &optional mode) |
20637 | 180 "Return regexp for matching HEADER. |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
181 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
|
182 return section regexp instead." |
31656
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
183 (if (eq mode 'section) |
52569
e4693bed89ad
(lm-with-file): Don't visit the file,
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
184 (concat "^;;;;* \\(" header "\\):[ \t]*$") |
e4693bed89ad
(lm-with-file): Don't visit the file,
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
185 (concat lm-header-prefix "\\(" header "\\)[ \t]*:[ \t]*"))) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
186 |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
187 (defun lm-get-package-name () |
20637 | 188 "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
|
189 (save-excursion |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
190 (goto-char (point-min)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
191 (if (and (looking-at (concat lm-header-prefix)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
192 (progn (goto-char (match-end 0)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
193 (looking-at "\\([^\t ]+\\)") |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
194 (match-end 1))) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
195 (match-string-no-properties 1)))) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
196 |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
197 (defun lm-section-start (header &optional after) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
198 "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
|
199 The HEADER is the section mark string to search for. |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
200 If AFTER is non-nil, return the location of the next line. |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
201 If the given section does not exist, return nil." |
879 | 202 (save-excursion |
203 (let ((case-fold-search t)) | |
204 (goto-char (point-min)) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
205 (if (re-search-forward (lm-get-header-re header 'section) nil t) |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
206 (line-beginning-position (if after 2)))))) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
207 (defalias 'lm-section-mark 'lm-section-start) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
208 |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
209 (defun lm-section-end (header) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
210 "Return the buffer location of the end of a given section. |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
211 The HEADER is the section string marking the beginning of the |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
212 section. If the given section does not exist, return nil. |
879 | 213 |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
214 The end of the section is defined as the beginning of the next |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
215 section of the same level or lower. The function |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
216 `lisp-outline-level' is used to compute the level of a section. |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
217 If no such section exists, return the end of the buffer." |
53488
daa5c6e18f62
(lm-section-end): require outline.
Richard M. Stallman <rms@gnu.org>
parents:
52687
diff
changeset
|
218 (require 'outline) ;; for outline-regexp. |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
219 (let ((start (lm-section-start header))) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
220 (when start |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
221 (save-excursion |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
222 (goto-char start) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
223 (let ((level (lisp-outline-level)) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
224 (case-fold-search t) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
225 next-section-found) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
226 (beginning-of-line 2) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
227 (while (and (setq next-section-found |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
228 (re-search-forward |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
229 (lm-get-header-re lm-any-header 'section) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
230 nil t)) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
231 (> (save-excursion |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
232 (beginning-of-line) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
233 (lisp-outline-level)) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
234 level))) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
235 (if next-section-found |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
236 (line-beginning-position) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
237 (point-max))))))) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
238 |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
239 (defsubst lm-code-start () |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
240 "Return the buffer location of the `Code' start marker." |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
241 (lm-section-start "Code")) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
242 (defalias 'lm-code-mark 'lm-code-start) |
879 | 243 |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
244 (defsubst lm-commentary-start () |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
245 "Return the buffer location of the `Commentary' start marker." |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
246 (lm-section-start lm-commentary-header)) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
247 (defalias 'lm-commentary-mark 'lm-commentary-start) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
248 |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
249 (defsubst lm-commentary-end () |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
250 "Return the buffer location of the `Commentary' section end." |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
251 (lm-section-end lm-commentary-header)) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
252 |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
253 (defsubst lm-history-start () |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
254 "Return the buffer location of the `History' start marker." |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
255 (lm-section-start lm-history-header)) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
256 (defalias 'lm-history-mark 'lm-history-start) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
257 |
34945
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
258 (defsubst lm-copyright-mark () |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
259 "Return the buffer location of the `Copyright' line." |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
260 (save-excursion |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
261 (let ((case-fold-search t)) |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
262 (goto-char (point-min)) |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
263 (if (re-search-forward lm-copyright-prefix nil t) |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
264 (point))))) |
34945
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
265 |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
266 (defun lm-header (header) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
267 "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
|
268 (goto-char (point-min)) |
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
269 (let ((case-fold-search t)) |
31656
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
270 (when (and (re-search-forward (lm-get-header-re header) (lm-code-mark) t) |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
271 ;; RCS ident likes format "$identifier: data$" |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
272 (looking-at |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
273 (if (save-excursion |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
274 (skip-chars-backward "^$" (match-beginning 0)) |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
275 (= (point) (match-beginning 0))) |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
276 "[^\n]+" "[^$\n]+"))) |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
277 (match-string-no-properties 0)))) |
879 | 278 |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
279 (defun lm-header-multiline (header) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
280 "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
|
281 The returned value is a list of strings, one per line." |
879 | 282 (save-excursion |
283 (goto-char (point-min)) | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
284 (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
|
285 (when res |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
286 (setq res (list res)) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
287 (forward-line 1) |
31656
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
288 (while (and (or (looking-at (concat lm-header-prefix "[\t ]+")) |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
289 (and (not (looking-at |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
290 (lm-get-header-re "\\sw\\(\\sw\\|\\s_\\)*"))) |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
291 (looking-at lm-header-prefix))) |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
292 (goto-char (match-end 0)) |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
293 (looking-at ".+")) |
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
294 (setq res (cons (match-string-no-properties 0) res)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
295 (forward-line 1))) |
31656
0090ca919308
(lm-get-header-re): Allow spaces between the header and the colon.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28376
diff
changeset
|
296 (nreverse res)))) |
879 | 297 |
298 ;; These give us smart access to the header fields and commentary | |
299 | |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
300 (defmacro lm-with-file (file &rest body) |
52569
e4693bed89ad
(lm-with-file): Don't visit the file,
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
301 "Execute BODY in a buffer containing the contents of FILE. |
52687
fb1ccaa34830
(lm-with-file): When FILE is nil, run BODY in current buffer.
Richard M. Stallman <rms@gnu.org>
parents:
52569
diff
changeset
|
302 If FILE is nil, execute BODY in the current buffer." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
303 (let ((filesym (make-symbol "file"))) |
52569
e4693bed89ad
(lm-with-file): Don't visit the file,
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
304 `(let ((,filesym ,file)) |
52687
fb1ccaa34830
(lm-with-file): When FILE is nil, run BODY in current buffer.
Richard M. Stallman <rms@gnu.org>
parents:
52569
diff
changeset
|
305 (if ,filesym |
fb1ccaa34830
(lm-with-file): When FILE is nil, run BODY in current buffer.
Richard M. Stallman <rms@gnu.org>
parents:
52569
diff
changeset
|
306 (with-temp-buffer |
fb1ccaa34830
(lm-with-file): When FILE is nil, run BODY in current buffer.
Richard M. Stallman <rms@gnu.org>
parents:
52569
diff
changeset
|
307 (insert-file-contents ,filesym) |
59572
3cd31d377b69
(lm-with-file): Use Lisp mode in temp buffer.
Richard M. Stallman <rms@gnu.org>
parents:
54500
diff
changeset
|
308 (lisp-mode) |
52687
fb1ccaa34830
(lm-with-file): When FILE is nil, run BODY in current buffer.
Richard M. Stallman <rms@gnu.org>
parents:
52569
diff
changeset
|
309 ,@body) |
64751
5b1a238fcbb4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64085
diff
changeset
|
310 (save-excursion |
59572
3cd31d377b69
(lm-with-file): Use Lisp mode in temp buffer.
Richard M. Stallman <rms@gnu.org>
parents:
54500
diff
changeset
|
311 ;; Switching major modes is too drastic, so just switch |
3cd31d377b69
(lm-with-file): Use Lisp mode in temp buffer.
Richard M. Stallman <rms@gnu.org>
parents:
54500
diff
changeset
|
312 ;; temporarily to the Lisp mode syntax table. |
3cd31d377b69
(lm-with-file): Use Lisp mode in temp buffer.
Richard M. Stallman <rms@gnu.org>
parents:
54500
diff
changeset
|
313 (with-syntax-table lisp-mode-syntax-table |
3cd31d377b69
(lm-with-file): Use Lisp mode in temp buffer.
Richard M. Stallman <rms@gnu.org>
parents:
54500
diff
changeset
|
314 ,@body)))))) |
3cd31d377b69
(lm-with-file): Use Lisp mode in temp buffer.
Richard M. Stallman <rms@gnu.org>
parents:
54500
diff
changeset
|
315 |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
316 (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
|
317 (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
|
318 |
42139
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
319 ;; Fixme: Probably this should be amalgamated with copyright.el; also |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
320 ;; we need a check for ranges in copyright years. |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
321 |
34945
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
322 (defun lm-crack-copyright (&optional file) |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
323 "Return the copyright holder, and a list of copyright years. |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
324 Use the current buffer if FILE is nil. |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
325 Return argument is of the form (\"HOLDER\" \"YEAR1\" ... \"YEARN\")" |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
326 (lm-with-file file |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
327 (goto-char (lm-copyright-mark)) |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
328 (let ((holder nil) |
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
329 (years nil) |
42139
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
330 (start (point)) |
34945
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
331 (end (line-end-position))) |
42139
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
332 ;; Cope with multi-line copyright `lines'. Assume the second |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
333 ;; line is indented (with the same commenting style). |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
334 (save-excursion |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
335 (beginning-of-line 2) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
336 (let ((str (concat (match-string-no-properties 1) "[ \t]+"))) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
337 (beginning-of-line) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
338 (while (looking-at str) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
339 (setq end (line-end-position)) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
340 (beginning-of-line 2)))) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
341 ;; Make a single line and parse that. |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
342 (let ((buff (current-buffer))) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
343 (with-temp-buffer |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
344 (insert-buffer-substring buff start end) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
345 (goto-char (point-min)) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
346 (while (re-search-forward "^;+[ \t]+" nil t) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
347 (replace-match "")) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
348 (goto-char (point-min)) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
349 (while (re-search-forward " *\n" nil t) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
350 (replace-match " ")) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
351 (goto-char (point-min)) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
352 (while (re-search-forward "\\([0-9]+\\),? +" nil t) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
353 (setq years (cons (match-string-no-properties 1) years))) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
354 (if (looking-at ".*$") |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
355 (setq holder (match-string-no-properties 0))))) |
5258f3b81740
(lm-copyright-prefix): Group the leader.
Dave Love <fx@gnu.org>
parents:
41918
diff
changeset
|
356 (cons holder (nreverse years))))) |
34945
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
357 |
879 | 358 (defun lm-summary (&optional file) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
359 "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
|
360 (lm-with-file file |
879 | 361 (goto-char (point-min)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
362 (if (and (looking-at lm-header-prefix) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
363 (progn (goto-char (match-end 0)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
364 (looking-at "[^ ]+[ \t]+--+[ \t]+\\(.*\\)"))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
365 (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
|
366 ;; Strip off -*- specifications. |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
367 (if (string-match "[ \t]*-\\*-.*-\\*-" summary) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
368 (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
|
369 summary))))) |
879 | 370 |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
371 (defun lm-crack-address (x) |
20637 | 372 "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
|
373 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
|
374 (cond ((string-match "\\(.+\\) [(<]\\(\\S-+@\\S-+\\)[>)]" x) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
375 (cons (match-string 1 x) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
376 (match-string 2 x))) |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
377 ((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
378 (cons (match-string 2 x) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
379 (match-string 1 x))) |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
380 ((string-match "\\S-+@\\S-+" x) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
381 (cons nil x)) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
382 (t |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
383 (cons x nil)))) |
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
384 |
879 | 385 (defun lm-authors (&optional file) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
386 "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
|
387 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
|
388 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
|
389 (lm-with-file file |
2352
8c8fe9da1f5e
(lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
879
diff
changeset
|
390 (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
|
391 (mapcar 'lm-crack-address authorlist)))) |
879 | 392 |
393 (defun lm-maintainer (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
394 "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
|
395 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
|
396 (lm-with-file file |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
397 (let ((maint (lm-header "maintainer"))) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
398 (if maint |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
399 (lm-crack-address maint) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
400 (car (lm-authors)))))) |
879 | 401 |
402 (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
|
403 "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
|
404 (lm-with-file file |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
405 (lm-header "created"))) |
879 | 406 |
28376
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
407 (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
|
408 "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
|
409 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
|
410 (lm-with-file file |
28376
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
411 (when (progn (goto-char (point-min)) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
412 (re-search-forward |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
413 "\\$[I]d: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) " |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
414 (lm-code-mark) t)) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
415 (let ((dd (match-string 3)) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
416 (mm (match-string 2)) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
417 (yyyy (match-string 1))) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
418 (if iso-date |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
419 (format "%s-%s-%s" yyyy mm dd) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
420 (format "%s %s %s" |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
421 dd |
62402
a7e02ef1e3d6
Replace `string-to-int' by `string-to-number'.
Juanma Barranquero <lekktu@gmail.com>
parents:
59572
diff
changeset
|
422 (nth (string-to-number mm) |
28376
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
423 '("" "Jan" "Feb" "Mar" "Apr" "May" "Jun" |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
424 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec")) |
38b2af227738
(lm-last-modified-date): Add parameter
Gerd Moellmann <gerd@gnu.org>
parents:
27786
diff
changeset
|
425 yyyy)))))) |
879 | 426 |
427 (defun lm-version (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
428 "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
|
429 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
|
430 (lm-with-file file |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
431 (or (lm-header "version") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
432 (let ((header-max (lm-code-mark))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
433 (goto-char (point-min)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
434 (cond |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
435 ;; Look for an RCS header |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
436 ((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
|
437 (match-string-no-properties 1)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
438 ((re-search-forward "\\$Revision: +\\([^ ]+\\) " header-max t) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
439 (match-string-no-properties 1)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
440 ;; Look for an SCCS header |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
441 ((re-search-forward |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
442 (concat |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
443 (regexp-quote "@(#)") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
444 (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
|
445 "\t\\([012345679.]*\\)") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
446 header-max t) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
447 (match-string-no-properties 1))))))) |
879 | 448 |
449 (defun lm-keywords (&optional file) | |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
450 "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
|
451 (lm-with-file file |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
452 (let ((keywords (lm-header "keywords"))) |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
453 (and keywords (downcase keywords))))) |
879 | 454 |
37182
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
455 (defun lm-keywords-list (&optional file) |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
456 "Return list of keywords given in file FILE." |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
457 (let ((keywords (lm-keywords file))) |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
458 (if keywords |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
459 (split-string keywords ",?[ \t]")))) |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
460 |
54500
7a30ab50eb0b
(lm-keywords-finder-p): Use defvar rather than with-no-warnings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
53864
diff
changeset
|
461 (defvar finder-known-keywords) |
37182
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
462 (defun lm-keywords-finder-p (&optional file) |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
463 "Return non-nil if any keywords in FILE are known to finder." |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
464 (require 'finder) |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
465 (let ((keys (lm-keywords-list file))) |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
466 (catch 'keyword-found |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
467 (while keys |
54500
7a30ab50eb0b
(lm-keywords-finder-p): Use defvar rather than with-no-warnings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
53864
diff
changeset
|
468 (if (assoc (intern (car keys)) finder-known-keywords) |
37182
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
469 (throw 'keyword-found t)) |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
470 (setq keys (cdr keys))) |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
471 nil))) |
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
472 |
879 | 473 (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
|
474 "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
|
475 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
|
476 distribution." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
477 (lm-with-file file |
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
478 (lm-header "adapted-by"))) |
879 | 479 |
2528
df68ddbcc2f1
(lm-commentary-region): Gone.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2352
diff
changeset
|
480 (defun lm-commentary (&optional file) |
14512
e7206013c310
Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
14505
diff
changeset
|
481 "Return the commentary in file FILE, or current buffer if FILE is nil. |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
482 Return the value as a string. In the file, the commentary |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
483 section starts with the tag `Commentary' or `Documentation' and |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
484 ends just before the next section. If the commentary section is |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
485 absent, return nil." |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
486 (lm-with-file file |
51155
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
487 (let ((start (lm-commentary-start))) |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
488 (when start |
c10e341483da
Make the description of the library more
Lute Kamstra <lute@gnu.org>
parents:
49598
diff
changeset
|
489 (buffer-substring-no-properties start (lm-commentary-end)))))) |
879 | 490 |
491 ;;; Verification and synopses | |
492 | |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
493 (defun lm-insert-at-column (col &rest strings) |
20637 | 494 "Insert, at column COL, list of STRINGS." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
495 (if (> (current-column) col) (insert "\n")) |
20127 | 496 (move-to-column col t) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
497 (apply 'insert strings)) |
879 | 498 |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
499 (defun lm-verify (&optional file showok verbose non-fsf-ok) |
879 | 500 "Check that the current buffer (or FILE if given) is in proper format. |
34945
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
501 If FILE is a directory, recurse on its files and generate a report in a |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
502 temporary buffer. In that case, the optional argument SHOWOK |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
503 says display \"OK\" in temp buffer for files that have no problems. |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
504 |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
505 Optional argument VERBOSE specifies verbosity level. |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
506 Optional argument NON-FSF-OK if non-nil means a non-FSF |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
507 copyright notice is allowed." |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
508 (interactive (list nil nil t)) |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
509 (let* ((ret (and verbose "Ok")) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
510 name) |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
511 (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
|
512 (setq ret |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
513 (with-temp-buffer |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
514 (mapcar |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
515 (lambda (f) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
516 (if (string-match ".*\\.el\\'" f) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
517 (let ((status (lm-verify f))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
518 (insert f ":") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
519 (if status |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
520 (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
|
521 "\n") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
522 (if showok |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
523 (lm-insert-at-column lm-comment-column |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
524 "OK\n")))))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
525 (directory-files file)))) |
26690
1006a8324029
(lm-header-multiline): fix spurious use of `cond'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
24219
diff
changeset
|
526 (lm-with-file file |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
527 (setq name (lm-get-package-name)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
528 (setq ret |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
529 (cond |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
530 ((null name) |
53864
8589159e3bd8
(lm-verify): Remove useless use of
Andreas Schwab <schwab@suse.de>
parents:
53488
diff
changeset
|
531 "Can't find package name") |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
532 ((not (lm-authors)) |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
533 "`Author:' tag missing") |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
534 ((not (lm-maintainer)) |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
535 "`Maintainer:' tag missing") |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
536 ((not (lm-summary)) |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
537 "Can't find the one-line summary description") |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
538 ((not (lm-keywords)) |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
539 "`Keywords:' tag missing") |
37182
c29d2430fdd9
(lm-keywords-list, lm-keywords-finder-p):
Gerd Moellmann <gerd@gnu.org>
parents:
34945
diff
changeset
|
540 ((not (lm-keywords-finder-p)) |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
541 "`Keywords:' has no valid finder keywords (see `finder-known-keywords')") |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
542 ((not (lm-commentary-mark)) |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
543 "Can't find a 'Commentary' section marker") |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
544 ((not (lm-history-mark)) |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
545 "Can't find a 'History' section marker") |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
546 ((not (lm-code-mark)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
547 "Can't find a 'Code' section marker") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
548 ((progn |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
549 (goto-char (point-max)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
550 (not |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
551 (re-search-backward |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
552 (concat "^;;;[ \t]+" name "[ \t]+ends here[ \t]*$" |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
553 "\\|^;;;[ \t]+ End of file[ \t]+" name) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
554 nil t))) |
53864
8589159e3bd8
(lm-verify): Remove useless use of
Andreas Schwab <schwab@suse.de>
parents:
53488
diff
changeset
|
555 "Can't find the footer line") |
34945
99252c8e0152
(lm-copyright-prefix): New Variable.
Gerd Moellmann <gerd@gnu.org>
parents:
34567
diff
changeset
|
556 ((not (and (lm-copyright-mark) (lm-crack-copyright))) |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
557 "Can't find a valid copyright notice") |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
558 ((not (or non-fsf-ok |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
559 (string-match "Free Software Foundation" |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
560 (car (lm-crack-copyright))))) |
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
561 "Copyright holder is not the Free Software Foundation") |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
562 (t |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
563 ret))))) |
41917
67cd4c7204bc
(lm-verify): New arg NON-FSF-OK.
Richard M. Stallman <rms@gnu.org>
parents:
39563
diff
changeset
|
564 (if verbose |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
565 (message ret)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
566 ret)) |
879 | 567 |
568 (defun lm-synopsis (&optional file showall) | |
569 "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
|
570 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
|
571 a temporary buffer. If SHOWALL is non-nil, also generate a line for files |
879 | 572 which do not include a recognizable synopsis." |
14501
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
573 (interactive |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
574 (list |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
575 (read-file-name "Synopsis for (file or dir): "))) |
6ac4623cdc87
(lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
14492
diff
changeset
|
576 |
879 | 577 (if (and file (file-directory-p file)) |
51395
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
578 (with-output-to-temp-buffer "*Synopsis*" |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
579 (set-buffer standard-output) |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
580 (dolist (f (directory-files file nil ".*\\.el\\'")) |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
581 (let ((syn (lm-synopsis (expand-file-name f file)))) |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
582 (when (or syn showall) |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
583 (insert f ":") |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
584 (lm-insert-at-column lm-comment-column (or syn "NA") "\n"))))) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
585 (save-excursion |
51395
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
586 (let ((must-kill (and file (not (get-file-buffer file))))) |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
587 (when file (find-file file)) |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
588 (prog1 |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
589 (if (interactive-p) |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
590 (message "%s" (lm-summary)) |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
591 (lm-summary)) |
ef9e066bc6f2
(lm-synopsis): Use relative filenames correctly. Show the synopsis to
Lute Kamstra <lute@gnu.org>
parents:
51155
diff
changeset
|
592 (when must-kill (kill-buffer (current-buffer)))))))) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
593 |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
594 (eval-when-compile (defvar report-emacs-bug-address)) |
879 | 595 |
596 (defun lm-report-bug (topic) | |
597 "Report a bug in the package currently being visited to its maintainer. | |
20637 | 598 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
|
599 (interactive "sBug Subject: ") |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
600 (require 'emacsbug) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
601 (let ((package (lm-get-package-name)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
602 (addr (lm-maintainer)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
603 (version (lm-version))) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
604 (compose-mail (if addr |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
605 (concat (car addr) " <" (cdr addr) ">") |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
606 report-emacs-bug-address) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
607 topic) |
879 | 608 (goto-char (point-max)) |
27786
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
609 (insert "\nIn " package) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
610 (if version |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
611 (insert " version " version)) |
2d57dfc8a2a4
Don't require emacsbug at top level.
Dave Love <fx@gnu.org>
parents:
26690
diff
changeset
|
612 (newline 2) |
65590
c45ae2a74f0f
message format spec fixes, commit # 9
Deepak Goel <deego@gnufans.org>
parents:
64751
diff
changeset
|
613 (message "%s" |
879 | 614 (substitute-command-keys "Type \\[mail-send] to send bug report.")))) |
615 | |
616 (provide 'lisp-mnt) | |
617 | |
52401 | 618 ;;; arch-tag: fa3c5ab4-a37b-4e46-b7cf-b6d78b90e69e |
879 | 619 ;;; lisp-mnt.el ends here |