*** empty log message ***
[bpt/emacs.git] / lisp / emacs-lisp / authors.el
CommitLineData
66fd374b 1;;; authors.el --- utility for maintaining Emacs' AUTHORS file -*-coding: iso-2022-7bit;-*-
3215096c 2
ceb4c4d3
TTN
3;; Copyright (C) 2000, 2002, 2003, 2004, 2005,
4;; 2006 Free Software Foundation, Inc.
3215096c 5
60e8e0a5 6;; Author: Gerd Moellmann <gerd@gnu.org>
f39caf44 7;; Maintainer: Kim F. Storm <storm@cua.dk>
60e8e0a5
GM
8;; Keywords: maint
9
3215096c
GM
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
23;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56
LK
24;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25;; Boston, MA 02110-1301, USA.
3215096c
GM
26
27;;; Commentary:
28
29;; Use M-x authors RET to create an *Authors* buffer that can used as
30;; or merged with Emacs' AUTHORS file.
31
32;;; Code:
33
f39caf44
KS
34(defvar authors-coding-system 'iso-2022-7bit
35 "Coding system used in the AUTHORS file.")
36
3215096c
GM
37(defconst authors-many-files 20
38 "Maximum number of files for which to print individual information.
f39caf44
KS
39If an author has modified more files, only the names of the most
40frequently modified files are printed and a count of the additional
41files.")
3215096c
GM
42
43(defconst authors-aliases
f39caf44 44 '(
9109bf49 45 ("Andrew Csillag" "Drew Csillag")
9dfa8726 46 ("Anna M. Bigatti" "Anna Bigatti")
f39caf44
KS
47 ("Barry A. Warsaw" "Barry A. Warsaw, Century Computing, Inc."
48 "Barry A. Warsaw, ITB" "Barry Warsaw")
49 ("Bj\e,Av\e(Brn Torkelsson" "Bjorn Torkelsson")
50 ("Brian Fox" "Brian J. Fox")
51 ("Christoph Wedler" "Christoph.Wedler@sap.com")
52 ("Daniel Pfeiffer" "<Daniel.Pfeiffer@Informatik.START.db.de>"
53 "<Daniel.Pfeiffer@Informatik.START.dbp.de>")
54 ("David Gillespie" "Dave Gillespie")
55 ("David K\e,Ae\e(Bgedal" "David K..edal")
605046ef
KS
56 ("David M. Koppelman" "David M. Koppelman, Koppel@Ee.Lsu.Edu"
57 "David Koppelman")
d0f483e8
KS
58 ("David M. Smith" "David Smith" "David M Smith")
59 ("Ed L. Cashin" "Ed L Cashin")
f39caf44
KS
60 ("Edward M. Reingold" "Ed Reingold" "Edward M Reingold"
61 "Reingold Edward M")
62 ("Eli Zaretskii" "eliz")
4ee02020 63 ("Emilio C. Lopes" "Emilio Lopes")
d0f483e8 64 ("Era Eriksson" "Era@Iki.Fi")
f39caf44
KS
65 ("Eric M. Ludlam" "Eric Ludlam")
66 ("Eric S. Raymond" "Eric Raymond")
67 ("Eric Youngdale" "(Eric Youngdale at youngdale@v6550c.nrl.navy.mil)")
d0f483e8 68 ("Francis J. Wright" "Dr Francis J. Wright" "Francis Wright")
f39caf44 69 ("Fran\e,Ag\e(Bois Pinard" "Francois Pinard")
97c437db 70 ("Francesco Potort\e,Al\e(B" "Francesco Potorti" "Francesco Potorti`")
f39caf44
KS
71 ("Frederic Pierresteguy" "Fred Pierresteguy")
72 ("Geoff Voelker" "voelker")
73 ("Hallvard B. Furuseth" "Hallvard B Furuseth")
d0f483e8 74 ("Hrvoje Nik\e,B9\e(Bi\e,Bf\e(B" "Hrvoje Niksic")
f39caf44
KS
75 (nil "(afs@hplb.hpl.hp.com)")
76 (nil "<Use-Author-Address-Header@\\[127.1\\]>")
77 (nil "Code Extracted")
78 (nil "Fsf")
79 (nil "ISO-2022-JP")
80 ("Jaeyoun Chung" "Jae-youn Chung" "Jae-you Chung" "Chung Jae-youn")
81 ("Jan Dj\e,Ad\e(Brv" "Jan D." "Jan Djarv")
d0f483e8
KS
82 ("Jay K. Adams" "jka@ece.cmu.edu" "Jay Adams")
83 ("J\e,Ai\e(Br\e,At\e(Bme Marant" "J\e,bi\e(Br\e,bt\e(Bme Marant" "Jerome Marant")
f39caf44 84 ("Jens-Ulrik Holger Petersen" "Jens-Ulrik Petersen")
605046ef 85 ("Jeremy Bertram Maitin-Shepard" "Jeremy Maitin-Shepard")
56c3f16c 86 ("Johan Bockg\e,Ae\e(Brd" "Johan Bockgard")
4ee02020 87 ("John W. Eaton" "John Eaton")
f39caf44
KS
88 ("Jonathan I. Kamens" "Jonathan Kamens")
89 ("Joseph Arceneaux" "Joe Arceneaux")
4ee02020 90 ("Juan Le\e,As\e(Bn Lahoz Garc\e,Am\e(Ba" "Juan-Leon Lahoz Garcia")
f39caf44
KS
91 ("K. Shane Hartman" "Shane Hartman")
92 ("Kai Gro\e,A_\e(Bjohann" "Kai Grossjohann" "Kai Gro\e,b_\e(Bjohann"
d0f483e8
KS
93 "Kai.Grossjohann@Cs.Uni-Dortmund.De"
94 "Kai.Grossjohann@Gmx.Net")
f39caf44 95 ("Karl Berry" "K. Berry")
7ad783eb 96 ("K\e,Aa\e(Broly L\e$,1 q\e(Brentey" "K\e,Aa\e(Broly L\e,Bu\e(Brentey" "L\e$,1 q\e(Brentey K\e,Aa\e(Broly")
d0f483e8 97 ("Kazushi Marukawa" "Kazushi")
f39caf44
KS
98 ("Ken Manheimer" "Kenneth Manheimer")
99 ("Kenichi Handa" "Ken'ichi Handa" "Kenichi HANDA")
4ee02020 100 ("Kevin Greiner" "Kevin J. Greiner")
f39caf44 101 ("Kim F. Storm" "Kim Storm")
d0f483e8 102 ("Kyle Jones" "Kyle E. Jones")
f39caf44 103 ("Marcus G. Daniels" "Marcus Daniels")
d0f483e8
KS
104 ("Mark D. Baushke" "Mark D Baushke")
105 ("Martin Lorentzon" "Martin Lorentzson")
106 ("Matt Swift" "Matthew Swift")
4ee02020 107 ("Michael R. Mauger" "Michael Mauger")
f39caf44 108 ("Michael D. Ernst" "Michael Ernst")
c0b1307a 109 ("Micha\e,Ak\e(Bl Cadilhac" "Michael Cadilhac")
f39caf44 110 ("Michael I. Bushnell" "Michael I Bushnell" "Michael I. Bushnell, P/Bsg")
4ee02020 111 ("Mikio Nakajima" "Nakajima Mikio")
f39caf44
KS
112 ("Paul Eggert" "eggert")
113 ("Paul Reilly" "(pmr@legacy.pajato.com)")
d0f483e8 114 ("Pavel Jan\e,Bm\e(Bk" "Pavel Jan\e,Am\e(Bk Ml." "Pavel Jan\e,Am\e(Bk" "Pavel@Janik.Cz")
f39caf44 115 ("Per Abrahamsen" "Per Abhiddenware")
d0f483e8
KS
116 ("Peter S. Galbraith" "Peter Galbraith")
117 ("Peter Runestig" "Peter 'luna' Runestig")
f39caf44
KS
118 ("Peter S. Galbraith" "Peter S Galbraith")
119 ("Richard M. Stallman" "Richard M. Stallman,,," "Richard Stallman"
a1506d29 120 "rms" "rms@gnu.org")
f39caf44
KS
121 ("Robert J. Chassell" "Bob Chassell")
122 ("Roland B. Roberts" "Roland B Roberts" "Roland Roberts")
123 ("Rui-Tao Dong" "Rui-Tao Dong ~{6-Hpln~}")
a8d37031 124 ("Sacha Chua" "Sandra Jean Chua")
f39caf44 125 ("Sam Steingold" "Sam Shteingold")
9109bf49 126 ("Satyaki Das" "Indexed search by Satyaki Das")
d0f483e8 127 ("Stefan Monnier" "Stefan")
f39caf44
KS
128 ("Stephen A. Wood" "(saw@cebaf.gov)")
129 ("Steven L. Baur" "SL Baur" "Steven L Baur")
130 ("Takaaki Ota" "Tak Ota")
4ee02020 131 ("Takahashi Naoto" "Naoto Takahashi")
d0f483e8 132 ("Teodor Zlatanov" "Ted Zlatanov")
f39caf44
KS
133 ("Torbj\e,Av\e(Brn Axelsson" "Torbjvrn Axelsson")
134 ("Torbj\e,Av\e(Brn Einarsson" "Torbj.*rn Einarsson")
135 ("Toru Tomabechi" "Toru Tomabechi,")
136 ("Vincent Del Vecchio" "Vince Del Vecchio")
9109bf49 137 ("William M. Perry" "Bill Perry")
f39caf44
KS
138 ("Wlodzimierz Bzyl" "W.*dek Bzyl")
139 ("Yutaka NIIBE" "NIIBE Yutaka")
d5ab63b2 140 )
3215096c
GM
141 "Alist of author aliases.
142
f39caf44 143Each entry is of the form (REALNAME REGEXP...). If an author's name
a1506d29 144matches one of the REGEXPs, use REALNAME instead.
f39caf44 145If REALNAME is nil, ignore that author.")
3215096c
GM
146
147
0a521885
GM
148(defvar authors-public-domain-files
149 '("auto-show\\.el"
150 "form-d2\\.el"
151 "emerge\\.el"
152 "unused\\.el"
153 "vi\\.el"
154 "feedmail\\.el"
155 "mailpost\\.el"
156 "hanoi\\.el"
157 "meese\\.el"
158 "studly\\.el"
159 "modula2\\.el")
160 "List of regexps matching files for which the FSF doesn't need papers.")
161
162
8a5506f2
GM
163(defvar authors-obsolete-files-regexps
164 '("vc-\\*\\.el$"
165 "spec.txt$"
166 "vc-\\(rcs\\|cvs\\|sccs\\)-hooks\\.el$")
167 "List of regexps matching obsolete files.
168Changes to files matching one of the regexps in this list are not
169listed.")
170
4ee02020
KS
171(defconst authors-ignored-files
172 '("external-lisp"
173 "lock" "share-lib" "local-lisp"
174 "noleim-Makefile.in"
56e48725 175 "NEWS" "PROBLEMS" "FAQ" "AUTHORS" "FOR-RELEASE" "TODO")
4ee02020
KS
176 "List of files and directories to ignore.
177Changes to files in this list are not listed.")
8a5506f2 178
d5ab63b2 179(defconst authors-fixed-entries
8b1163a3 180 '(("Richard M. Stallman" :wrote "[The original GNU Emacs and numerous files]")
f39caf44 181 ("Joseph Arceneaux" :wrote "xrdb.c")
d5ab63b2
GM
182 ("Blitz Product Development Corporation" :wrote "ispell.el")
183 ("Frank Bresz" :wrote "diff.el")
184 ("David M. Brown" :wrote "array.el")
185 ("Gary Byers" :changed "xenix.h")
186 ("Shawn M. Carey" :wrote "freebsd.h")
187 ("Eric Decker" :changed "hp9000s800.h" "hpux.h" "sysdep.c")
188 ("Lawrence R. Dodd" :wrote "dired-x.el")
189 ("Viktor Dukhovni" :wrote "unexsunos4.c")
190 ("Paul Eggert" :wrote "rcs2log" "vcdiff")
191 ("Fred Fish" :changed "unexec.c")
192 ("Tim Fleehart" :wrote "makefile.nt")
193 ("Keith Gabryelski" :wrote "hexl.c")
194 ("Kevin Gallagher" :wrote "flow-ctrl.el")
195 ("Howard Gayle" :wrote "disp-table.el" "iso-syntax.el" "casetab.c")
196 ("Stephen Gildea" :wrote "refcard.tex" "mh-funcs.el" "mh-pick.el")
197 ("David Gillespie" :wrote "cl.texinfo")
198 ("Hewlett-Packard" :changed "emacsclient.c" "emacsserver.c"
199 "server.el" "keyboard.c")
200 ("Thomas Horsley" :wrote "cxux.h" "cxux7.h")
201 ("Indiana University Foundation" :changed "buffer.c" "buffer.h"
202 "indent.c" "search.c" "xdisp.c" "region-cache.c" "region-cache.h")
203 ("International Business Machines" :changed "emacs.c" "fileio.c"
204 "ibmrt.h" "process.c" "sysdep.c" "unexec.c" "ibmrt-aix.h")
205 ("Ishikawa Chiaki" :changed "aviion.h" "dgux.h")
206 ("Michael K. Johnson" :changed "configure.in" "emacs.c" "intel386.h"
207 "mem-limits.h" "process.c" "template.h" "sysdep.c" "syssignal.h" "systty.h" "unexec.c"
208 "ymakefile" "linux.h")
56c3f16c 209 ("Kyle Jones" :wrote "mldrag.el")
4ee02020 210 ("Henry Kautz" :wrote "bib-mode.el")
d5ab63b2
GM
211 ("Joseph M. Kelsey" :changed "fileio.c" "vms-pwd.h" "vmsfns.c" "dir.h"
212 "uaf.h")
213 ("Sam Kendall" :changed "etags.c" "etags.el")
214 ("Richard King" :wrote "backquote.el" "userlock.el" "filelock.c")
215 ("Larry Kolodney" :wrote "cvtmail.c")
216 ("Sebastian Kremer" :changed "add-log.el")
217 ("Mark Lambert" :changed "process.c" "process.h")
218 ("Aaron Larson" :changed "bibtex.el")
219 ("James R. Larus" :wrote "mh-e.el")
220 ("Lars Lindberg" :changed "dabbrev.el" :wrote "imenu.el")
221 ("Lucid, Inc." :changed "bytecode.c" "byte-opt.el" "byte-run.el"
222 "bytecomp.el" "delsel.el" "disass.el" "faces.el" "font-lock.el"
223 "lmenu.el" "lselect.el" "mailabbrev.el" "select.el" "xfaces.c"
224 "xselect.c")
225 ("MCC" :changed "etags.c" "emacsclient.c" "emacsserver.c" "movemail.c"
226 "rmail.el" "rmailedit.el" "rmailkwd.el"
227 "rmailmsc.el" "rmailout.el" "rmailsum.el" "scribe.el"
228 "server.el" "lisp.h" "sysdep.c" "unexec.c" :wrote "xmenu.c")
229 ("Niall Mansfield" :changed "etags.c")
230 ("Brian Marick" :wrote "hideif.el")
231 ("Marko Kohtala" :changed "info.el")
232 ("Sidney Markowitz" :changed "doctor.el")
233 ("Richard Mlynarik" :wrote "env.c" "ehelp.el")
234 ("Mosur Mohan" :changed "etags.c")
235 ("Jeff Morgenthaler" :changed "flow-ctrl.el" "vt200.el" "vt201.el"
236 "vt220.el" "vt240.el")
237 ("Motorola" :changed "buff-menu.el")
238 ("Hiroshi Nakano" :changed "ralloc.c")
239 ("Sundar Narasimhan" :changed "rnewspost.el")
240 ("NeXT, Inc." :wrote "unexnext.c")
241 ("Mark Neale" :changed "fortran.el")
242 ("Martin Neitzel" :changed "sc.el")
243 ("Andrew Oram" :changed "miscellaneous changes to files in man/"
244 "man/calendar.texi")
245 ("Frederic Pierresteguy" :wrote "widget.c")
246 ("Michael D. Prange" :changed "tex-mode.el")
247 ("Paul Reilly" :wrote "gux5-4r2.h" "dgux5-4r3.h")
d0f483e8 248 ("Roland B. Roberts" :changed "files.el" "sort.el" "vmsproc.el"
d5ab63b2
GM
249 "buffer.h" "callproc.c" "dired.c" "process.c" "sysdep.c" "systty.h"
250 "vmspaths.h" "build.com" "compile.com" "kepteditor.com" "precomp.com"
251 :wrote "logout.com" "mailemacs.com")
252 ("Guillermo J. Rozas" :wrote "fakemail.c")
253 ("Wolfgang Rupprecht" :changed "lisp-mode.el" "loadup.el"
254 "sort.el" "alloc.c" "callint.c"
255 "config.h.in" "crt0.c" "data.c" "fns.c"
256 "lisp.h" "lread.c" "sun3.h"
257 "print.c" "ymakefile" :wrote "float-sup.el" "floatfns.c")
258 ("Schlumberger Technology Corporation" :changed "gud.el")
259 ("Gregor Schmid" :wrote "tcl-mode.el")
260 ("Rainer Schoepf" :wrote "alpha.h" "unexalpha.c")
261 ("William Sommerfeld" :wrote "emacsclient.c" "emacsserver.c" "scribe.el")
262 ("Leigh Stoller" :changed "emacsclient.c" "emacsserver.c" "server.el")
263 ("Steve Strassman" :wrote "spook.el")
264 ("Shinichirou Sugou" :changed "etags.c")
265 ("Sun Microsystems, Inc" :changed "emacsclient.c" "emacsserver.c"
266 "server.el" :wrote "emacs.icon" "emacstool.1" "emacstool.c" "sun-curs.el"
267 "sun-fns.el" "sun-mouse.el" "sun.el" "sunfns.c")
268 ("Kayvan Sylvan" :changed "sc.el")
269 ("Spencer Thomas" :changed "emacsclient.c" "emacsserver.c" "server.el"
270 "dabbrev.el" "unexec.c" "tcp.c" "gnus.texi")
271 ("Jonathan Vail" :changed "vc.el")
272 ("James Van Artsdalen" :changed "usg5-4.h" "unexec.c")
273 ("Geoff Voelker" :wrote "src/makefile.nt" "lisp/makefile.nt" "winnt.el"
274 "nt.c" "nt.h" "ntheap.c" "ntheap.h" "ntinevt.c"
275 "ntproc.c" "ntterm.c" "windowsnt.h")
276 ("Morten Welinder" :wrote "dosfns.c" "[many MSDOS files]" "msdos.h")
277 ("Pace Willisson" :wrote "ispell.el")
278 ("Garrett Wollman" :changed "sendmail.el")
9109bf49 279 ("Dale R. Worley" :changed "mail-extr.el")
d5ab63b2
GM
280 ("Jamie Zawinski" :changed "bytecode.c" :wrote "disass.el" "tar-mode.el"))
281 "Actions taken from the original, manually (un)maintained AUTHORS file.")
282
283
f39caf44
KS
284(defconst authors-valid-file-names
285 '("aclocal.m4"
4ee02020
KS
286 "makedist.bat"
287 "make-delta")
f39caf44
KS
288 "File names which are valid, but no longer exists (or cannot be
289found) in the repository.")
290
291(defconst authors-renamed-files-alist
292 '(("nt.c" . "w32.c") ("nt.h" . "w32.h")
293 ("ntheap.c" . "w32heap.c") ("ntheap.h" . "w32heap.h")
294 ("ntinevt.c" . "w32inevt.c") ("ntinevt.h" . "w32inevt.h")
295 ("ntproc.c" . "w32proc.c")
296 ("w32console.c" . "w32term.c")
297 ("unexnt.c" . "unexw32.c")
298 ("s/windowsnt.h" . "s/ms-w32.h")
299 ("config.emacs" . "configure")
300 ("GETTING.GNU.SOFTWARE" . "FTP")
4ee02020
KS
301 ("leim-Makefile" . "leim/Makefile")
302 ("leim-Makefile.in" . "leim/Makefile.in")
303 ("INSTALL-CVS" . "INSTALL.CVS")
f39caf44
KS
304 )
305 "Alist of files which have been renamed during their lifetime.
306Elements are (OLDNAME . NEWNAME).")
307
308(defconst authors-renamed-files-regexps
309 '(("^m/m-\\(.*\\.h\\)$" . "m/\\1")
310 ("^m-\\(.*\\.h\\)$" . "\\1")
311 ("^s/s-\\(.*\\.h\\)$" . "s/\\1")
312 ("^s-\\(.*\\.h\\)$" . "\\1")
313 ("^s/[-.a-zA-Z0-9_]+\\.h$" . t)
314 ("\\(.*\\)\\.cmd$" . "\\1.bat")
315 ("\\.bat$" . t)
316 ("\\.[ch]$" . t)
317 ("\\.el$" . t)
318 ("\\.ps$" . t)
319 ("\\.texi?$" . t)
320 ("\\.texinfo$" . t)
321 ("\\.xml?$" . t)
322 ("\\.x[pb]m$" . t)
323 ("\\.[xp]bm$" . t)
324 ("^paths\\." . t)
325 ("^install\\." . t)
326 )
327 "List regexps and rewriting rules for renamed files.
328Elements are (REGEXP . REPLACE). If REPLACE is a string, the file
329name matching REGEXP is replaced by REPLACE using `replace-string'.
330Otherwise, the file name is accepted as is.")
331
332(defvar authors-checked-files-alist)
333(defvar authors-invalid-file-names)
334
335(defun authors-canonical-file-name (file log-file pos author)
336 "Return canonical file name for FILE found in LOG-FILE at POS for AUTHOR.
337Checks whether FILE is a valid (existing) file name, has been renamed,
338or is on the list of removed files. Returns the non-diretory part of
339the file name."
340 (let ((entry (assoc file authors-checked-files-alist))
341 relname
342 valid)
343 (if entry
344 (cdr entry)
345 (setq relname (file-name-nondirectory file))
346 (if (or (member relname authors-valid-file-names)
347 (file-exists-p file)
348 (file-exists-p relname)
349 (file-exists-p (concat "etc/" relname)))
350 (setq valid relname)
351 (setq valid (assoc file authors-renamed-files-alist))
352 (if valid
353 (setq valid (cdr valid))
354 (let ((rules authors-renamed-files-regexps))
355 (while rules
356 (if (string-match (car (car rules)) file)
357 (setq valid (if (stringp (cdr (car rules)))
358 (file-name-nondirectory
359 (replace-match (cdr (car rules)) t nil file))
360 relname)
361 rules nil))
362 (setq rules (cdr rules))))))
363 (setq authors-checked-files-alist
364 (cons (cons file valid) authors-checked-files-alist))
9109bf49
KS
365 (unless (or valid
366 (string-match "[*]" file)
367 (string-match "^[0-9.]+$" file))
a1506d29 368 (setq authors-invalid-file-names
f39caf44
KS
369 (cons (format "%s:%d: unrecognized `%s' for %s"
370 log-file
371 (1+ (count-lines (point-min) pos))
372 file author)
373 authors-invalid-file-names)))
374 valid)))
375
d5ab63b2
GM
376(defun authors-add-fixed-entries (table)
377 "Add actions from `authors-fixed-entries' to TABLE."
378 (dolist (entry authors-fixed-entries)
379 (let ((author (car entry))
380 action)
381 (dolist (item (cdr entry))
382 (if (symbolp item)
383 (setq action item)
384 (authors-add author item action table))))))
385
3932b29a 386
8a5506f2
GM
387(defun authors-obsolete-file-p (file)
388 "Return non-nil if FILE is obsolete.
3932b29a 389FILE is considered obsolete if it matches one of the regular expressions
8a5506f2
GM
390from `authors-obsolete-files-regexps'."
391 (let (obsolete-p
392 (regexps authors-obsolete-files-regexps))
393 (while (and regexps (not obsolete-p))
394 (setq obsolete-p (string-match (car regexps) file)
395 regexps (cdr regexps)))
396 obsolete-p))
397
398
3215096c
GM
399(defun authors-add (author file action table)
400 "Record that AUTHOR worked on FILE.
401ACTION is a keyword symbol describing what he did. Record file,
402author and what he did in hash table TABLE. See the description of
403`authors-scan-change-log' for the structure of the hash table."
4ee02020
KS
404 (unless (or (member file authors-ignored-files)
405 (authors-obsolete-file-p file)
9c1af546 406 (equal author ""))
8a5506f2 407 (let* ((value (gethash author table))
f39caf44
KS
408 (entry (assoc file value))
409 slot)
8a5506f2 410 (if (null entry)
f39caf44
KS
411 (puthash author (cons (list file (cons action 1)) value) table)
412 (if (setq slot (assoc action (cdr entry)))
413 (setcdr slot (1+ (cdr slot)))
414 (nconc entry (list (cons action 1))))))))
3215096c
GM
415
416
417(defun authors-process-lines (program &rest args)
418 "Execute PROGRAM with ARGS, returning its output as a list of lines.
419Signal an error if the program returns with a non-zero exit status."
420 (with-temp-buffer
421 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
422 (unless (eq status 0)
423 (error "%s exited with status %s" program status))
424 (goto-char (point-min))
425 (let (lines)
426 (while (not (eobp))
427 (setq lines (cons (buffer-substring-no-properties
428 (line-beginning-position)
429 (line-end-position))
430 lines))
431 (forward-line 1))
432 (nreverse lines)))))
433
434
435(defun authors-canonical-author-name (author)
436 "Return a canonicalized form of AUTHOR, an author name.
437If AUTHOR has an alias, use that. Remove email addresses. Capitalize
438words in the author's name."
f39caf44
KS
439 (let* ((aliases authors-aliases)
440 regexps realname)
3215096c 441 (while aliases
f39caf44
KS
442 (setq realname (car (car aliases))
443 regexps (cdr (car aliases))
444 aliases (cdr aliases))
445 (while regexps
446 (if (string-match (car regexps) author)
447 (setq author realname
448 regexps nil
449 aliases nil)
450 (setq regexps (cdr regexps))))))
451 (when author
452 (setq author (replace-regexp-in-string "[ \t]*[(<].*$" "" author))
d0f483e8 453 (setq author (replace-regexp-in-string "\`[ \t]+" "" author))
f39caf44 454 (setq author (replace-regexp-in-string "[ \t]+$" "" author))
d0f483e8
KS
455 (setq author (replace-regexp-in-string "[ \t]+" " " author))
456 (unless (string-match "[-, \t]" author)
457 (setq author ""))
f39caf44
KS
458 (capitalize author)))
459
f39caf44
KS
460(defun authors-scan-change-log (log-file table)
461 "Scan change log LOG-FILE for author information.
3215096c
GM
462
463For each change mentioned in the log, add an entry to hash table TABLE
464under the author's canonical name.
465
466Keys of TABLE are author names. Values are alists of entries (FILE
f39caf44
KS
467\(ACTION . COUNT) ...). FILE is one file the author worked on. The
468rest of the entry is a list of keyword symbols describing what he did
469with the file and the number of each action.
3215096c
GM
470
471:wrote means the author wrote the file
f39caf44 472:changed means he changed the file COUNT times."
3932b29a 473
3215096c
GM
474 (let* ((enable-local-variables t)
475 (enable-local-eval t)
f39caf44
KS
476 (existing-buffer (get-file-buffer log-file))
477 (buffer (find-file-noselect log-file))
478 author file pos)
3215096c
GM
479 (save-excursion
480 (set-buffer buffer)
481 (save-restriction
482 (widen)
483 (goto-char (point-min))
484 (while (re-search-forward "^[0-9]\\|^[ \t]+\\* " nil t)
485 (beginning-of-line)
f39caf44 486 (setq pos (point))
3215096c
GM
487 (cond ((looking-at "^[0-9]+-[0-9]+-[0-9]+")
488 (skip-chars-forward " \t+:0-9-")
489 (setq author (buffer-substring-no-properties
490 (point) (line-end-position)))
491 (setq author (authors-canonical-author-name author))
492 (forward-line 1))
493 ((looking-at "^[ \t]+\\*")
494 (let ((line (buffer-substring-no-properties
495 (match-end 0) (line-end-position))))
496 (while (and (not (string-match ":" line))
497 (forward-line 1)
498 (not (looking-at ":\\|^[ \t]*$")))
499 (setq line (concat line
500 (buffer-substring-no-properties
501 (line-beginning-position)
502 (line-end-position)))))
503 (when (string-match ":" line)
504 (setq line (substring line 0 (match-beginning 0)))
505 (setq line (replace-regexp-in-string "[[(<{].*$" "" line))
506 (setq line (replace-regexp-in-string "," "" line))
507 (dolist (file (split-string line))
f39caf44
KS
508 (when (setq file (authors-canonical-file-name file log-file pos author))
509 ;;(message "%s changed %s" author file)
510 (authors-add author file :changed table))))
3215096c
GM
511 (forward-line 1)))))))
512 (unless existing-buffer
513 (kill-buffer buffer))))
514
515
516(defun authors-scan-el (file table)
517 "Scan Lisp file FILE for author information.
518TABLE is a hash table to add author information to."
519 (let* ((existing-buffer (get-file-buffer file))
520 (enable-local-variables t)
521 (enable-local-eval t)
522 (buffer (find-file-noselect file)))
523 (save-excursion
524 (set-buffer buffer)
525 (save-restriction
526 (widen)
527 (goto-char (point-min))
528 (while (and (re-search-forward
529 "^;+[ \t]*\\(Author\\|Commentary\\):[ \t]*" nil t)
530 (not (string= (match-string 1) "Commentary")))
531 ;; Some entries contain a year range in front of the
532 ;; author's name.
533 (skip-chars-forward "-0-9 \t")
534 (let ((author (buffer-substring-no-properties
535 (point) (line-end-position))))
536 (setq author (authors-canonical-author-name author))
537 (setq file (file-name-nondirectory file))
538 (authors-add author file :wrote table)))))
539 (unless existing-buffer
540 (kill-buffer buffer))))
541
542
0a521885
GM
543(defun authors-public-domain-p (file)
544 "Return t if FILE is a file that was put in public domain."
545 (let ((public-domain-p nil)
546 (list authors-public-domain-files))
547 (while (and list (not public-domain-p))
548 (when (string-match (car list) file)
549 (setq public-domain-p t))
550 (setq list (cdr list)))
551 public-domain-p))
552
f39caf44
KS
553(defvar authors-author-list)
554
555(defun authors-add-to-author-list (author changes)
556 "Insert information about AUTHOR's work on Emacs into `authors-author-list'.
557CHANGES is an alist of entries (FILE (ACTION . COUNT) ...), as produced by
558`authors-scan-change-log'.
559The element added to `authors-author-list' is (AUTHOR WROTE CHANGED), where
a1506d29 560WROTE and CHANGED are lists of the files written and changed by AUTHOR."
f39caf44
KS
561 (when author
562 (let ((nchanged 0)
563 wrote-list
564 changed-list)
3215096c
GM
565 (dolist (change changes)
566 (let ((actions (cdr change))
f39caf44
KS
567 (file (car change))
568 slot)
569 (if (assq :wrote actions)
570 (setq wrote-list
571 (cons
572 (if (authors-public-domain-p file)
573 (concat file " (public domain)")
574 file)
575 wrote-list))
576 (setq changed-list
577 (cons (cons file (cdr (assq :changed actions)))
578 changed-list)))))
579 (if wrote-list
580 (setq wrote-list (sort wrote-list 'string-lessp)))
581 (when changed-list
582 (setq changed-list (sort changed-list
583 (lambda (a b)
584 (if (= (cdr a) (cdr b))
585 (string-lessp (car a) (car b))
586 (> (cdr a) (cdr b))))))
587 (setq nchanged (length changed-list))
588 (setq changed-list (mapcar 'car changed-list)))
589 (if (> (- nchanged authors-many-files) 2)
590 (setcdr (nthcdr authors-many-files changed-list)
591 (list (format "and %d other files" (- nchanged authors-many-files)))))
592 (setq authors-author-list
593 (cons (list author wrote-list changed-list)
594 authors-author-list)))))
3215096c 595
3215096c
GM
596(defun authors (root)
597 "Extract author information from change logs and Lisp source files.
598ROOT is the root directory under which to find the files. If called
a1506d29 599interactively, ROOT is read from the minibuffer.
f39caf44
KS
600Result is a buffer *Authors* containing authorship information, and a
601buffer *Authors Errors* containing references to unknown files."
3215096c 602 (interactive "DEmacs source directory: ")
d2f288c6 603 (setq root (expand-file-name root))
3215096c
GM
604 (let ((logs (authors-process-lines "find" root "-name" "ChangeLog*"))
605 (table (make-hash-table :test 'equal))
f39caf44
KS
606 (buffer-name "*Authors*")
607 authors-checked-files-alist
608 authors-invalid-file-names)
d5ab63b2 609 (authors-add-fixed-entries table)
3215096c
GM
610 (unless (file-exists-p (expand-file-name "src/emacs.c" root))
611 (error "Not the root directory of Emacs: %s" root))
612 (dolist (log logs)
77777daf 613 (when (string-match "ChangeLog\\(.[0-9]+\\)?$" log)
3215096c
GM
614 (message "Scanning %s..." log)
615 (authors-scan-change-log log table)))
616 (let ((els (authors-process-lines "find" root "-name" "*.el")))
617 (dolist (file els)
618 (message "Scanning %s..." file)
619 (authors-scan-el file table)))
f39caf44 620 (message "Generating buffer %s..." buffer-name)
3215096c
GM
621 (set-buffer (get-buffer-create buffer-name))
622 (erase-buffer)
f39caf44 623 (set-buffer-file-coding-system authors-coding-system)
a1506d29 624 (insert
f39caf44
KS
625"Many people have contributed code included in the Free Software
626Foundation's distribution of GNU Emacs. To show our appreciation for
627their public spirit, we list here in alphabetical order a condensed
628list of their contributions.\n")
629 (let (authors-author-list a)
630 (maphash #'authors-add-to-author-list table)
a1506d29 631 (setq authors-author-list
f39caf44
KS
632 (sort authors-author-list
633 (lambda (a b) (string-lessp (car a) (car b)))))
634 (dolist (a authors-author-list)
635 (let ((author (car a))
636 (wrote (nth 1 a))
637 (changed (nth 2 a))
638 file)
639 (insert "\n" author ": ")
640 (when wrote
641 (insert "wrote")
642 (dolist (file wrote)
643 (if (> (+ (current-column) (length file)) 72)
644 (insert "\n "))
645 (insert " " file))
646 (insert "\n"))
647 (when changed
648 (if wrote
649 (insert "and "))
650 (insert "changed")
651 (dolist (file changed)
652 (if (> (+ (current-column) (length file)) 72)
653 (insert "\n "))
654 (insert " " file))
655 (insert "\n")))))
a1506d29 656 (insert "\nLocal" " Variables:\ncoding: "
f39caf44
KS
657 (symbol-name authors-coding-system) "\nEnd:\n")
658 (message "Generating buffer %s... done" buffer-name)
d5ab63b2 659 (unless noninteractive
f39caf44
KS
660 (when authors-invalid-file-names
661 (with-current-buffer (get-buffer-create "*Authors Errors*")
662 (erase-buffer)
663 (set-buffer-file-coding-system authors-coding-system)
664 (insert "Unrecognized file entries found:\n\n")
665 (mapcar (lambda (f) (if (not (string-match "^[A-Za-z]+$" f)) (insert f "\n")))
666 (sort authors-invalid-file-names 'string-lessp))
667 (goto-char (point-min))
668 (compilation-mode)
669 (message "Errors were found. See buffer %s" (buffer-name))))
d5ab63b2
GM
670 (pop-to-buffer buffer-name))))
671
672
d5ab63b2
GM
673(defun batch-update-authors ()
674 "Produce an AUTHORS file.
675Call this function in batch mode with two command line arguments FILE
676and ROOT. FILE is the file to write, ROOT is the root directory of
677the Emacs source tree, from which to build the file."
678 (unless noninteractive
679 (error "`batch-update-authors' is to be used only with -batch"))
680 (when (/= (length command-line-args-left) 2)
681 (error "Call `batch-update-authors' with the name of the file to write"))
682 (let* ((file (pop command-line-args-left))
683 (root (pop command-line-args-left)))
684 (authors root)
685 (write-file file)))
3215096c 686
ab5796a9 687;;; arch-tag: 659d5900-5ff2-43b0-954c-a315cc1e4dc1
55535639 688;;; authors.el ends here