X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/f7769aa59edf082f925afdd8226f46cd78f6aa0e..8a76ffd1435bc0fc42983f5c1bf9b4ce59c1d679:/lisp/time-stamp.el diff --git a/lisp/time-stamp.el b/lisp/time-stamp.el index a9c8b1d31f..c66736a359 100644 --- a/lisp/time-stamp.el +++ b/lisp/time-stamp.el @@ -1,35 +1,38 @@ ;;; time-stamp.el --- Maintain last change time stamps in files edited by Emacs -;; Copyright 1989, 1993, 1994, 1995, 1997 Free Software Foundation, Inc. +;; Copyright (C) 1989, 1993, 1994, 1995, 1997, 2000, 2001, 2002, 2003, +;; 2004, 2005, 2006 Free Software Foundation, Inc. -;; Maintainer's Time-stamp: <1999-01-06 11:06:03 gildea> -;; Maintainer: Stephen Gildea +;; This file is part of GNU Emacs. + +;; Maintainer's Time-stamp: <2006-04-12 20:30:56 rms> +;; Maintainer: Stephen Gildea ;; Keywords: tools -;; This file is free software; you can redistribute it and/or modify +;; GNU Emacs is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation; either version 2, or (at your option) ;; any later version. -;; This file is distributed in the hope that it will be useful, +;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs; see the file COPYING. If not, write to the -;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, -;; Boston, MA 02111-1307, USA. +;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: ;; A template in a file can be updated with a new time stamp when ;; you save the file. For example: -;; static char *ts = "sdmain.c Time-stamp: <1996-08-13 10:20:51 gildea>"; +;; static char *ts = "sdmain.c Time-stamp: <2001-08-13 10:20:51 gildea>"; ;; See the top of `time-stamp.el' for another example. ;; To use time-stamping, add this line to your .emacs file: -;; (add-hook 'write-file-hooks 'time-stamp) +;; (add-hook 'before-save-hook 'time-stamp) ;; Now any time-stamp templates in your files will be updated automatically. ;; See the documentation for the functions `time-stamp' @@ -47,7 +50,11 @@ The value may be a string or a list. Lists are supported only for backward compatibility; see variable `time-stamp-old-format-warn'. -A string is used verbatim except for character sequences beginning with %: +A string is used verbatim except for character sequences beginning +with %, as follows. The values of non-numeric formatted items depend +on the locale setting recorded in `system-time-locale' and +`locale-coding-system'. The examples here are for the default +\(`C') locale. %:a weekday name: `Monday'. %#A gives uppercase: `MONDAY' %3a abbreviated weekday: `Mon'. %3A gives uppercase: `MON' @@ -61,7 +68,7 @@ A string is used verbatim except for character sequences beginning with %: %#p `am' or `pm'. %P gives uppercase: `AM' or `PM' %02S seconds %w day number of week, Sunday is 0 -%02y 2-digit year: `97' %:y 4-digit year: `1997' +%02y 2-digit year: `03' %:y 4-digit year: `2003' %z time zone name: `est'. %Z gives uppercase: `EST' Non-date items: @@ -73,18 +80,20 @@ Non-date items: Decimal digits between the % and the type character specify the field width. Strings are truncated on the right; years on the left. -A leading zero causes numbers to be zero-filled. +A leading zero in the field width zero-fills a number. For example, to get the format used by the `date' command, use \"%3a %3b %2d %02H:%02M:%02S %Z %:y\". -In the future these formats will be aligned more with format-time-string. +In the future these formats will be aligned more with `format-time-string'. Because of this transition, the default padding for numeric formats will change in a future version. Therefore either a padding width should be specified, or the : modifier should be used to explicitly request the historical default." :type 'string - :group 'time-stamp) + :group 'time-stamp + :version "20.1") +;;;###autoload(put 'time-stamp-format 'safe-local-variable 'stringp) (defcustom time-stamp-active t "*Non-nil to enable time-stamping of buffers by \\[time-stamp]. @@ -94,133 +103,190 @@ See also the variable `time-stamp-warn-inactive'." :group 'time-stamp) (defcustom time-stamp-warn-inactive t - "Non-nil to have \\[time-stamp] warn if a buffer did not get time-stamped. -A warning is printed if `time-stamp-active' is nil and the buffer contains -a time stamp template that would otherwise have been updated." + "Have \\[time-stamp] warn if a buffer did not get time-stamped. +If non-nil, a warning is displayed if `time-stamp-active' has +deactivated time stamping and the buffer contains a template that +otherwise would have been updated." :type 'boolean - :group 'time-stamp) + :group 'time-stamp + :version "19.29") (defcustom time-stamp-old-format-warn 'ask - "Action to take if `time-stamp-format' is an old-style list. + "Action if `time-stamp-format' is an old-style list. If `error', the format is not used. If `ask', the user is queried about using the time-stamp-format. If `warn', a warning is displayed. If nil, no notification is given." - :type '(choice (const :tag "No notification" nil) - (const :tag "Don't use the format" error) - (const ask) (const warn)) + :type '(choice (const :tag "Don't use the format" error) + (const ask) + (const warn) + (const :tag "No notification" nil)) :group 'time-stamp) (defcustom time-stamp-time-zone nil "If non-nil, a string naming the timezone to be used by \\[time-stamp]. Format is the same as that used by the environment variable TZ on your system." :type '(choice (const nil) string) - :group 'time-stamp) + :group 'time-stamp + :version "20.1") ;;; Do not change time-stamp-line-limit, time-stamp-start, -;;; time-stamp-end, or time-stamp-pattern in your .emacs -;;; or you will be incompatible with other people's files! -;;; If you must change them, do so only in the local variables -;;; section of the file itself. +;;; time-stamp-end, time-stamp-pattern, time-stamp-inserts-lines, +;;; or time-stamp-count in your .emacs or you will be incompatible +;;; with other people's files! If you must change them, do so only +;;; in the local variables section of the file itself. (defvar time-stamp-line-limit 8 ;Do not change! "Lines of a file searched; positive counts from start, negative from end. -The patterns `time-stamp-start' and `time-stamp-end' must be found on one -of the first (last) `time-stamp-line-limit' lines of the file for the +The patterns `time-stamp-start' and `time-stamp-end' must be found in +the first (last) `time-stamp-line-limit' lines of the file for the file to be time-stamped by \\[time-stamp]. A value of 0 searches the entire buffer (use with care). -Do not change `time-stamp-line-limit', `time-stamp-start', or -`time-stamp-end' for yourself or you will be incompatible -with other people's files! If you must change them for some application, -do so in the local variables section of the time-stamped file itself.") +This value can also be set with the variable `time-stamp-pattern'. +Do not change `time-stamp-line-limit', `time-stamp-start', +`time-stamp-end', or `time-stamp-pattern' for yourself or you will be +incompatible with other people's files! If you must change them for some +application, do so in the local variables section of the time-stamped file +itself.") +;;;###autoload(put 'time-stamp-line-limit 'safe-local-variable 'integerp) (defvar time-stamp-start "Time-stamp:[ \t]+\\\\?[\"<]+" ;Do not change! "Regexp after which the time stamp is written by \\[time-stamp]. See also the variables `time-stamp-end' and `time-stamp-line-limit'. -Do not change `time-stamp-line-limit', `time-stamp-start', or -`time-stamp-end' for yourself or you will be incompatible -with other people's files! If you must change them for some application, -do so in the local variables section of the time-stamped file itself.") +This value can also be set with the variable `time-stamp-pattern'. +Do not change `time-stamp-line-limit', `time-stamp-start', +`time-stamp-end', or `time-stamp-pattern' for yourself or you will be +incompatible with other people's files! If you must change them for some +application, do so in the local variables section of the time-stamped file +itself.") +;;;###autoload(put 'time-stamp-start 'safe-local-variable 'stringp) (defvar time-stamp-end "\\\\?[\">]" ;Do not change! "Regexp marking the text after the time stamp. \\[time-stamp] deletes the text between the first match of `time-stamp-start' -and the following match of `time-stamp-end' on the same line, -then writes the time stamp specified by `time-stamp-format' between them. +and the following match of `time-stamp-end', then writes the +time stamp specified by `time-stamp-format' between them. + +This value can also be set with the variable `time-stamp-pattern'. -Do not change `time-stamp-line-limit', `time-stamp-start', or -`time-stamp-end' for yourself or you will be incompatible +The end text normally starts on the same line as the start text ends, +but if there are any newlines in `time-stamp-format', the same number +of newlines must separate the start and end. \\[time-stamp] tries +to not change the number of lines in the buffer. `time-stamp-inserts-lines' +controls this behavior. + +Do not change `time-stamp-start', `time-stamp-end', `time-stamp-pattern', +or `time-stamp-inserts-lines' for yourself or you will be incompatible with other people's files! If you must change them for some application, do so in the local variables section of the time-stamped file itself.") +;;;###autoload(put 'time-stamp-end 'safe-local-variable 'stringp) + +(defvar time-stamp-inserts-lines nil ;Do not change! + "Whether \\[time-stamp] can change the number of lines in a file. +If nil, \\[time-stamp] skips as many lines as there are newlines in +`time-stamp-format' before looking for the `time-stamp-end' pattern, +thus it tries not to change the number of lines in the buffer. +If non-nil, \\[time-stamp] starts looking for the end pattern +immediately after the start pattern. This behavior can cause +unexpected changes in the buffer if used carelessly, but it is useful +for generating repeated time stamps. -(defvar time-stamp-pattern "%%" ;Do not change! - "Convenience variable setting all time-stamp location and format variables. +Do not change `time-stamp-end' or `time-stamp-inserts-lines' for +yourself or you will be incompatible with other people's files! +If you must change them for some application, do so in the local +variables section of the time-stamped file itself.") +;;;###autoload(put 'time-stamp-inserts-lines 'safe-local-variable 'symbolp) + + +(defvar time-stamp-count 1 ;Do not change! + "How many templates \\[time-stamp] will look for in a buffer. +The same time stamp will be written in each case. + +Do not change `time-stamp-count' for yourself or you will be +incompatible with other people's files! If you must change it for +some application, do so in the local variables section of the +time-stamped file itself.") +;;;###autoload(put 'time-stamp-count 'safe-local-variable 'integerp) + + +(defvar time-stamp-pattern nil ;Do not change! + "Convenience variable setting all `time-stamp' location and format values. This string has four parts, each of which is optional. -These four parts set time-stamp-line-limit, time-stamp-start, -time-stamp-format, and time-stamp-end. See the documentation +These four parts set `time-stamp-line-limit', `time-stamp-start', +`time-stamp-format', and `time-stamp-end'. See the documentation for each of these variables for details. The first part is a number followed by a slash; the number sets the number of lines at the beginning (negative counts from end) of the file searched -for the time-stamp. The number and the slash may be omitted to use the +for the time stamp. The number and the slash may be omitted to use the normal value. The second part is a regexp identifying the pattern preceding the time stamp. This part may be omitted to use the normal pattern. -The third part specifies the format of the time-stamp inserted. See -the documentation for time-stamp-format for details. Specify this +The third part specifies the format of the time stamp inserted. See +the documentation for `time-stamp-format' for details. Specify this part as \"%%\" to use the normal format. The fourth part is a regexp identifying the pattern following the time stamp. This part may be omitted to use the normal pattern. -As an example, the default behavior can be specified something like this: -\"8/Time-stamp: [\\\"<]%:y-%02m-%02d %02H:%02M:%02S %u[\\\">]\" +Examples: +\"-10/\" +\"-9/^Last modified: %%$\" +\"@set Time-stamp: %:b %:d, %:y$\" +\"newcommand{\\\\\\\\timestamp}{%%}\" -Do not change `time-stamp-pattern' for yourself or you will be incompatible -with other people's files! Set it only in the local variables section -of the time-stamped file itself.") +Do not change `time-stamp-pattern' `time-stamp-line-limit', +`time-stamp-start', or `time-stamp-end' for yourself or you will be +incompatible with other people's files! If you must change them for +some application, do so only in the local variables section of the +time-stamped file itself.") +;;;###autoload(put 'time-stamp-pattern 'safe-local-variable 'stringp) ;;;###autoload (defun time-stamp () - "Update the time stamp string in the buffer. + "Update the time stamp string(s) in the buffer. A template in a file can be automatically updated with a new time stamp every time you save the file. Add this line to your .emacs file: - (add-hook 'write-file-hooks 'time-stamp) + (add-hook 'before-save-hook 'time-stamp) +or customize `before-save-hook' through Custom. Normally the template must appear in the first 8 lines of a file and look like one of the following: Time-stamp: <> Time-stamp: \" \" The time stamp is written between the brackets or quotes: - Time-stamp: <1998-02-18 10:20:51 gildea> + Time-stamp: <2001-02-18 10:20:51 gildea> The time stamp is updated only if the variable `time-stamp-active' is non-nil. -The format of the time stamp is set by the variable `time-stamp-format'. -The variables `time-stamp-line-limit', `time-stamp-start', -and `time-stamp-end' control finding the template." +The format of the time stamp is set by the variable `time-stamp-pattern' or +`time-stamp-format'. The variables `time-stamp-pattern', +`time-stamp-line-limit', `time-stamp-start', `time-stamp-end', +`time-stamp-count', and `time-stamp-inserts-lines' control finding +the template." (interactive) - (let ((case-fold-search nil) - (start nil) - (end nil) - search-limit - (line-limit time-stamp-line-limit) + (let ((line-limit time-stamp-line-limit) (ts-start time-stamp-start) (ts-format time-stamp-format) - (ts-end time-stamp-end)) + (ts-end time-stamp-end) + (ts-count time-stamp-count) + (format-lines 0) + (end-lines 1) + (start nil) + search-limit) (if (stringp time-stamp-pattern) (progn - (string-match "\\`\\(\\(-?[0-9]+\\)/\\)?\\([^%]+\\)?\\(\\(.\\|\n\\)*%[-.,:@+_ #^()0-9]*[A-Za-z%]\\)?\\([^%]+\\)?\\'" time-stamp-pattern) + (string-match "\\`\\(\\(-?[0-9]+\\)/\\)?\\([^%]+\\)?\\(\\(%[-.,:@+_ #^()0-9]*[A-Za-z%][^%]*\\)*%[-.,:@+_ #^()0-9]*[A-Za-z%]\\)?\\([^%]+\\)?\\'" time-stamp-pattern) (and (match-beginning 2) (setq line-limit - (string-to-int (match-string 2 time-stamp-pattern)))) + (string-to-number (match-string 2 time-stamp-pattern)))) (and (match-beginning 3) (setq ts-start (match-string 3 time-stamp-pattern))) (and (match-beginning 4) @@ -232,6 +298,23 @@ and `time-stamp-end' control finding the template." (setq line-limit 8) (message "time-stamp-line-limit is not an integer") (sit-for 1))) + (cond ((not (integerp ts-count)) + (setq ts-count 1) + (message "time-stamp-count is not an integer") + (sit-for 1)) + ((< ts-count 1) + ;; We need to call time-stamp-once at least once + ;; to output any warnings about time-stamp not being active. + (setq ts-count 1))) + ;; Figure out what lines the end should be on. + (if (stringp ts-format) + (let ((nl-start 0)) + (while (string-match "\n" ts-format nl-start) + (setq format-lines (1+ format-lines) nl-start (match-end 0))))) + (let ((nl-start 0)) + (while (string-match "\n" ts-end nl-start) + (setq end-lines (1+ end-lines) nl-start (match-end 0)))) + ;; Find overall what lines to look at (save-excursion (save-restriction (widen) @@ -245,17 +328,45 @@ and `time-stamp-end' control finding the template." (setq start (point))) (t ;0 => no limit (use with care!) (setq start (point-min)) - (setq search-limit (point-max)))) - (goto-char start) - (while (and (< (point) search-limit) + (setq search-limit (point-max)))))) + (while (and start + (< start search-limit) + (> ts-count 0)) + (setq start (time-stamp-once start search-limit ts-start ts-end + ts-format format-lines end-lines)) + (setq ts-count (1- ts-count)))) + nil) + +(defun time-stamp-once (start search-limit ts-start ts-end + ts-format format-lines end-lines) + "Update one time stamp. Internal routine called by \\[time-stamp]. +Returns the end point, which is where `time-stamp' begins the next search." + (let ((case-fold-search nil) + (end nil) + end-search-start + (end-length nil)) + (save-excursion + (save-restriction + (widen) + ;; Find the location of the time stamp. + (while (and (< (goto-char start) search-limit) (not end) (re-search-forward ts-start search-limit 'move)) (setq start (point)) - (end-of-line) - (let ((line-end (point))) - (goto-char start) - (if (re-search-forward ts-end line-end 'move) - (setq end (match-beginning 0))))))) + (if (not time-stamp-inserts-lines) + (forward-line format-lines)) + (setq end-search-start (max start (point))) + (if (= (forward-line end-lines) 0) + (progn + (and (bolp) (backward-char)) + (let ((line-end (min (point) search-limit))) + (if (>= line-end end-search-start) + (progn + (goto-char end-search-start) + (if (re-search-forward ts-end line-end t) + (progn + (setq end (match-beginning 0)) + (setq end-length (- (match-end 0) end)))))))))))) (if end (progn ;; do all warnings outside save-excursion @@ -283,22 +394,56 @@ and `time-stamp-end' control finding the template." (insert-and-inherit new-time-stamp) (setq end (point)) ;; remove any tabs used to format time stamp - (goto-char start) - (if (search-forward "\t" end t) - (untabify start end))))))))))) - ;; be sure to return nil so can be used on write-file-hooks - nil) + (if (search-backward "\t" start t) + (progn + (untabify start end) + (setq end (point)))))))))))) + ;; return the location after this time stamp, if there was one + (and end end-length + (+ end end-length)))) + ;;;###autoload (defun time-stamp-toggle-active (&optional arg) "Toggle `time-stamp-active', setting whether \\[time-stamp] updates a buffer. -With arg, turn time stamping on if and only if arg is positive." +With ARG, turn time stamping on if and only if arg is positive." (interactive "P") (setq time-stamp-active (if (null arg) (not time-stamp-active) (> (prefix-numeric-value arg) 0))) - (message "time-stamp is now %s." (if time-stamp-active "active" "off"))) + (message "time-stamp is now %s." (if time-stamp-active "active" "off"))) + + +(defun time-stamp-string (&optional ts-format) + "Generate the new string to be inserted by \\[time-stamp]. +Optionally use format TS-FORMAT instead of `time-stamp-format' to +format the string." + (or ts-format + (setq ts-format time-stamp-format)) + (if (stringp ts-format) + (if (stringp time-stamp-time-zone) + (let ((ts-real-time-zone (getenv "TZ"))) + (unwind-protect + (progn + (set-time-zone-rule time-stamp-time-zone) + (format-time-string + (time-stamp-string-preprocess ts-format))) + (set-time-zone-rule ts-real-time-zone))) + (format-time-string + (time-stamp-string-preprocess ts-format))) + ;; handle version 1 compatibility + (cond ((or (eq time-stamp-old-format-warn 'error) + (and (eq time-stamp-old-format-warn 'ask) + (not (y-or-n-p "Use non-string time-stamp-format? ")))) + (message "Warning: no time-stamp: time-stamp-format not a string") + (sit-for 1) + nil) + (t + (cond ((eq time-stamp-old-format-warn 'warn) + (message "Obsolescent time-stamp-format type; should be string") + (sit-for 1))) + (time-stamp-fconcat ts-format " "))))) (defconst time-stamp-no-file "(no file)" "String to use when the buffer is not associated with a file.") @@ -316,10 +461,10 @@ With arg, turn time stamping on if and only if arg is positive." ;;; The : modifier is a temporary conversion feature used to resolve ;;; ambiguous formats--formats that are changing (over time) incompatibly. (defun time-stamp-string-preprocess (format &optional time) - ;; Uses a FORMAT to format date, time, file, and user information. - ;; Optional second argument TIME is only for testing. - ;; Implements non-time extensions to format-time-string - ;; and all time-stamp-format compatibility. + "Use a FORMAT to format date, time, file, and user information. +Optional second argument TIME is only for testing. +Implements non-time extensions to `format-time-string' +and all `time-stamp-format' compatibility." (let ((fmt-len (length format)) (ind 0) cur-char @@ -345,7 +490,7 @@ With arg, turn time stamping on if and only if arg is positive." ?\0)) (or (eq ?. cur-char) (eq ?, cur-char) (eq ?: cur-char) (eq ?@ cur-char) - (eq ?- cur-char) (eq ?+ cur-char) (eq ?_ cur-char) + (eq ?- cur-char) (eq ?+ cur-char) (eq ?_ cur-char) (eq ?\ cur-char) (eq ?# cur-char) (eq ?^ cur-char) (and (eq ?\( cur-char) (not (eq prev-char ?\\)) @@ -377,10 +522,10 @@ With arg, turn time stamping on if and only if arg is positive." (setq field-result (cond ((eq cur-char ?%) - "%") + "%%") ((eq cur-char ?a) ;day of week (if change-case - (format-time-string "%#A" time) + (format-time-string "%#a" time) (or alt-form (not (string-equal field-width "")) (time-stamp-conv-warn "%a" "%:a")) (if (and alt-form (not (string-equal field-width ""))) @@ -394,7 +539,7 @@ With arg, turn time stamping on if and only if arg is positive." (format-time-string "%#A" time))) ((eq cur-char ?b) ;month name (if change-case - (format-time-string "%#B" time) + (format-time-string "%#b" time) (or alt-form (not (string-equal field-width "")) (time-stamp-conv-warn "%b" "%:b")) (if (and alt-form (not (string-equal field-width ""))) @@ -429,9 +574,9 @@ With arg, turn time stamping on if and only if arg is positive." ((eq cur-char ?y) ;year (or alt-form (not (string-equal field-width "")) (time-stamp-conv-warn "%y" "%:y")) - (string-to-int (format-time-string "%Y" time))) + (string-to-number (format-time-string "%Y" time))) ((eq cur-char ?Y) ;4-digit year, new style - (string-to-int (format-time-string "%Y" time))) + (string-to-number (format-time-string "%Y" time))) ((eq cur-char ?z) ;time zone lower case (if change-case "" ;discourage %z variations @@ -453,57 +598,68 @@ With arg, turn time stamping on if and only if arg is positive." (user-login-name)) ((eq cur-char ?U) ;user full name (user-full-name)) + ((eq cur-char ?l) ;logname (undocumented user name alt) + (user-login-name)) + ((eq cur-char ?L) ;(undocumented alt user full name) + (user-full-name)) ((eq cur-char ?h) ;mail host name (time-stamp-mail-host-name)) + ((eq cur-char ?q) ;(undocumented unqual hostname) + (let ((qualname (system-name))) + (if (string-match "\\." qualname) + (substring qualname 0 (match-beginning 0)) + qualname))) + ((eq cur-char ?Q) ;(undocumented fully-qualified host) + (system-name)) )) - (if (string-equal field-width "") - field-result - (let ((padded-result - (format (format "%%%s%c" - field-width - (if (numberp field-result) ?d ?s)) - (or field-result "")))) - (let ((initial-length (length padded-result)) - (desired-length (string-to-int field-width))) - (if (> initial-length desired-length) - ;; truncate strings on right, years on left - (if (stringp field-result) - (substring padded-result 0 desired-length) - (if (eq cur-char ?y) - (substring padded-result (- desired-length)) - padded-result)) ;non-year numbers don't truncate - padded-result))))) + (let ((padded-result + (format (format "%%%s%c" + field-width + (if (numberp field-result) ?d ?s)) + (or field-result "")))) + (let* ((initial-length (length padded-result)) + (desired-length (if (string-equal field-width "") + initial-length + (string-to-number field-width)))) + (if (> initial-length desired-length) + ;; truncate strings on right, years on left + (if (stringp field-result) + (substring padded-result 0 desired-length) + (if (eq cur-char ?y) + (substring padded-result (- desired-length)) + padded-result)) ;non-year numbers don't truncate + padded-result)))) (t (char-to-string cur-char))))) (setq ind (1+ ind))) result)) (defun time-stamp-do-number (format-char alt-form field-width time) - ;; Handle a compatible FORMAT-CHAR where only - ;; the default width/padding will change. - ;; ALT-FORM is whether `#' specified. FIELD-WIDTH is the string - ;; width specification or "". TIME is the time to convert. + "Handle compatible FORMAT-CHAR where only default width/padding will change. +ALT-FORM is whether `#' specified. FIELD-WIDTH is the string +width specification or \"\". TIME is the time to convert." (let ((format-string (concat "%" (char-to-string format-char)))) (and (not alt-form) (string-equal field-width "") (time-stamp-conv-warn format-string (format "%%:%c" format-char))) (if (and alt-form (not (string-equal field-width ""))) "" ;discourage "%:2d" and the like - (string-to-int (format-time-string format-string time))))) + (string-to-number (format-time-string format-string time))))) (defvar time-stamp-conversion-warn t - "Non-nil to warn about soon-to-be-unsupported forms in time-stamp-format. -In would be a bad idea to disable these warnings! + "Warn about soon-to-be-unsupported forms in `time-stamp-format'. +If nil, these warnings are disabled, which would be a bad idea! You really need to update your files instead. The new formats will work with old versions of Emacs. -New formats are being recommended now to allow time-stamp-format -to change in the future to be compatible with format-time-string. +New formats are being recommended now to allow `time-stamp-format' +to change in the future to be compatible with `format-time-string'. The new forms being recommended now will continue to work then.") (defun time-stamp-conv-warn (old-form new-form) - ;; Display a warning about a soon-to-be-obsolete format. + "Display a warning about a soon-to-be-obsolete format. +Suggests replacing OLD-FORM with NEW-FORM." (cond (time-stamp-conversion-warn (save-excursion @@ -520,42 +676,10 @@ The new forms being recommended now will continue to work then.") -(defun time-stamp-string (&optional ts-format) - "Generate the new string to be inserted by \\[time-stamp]. -Optionally use FORMAT." - (or ts-format - (setq ts-format time-stamp-format)) - (if (stringp ts-format) - (if (stringp time-stamp-time-zone) - (let ((real-time-zone (getenv "TZ"))) - (unwind-protect - (progn - (setenv "TZ" time-stamp-time-zone) - (format-time-string - (time-stamp-string-preprocess ts-format))) - (setenv "TZ" real-time-zone))) - (format-time-string - (time-stamp-string-preprocess ts-format))) - ;; handle version 1 compatibility - (cond ((or (eq time-stamp-old-format-warn 'error) - (and (eq time-stamp-old-format-warn 'ask) - (not (y-or-n-p "Use non-string time-stamp-format? ")))) - (message "Warning: no time-stamp: time-stamp-format not a string") - (sit-for 1) - nil) - (t - (cond ((eq time-stamp-old-format-warn 'warn) - (message "Obsolescent time-stamp-format type; should be string") - (sit-for 1))) - (time-stamp-fconcat ts-format " "))))) - -(defconst time-stamp-no-file "(no file)" - "String to use when the buffer is not associated with a file.") - (defun time-stamp-mail-host-name () "Return the name of the host where the user receives mail. This is the value of `mail-host-address' if bound and a string, -otherwise the value of the function system-name." +otherwise the value of the function `system-name'." (or (and (boundp 'mail-host-address) (stringp mail-host-address) mail-host-address) @@ -585,8 +709,24 @@ around literals." ;;; Some functions used in time-stamp-format -;;; Could generate most of a message-id with -;;; '(time-stamp-yymmdd "" time-stamp-hhmm "@" time-stamp-mail-host-name) +;;; These functions have been obsolete since 1995 +;;; and will be removed in Emacs 22. +;;; Meanwhile, discourage other packages from using them. +(let ((obsolete-functions '(time-stamp-month-dd-yyyy + time-stamp-dd/mm/yyyy + time-stamp-mon-dd-yyyy + time-stamp-dd-mon-yy + time-stamp-yy/mm/dd + time-stamp-yyyy/mm/dd + time-stamp-yyyy-mm-dd + time-stamp-yymmdd + time-stamp-hh:mm:ss + time-stamp-hhmm))) + (while obsolete-functions + (make-obsolete (car obsolete-functions) + "use time-stamp-string or format-time-string instead." + "20.1") + (setq obsolete-functions (cdr obsolete-functions)))) ;;; pretty form, suitable for a title page @@ -643,4 +783,5 @@ The first character of DD is space if the value is less than 10." (provide 'time-stamp) +;;; arch-tag: 8a12c5c3-25d6-4a71-adc5-24b0e025a1e7 ;;; time-stamp.el ends here