1 ;;; upd-copyr.el --- update the copyright notice in a GNU Emacs Lisp file
3 ;;; Copyright (C) 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
5 ;; Author: Roland McGrath <roland@gnu.ai.mit.edu>
8 ;;; This file is part of GNU Emacs.
10 ;;; This program is free software; you can redistribute it and/or modify
11 ;;; it under the terms of the GNU General Public License as published by
12 ;;; the Free Software Foundation; either version 2, or (at your option)
13 ;;; any later version.
15 ;;; This program is distributed in the hope that it will be useful,
16 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;;; GNU General Public License for more details.
20 ;;; A copy of the GNU General Public License can be obtained from this
21 ;;; program's author (send electronic mail to roland@ai.mit.edu) or from
22 ;;; the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
27 (defconst current-year (substring (current-time-string) -4)
28 "String representing the current year.")
30 (defvar current-gpl-version "2"
31 "String representing the current version of the GPL.")
34 (defvar replace-copying-with nil
35 "*If non-nil, replace copying notices with this file.")
37 (defvar inhibit-update-copyright nil
38 "If nil, ask the user whether or not to update the copyright notice.
39 If the user has said no, we set this to t locally.")
42 (defun update-copyright (&optional replace ask-upd ask-year)
43 "Update the copyright notice at the beginning of the buffer
44 to indicate the current year. If optional arg REPLACE is given
45 \(interactively, with prefix arg\) replace the years in the notice
46 rather than adding the current year after them.
47 If `replace-copying-with' is set, the copying permissions following the
48 copyright are replaced as well.
50 If optional third argument ASK is non-nil, the user is prompted for whether
51 or not to update the copyright. If optional fourth argument ASK-YEAR is
52 non-nil, the user is prompted for whether or not to replace the year rather
58 (goto-char (point-min))
59 ;; Handle abbreviated year lists like "1800, 01, 02, 03"
60 ;; or "1900, '01, '02, '03".
61 (if (re-search-forward (concat "\\(" (substring current-year 0 2)
63 "\\([0-9][0-9]\\(,\\s \\)+\\)*'?"
64 (substring current-year 2))
67 (message "Copyright notice already includes %s." current-year))
68 (goto-char (point-min))
69 (if (and (not inhibit-update-copyright)
71 ;; If implicit, narrow it down to things that
72 ;; look like GPL notices.
74 (search-forward "is free software" nil t)
75 (goto-char (point-min))))
77 "[Cc]opyright[^0-9]*\\(\\(\\([-, \t]*\\([0-9]+\\)\\)\\)+\\)"
80 (save-window-excursion
81 (pop-to-buffer (current-buffer))
83 ;; Show the user the copyright.
84 (goto-char (point-min))
86 (or (y-or-n-p "Update copyright? ")
88 (set (make-local-variable
89 'inhibit-update-copyright) t)
95 (save-window-excursion
96 (pop-to-buffer (current-buffer))
98 ;; Show the user the copyright.
99 (goto-char (point-min))
101 (y-or-n-p "Replace copyright year? "))))))
103 (delete-region (match-beginning 1) (match-end 1))
105 (insert current-year)
106 (message "Copyright updated to %s%s."
107 (if replace "" "include ") current-year)
108 (if replace-copying-with
109 (let ((case-fold-search t)
111 (goto-char (point-min))
112 ;; Find the beginning of the copyright.
113 (if (search-forward "copyright" nil t)
115 ;; Look for a blank line or a line
116 ;; containing only comment chars.
117 (if (re-search-forward "^\\(\\s \\s<\\|\\s>\\)*$" nil t)
119 (with-output-to-temp-buffer "*Help*"
120 (princ (substitute-command-keys "\
121 I don't know where the copying notice begins.
122 Put point there and hit \\[exit-recursive-edit]."))
124 (set-buffer standard-output)
128 (or (search-forward "02139, USA." nil t)
129 (with-output-to-temp-buffer "*Help*"
130 (princ (substitute-command-keys "\
131 I don't know where the copying notice ends.
132 Put point there and hit \\[exit-recursive-edit]."))
134 (set-buffer standard-output)
137 (delete-region beg (point))))
138 (insert-file replace-copying-with))
139 (if (re-search-forward
140 "; either version \\(.+\\), or (at your option)"
143 (goto-char (match-beginning 1))
144 (delete-region (point) (match-end 1))
145 (insert current-gpl-version))))))))))
148 (defun ask-to-update-copyright ()
149 "If the current buffer contains a copyright notice that is out of date,
150 ask the user if it should be updated with `update-copyright' (which see).
151 Put this on write-file-hooks."
152 (update-copyright nil t t)
153 ;; Be sure return nil; if a write-file-hook return non-nil,
154 ;; the file is presumed to be already written.
159 ;;; upd-copyr.el ends here