lisp/emacs-lisp/copyright.el

   1 ;;; copyright.el --- update the copyright notice in current buffer
   2
   3 ;; Copyright (C) 1991, 92, 93, 94, 95, 1998 Free Software Foundation, Inc.
   4
   5 ;; Author: Daniel Pfeiffer <occitan@esperanto.org>
   6 ;; Keywords: maint, tools
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs 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.
  14
  15 ;; GNU Emacs 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.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;; Allows updating the copyright year and above mentioned GPL version manually
  28 ;; or when saving a file.  Do (add-hook 'write-file-hooks 'copyright-update).
  29
  30 ;;; Code:
  31
  32 (defgroup copyright nil
  33   "Update the copyright notice in current buffer."
  34   :group 'tools)
  35
  36 (defcustom copyright-limit 2000
  37   "*Don't try to update copyright beyond this position unless interactive.
  38 `nil' means to search whole buffer."
  39   :group 'copyright
  40   :type '(choice (integer :tag "Limit")
  41                  (const :tag "No limit")))
  42
  43 ;; Cleaner to specify Latin-1 coding for this file, and not use both
  44 ;; unibyte and multibyte copyright symbol characters?
  45 (defcustom copyright-regexp
  46   "\\([\251\81©]\\|@copyright{}\\|[Cc]opyright\\s *:?\\s *(C)\
  47 \\|[Cc]opyright\\s *:?\\s *[\251\81©]\\)\
  48 \\s *\\([1-9][-0-9, ']*[0-9]+\\)"
  49   "*What your copyright notice looks like.
  50 The second \\( \\) construct must match the years."
  51   :group 'copyright
  52   :type 'regexp)
  53
  54
  55 (defcustom copyright-query 'function
  56   "*If non-`nil', ask user before changing copyright.
  57 When this is `function', only ask when called non-interactively."
  58   :group 'copyright
  59   :type '(choice (const :tag "Do not ask")
  60                  (const :tag "Ask unless interactive" function)
  61                  (other :tag "Ask" t)))
  62
  63
  64 (defconst copyright-current-year (substring (current-time-string) -4)
  65   "String representing the current year.")
  66
  67
  68 ;; when modifying this, also modify the comment generated by autoinsert.el
  69 (defconst copyright-current-gpl-version "2"
  70   "String representing the current version of the GPL or `nil'.")
  71
  72 (defvar copyright-update t)
  73
  74 ;;;###autoload
  75 (defun copyright-update (&optional arg)
  76   "Update the copyright notice at the beginning of the buffer to indicate
  77 the current year.  If optional prefix ARG is given replace the years in the
  78 notice rather than adding the current year after them.  If necessary and
  79 `copyright-current-gpl-version' is set, the copying permissions following the
  80 copyright, if any, are updated as well."
  81   (interactive "*P")
  82   (if copyright-update
  83       (save-excursion
  84         (save-restriction
  85           (widen)
  86           (goto-char (point-min))
  87           (if (re-search-forward copyright-regexp copyright-limit t)
  88               (if (string= (buffer-substring (- (match-end 2) 2) (match-end 2))
  89                            (substring copyright-current-year -2))
  90                   ()
  91                 (if (or (not copyright-query)
  92                         (and (eq copyright-query 'function)
  93                              (eq this-command 'copyright-update))
  94                         (y-or-n-p (if arg
  95                                       (concat "Replace copyright year(s) by "
  96                                               copyright-current-year "? ")
  97                                     (concat "Add " copyright-current-year
  98                                             " to copyright? "))))
  99                     (if arg
 100                         (progn
 101                           (delete-region (match-beginning 1) (match-end 1))
 102                           (insert copyright-current-year))
 103                       (setq arg (save-excursion (skip-chars-backward "0-9")))
 104                       (if (and (eq (% (- (string-to-number
 105                                           copyright-current-year)
 106                                          (string-to-number (buffer-substring
 107                                                             (+ (point) arg)
 108                                                             (point))))
 109                                       100)
 110                                    1)
 111                                (or (eq (char-after (+ (point) arg -1)) ?-)
 112                                    (eq (char-after (+ (point) arg -2)) ?-)))
 113                           (delete-char arg)
 114                         (insert ", ")
 115                         (if (eq (char-after (+ (point) arg -3)) ?')
 116                             (insert ?')))
 117                       (insert (substring copyright-current-year arg))))))
 118           (goto-char (point-min))
 119           (and copyright-current-gpl-version
 120                ;; match the GPL version comment in .el files, including the
 121                ;; bilingual Esperanto one in two-column, and in texinfo.tex
 122                (re-search-forward "\\(the Free Software Foundation; either \\|; a\\^u eldono \\([0-9]+\\)a, ? a\\^u (la\\^u via  \\)version \\([0-9]+\\), or (at"
 123                                   copyright-limit t)
 124                (not (string= (buffer-substring (match-beginning 3) (match-end 3))
 125                              copyright-current-gpl-version))
 126                (or (not copyright-query)
 127                    (and (eq copyright-query 'function)
 128                         (eq this-command 'copyright-update))
 129                    (y-or-n-p (concat "Replace GPL version by "
 130                                      copyright-current-gpl-version "? ")))
 131                (progn
 132                  (if (match-end 2)
 133                      ;; Esperanto bilingual comment in two-column.el
 134                      (progn
 135                        (delete-region (match-beginning 2) (match-end 2))
 136                        (goto-char (match-beginning 2))
 137                        (insert copyright-current-gpl-version)))
 138                  (delete-region (match-beginning 3) (match-end 3))
 139                  (goto-char (match-beginning 3))
 140                  (insert copyright-current-gpl-version))))
 141         (set (make-local-variable 'copyright-update) nil)))
 142   ;; If a write-file-hook returns non-nil, the file is presumed to be written.
 143   nil)
 144
 145
 146 ;;;###autoload
 147 (define-skeleton copyright
 148   "Insert a copyright by $ORGANIZATION notice at cursor."
 149   "Company: "
 150   comment-start
 151   "Copyright (C) " copyright-current-year " by "
 152   (or (getenv "ORGANIZATION")
 153       str)
 154   '(if (> (point) copyright-limit)
 155        (message "Copyright extends beyond `copyright-limit' and won't be updated automatically."))
 156   comment-end)
 157
 158 (provide 'copyright)
 159
 160 ;; For the copyright sign:
 161 ;; Local Variables:
 162 ;; coding: emacs-mule
 163 ;; End:
 164
 165 ;; copyright.el ends here