Mercurial > emacs
annotate lisp/time-stamp.el @ 9925:b039e4156d74
(OVERLAY_START, OVERLAY_END): Use new overlay substructure.
author | Karl Heuer <kwzh@gnu.org> |
---|---|
date | Tue, 15 Nov 1994 02:04:23 +0000 |
parents | 160a90eaa7d8 |
children | b12a8765508b |
rev | line source |
---|---|
3854 | 1 ;;; time-stamp.el --- Maintain last change time stamps in files edited by Emacs |
7298 | 2 ;;; Copyright 1989, 1993, 1994 Free Software Foundation, Inc. |
3854 | 3 |
4 ;; Maintainer: Stephen Gildea <gildea@lcs.mit.edu> | |
9016
160a90eaa7d8
(time-stamp-mail-host-name): Use mail-host-address.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
5 ;; Time-stamp: <94/09/22 15:34:12 gildea> |
3854 | 6 ;; Keywords: tools |
7 | |
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) | |
11 ;; any later version. | |
12 | |
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. | |
17 | |
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. | |
21 | |
22 ;;; Commentary: | |
23 | |
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: | |
27 ;;; Time-stamp: <> | |
4325 | 28 ;;; Time-stamp: " " |
3854 | 29 ;;; The time stamp is written between the brackets or quotes, resulting in |
30 ;;; Time-stamp: <93/06/18 10:26: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: <>"; | |
33 | |
34 ;;; To activate automatic time stamping, add this code to your .emacs file: | |
35 ;;; | |
36 ;;; (if (not (memq 'time-stamp write-file-hooks)) | |
37 ;;; (setq write-file-hooks | |
38 ;;; (cons 'time-stamp write-file-hooks))) | |
5072 | 39 ;;; |
40 ;;; In Emacs 18 you will also need | |
41 ;;; (autoload 'time-stamp "time-stamp" "Update the time stamp in a buffer." t) | |
3854 | 42 |
43 ;;; Change Log: | |
44 | |
45 ;;; Originally based on the 19 Dec 88 version of | |
46 ;;; date.el by John Sturdy <mcvax!harlqn.co.uk!jcgs@uunet.uu.net> | |
47 | |
48 ;;; Code: | |
49 | |
50 (defvar time-stamp-active t | |
51 "*Non-nil to enable time-stamping of files. See the function time-stamp.") | |
52 | |
53 (defvar time-stamp-format | |
54 '(time-stamp-yy/mm/dd time-stamp-hh:mm:ss user-login-name) | |
55 "*A list of functions to call to generate the time stamp string. | |
56 Each element of the list is called as a function and the results are | |
57 concatenated together separated by spaces. Elements may also be strings, | |
58 which are included verbatim. Spaces are not inserted around literal strings.") | |
59 | |
60 ;;; Do not change time-stamp-line-limit, time-stamp-start, or | |
61 ;;; time-stamp-end in your .emacs or you will be incompatible | |
62 ;;; with other people's files! If you must change them, | |
63 ;;; do so only in the local variables section of the file itself. | |
64 | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
65 (defvar time-stamp-line-limit 8 ;Do not change! |
3854 | 66 "Number of lines at the beginning of a file that are searched. |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
67 The patterns `time-stamp-start' and `time-stamp-end' must be found on one |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
68 of the first `time-stamp-line-limit' lines of the file for the file to |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
69 be time-stamped by \\[time-stamp]. |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
70 |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
71 Do not change `time-stamp-line-limit', `time-stamp-start', or |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
72 `time-stamp-end' for yourself or you will be incompatible |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
73 with other people's files! If you must change them for some application, |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
74 do so in the local variables section of the time-stamped file itself.") |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
75 |
3854 | 76 |
5971
f97f4938fffa
(time-stamp-start): Allow more white space
Richard M. Stallman <rms@gnu.org>
parents:
5632
diff
changeset
|
77 (defvar time-stamp-start "Time-stamp:[ \t]+\\\\?[\"<]+" ;Do not change! |
3854 | 78 "Regexp after which the time stamp is written by \\[time-stamp]. |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
79 See also the variables `time-stamp-end' and `time-stamp-line-limit'. |
3854 | 80 |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
81 Do not change `time-stamp-line-limit', `time-stamp-start', or |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
82 `time-stamp-end' for yourself or you will be incompatible |
3854 | 83 with other people's files! If you must change them for some application, |
84 do so in the local variables section of the time-stamped file itself.") | |
85 | |
86 | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
87 (defvar time-stamp-end "\\\\?[\">]" ;Do not change! |
3854 | 88 "Regexp marking the text after the time stamp. |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
89 \\[time-stamp] deletes the text between the first match of `time-stamp-start' |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
90 and the following match of `time-stamp-end' on the same line, |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
91 then writes the time stamp specified by `time-stamp-format' between them. |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
92 |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
93 Do not change `time-stamp-line-limit', `time-stamp-start', or |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
94 `time-stamp-end' for yourself or you will be incompatible |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
95 with other people's files! If you must change them for some application, |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
96 do so in the local variables section of the time-stamped file itself.") |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
97 |
3854 | 98 |
4327
771786f5d8c2
(time-stamp): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
4325
diff
changeset
|
99 ;;;###autoload |
3854 | 100 (defun time-stamp () |
101 "Update the time stamp string in the buffer. | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
102 If you put a time stamp template anywhere in the first 8 lines of a file, |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
103 it can be updated every time you save the file. See the top of |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
104 `time-stamp.el' for a sample. The template looks like one of the following: |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
105 Time-stamp: <> |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
106 Time-stamp: \" \" |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
107 The time stamp is written between the brackets or quotes, resulting in |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
108 Time-stamp: <93/06/18 10:26:51 gildea> |
3854 | 109 Only does its thing if the variable time-stamp-active is non-nil. |
110 Typically used on write-file-hooks for automatic time-stamping. | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
111 The format of the time stamp is determined by the variable time-stamp-format. |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
112 The variables time-stamp-line-limit, time-stamp-start, and time-stamp-end |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
113 control finding the template." |
3854 | 114 (interactive) |
115 (if time-stamp-active | |
116 (let ((case-fold-search nil)) | |
117 (if (and (stringp time-stamp-start) | |
118 (stringp time-stamp-end)) | |
119 (save-excursion | |
120 (goto-char (point-min)) | |
121 (if (re-search-forward time-stamp-start | |
122 (save-excursion | |
123 (forward-line time-stamp-line-limit) | |
124 (point)) | |
125 t) | |
126 (let ((start (point))) | |
127 (if (re-search-forward time-stamp-end | |
128 (save-excursion (end-of-line) (point)) | |
129 t) | |
130 (let ((end (match-beginning 0))) | |
131 (delete-region start end) | |
132 (goto-char start) | |
133 (insert (time-stamp-string)) | |
134 (setq end (point)) | |
135 ;; remove any tabs used to format the time stamp | |
136 (goto-char start) | |
137 (if (search-forward "\t" end t) | |
138 (untabify start end))))))) | |
139 ;; don't signal an error in a write-file-hook | |
140 (message "time-stamp-start or time-stamp-end is not a string")))) | |
141 ;; be sure to return nil so can be used on write-file-hooks | |
142 nil) | |
143 | |
144 (defun time-stamp-string () | |
145 "Generate the new string to be inserted by \\[time-stamp]." | |
146 (time-stamp-fconcat time-stamp-format " ")) | |
147 | |
148 (defun time-stamp-fconcat (list sep) | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
149 "Similar to (mapconcat 'funcall LIST SEP) but LIST allows literals. |
3854 | 150 If an element of LIST is a symbol, it is funcalled to get the string to use; |
151 the separator SEP is used between two strings obtained by funcalling a | |
152 symbol. Otherwise the element itself is inserted; no separator is used | |
153 around literals." | |
154 (let ((return-string "") | |
155 (insert-sep-p nil)) | |
156 (while list | |
157 (cond ((symbolp (car list)) | |
158 (if insert-sep-p | |
159 (setq return-string (concat return-string sep))) | |
160 (setq return-string (concat return-string (funcall (car list)))) | |
161 (setq insert-sep-p t)) | |
162 (t | |
163 (setq return-string (concat return-string (car list))) | |
164 (setq insert-sep-p nil))) | |
165 (setq list (cdr list))) | |
166 return-string)) | |
167 | |
168 | |
169 (defconst time-stamp-month-numbers | |
170 '(("Jan" . 1) ("Feb" . 2) ("Mar" . 3) ("Apr" . 4) ("May" . 5) ("Jun" . 6) | |
171 ("Jul" . 7) ("Aug" . 8) ("Sep" . 9) ("Oct" . 10) ("Nov" . 11) ("Dec" . 12)) | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
172 "Alist of months and their number.") |
3854 | 173 |
174 (defconst time-stamp-month-full-names | |
175 ["(zero)" "January" "February" "March" "April" "May" "June" | |
176 "July" "August" "September" "October" "November" "December"]) | |
177 | |
178 ;;; Some useful functions to use in time-stamp-format | |
179 | |
180 ;;; Could generate most of a message-id with | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
181 ;;; '(time-stamp-yymmdd "" time-stamp-hhmm "@" time-stamp-mail-host-name) |
3854 | 182 |
183 (defun time-stamp-mail-host-name () | |
184 "Return the name of the host where the user receives mail. | |
9016
160a90eaa7d8
(time-stamp-mail-host-name): Use mail-host-address.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
185 This is the value of `mail-host-address' if bound and a string, |
160a90eaa7d8
(time-stamp-mail-host-name): Use mail-host-address.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
186 otherwise the value of `time-stamp-mail-host' (for versions of Emacs |
160a90eaa7d8
(time-stamp-mail-host-name): Use mail-host-address.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
187 before 19.28) otherwise the value of the function system-name. |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
188 This function may be usefully referenced by `time-stamp-format'." |
9016
160a90eaa7d8
(time-stamp-mail-host-name): Use mail-host-address.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
189 (or (and (boundp 'mail-host-address) |
160a90eaa7d8
(time-stamp-mail-host-name): Use mail-host-address.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
190 (stringp mail-host-address) |
160a90eaa7d8
(time-stamp-mail-host-name): Use mail-host-address.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
191 mail-host-address) |
160a90eaa7d8
(time-stamp-mail-host-name): Use mail-host-address.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
192 (and (boundp 'time-stamp-mail-host) |
3854 | 193 (stringp time-stamp-mail-host) |
194 time-stamp-mail-host) | |
195 (system-name))) | |
196 | |
197 ;;; pretty form, suitable for a title page | |
198 | |
199 (defun time-stamp-month-dd-yyyy () | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
200 "Return the current date as a string in \"Month DD, YYYY\" form." |
3854 | 201 (let ((date (current-time-string))) |
5287
6811f9d90b62
(time-stamp-month-dd-yyyy): no leading zero on day.
Richard M. Stallman <rms@gnu.org>
parents:
5072
diff
changeset
|
202 (format "%s %d, %s" |
3854 | 203 (aref time-stamp-month-full-names |
204 (cdr (assoc (substring date 4 7) time-stamp-month-numbers))) | |
205 (string-to-int (substring date 8 10)) | |
206 (substring date -4)))) | |
207 | |
208 ;;; same as __DATE__ in ANSI C | |
209 | |
210 (defun time-stamp-mon-dd-yyyy () | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
211 "Return the current date as a string in \"Mon DD YYYY\" form. |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
212 The first character of DD is space if the value is less than 10." |
3854 | 213 (let ((date (current-time-string))) |
214 (format "%s %2d %s" | |
215 (substring date 4 7) | |
216 (string-to-int (substring date 8 10)) | |
217 (substring date -4)))) | |
218 | |
219 ;;; RFC 822 date | |
220 | |
221 (defun time-stamp-dd-mon-yy () | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
222 "Return the current date as a string in \"DD Mon YY\" form." |
3854 | 223 (let ((date (current-time-string))) |
224 (format "%02d %s %s" | |
225 (string-to-int (substring date 8 10)) | |
226 (substring date 4 7) | |
227 (substring date -2)))) | |
228 | |
229 ;;; RCS 3 date | |
230 | |
231 (defun time-stamp-yy/mm/dd () | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
232 "Return the current date as a string in \"YY/MM/DD\" form." |
3854 | 233 (let ((date (current-time-string))) |
234 (format "%s/%02d/%02d" | |
235 (substring date -2) | |
236 (cdr (assoc (substring date 4 7) time-stamp-month-numbers)) | |
237 (string-to-int (substring date 8 10))))) | |
238 | |
239 ;;; RCS 5 date | |
240 | |
241 (defun time-stamp-yyyy/mm/dd () | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
242 "Return the current date as a string in \"YYYY/MM/DD\" form." |
3854 | 243 (let ((date (current-time-string))) |
244 (format "%s/%02d/%02d" | |
245 (substring date -4) | |
246 (cdr (assoc (substring date 4 7) time-stamp-month-numbers)) | |
247 (string-to-int (substring date 8 10))))) | |
248 | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
249 ;;; ISO 8601 date |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
250 |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
251 (defun time-stamp-yyyy-mm-dd () |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
252 "Return the current date as a string in \"YYYY-MM-DD\" form." |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
253 (let ((date (current-time-string))) |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
254 (format "%s-%02d-%02d" |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
255 (substring date -4) |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
256 (cdr (assoc (substring date 4 7) time-stamp-month-numbers)) |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
257 (string-to-int (substring date 8 10))))) |
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
258 |
3854 | 259 (defun time-stamp-yymmdd () |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
260 "Return the current date as a string in \"YYMMDD\" form." |
3854 | 261 (let ((date (current-time-string))) |
262 (format "%s%02d%02d" | |
263 (substring date -2) | |
264 (cdr (assoc (substring date 4 7) time-stamp-month-numbers)) | |
265 (string-to-int (substring date 8 10))))) | |
266 | |
267 (defun time-stamp-hh:mm:ss () | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
268 "Return the current time as a string in \"HH:MM:SS\" form." |
3854 | 269 (substring (current-time-string) 11 19)) |
270 | |
271 (defun time-stamp-hhmm () | |
5632
63d80d94e0d7
Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
5287
diff
changeset
|
272 "Return the current time as a string in \"HHMM\" form." |
3854 | 273 (let ((date (current-time-string))) |
274 (concat (substring date 11 13) | |
275 (substring date 14 16)))) | |
276 | |
277 (provide 'time-stamp) | |
278 | |
279 ;;; time-stamp.el ends here |