X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/4ea0018b7fd298525be4b9eb54d720a74e2f18a1..8b6361c15f9578041aa41a41c59d8dc772737f7f:/lisp/add-log.el diff --git a/lisp/add-log.el b/lisp/add-log.el index d7f9f9b984..47a839d539 100644 --- a/lisp/add-log.el +++ b/lisp/add-log.el @@ -1,7 +1,7 @@ ;;; add-log.el --- change log maintenance commands for Emacs ;; Copyright (C) 1985, 1986, 1988, 1993, 1994, 1997, 1998, 2000, 2002, -;; 2003, 2004, 2005 Free Software Foundation, Inc. +;; 2003, 2004, 2005, 2006 Free Software Foundation, Inc. ;; Maintainer: FSF ;; Keywords: tools @@ -45,6 +45,8 @@ :type '(choice (const :tag "default" nil) string) :group 'change-log) +(put 'change-log-default-name 'safe-local-variable + (lambda (a) (or (stringp a) (null a)))) (defcustom change-log-mode-hook nil "Normal hook run by `change-log-mode'." @@ -70,7 +72,7 @@ This defaults to the value returned by the function `user-full-name'." ;;;###autoload (defcustom add-log-mailing-address nil - "*Email addresses of user, for inclusion in ChangeLog headers. + "Email addresses of user, for inclusion in ChangeLog headers. This defaults to the value of `user-mail-address'. In addition to being a simple string, this value can also be a list. All elements will be recognized as referring to the same user; when creating a new @@ -81,7 +83,7 @@ ChangeLog entry, one element will be chosen at random." :group 'change-log) (defcustom add-log-time-format 'add-log-iso8601-time-string - "*Function that defines the time format. + "Function that defines the time format. For example, `add-log-iso8601-time-string', which gives the date in international ISO 8601 format, and `current-time-string' are two valid values." @@ -93,7 +95,7 @@ and `current-time-string' are two valid values." :group 'change-log) (defcustom add-log-keep-changes-together nil - "*If non-nil, normally keep day's log entries for one file together. + "If non-nil, normally keep day's log entries for one file together. Log entries for a given file made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window] will only be added to others \ @@ -125,20 +127,20 @@ this variable." :group 'change-log) (defcustom add-log-always-start-new-record nil - "*If non-nil, `add-change-log-entry' will always start a new record." + "If non-nil, `add-change-log-entry' will always start a new record." :version "22.1" :type 'boolean :group 'change-log) (defcustom add-log-buffer-file-name-function nil - "*If non-nil, function to call to identify the full filename of a buffer. + "If non-nil, function to call to identify the full filename of a buffer. This function is called with no argument. If this is nil, the default is to use `buffer-file-name'." :type '(choice (const nil) function) :group 'change-log) (defcustom add-log-file-name-function nil - "*If non-nil, function to call to identify the filename for a ChangeLog entry. + "If non-nil, function to call to identify the filename for a ChangeLog entry. This function is called with one argument, the value of variable `buffer-file-name' in that buffer. If this is nil, the default is to use the file's name relative to the directory of the change log file." @@ -284,12 +286,16 @@ Note: The search is conducted only within 10%, at the beginning of the file." map) "Keymap for Change Log major mode.") -(defvar change-log-time-zone-rule nil +;; It used to be called change-log-time-zone-rule but really should be +;; called add-log-time-zone-rule since it's only used from add-log-* code. +(defvaralias 'change-log-time-zone-rule 'add-log-time-zone-rule) +(defvar add-log-time-zone-rule nil "Time zone used for calculating change log time stamps. It takes the same format as the TZ argument of `set-time-zone-rule'. -If nil, use local time.") +If nil, use local time. +If t, use universal time.") -(defun add-log-iso8601-time-zone (time) +(defun add-log-iso8601-time-zone (&optional time) (let* ((utc-offset (or (car (current-time-zone time)) 0)) (sign (if (< utc-offset 0) ?- ?+)) (sec (abs utc-offset)) @@ -302,18 +308,14 @@ If nil, use local time.") (t "%c%02d")) sign hh mm ss))) +(defvar add-log-iso8601-with-time-zone nil) + (defun add-log-iso8601-time-string () - (if change-log-time-zone-rule - (let ((tz (getenv "TZ")) - (now (current-time))) - (unwind-protect - (progn - (set-time-zone-rule change-log-time-zone-rule) - (concat - (format-time-string "%Y-%m-%d " now) - (add-log-iso8601-time-zone now))) - (set-time-zone-rule tz))) - (format-time-string "%Y-%m-%d"))) + (let ((time (format-time-string "%Y-%m-%d" + nil (eq t add-log-time-zone-rule)))) + (if add-log-iso8601-with-time-zone + (concat time " " (add-log-iso8601-time-zone)) + time))) (defun change-log-name () "Return (system-dependent) default name for a change log file." @@ -492,7 +494,7 @@ The change log file can start with a copyright notice and a copying permission notice. The first blank line indicates the end of these notices. -Today's date is calculated according to `change-log-time-zone-rule' if +Today's date is calculated according to `add-log-time-zone-rule' if non-nil, otherwise in local time." (interactive (list current-prefix-arg (prompt-for-change-log-name))) @@ -536,13 +538,22 @@ non-nil, otherwise in local time." (skip-chars-forward "\n")) ;; Advance into first entry if it is usable; else make new one. - (let ((new-entries (mapcar (lambda (addr) - (concat (funcall add-log-time-format) - " " full-name - " <" addr ">")) - (if (consp mailing-address) - mailing-address - (list mailing-address))))) + (let ((new-entries + (mapcar (lambda (addr) + (concat + (if (stringp add-log-time-zone-rule) + (let ((tz (getenv "TZ"))) + (unwind-protect + (progn + (set-time-zone-rule add-log-time-zone-rule) + (funcall add-log-time-format)) + (set-time-zone-rule tz))) + (funcall add-log-time-format)) + " " full-name + " <" addr ">")) + (if (consp mailing-address) + mailing-address + (list mailing-address))))) (if (and (not add-log-always-start-new-record) (let ((hit nil)) (dolist (entry new-entries hit) @@ -551,7 +562,8 @@ non-nil, otherwise in local time." (forward-line 1) (insert (nth (random (length new-entries)) new-entries) - hard-newline hard-newline) + (if use-hard-newlines hard-newline "\n") + (if use-hard-newlines hard-newline "\n")) (forward-line -1))) ;; Determine where we should stop searching for a usable @@ -584,7 +596,8 @@ non-nil, otherwise in local time." ;; Delete excess empty lines; make just 2. (while (and (not (eobp)) (looking-at "^\\s *$")) (delete-region (point) (line-beginning-position 2))) - (insert hard-newline hard-newline) + (insert (if use-hard-newlines hard-newline "\n") + (if use-hard-newlines hard-newline "\n")) (forward-line -2) (indent-relative-maybe)) (t @@ -593,7 +606,9 @@ non-nil, otherwise in local time." (forward-line 1)) (while (and (not (eobp)) (looking-at "^\\s *$")) (delete-region (point) (line-beginning-position 2))) - (insert hard-newline hard-newline hard-newline) + (insert (if use-hard-newlines hard-newline "\n") + (if use-hard-newlines hard-newline "\n") + (if use-hard-newlines hard-newline "\n")) (forward-line -2) (indent-to left-margin) (insert "* ") @@ -646,21 +661,21 @@ the change log file in another window." (add-change-log-entry whoami file-name t)) ;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window) -(defvar add-log-indent-text 0) +(defvar change-log-indent-text 0) -(defun add-log-indent () +(defun change-log-indent () (let* ((indent (save-excursion (beginning-of-line) (skip-chars-forward " \t") (cond - ((and (looking-at "\\(.*\\) [^ \n].*[^ \n] <.*>$") + ((and (looking-at "\\(.*\\) [^ \n].*[^ \n] <.*>\\(?: +(.*)\\)? *$") ;; Matching the output of add-log-time-format is difficult, ;; but I'll get it has at least two adjacent digits. (string-match "[[:digit:]][[:digit:]]" (match-string 1))) 0) ((looking-at "[^*(]") - (+ (current-left-margin) add-log-indent-text)) + (+ (current-left-margin) change-log-indent-text)) (t (current-left-margin))))) (pos (save-excursion (indent-line-to indent) (point)))) (if (> pos (point)) (goto-char pos)))) @@ -682,7 +697,7 @@ Runs `change-log-mode-hook'. tab-width 8) (set (make-local-variable 'fill-paragraph-function) 'change-log-fill-paragraph) - (set (make-local-variable 'indent-line-function) 'add-log-indent) + (set (make-local-variable 'indent-line-function) 'change-log-indent) (set (make-local-variable 'tab-always-indent) nil) ;; We really do want "^" in paragraph-start below: it is only the ;; lines that begin at column 0 (despite the left-margin of 8) that @@ -716,23 +731,23 @@ Prefix arg means justify as well." (defcustom add-log-current-defun-header-regexp "^\\([[:upper:]][[:upper:]_ ]*[[:upper:]_]\\|[-_[:alpha:]]+\\)[ \t]*[:=]" - "*Heuristic regexp used by `add-log-current-defun' for unknown major modes." + "Heuristic regexp used by `add-log-current-defun' for unknown major modes." :type 'regexp :group 'change-log) ;;;###autoload (defvar add-log-lisp-like-modes - '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode) + '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode) "*Modes that look like Lisp to `add-log-current-defun'.") ;;;###autoload (defvar add-log-c-like-modes - '(c-mode c++-mode c++-c-mode objc-mode) + '(c-mode c++-mode c++-c-mode objc-mode) "*Modes that look like C to `add-log-current-defun'.") ;;;###autoload (defvar add-log-tex-like-modes - '(TeX-mode plain-TeX-mode LaTeX-mode plain-tex-mode latex-mode) + '(TeX-mode plain-TeX-mode LaTeX-mode plain-tex-mode latex-mode) "*Modes that look like TeX to `add-log-current-defun'.") ;;;###autoload @@ -1066,7 +1081,7 @@ old-style time formats for entries are supported." (and (= ?\n (char-before)) (or (<= (1- (point)) (point-min)) (= ?\n (char-before (1- (point))))))) - (insert hard-newline)) + (insert (if use-hard-newlines hard-newline "\n"))) ;; Move to the end of it to terminate outer loop. (with-current-buffer other-buf (goto-char (point-max))) @@ -1097,5 +1112,5 @@ old-style time formats for entries are supported." (provide 'add-log) -;;; arch-tag: 81eee6fc-088f-4372-a37f-80ad9620e762 +;; arch-tag: 81eee6fc-088f-4372-a37f-80ad9620e762 ;;; add-log.el ends here