1 ;;; time-stamp.el --- Maintain last change time stamps in files edited by Emacs
2 ;;; Copyright 1989, 1993, 1994, 1995 Free Software Foundation, Inc.
3 ;;; Maintainer's Time-stamp: <95/09/21 12:32:56 gildea>
5 ;; Maintainer: Stephen Gildea <gildea@lcs.mit.edu>
8 ;; This file is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; This file is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to
20 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24 ;;; If you put a time stamp template anywhere in the first 8 lines of a file,
25 ;;; it can be updated every time you save the file. See the top of
26 ;;; time-stamp.el for a sample. The template looks like one of the following:
29 ;;; The time stamp is written between the brackets or quotes, resulting in
30 ;;; Time-stamp: <95/01/18 10:20:51 gildea>
31 ;;; Here is an example which puts the file name and time stamp in the binary:
32 ;;; static char *time_stamp = "sdmain.c Time-stamp: <>";
34 ;;; To activate automatic time stamping in GNU Emacs 19, add this code
35 ;;; to your .emacs file:
36 ;;; (add-hook 'write-file-hooks 'time-stamp)
38 ;;; In Emacs 18 you will need to do this instead:
39 ;;; (if (not (memq 'time-stamp write-file-hooks))
40 ;;; (setq write-file-hooks
41 ;;; (cons 'time-stamp write-file-hooks)))
42 ;;; (autoload 'time-stamp "time-stamp" "Update the time stamp in a buffer." t)
44 ;;; See the documentation for the function `time-stamp' for more details.
48 ;;; Originally based on the 19 Dec 88 version of
49 ;;; date.el by John Sturdy <mcvax!harlqn.co.uk!jcgs@uunet.uu.net>
50 ;;; version 2, January 1995: replaced functions with %-escapes
51 ;;; $Id: time-stamp.el,v 1.14 1995/05/31 20:00:40 kwzh Exp kwzh $
55 (defvar time-stamp-active t
56 "*Non-nil to enable time-stamping of buffers by \\[time-stamp].
57 Can be toggled by \\[time-stamp-toggle-active].
58 See also the variable time-stamp-warn-inactive.")
60 (defvar time-stamp-warn-inactive t
61 "*Non-nil to have \\[time-stamp] warn if a buffer did not get time-stamped.
62 A warning is printed if time-stamp-active is nil and the buffer contains
63 a time stamp template that would otherwise have been updated.")
65 (defvar time-stamp-format
"%02y/%02m/%02d %02H:%02M:%02S %u"
66 "*Template for the string inserted by \\[time-stamp].
67 Value may be a string or a list. (Lists are supported only for
68 backward compatibility.) A string is used verbatim except
69 for character sequences beginning with %:
71 %a weekday name: `Monday'. %A gives uppercase: `MONDAY'
72 %b month name: `January'. %B gives uppercase: `JANUARY'
78 %p `am' or `pm'. %P gives uppercase: `AM' or `PM'
80 %w day number of week, Sunday is 0
82 %z time zone name: `est'. %Z gives uppercase: `EST'
85 %% a literal percent character: `%'
86 %f file name without directory %F gives absolute pathname
91 Decimal digits between the % and the type character specify the
92 field width. Strings are truncated on the right; numbers on the left.
93 A leading zero causes numbers to be zero-filled.
95 For example, to get the format used by the `date' command,
96 use \"%3a %3b %2d %02H:%02M:%02S %Z %y\"")
99 ;;; Do not change time-stamp-line-limit, time-stamp-start, or
100 ;;; time-stamp-end in your .emacs or you will be incompatible
101 ;;; with other people's files! If you must change them,
102 ;;; do so only in the local variables section of the file itself.
104 (defvar time-stamp-line-limit
8 ;Do not change!
105 "Number of lines at the beginning of a file that are searched.
106 The patterns `time-stamp-start' and `time-stamp-end' must be found on one
107 of the first `time-stamp-line-limit' lines of the file for the file to
108 be time-stamped by \\[time-stamp].
110 Do not change `time-stamp-line-limit', `time-stamp-start', or
111 `time-stamp-end' for yourself or you will be incompatible
112 with other people's files! If you must change them for some application,
113 do so in the local variables section of the time-stamped file itself.")
116 (defvar time-stamp-start
"Time-stamp:[ \t]+\\\\?[\"<]+" ;Do not change!
117 "Regexp after which the time stamp is written by \\[time-stamp].
118 See also the variables `time-stamp-end' and `time-stamp-line-limit'.
120 Do not change `time-stamp-line-limit', `time-stamp-start', or
121 `time-stamp-end' for yourself or you will be incompatible
122 with other people's files! If you must change them for some application,
123 do so in the local variables section of the time-stamped file itself.")
126 (defvar time-stamp-end
"\\\\?[\">]" ;Do not change!
127 "Regexp marking the text after the time stamp.
128 \\[time-stamp] deletes the text between the first match of `time-stamp-start'
129 and the following match of `time-stamp-end' on the same line,
130 then writes the time stamp specified by `time-stamp-format' between them.
132 Do not change `time-stamp-line-limit', `time-stamp-start', or
133 `time-stamp-end' for yourself or you will be incompatible
134 with other people's files! If you must change them for some application,
135 do so in the local variables section of the time-stamped file itself.")
140 "Update the time stamp string in the buffer.
141 If you put a time stamp template anywhere in the first 8 lines of a file,
142 it can be updated every time you save the file. See the top of
143 `time-stamp.el' for a sample. The template looks like one of the following:
146 The time stamp is written between the brackets or quotes, resulting in
147 Time-stamp: <95/01/18 10:20:51 gildea>
148 Only does its thing if the variable time-stamp-active is non-nil.
149 Typically used on write-file-hooks for automatic time-stamping.
150 The format of the time stamp is determined by the variable time-stamp-format.
151 The variables time-stamp-line-limit, time-stamp-start, and time-stamp-end
152 control finding the template."
154 (let ((case-fold-search nil
)
156 (if (and (stringp time-stamp-start
)
157 (stringp time-stamp-end
))
161 (goto-char (point-min))
162 (forward-line time-stamp-line-limit
)
163 (let ((start (point-min))
164 (search-end (point)))
167 (and (< (point) search-end
)
168 (re-search-forward time-stamp-start search-end
'move
))
171 (let ((line-end (point)))
173 (if (re-search-forward time-stamp-end line-end
'move
)
175 (if time-stamp-active
176 (let ((end (match-beginning 0)))
177 (delete-region start end
)
179 (insert (time-stamp-string))
181 ;; remove any tabs used to format time stamp
183 (if (search-forward "\t" end t
)
184 (untabify start end
)))
185 (if time-stamp-warn-inactive
186 ;; do warning outside save-excursion
187 (setq need-to-warn t
)))
188 (setq search-end
(point)))))))))
189 ;; don't signal an error in a write-file-hook
190 (message "time-stamp-start or time-stamp-end is not a string")
194 (message "Warning: time-stamp-active is off; did not time-stamp buffer.")
196 ;; be sure to return nil so can be used on write-file-hooks
200 (defun time-stamp-toggle-active (&optional arg
)
201 "Toggle time-stamp-active, setting whether \\[time-stamp] updates a buffer.
202 With arg, turn time stamping on if and only if arg is positive."
204 (setq time-stamp-active
206 (not time-stamp-active
)
207 (> (prefix-numeric-value arg
) 0)))
208 (message "time-stamp is now %s." (if time-stamp-active
"active" "off")))
211 (defun time-stamp-string ()
212 "Generate the new string to be inserted by \\[time-stamp]."
213 (if (stringp time-stamp-format
)
214 (time-stamp-strftime time-stamp-format
)
215 (time-stamp-fconcat time-stamp-format
" "))) ;version 1 compatibility
217 (defconst time-stamp-month-numbers
218 '(("Jan" .
1) ("Feb" .
2) ("Mar" .
3) ("Apr" .
4) ("May" .
5) ("Jun" .
6)
219 ("Jul" .
7) ("Aug" .
8) ("Sep" .
9) ("Oct" .
10) ("Nov" .
11) ("Dec" .
12))
220 "Alist of months and their number.")
222 (defconst time-stamp-month-full-names
223 ["(zero)" "January" "February" "March" "April" "May" "June"
224 "July" "August" "September" "October" "November" "December"])
226 (defconst time-stamp-weekday-numbers
227 '(("Sun" .
0) ("Mon" .
1) ("Tue" .
2) ("Wed" .
3)
228 ("Thu" .
4) ("Fri" .
5) ("Sat" .
6))
229 "Alist of weekdays and their number.")
231 (defconst time-stamp-weekday-full-names
232 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"])
234 (defun time-stamp-strftime (format &optional time
)
235 "Uses a FORMAT to format date, time, file, and user information.
236 Optional second argument TIME will be used instead of the current time.
237 See the description of the variable `time-stamp-format' for a description
238 of the format string."
239 (let ((time-string (cond ((stringp time
)
242 (current-time-string time
))
244 (current-time-string))))
245 (fmt-len (length format
))
254 (while (< ind fmt-len
)
255 (setq cur-char
(aref format ind
))
261 (setq field-index
(1+ ind
))
264 (setq cur-char
(if (< ind fmt-len
)
267 (and (<= ?
0 cur-char
) (>= ?
9 cur-char
))))
268 (setq field-width
(substring format field-index ind
))
269 ;; eat any additional args to allow for future expansion
270 (while (or (and (<= ?
0 cur-char
) (>= ?
9 cur-char
)) (eq ?. cur-char
)
271 (eq ?
, cur-char
) (eq ?
: cur-char
) (eq ?
@ cur-char
)
272 (eq ?- cur-char
) (eq ?
+ cur-char
)
273 (eq ?\ cur-char
) (eq ?
# cur-char
)
274 (and (eq ?\
( cur-char
)
275 (not (eq prev-char ?
\\))
276 (setq paren-level
(1+ paren-level
)))
277 (if (and (eq ?\
) cur-char
)
278 (not (eq prev-char ?
\\))
280 (setq paren-level
(1- paren-level
))
281 (and (> paren-level
0)
284 (setq prev-char cur-char
)
285 (setq cur-char
(if (< ind fmt-len
)
292 ((or (eq cur-char ?a
) ;weekday name
295 (aref time-stamp-weekday-full-names
296 (cdr (assoc (substring time-string
0 3)
297 time-stamp-weekday-numbers
)))))
301 ((or (eq cur-char ?b
) ;month name
304 (aref time-stamp-month-full-names
305 (cdr (assoc (substring time-string
4 7)
306 time-stamp-month-numbers
)))))
310 ((eq cur-char ?d
) ;day of month, 1-31
311 (string-to-int (substring time-string
8 10)))
312 ((eq cur-char ?H
) ;hour, 0-23
313 (string-to-int (substring time-string
11 13)))
314 ((eq cur-char ?I
) ;hour, 1-12
315 (let ((hour (string-to-int (substring time-string
11 13))))
322 ((eq cur-char ?m
) ;month number, 1-12
323 (cdr (assoc (substring time-string
4 7)
324 time-stamp-month-numbers
)))
325 ((eq cur-char ?M
) ;minute, 0-59
326 (string-to-int (substring time-string
14 16)))
327 ((or (eq cur-char ?p
) ;am or pm
330 (if (> 12 (string-to-int (substring time-string
11 13)))
336 ((eq cur-char ?S
) ;seconds, 00-60
337 (string-to-int (substring time-string
17 19)))
338 ((eq cur-char ?w
) ;weekday number, Sunday is 0
339 (cdr (assoc (substring time-string
0 3) time-stamp-weekday-numbers
)))
340 ((eq cur-char ?y
) ;year
341 (string-to-int (substring time-string -
4)))
342 ((or (eq cur-char ?z
) ;time zone
345 (if (fboundp 'current-time-zone
)
346 (car (cdr (current-time-zone time
))))))
347 (or name
(setq name
""))
351 ((eq cur-char ?f
) ;buffer-file-name, base name only
353 (file-name-nondirectory buffer-file-name
)
355 ((eq cur-char ?F
) ;buffer-file-name, full path
358 ((eq cur-char ?s
) ;system name
360 ((eq cur-char ?u
) ;user name
362 ((eq cur-char ?h
) ;mail host name
363 (time-stamp-mail-host-name))
365 (if (string-equal field-width
"")
368 (format (format "%%%s%c"
370 (if (numberp field-result
) ?d ?s
))
371 (or field-result
""))))
372 (let ((initial-length (length padded-result
))
373 (desired-length (string-to-int field-width
)))
374 (if (> initial-length desired-length
)
375 ;; truncate strings on right, numbers on left
376 (if (stringp field-result
)
377 (substring padded-result
0 desired-length
)
378 (substring padded-result
(- desired-length
)))
381 (char-to-string cur-char
)))))
385 (defun time-stamp-mail-host-name ()
386 "Return the name of the host where the user receives mail.
387 This is the value of `mail-host-address' if bound and a string,
388 otherwise the value of `time-stamp-mail-host' (for versions of Emacs
389 before 19.29) otherwise the value of the function system-name.
390 This function may be usefully referenced by `time-stamp-format'."
391 (or (and (boundp 'mail-host-address
)
392 (stringp mail-host-address
)
394 (and (boundp 'time-stamp-mail-host
) ;for backward compatibility
395 (stringp time-stamp-mail-host
)
396 time-stamp-mail-host
)
399 ;;; the rest of this file is for version 1 compatibility
401 (defun time-stamp-fconcat (list sep
)
402 "Similar to (mapconcat 'funcall LIST SEP) but LIST allows literals.
403 If an element of LIST is a symbol, it is funcalled to get the string to use;
404 the separator SEP is used between two strings obtained by funcalling a
405 symbol. Otherwise the element itself is inserted; no separator is used
407 (let ((return-string "")
410 (cond ((symbolp (car list
))
412 (setq return-string
(concat return-string sep
)))
413 (setq return-string
(concat return-string
(funcall (car list
))))
414 (setq insert-sep-p t
))
416 (setq return-string
(concat return-string
(car list
)))
417 (setq insert-sep-p nil
)))
418 (setq list
(cdr list
)))
422 ;;; Some useful functions to use in time-stamp-format
424 ;;; Could generate most of a message-id with
425 ;;; '(time-stamp-yymmdd "" time-stamp-hhmm "@" time-stamp-mail-host-name)
427 ;;; pretty form, suitable for a title page
429 (defun time-stamp-month-dd-yyyy ()
430 "Return the current date as a string in \"Month DD, YYYY\" form."
431 (let ((date (current-time-string)))
433 (aref time-stamp-month-full-names
434 (cdr (assoc (substring date
4 7) time-stamp-month-numbers
)))
435 (string-to-int (substring date
8 10))
436 (substring date -
4))))
438 ;;; same as __DATE__ in ANSI C
440 (defun time-stamp-mon-dd-yyyy ()
441 "Return the current date as a string in \"Mon DD YYYY\" form.
442 The first character of DD is space if the value is less than 10."
443 (let ((date (current-time-string)))
446 (string-to-int (substring date
8 10))
447 (substring date -
4))))
451 (defun time-stamp-dd-mon-yy ()
452 "Return the current date as a string in \"DD Mon YY\" form."
453 (let ((date (current-time-string)))
455 (string-to-int (substring date
8 10))
457 (substring date -
2))))
461 (defun time-stamp-yy/mm
/dd
()
462 "Return the current date as a string in \"YY/MM/DD\" form."
463 (let ((date (current-time-string)))
464 (format "%s/%02d/%02d"
466 (cdr (assoc (substring date
4 7) time-stamp-month-numbers
))
467 (string-to-int (substring date
8 10)))))
471 (defun time-stamp-yyyy/mm
/dd
()
472 "Return the current date as a string in \"YYYY/MM/DD\" form."
473 (let ((date (current-time-string)))
474 (format "%s/%02d/%02d"
476 (cdr (assoc (substring date
4 7) time-stamp-month-numbers
))
477 (string-to-int (substring date
8 10)))))
481 (defun time-stamp-yyyy-mm-dd ()
482 "Return the current date as a string in \"YYYY-MM-DD\" form."
483 (let ((date (current-time-string)))
484 (format "%s-%02d-%02d"
486 (cdr (assoc (substring date
4 7) time-stamp-month-numbers
))
487 (string-to-int (substring date
8 10)))))
489 (defun time-stamp-yymmdd ()
490 "Return the current date as a string in \"YYMMDD\" form."
491 (let ((date (current-time-string)))
494 (cdr (assoc (substring date
4 7) time-stamp-month-numbers
))
495 (string-to-int (substring date
8 10)))))
497 (defun time-stamp-hh:mm
:ss
()
498 "Return the current time as a string in \"HH:MM:SS\" form."
499 (substring (current-time-string) 11 19))
501 (defun time-stamp-hhmm ()
502 "Return the current time as a string in \"HHMM\" form."
503 (let ((date (current-time-string)))
504 (concat (substring date
11 13)
505 (substring date
14 16))))
507 (provide 'time-stamp
)
509 ;;; time-stamp.el ends here