annotate lisp/emacs-lisp/lisp-mnt.el @ 15969:a93195fe5297

(cmd_error): Add number of kbd macro iterations to the error message.
author Richard M. Stallman <rms@gnu.org>
date Thu, 29 Aug 1996 04:38:33 +0000
parents e7206013c310
children c3b46f285d54
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
1 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
2
7300
cc7cd83ccf3f Update copyright.
Karl Heuer <kwzh@gnu.org>
parents: 5359
diff changeset
3 ;; Copyright (C) 1992, 1994 Free Software Foundation, Inc.
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
4
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
6 ;; Maintainer: Eric S. Raymond <esr@snark.thyrsus.com>
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
7 ;; Created: 14 Jul 1992
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
8 ;; Version: $Id: lisp-mnt.el,v 1.16 1996/02/06 21:35:20 erik Exp rms $
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
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
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
11
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
12 ;; This file is part of GNU Emacs.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
13
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
15 ;; it under the terms of the GNU General Public License as published by
12244
ac7375e60931 Update GPL to version 2.
Karl Heuer <kwzh@gnu.org>
parents: 11035
diff changeset
16 ;; the Free Software Foundation; either version 2, or (at your option)
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
17 ;; any later version.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
18
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
19 ;; GNU Emacs is distributed in the hope that it will be useful,
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
22 ;; GNU General Public License for more details.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
23
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
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
14505
fd6e27938b72 Fix the FSF address again.
Erik Naggum <erik@naggum.no>
parents: 14501
diff changeset
26 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
fd6e27938b72 Fix the FSF address again.
Erik Naggum <erik@naggum.no>
parents: 14501
diff changeset
27 ;; Boston, MA 02111-1307, USA.
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
28
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
29 ;;; Commentary:
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
30
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
31 ;; This minor mode adds some services to Emacs-Lisp editing mode.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
32 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
33 ;; First, it knows about the header conventions for library packages.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
34 ;; One entry point supports generating synopses from a library directory.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
35 ;; Another can be used to check for missing headers in library files.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
36 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
37 ;; Another entry point automatically addresses bug mail to a package's
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
38 ;; maintainer or author.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
39
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
40 ;; This file can be loaded by your lisp-mode-hook. Have it (require 'lisp-mnt)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
41
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
42 ;; This file is an example of the header conventions. Note the following
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
43 ;; features:
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
44 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
45 ;; * Header line --- makes it possible to extract a one-line summary of
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
46 ;; the package's uses automatically for use in library synopses, KWIC
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
47 ;; indexes and the like.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
48 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
49 ;; Format is three semicolons, followed by the filename, followed by
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
50 ;; three dashes, followed by the summary. All fields space-separated.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
51 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
52 ;; * Author line --- contains the name and net address of at least
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
53 ;; the principal author.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
54 ;;
2352
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
55 ;; If there are multiple authors, they should be listed on continuation
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
56 ;; lines led by ;;<TAB>, like this:
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
57 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
58 ;; ;; Author: Ashwin Ram <Ram-Ashwin@cs.yale.edu>
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
59 ;; ;; Dave Sill <de5@ornl.gov>
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
60 ;; ;; David Lawrence <tale@pawl.rpi.edu>
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
61 ;; ;; Noah Friedman <friedman@ai.mit.edu>
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
62 ;; ;; Joe Wells <jbw@maverick.uswest.com>
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
63 ;; ;; Dave Brennan <brennan@hal.com>
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
64 ;; ;; Eric Raymond <esr@snark.thyrsus.com>
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
65 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
66 ;; This field may have some special values; notably "FSF", meaning
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
67 ;; "Free Software Foundation".
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
68 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
69 ;; * Maintainer line --- should be a single name/address as in the Author
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
70 ;; line, or an address only, or the string "FSF". If there is no maintainer
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
71 ;; line, the person(s) in the Author field are presumed to be it. The example
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
72 ;; 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
73 ;; The idea behind these two fields is to be able to write a Lisp function
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
74 ;; that does "send mail to the author" without having to mine the name out by
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
75 ;; hand. Please be careful about surrounding the network address with <> if
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
76 ;; there's also a name in the field.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
77 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
78 ;; * Created line --- optional, gives the original creation date of the
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
79 ;; file. For historical interest, basically.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
80 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
81 ;; * 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
82 ;; 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
83 ;; may be an RCS or SCCS header.
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
84 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
85 ;; * Adapted-By line --- this is for FSF's internal use. The person named
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
86 ;; in this field was the one responsible for installing and adapting the
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
87 ;; package for the distribution. (This file doesn't have one because the
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
88 ;; author *is* one of the maintainers.)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
89 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
90 ;; * Keywords line --- used by the finder code (now under construction)
11035
97da4cb32d03 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 7940
diff changeset
91 ;; for finding Emacs Lisp code related to a topic.
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
92 ;;
5221
50e623c19fff (Bogus-Bureaucratic-Cruft): Changed to `X-Bogus-Bureaucratic-Cruft'.
Noah Friedman <friedman@splode.com>
parents: 4291
diff changeset
93 ;; * 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
94 ;; 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
95 ;; 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
96 ;; without invoking the wrath of any program.
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
97 ;;
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
98 ;; * Commentary line --- enables Lisp code to find the developer's and
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
99 ;; maintainers' explanations of the package internals.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
100 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
101 ;; * Change log line --- optional, exists to terminate the commentary
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
102 ;; section and start a change-log part, if one exists.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
103 ;;
11035
97da4cb32d03 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 7940
diff changeset
104 ;; * Code line --- exists so Lisp can know where commentary and/or
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
105 ;; change-log sections end.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
106 ;;
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
107 ;; * Footer line --- marks end-of-file so it can be distinguished from
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
108 ;; an expanded formfeed or the results of truncation.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
109
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
110 ;;; Change Log:
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
111
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
112 ;; Tue Jul 14 23:44:17 1992 ESR
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
113 ;; * Created.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
114
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
115 ;;; Code:
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
116
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
117 (require 'picture) ; provides move-to-column-force
2352
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
118 (require 'emacsbug)
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
119
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
120 ;;; Variables:
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
121
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
122 (defvar lm-header-prefix "^;;*[ \t]+\\(@\(#\)\\)?[ \t]*\\([\$]\\)?"
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
123 "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
124 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
125 in your Lisp package:
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
126
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
127 ;; @(#) package.el -- pacakge description
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
128 ;;
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
129 ;; @(#) $Maintainer: Person Foo Bar $
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
130
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
131 The @(#) construct is used by unix what(1) and
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
132 then $identifier: doc string $ is used by GNU ident(1)")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
133
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
134 (defvar lm-comment-column 16
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
135 "Column used for placing formatted output.")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
136
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
137 (defvar lm-commentary-header "Commentary\\|Documentation"
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
138 "Regexp which matches start of documentation section.")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
139
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
140 (defvar lm-history-header "Change Log\\|History"
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
141 "Regexp which matches the start of code log section.")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
142
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
143 ;;; Functions:
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
144
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
145 ;; These functions all parse the headers of the current buffer
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
146
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
147 (defsubst lm-get-header-re (header &optional mode)
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
148 "Returns regexp for matching HEADER.
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
149 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
150 return section regexp instead."
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
151 (cond ((eq mode 'section)
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
152 (concat "^;;;;* " header ":[ \t]*$"))
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
153 (t
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
154 (concat lm-header-prefix header ":[ \t]*"))))
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
155
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
156 (defsubst lm-get-package-name ()
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
157 "Returns package name by looking at the first line."
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
158 (save-excursion
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
159 (goto-char (point-min))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
160 (if (and (looking-at (concat lm-header-prefix))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
161 (progn (goto-char (match-end 0))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
162 (looking-at "\\([^\t ]+\\)")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
163 (match-end 1)))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
164 (buffer-substring (match-beginning 1) (match-end 1))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
165 )))
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 (defun lm-section-mark (header &optional after)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
168 "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
169 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
170 If AFTER is non-nil, return the location of the next line."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
171 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
172 (let ((case-fold-search t))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
173 (goto-char (point-min))
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
174 (if (re-search-forward (lm-get-header-re header 'section) nil t)
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
175 (progn
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
176 (beginning-of-line)
2528
df68ddbcc2f1 (lm-commentary-region): Gone.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2352
diff changeset
177 (if after (forward-line 1))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
178 (point))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
179 nil))))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
180
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
181 (defsubst lm-code-mark ()
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
182 "Return the buffer location of the `Code' start marker."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
183 (lm-section-mark "Code"))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
184
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
185 (defsubst lm-commentary-mark ()
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
186 "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
187 (lm-section-mark lm-commentary-header))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
188
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
189 (defsubst lm-history-mark ()
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
190 "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
191 (lm-section-mark lm-history-header))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
192
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
193 (defun lm-header (header)
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
194 "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
195 (goto-char (point-min))
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
196 (let ((case-fold-search t))
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
197 (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
198 ;; RCS ident likes format "$identifier: data$"
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
199 (looking-at "\\([^$\n]+\\)")
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
200 (match-end 1))
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
201 (buffer-substring (match-beginning 1) (match-end 1))
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
202 nil)))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
203
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
204 (defun lm-header-multiline (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, with continuation lines.
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
206 The returned value is a list of strings, one per line."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
207 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
208 (goto-char (point-min))
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
209 (let ((res (lm-header header)))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
210 (cond
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
211 (res
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
212 (setq res (list res))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
213 (forward-line 1)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
214
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
215 (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
216 (progn
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
217 (goto-char (match-end 0))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
218 (looking-at "\\(.*\\)"))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
219 (match-end 1))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
220 (setq res (cons (buffer-substring
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
221 (match-beginning 1)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
222 (match-end 1))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
223 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 res
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
227 )))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
228
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
229 ;; These give us smart access to the header fields and commentary
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
230
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
231 (defun lm-summary (&optional file)
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
232 "Return the one-line summary of file FILE, or current buffer if FILE is nil."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
233 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
234 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
235 (find-file file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
236 (goto-char (point-min))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
237 (prog1
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
238 (if (and
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
239 (looking-at lm-header-prefix)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
240 (progn (goto-char (match-end 0))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
241 (looking-at "[^ ]+[ \t]+--+[ \t]+\\(.*\\)")))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
242 (buffer-substring (match-beginning 1) (match-end 1)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
243 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
244 (kill-buffer (current-buffer)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
245 )))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
246
2352
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
247 (defun lm-crack-address (x)
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
248 "Split up an email address into full name and real email address.
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
249 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
250 (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
251 (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
252 (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
253 ((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x)
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
254 (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
255 (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
256 ((string-match "\\S-+@\\S-+" x)
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
257 (cons nil x))
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
258 (t
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
259 (cons x nil))))
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
260
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
261 (defun lm-authors (&optional file)
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
262 "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
263 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
264 the cdr is an email address."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
265 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
266 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
267 (find-file file))
2352
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
268 (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
269 (prog1
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
270 (mapcar 'lm-crack-address authorlist)
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
271 (if file
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
272 (kill-buffer (current-buffer)))
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
273 ))))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
274
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
275 (defun lm-maintainer (&optional file)
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
276 "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
277 The return value has the form (NAME . ADDRESS)."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
278 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
279 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
280 (find-file file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
281 (prog1
2352
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
282 (let ((maint (lm-header "maintainer")))
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
283 (if maint
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
284 (lm-crack-address maint)
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
285 (car (lm-authors))))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
286 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
287 (kill-buffer (current-buffer)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
288 )))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
289
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
290 (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
291 "Return the created date given in file FILE, or current buffer if FILE is nil."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
292 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
293 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
294 (find-file file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
295 (prog1
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
296 (lm-header "created")
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
297 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
298 (kill-buffer (current-buffer)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
299 )))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
300
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
301
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
302 (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
303 "Return the modify-date given in file FILE, or current buffer if FILE is nil."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
304 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
305 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
306 (find-file file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
307 (prog1
2352
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
308 (if (progn
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
309 (goto-char (point-min))
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
310 (re-search-forward
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
311 "\\$Id: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) "
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
312 (lm-code-mark) t))
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
313 (format "%s %s %s"
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
314 (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
315 (nth (string-to-int
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
316 (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
317 '("" "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
318 "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
319 (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
320 ))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
321 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
322 (kill-buffer (current-buffer)))
2352
8c8fe9da1f5e (lm-last-modified-date) Fixed return bug.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 879
diff changeset
323 )))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
324
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
325 (defun lm-version (&optional file)
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
326 "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
327 This can befound in an RCS or SCCS header to crack it out of."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
328 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
329 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
330 (find-file file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
331 (prog1
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
332 (or
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
333 (lm-header "version")
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
334 (let ((header-max (lm-code-mark)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
335 (goto-char (point-min))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
336 (cond
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
337 ;; Look for an RCS header
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
338 ((re-search-forward "\\$Id: [^ ]+ \\([^ ]+\\) " header-max t)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
339 (buffer-substring (match-beginning 1) (match-end 1)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
340
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
341 ;; Look for an SCCS header
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
342 ((re-search-forward
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
343 (concat
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
344 (regexp-quote "@(#)")
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
345 (regexp-quote (file-name-nondirectory (buffer-file-name)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
346 "\t\\([012345679.]*\\)")
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
347 header-max t)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
348 (buffer-substring (match-beginning 1) (match-end 1)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
349
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
350 (t nil))))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
351 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
352 (kill-buffer (current-buffer)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
353 )))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
354
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
355 (defun lm-keywords (&optional file)
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
356 "Return the keywords given in file FILE, or current buffer if FILE is nil."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
357 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
358 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
359 (find-file file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
360 (prog1
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
361 (let ((keywords (lm-header "keywords")))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
362 (and keywords (downcase keywords)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
363 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
364 (kill-buffer (current-buffer)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
365 )))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
366
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
367 (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
368 "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
369 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
370 distribution."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
371 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
372 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
373 (find-file file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
374 (prog1
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
375 (lm-header "adapted-by")
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
376 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
377 (kill-buffer (current-buffer)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
378 )))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
379
2528
df68ddbcc2f1 (lm-commentary-region): Gone.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2352
diff changeset
380 (defun lm-commentary (&optional file)
14512
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
381 "Return the commentary 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
382 The value is returned as a string. In the text, the commentary starts
e7206013c310 Change defconst into defvar. Many doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 14505
diff changeset
383 with tag `Commentary' and ends with tag `Change Log' or `History'."
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
384 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
385 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
386 (find-file file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
387 (prog1
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
388 (let ((commentary (lm-commentary-mark))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
389 (change-log (lm-history-mark))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
390 (code (lm-code-mark))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
391 )
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
392 (cond
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
393 ((and commentary change-log)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
394 (buffer-substring commentary change-log))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
395 ((and commentary code)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
396 (buffer-substring commentary code))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
397 (t
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
398 nil)))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
399 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
400 (kill-buffer (current-buffer)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
401 )))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
402
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
403 ;;; Verification and synopses
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
404
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
405 (defun lm-insert-at-column (col &rest strings)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
406 "Insert list of STRINGS, at column COL."
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
407 (if (> (current-column) col) (insert "\n"))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
408 (move-to-column-force col)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
409 (apply 'insert strings))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
410
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
411 (defun lm-verify (&optional file showok &optional verb)
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
412 "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
413 If FILE is a directory, recurse on its files and generate a report in
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
414 a temporary buffer."
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
415 (interactive)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
416 (let* ((verb (or verb (interactive-p)))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
417 ret
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
418 name
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
419 )
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
420 (if verb
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
421 (setq ret "Ok.")) ;init value
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
422
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
423 (if (and file (file-directory-p file))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
424 (setq
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
425 ret
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
426 (progn
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
427 (switch-to-buffer (get-buffer-create "*lm-verify*"))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
428 (erase-buffer)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
429 (mapcar
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
430 '(lambda (f)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
431 (if (string-match ".*\\.el$" f)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
432 (let ((status (lm-verify f)))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
433 (if status
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
434 (progn
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
435 (insert f ":")
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
436 (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
437 (and showok
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
438 (progn
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
439 (insert f ":")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
440 (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
441 (directory-files file))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
442 ))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
443 (save-excursion
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
444 (if file
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
445 (find-file file))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
446 (setq name (lm-get-package-name))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
447
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
448 (setq
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
449 ret
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
450 (prog1
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
451 (cond
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
452 ((null name)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
453 "Can't find a package NAME")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
454
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
455 ((not (lm-authors))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
456 "Author: tag missing.")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
457
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
458 ((not (lm-maintainer))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
459 "Maintainer: tag missing.")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
460
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
461 ((not (lm-summary))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
462 "Can't find a one-line 'Summary' description")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
463
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
464 ((not (lm-keywords))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
465 "Keywords: tag missing.")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
466
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
467 ((not (lm-commentary-mark))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
468 "Can't find a 'Commentary' section marker.")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
469
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
470 ((not (lm-history-mark))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
471 "Can't find a 'History' section marker.")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
472
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
473 ((not (lm-code-mark))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
474 "Can't find a 'Code' section marker")
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
475
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
476 ((progn
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
477 (goto-char (point-max))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
478 (not
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
479 (re-search-backward
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
480 (concat "^;;;[ \t]+" name "[ \t]+ends here[ \t]*$"
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
481 "\\|^;;;[ \t]+ End of file[ \t]+" name)
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
482 nil t
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 (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
485 (t
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
486 ret))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
487 (if file
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
488 (kill-buffer (current-buffer)))
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 (if verb
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
491 (message ret))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
492 ret
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
493 ))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
494
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
495 (defun lm-synopsis (&optional file showall)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
496 "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
497 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
498 a temporary buffer. If SHOWALL is non-nil, also generate a line for files
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
499 which do not include a recognizable synopsis."
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
500 (interactive
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
501 (list
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
502 (read-file-name "Synopsis for (file or dir): ")))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
503
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
504 (if (and file (file-directory-p file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
505 (progn
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
506 (switch-to-buffer (get-buffer-create "*lm-verify*"))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
507 (erase-buffer)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
508 (mapcar
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
509 '(lambda (f)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
510 (if (string-match ".*\\.el$" f)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
511 (let ((syn (lm-synopsis f)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
512 (if syn
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
513 (progn
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
514 (insert f ":")
14492
0ebde55bb21d (lm-insert-at-column): Renamed from insert-at-column.
Richard M. Stallman <rms@gnu.org>
parents: 14320
diff changeset
515 (lm-insert-at-column lm-comment-column syn "\n"))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
516 (and showall
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
517 (progn
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
518 (insert f ":")
14492
0ebde55bb21d (lm-insert-at-column): Renamed from insert-at-column.
Richard M. Stallman <rms@gnu.org>
parents: 14320
diff changeset
519 (lm-insert-at-column lm-comment-column "NA\n")))))))
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
520 (directory-files file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
521 )
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
522 (save-excursion
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
523 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
524 (find-file file))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
525 (prog1
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
526 (lm-summary)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
527 (if file
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
528 (kill-buffer (current-buffer)))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
529 ))))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
530
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
531 (defun lm-report-bug (topic)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
532 "Report a bug in the package currently being visited to its maintainer.
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
533 Prompts for bug subject. 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
534 (interactive "sBug Subject: ")
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
535 (let ((package (lm-get-package-name))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
536 (addr (lm-maintainer))
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
537 (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
538 (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
539 (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
540 (concat (car addr) " <" (cdr 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
541 bug-gnu-emacs)
c87a767f137e (lm-report-bug): lm-maintainer returns a cons; convert it to a string.
Richard M. Stallman <rms@gnu.org>
parents: 5358
diff changeset
542 topic)
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
543 (goto-char (point-max))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
544 (insert "\nIn "
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
545 package
5358
98efb3231d81 (lm-report-bug): Don't crash if version is nil.
Richard M. Stallman <rms@gnu.org>
parents: 5221
diff changeset
546 (if version (concat " version " version) "")
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
547 "\n\n")
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
548 (message
879
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
549 (substitute-command-keys "Type \\[mail-send] to send bug report."))))
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
550
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
551 (provide 'lisp-mnt)
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
552
6dc5b7273a07 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
553 ;;; lisp-mnt.el ends here
14501
6ac4623cdc87 (lm-header-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 14492
diff changeset
554