1 ;;; copyright.el --- update the copyright notice in current buffer
3 ;; Copyright (C) 1991, 1992, 1993, 1994, 1995, 1998, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Daniel Pfeiffer <occitan@esperanto.org>
7 ;; Keywords: maint, tools
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; Allows updating the copyright year and above mentioned GPL version manually
27 ;; or when saving a file.
28 ;; Do (add-hook 'before-save-hook 'copyright-update), or use
29 ;; M-x customize-variable RET before-save-hook RET.
33 (defgroup copyright nil
34 "Update the copyright notice in current buffer."
37 (defcustom copyright-limit
2000
38 "Don't try to update copyright beyond this position unless interactive.
39 A value of nil means to search whole buffer."
41 :type
'(choice (integer :tag
"Limit")
42 (const :tag
"No limit")))
44 (defcustom copyright-at-end-flag nil
45 "Non-nil means to search backwards from the end of the buffer for copyright.
46 This is useful for ChangeLogs."
51 (defcustom copyright-regexp
52 "\\(©\\|@copyright{}\\|[Cc]opyright\\s *:?\\s *\\(?:(C)\\)?\
53 \\|[Cc]opyright\\s *:?\\s *©\\)\
54 \\s *\\([1-9]\\([-0-9, ';/*%#\n\t]\\|\\s<\\|\\s>\\)*[0-9]+\\)"
55 "What your copyright notice looks like.
56 The second \\( \\) construct must match the years."
60 (defcustom copyright-names-regexp
""
61 "Regexp matching the names which correspond to the user.
62 Only copyright lines where the name matches this regexp will be updated.
63 This allows you to avoid adding years to a copyright notice belonging to
64 someone else or to a group for which you do not work."
68 (defcustom copyright-years-regexp
69 "\\(\\s *\\)\\([1-9]\\([-0-9, ';/*%#\n\t]\\|\\s<\\|\\s>\\)*[0-9]+\\)"
70 "Match additional copyright notice years.
71 The second \\( \\) construct must match the years."
76 (defcustom copyright-query
'function
77 "If non-nil, ask user before changing copyright.
78 When this is `function', only ask when called non-interactively."
80 :type
'(choice (const :tag
"Do not ask")
81 (const :tag
"Ask unless interactive" function
)
82 (other :tag
"Ask" t
)))
85 ;; when modifying this, also modify the comment generated by autoinsert.el
86 (defconst copyright-current-gpl-version
"3"
87 "String representing the current version of the GPL or nil.")
89 (defvar copyright-update t
)
91 ;; This is a defvar rather than a defconst, because the year can
92 ;; change during the Emacs session.
93 (defvar copyright-current-year
(substring (current-time-string) -
4)
94 "String representing the current year.")
96 (defsubst copyright-limit
() ; re-search-forward BOUND
98 (if copyright-at-end-flag
99 (- (point) copyright-limit
)
100 (+ (point) copyright-limit
))))
102 (defun copyright-re-search (regexp &optional bound noerror count
)
103 "Re-search forward or backward depending on `copyright-at-end-flag'."
104 (if copyright-at-end-flag
105 (re-search-backward regexp bound noerror count
)
106 (re-search-forward regexp bound noerror count
)))
108 (defun copyright-start-point ()
109 "Return point-min or point-max, depending on `copyright-at-end-flag'."
110 (if copyright-at-end-flag
114 (defun copyright-offset-too-large-p ()
115 "Return non-nil if point is too far from the edge of the buffer."
116 (when copyright-limit
117 (if copyright-at-end-flag
118 (< (point) (- (point-max) copyright-limit
))
119 (> (point) (+ (point-min) copyright-limit
)))))
121 (defun copyright-update-year (replace noquery
)
124 ;; (1) Need the extra \\( \\) around copyright-regexp because we
125 ;; goto (match-end 1) below. See note (2) below.
126 (copyright-re-search (concat "\\(" copyright-regexp
127 "\\)\\([ \t]*\n\\)?.*\\(?:"
128 copyright-names-regexp
"\\)")
131 ;; In case the regexp is rejected. This is useful because
132 ;; copyright-update is typically called from before-save-hook where
133 ;; such an error is very inconvenient for the user.
134 (error (message "Can't update copyright: %s" err
) nil
))
135 (goto-char (match-end 1))
136 ;; If the years are continued onto multiple lines
137 ;; that are marked as comments, skip to the end of the years anyway.
138 (while (save-excursion
139 (and (eq (following-char) ?
,)
140 (progn (forward-char 1) t
)
141 (progn (skip-chars-forward " \t") (eolp))
145 (and (looking-at comment-start-skip
)
146 (goto-char (match-end 0))))
147 (looking-at-p copyright-years-regexp
)))
149 (re-search-forward comment-start-skip
)
150 ;; (2) Need the extra \\( \\) so that the years are subexp 3, as
151 ;; they are at note (1) above.
152 (re-search-forward (format "\\(%s\\)" copyright-years-regexp
)))
154 ;; Note that `current-time-string' isn't locale-sensitive.
155 (setq copyright-current-year
(substring (current-time-string) -
4))
156 (unless (string= (buffer-substring (- (match-end 3) 2) (match-end 3))
157 (substring copyright-current-year -
2))
159 (y-or-n-p (if replace
160 (concat "Replace copyright year(s) by "
161 copyright-current-year
"? ")
162 (concat "Add " copyright-current-year
163 " to copyright? "))))
165 (replace-match copyright-current-year t t nil
3)
166 (let ((size (save-excursion (skip-chars-backward "0-9"))))
167 (if (and (eq (%
(- (string-to-number copyright-current-year
)
168 (string-to-number (buffer-substring
173 (or (eq (char-after (+ (point) size -
1)) ?-
)
174 (eq (char-after (+ (point) size -
2)) ?-
)))
175 ;; This is a range so just replace the end part.
177 ;; Insert a comma with the preferred number of spaces.
180 (if (re-search-backward "[0-9]\\( *, *\\)[0-9]"
181 (line-beginning-position) t
)
184 ;; If people use the '91 '92 '93 scheme, do that as well.
185 (if (eq (char-after (+ (point) size -
3)) ?
')
187 ;; Finally insert the new year.
188 (insert (substring copyright-current-year size
))))))))
191 (defun copyright-update (&optional arg interactivep
)
192 "Update copyright notice at beginning of buffer to indicate the current year.
193 With prefix ARG, replace the years in the notice rather than adding
194 the current year after them. If necessary, and
195 `copyright-current-gpl-version' is set, any copying permissions
196 following the copyright are updated as well.
197 If non-nil, INTERACTIVEP tells the function to behave as when it's called
199 (interactive "*P\nd")
200 (when (or copyright-update interactivep
)
201 (let ((noquery (or (not copyright-query
)
202 (and (eq copyright-query
'function
) interactivep
))))
206 (goto-char (copyright-start-point))
207 (copyright-update-year arg noquery
)
208 (goto-char (copyright-start-point))
209 (and copyright-current-gpl-version
210 ;; match the GPL version comment in .el files, including the
211 ;; bilingual Esperanto one in two-column, and in texinfo.tex
213 "\\(the Free Software Foundation;\
214 either \\|; a\\^u eldono \\([0-9]+\\)a, ? a\\^u (la\\^u via \\)\
215 version \\([0-9]+\\), or (at"
217 ;; Don't update if the file is already using a more recent
218 ;; version than the "current" one.
219 (< (string-to-number (match-string 3))
220 (string-to-number copyright-current-gpl-version
))
222 (y-or-n-p (format "Replace GPL version by %s? "
223 copyright-current-gpl-version
)))
226 ;; Esperanto bilingual comment in two-column.el
227 (replace-match copyright-current-gpl-version t t nil
2))
228 (replace-match copyright-current-gpl-version t t nil
3))))
229 (set (make-local-variable 'copyright-update
) nil
)))
230 ;; If a write-file-hook returns non-nil, the file is presumed to be written.
235 (defun copyright-fix-years ()
236 "Convert 2 digit years to 4 digit years.
237 Uses heuristic: year >= 50 means 19xx, < 50 means 20xx."
240 (goto-char (copyright-start-point))
241 (if (copyright-re-search copyright-regexp
(copyright-limit) t
)
242 (let ((s (match-beginning 2))
243 (e (copy-marker (1+ (match-end 2))))
247 (while (re-search-forward "[0-9]+" e t
)
248 (set-marker p
(point))
249 (goto-char (match-beginning 0))
250 (let ((sep (char-before))
251 (year (string-to-number (match-string 0))))
253 (/= (char-syntax sep
) ?\s
)
257 (insert (if (>= year
50) "19" "20"))))
262 ;; Don't mess up whitespace after the years.
263 (skip-chars-backward " \t")
265 (narrow-to-region (copyright-start-point) (point))
266 (let ((fill-prefix " "))
267 (fill-region s last
))))
270 (copyright-update nil t
))
271 (message "No copyright message")))
274 (define-skeleton copyright
275 "Insert a copyright by $ORGANIZATION notice at cursor."
278 "Copyright (C) " `(substring (current-time-string) -
4) " by "
279 (or (getenv "ORGANIZATION")
281 '(if (copyright-offset-too-large-p)
282 (message "Copyright extends beyond `copyright-limit' and won't be updated automatically."))
285 (defun copyright-update-directory (directory match
)
286 "Update copyright notice for all files in DIRECTORY matching MATCH."
287 (interactive "DDirectory: \nMFilenames matching: ")
288 (dolist (file (directory-files directory t match nil
))
290 (let ((copyright-query nil
))
293 (kill-buffer (current-buffer))))
297 ;; For the copyright sign:
302 ;; arch-tag: b4991afb-b6b1-4590-bebe-e076d9d4aee8
303 ;;; copyright.el ends here