(do_check_ram_size): Don't hardcode the lisp address space size.
[emacs.git] / lisp / time-stamp.el
blobb6e76ee5394a0a561250eeb5f1ce54cccda149a8
1 ;;; time-stamp.el --- Maintain last change time stamps in files edited by Emacs
3 ;; Copyright 1989, 1993, 1994, 1995, 1997, 2000, 2001
4 ;;; Free Software Foundation, Inc.
6 ;; This file is part of GNU Emacs.
8 ;; Maintainer's Time-stamp: <2003-02-01 09:26:25 gildea>
9 ;; Maintainer: Stephen Gildea <gildea@stop.mail-abuse.org>
10 ;; Keywords: tools
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; A template in a file can be updated with a new time stamp when
30 ;; you save the file. For example:
31 ;; static char *ts = "sdmain.c Time-stamp: <2001-08-13 10:20:51 gildea>";
32 ;; See the top of `time-stamp.el' for another example.
34 ;; To use time-stamping, add this line to your .emacs file:
35 ;; (add-hook 'write-file-hooks 'time-stamp)
36 ;; Now any time-stamp templates in your files will be updated automatically.
38 ;; See the documentation for the functions `time-stamp'
39 ;; and `time-stamp-toggle-active' for details.
41 ;;; Code:
43 (defgroup time-stamp nil
44 "Maintain last change time stamps in files edited by Emacs."
45 :group 'data
46 :group 'extensions)
48 (defcustom time-stamp-format "%:y-%02m-%02d %02H:%02M:%02S %u"
49 "*Format of the string inserted by \\[time-stamp].
50 The value may be a string or a list. Lists are supported only for
51 backward compatibility; see variable `time-stamp-old-format-warn'.
53 A string is used verbatim except for character sequences beginning
54 with %, as follows. The values of non-numeric formatted items depend
55 on the locale setting recorded in `system-time-locale' and
56 `locale-coding-system'. The examples here are for the default
57 \(`C') locale.
59 %:a weekday name: `Monday'. %#A gives uppercase: `MONDAY'
60 %3a abbreviated weekday: `Mon'. %3A gives uppercase: `MON'
61 %:b month name: `January'. %#B gives uppercase: `JANUARY'
62 %3b abbreviated month: `Jan'. %3B gives uppercase: `JAN'
63 %02d day of month
64 %02H 24-hour clock hour
65 %02I 12-hour clock hour
66 %02m month number
67 %02M minute
68 %#p `am' or `pm'. %P gives uppercase: `AM' or `PM'
69 %02S seconds
70 %w day number of week, Sunday is 0
71 %02y 2-digit year: `03' %:y 4-digit year: `2003'
72 %z time zone name: `est'. %Z gives uppercase: `EST'
74 Non-date items:
75 %% a literal percent character: `%'
76 %f file name without directory %F gives absolute pathname
77 %s system name
78 %u user's login name %U user's full name
79 %h mail host name
81 Decimal digits between the % and the type character specify the
82 field width. Strings are truncated on the right; years on the left.
83 A leading zero in the field width zero-fills a number.
85 For example, to get the format used by the `date' command,
86 use \"%3a %3b %2d %02H:%02M:%02S %Z %:y\".
88 In the future these formats will be aligned more with `format-time-string'.
89 Because of this transition, the default padding for numeric formats will
90 change in a future version. Therefore either a padding width should be
91 specified, or the : modifier should be used to explicitly request the
92 historical default."
93 :type 'string
94 :group 'time-stamp
95 :version "20.1")
97 (defcustom time-stamp-active t
98 "*Non-nil to enable time-stamping of buffers by \\[time-stamp].
99 Can be toggled by \\[time-stamp-toggle-active].
100 See also the variable `time-stamp-warn-inactive'."
101 :type 'boolean
102 :group 'time-stamp)
104 (defcustom time-stamp-warn-inactive t
105 "Have \\[time-stamp] warn if a buffer did not get time-stamped.
106 If non-nil, a warning is displayed if `time-stamp-active' has
107 deactivated time stamping and the buffer contains a template that
108 otherwise would have been updated."
109 :type 'boolean
110 :group 'time-stamp
111 :version "19.29")
113 (defcustom time-stamp-old-format-warn 'ask
114 "Action if `time-stamp-format' is an old-style list.
115 If `error', the format is not used. If `ask', the user is queried about
116 using the time-stamp-format. If `warn', a warning is displayed.
117 If nil, no notification is given."
118 :type '(choice (const :tag "Don't use the format" error)
119 (const ask)
120 (const warn)
121 (const :tag "No notification" nil))
122 :group 'time-stamp)
124 (defcustom time-stamp-time-zone nil
125 "If non-nil, a string naming the timezone to be used by \\[time-stamp].
126 Format is the same as that used by the environment variable TZ on your system."
127 :type '(choice (const nil) string)
128 :group 'time-stamp
129 :version "20.1")
132 ;;; Do not change time-stamp-line-limit, time-stamp-start,
133 ;;; time-stamp-end, time-stamp-pattern, time-stamp-inserts-lines,
134 ;;; or time-stamp-count in your .emacs or you will be incompatible
135 ;;; with other people's files! If you must change them, do so only
136 ;;; in the local variables section of the file itself.
139 (defvar time-stamp-line-limit 8 ;Do not change!
140 "Lines of a file searched; positive counts from start, negative from end.
141 The patterns `time-stamp-start' and `time-stamp-end' must be found in
142 the first (last) `time-stamp-line-limit' lines of the file for the
143 file to be time-stamped by \\[time-stamp]. A value of 0 searches the
144 entire buffer (use with care).
146 Do not change `time-stamp-line-limit', `time-stamp-start', or
147 `time-stamp-end' for yourself or you will be incompatible
148 with other people's files! If you must change them for some application,
149 do so in the local variables section of the time-stamped file itself.")
152 (defvar time-stamp-start "Time-stamp:[ \t]+\\\\?[\"<]+" ;Do not change!
153 "Regexp after which the time stamp is written by \\[time-stamp].
154 See also the variables `time-stamp-end' and `time-stamp-line-limit'.
156 Do not change `time-stamp-line-limit', `time-stamp-start', or
157 `time-stamp-end' for yourself or you will be incompatible
158 with other people's files! If you must change them for some application,
159 do so in the local variables section of the time-stamped file itself.")
162 (defvar time-stamp-end "\\\\?[\">]" ;Do not change!
163 "Regexp marking the text after the time stamp.
164 \\[time-stamp] deletes the text between the first match of `time-stamp-start'
165 and the following match of `time-stamp-end', then writes the
166 time stamp specified by `time-stamp-format' between them.
168 The end text normally starts on the same line as the start text ends,
169 but if there are any newlines in `time-stamp-format', the same number
170 of newlines must separate the start and end. \\[time-stamp] tries
171 to not change the number of lines in the buffer. `time-stamp-inserts-lines'
172 controls this behavior.
174 Do not change `time-stamp-line-limit', `time-stamp-start', `time-stamp-end',
175 or `time-stamp-inserts-lines' for yourself or you will be incompatible
176 with other people's files! If you must change them for some application,
177 do so in the local variables section of the time-stamped file itself.")
180 (defvar time-stamp-inserts-lines nil ;Do not change!
181 "Whether \\[time-stamp] can change the number of lines in a file.
182 If nil, \\[time-stamp] skips as many lines as there are newlines in
183 `time-stamp-format' before looking for the `time-stamp-end' pattern,
184 thus it tries not to change the number of lines in the buffer.
185 If non-nil, \\[time-stamp] starts looking for the end pattern
186 immediately after the start pattern. This behavior can cause
187 unexpected changes in the buffer if used carelessly, but it is useful
188 for generating repeated time stamps.
190 Do not change `time-stamp-end' or `time-stamp-inserts-lines' for
191 yourself or you will be incompatible with other people's files!
192 If you must change them for some application, do so in the local
193 variables section of the time-stamped file itself.")
196 (defvar time-stamp-count 1 ;Do not change!
197 "How many templates \\[time-stamp] will look for in a buffer.
198 The same time stamp will be written in each case.
200 Do not change `time-stamp-count' for yourself or you will be
201 incompatible with other people's files! If you must change it for
202 some application, do so in the local variables section of the
203 time-stamped file itself.")
206 (defvar time-stamp-pattern nil ;Do not change!
207 "Convenience variable setting all `time-stamp' location and format values.
208 This string has four parts, each of which is optional.
209 These four parts set `time-stamp-line-limit', `time-stamp-start',
210 `time-stamp-format', and `time-stamp-end'. See the documentation
211 for each of these variables for details.
213 The first part is a number followed by a slash; the number sets the number
214 of lines at the beginning (negative counts from end) of the file searched
215 for the time stamp. The number and the slash may be omitted to use the
216 normal value.
218 The second part is a regexp identifying the pattern preceding the time stamp.
219 This part may be omitted to use the normal pattern.
221 The third part specifies the format of the time stamp inserted. See
222 the documentation for `time-stamp-format' for details. Specify this
223 part as \"%%\" to use the normal format.
225 The fourth part is a regexp identifying the pattern following the time stamp.
226 This part may be omitted to use the normal pattern.
228 Examples:
229 \"-10/\"
230 \"-9/^Last modified: %%$\"
231 \"@set Time-stamp: %:b %:d, %:y$\"
232 \"newcommand{\\\\\\\\timestamp}{%%}\"
234 Do not change `time-stamp-pattern' for yourself or you will be incompatible
235 with other people's files! Set it only in the local variables section
236 of the time-stamped file itself.")
240 ;;;###autoload
241 (defun time-stamp ()
242 "Update the time stamp string(s) in the buffer.
243 A template in a file can be automatically updated with a new time stamp
244 every time you save the file. Add this line to your .emacs file:
245 (add-hook 'write-file-hooks 'time-stamp)
246 Normally the template must appear in the first 8 lines of a file and
247 look like one of the following:
248 Time-stamp: <>
249 Time-stamp: \" \"
250 The time stamp is written between the brackets or quotes:
251 Time-stamp: <2001-02-18 10:20:51 gildea>
252 The time stamp is updated only if the variable `time-stamp-active' is non-nil.
253 The format of the time stamp is set by the variable `time-stamp-format'.
254 The variables `time-stamp-line-limit', `time-stamp-start', `time-stamp-end',
255 `time-stamp-count', and `time-stamp-inserts-lines' control finding the
256 template."
257 (interactive)
258 (let ((line-limit time-stamp-line-limit)
259 (ts-start time-stamp-start)
260 (ts-format time-stamp-format)
261 (ts-end time-stamp-end)
262 (ts-count time-stamp-count)
263 (format-lines 0)
264 (end-lines 1)
265 (start nil)
266 search-limit)
267 (if (stringp time-stamp-pattern)
268 (progn
269 (string-match "\\`\\(\\(-?[0-9]+\\)/\\)?\\([^%]+\\)?\\(\\(%[-.,:@+_ #^()0-9]*[A-Za-z%][^%]*\\)*%[-.,:@+_ #^()0-9]*[A-Za-z%]\\)?\\([^%]+\\)?\\'" time-stamp-pattern)
270 (and (match-beginning 2)
271 (setq line-limit
272 (string-to-int (match-string 2 time-stamp-pattern))))
273 (and (match-beginning 3)
274 (setq ts-start (match-string 3 time-stamp-pattern)))
275 (and (match-beginning 4)
276 (not (string-equal (match-string 4 time-stamp-pattern) "%%"))
277 (setq ts-format (match-string 4 time-stamp-pattern)))
278 (and (match-beginning 6)
279 (setq ts-end (match-string 6 time-stamp-pattern)))))
280 (cond ((not (integerp line-limit))
281 (setq line-limit 8)
282 (message "time-stamp-line-limit is not an integer")
283 (sit-for 1)))
284 (cond ((not (integerp ts-count))
285 (setq ts-count 1)
286 (message "time-stamp-count is not an integer")
287 (sit-for 1))
288 ((< ts-count 1)
289 ;; We need to call time-stamp-once at least once
290 ;; to output any warnings about time-stamp not being active.
291 (setq ts-count 1)))
292 ;; Figure out what lines the end should be on.
293 (if (stringp ts-format)
294 (let ((nl-start 0))
295 (while (string-match "\n" ts-format nl-start)
296 (setq format-lines (1+ format-lines) nl-start (match-end 0)))))
297 (let ((nl-start 0))
298 (while (string-match "\n" ts-end nl-start)
299 (setq end-lines (1+ end-lines) nl-start (match-end 0))))
300 ;; Find overall what lines to look at
301 (save-excursion
302 (save-restriction
303 (widen)
304 (cond ((> line-limit 0)
305 (goto-char (setq start (point-min)))
306 (forward-line line-limit)
307 (setq search-limit (point)))
308 ((< line-limit 0)
309 (goto-char (setq search-limit (point-max)))
310 (forward-line line-limit)
311 (setq start (point)))
312 (t ;0 => no limit (use with care!)
313 (setq start (point-min))
314 (setq search-limit (point-max))))))
315 (while (and start
316 (< start search-limit)
317 (> ts-count 0))
318 (setq start (time-stamp-once start search-limit ts-start ts-end
319 ts-format format-lines end-lines))
320 (setq ts-count (1- ts-count))))
321 ;; be sure to return nil so can be used on write-file-hooks
322 nil)
324 (defun time-stamp-once (start search-limit ts-start ts-end
325 ts-format format-lines end-lines)
326 "Update one time stamp. Internal routine called by \\[time-stamp].
327 Returns the end point, which is where `time-stamp' begins the next search."
328 (let ((case-fold-search nil)
329 (end nil)
330 end-search-start
331 (end-length nil))
332 (save-excursion
333 (save-restriction
334 (widen)
335 ;; Find the location of the time stamp.
336 (while (and (< (goto-char start) search-limit)
337 (not end)
338 (re-search-forward ts-start search-limit 'move))
339 (setq start (point))
340 (if (not time-stamp-inserts-lines)
341 (forward-line format-lines))
342 (setq end-search-start (max start (point)))
343 (if (= (forward-line end-lines) 0)
344 (progn
345 (and (bolp) (backward-char))
346 (let ((line-end (min (point) search-limit)))
347 (if (>= line-end end-search-start)
348 (progn
349 (goto-char end-search-start)
350 (if (re-search-forward ts-end line-end t)
351 (progn
352 (setq end (match-beginning 0))
353 (setq end-length (- (match-end 0) end))))))))))))
354 (if end
355 (progn
356 ;; do all warnings outside save-excursion
357 (cond
358 ((not time-stamp-active)
359 (if time-stamp-warn-inactive
360 ;; don't signal an error in a write-file-hook
361 (progn
362 (message "Warning: time-stamp-active is off; did not time-stamp buffer.")
363 (sit-for 1))))
364 ((not (and (stringp ts-start)
365 (stringp ts-end)))
366 (message "time-stamp-start or time-stamp-end is not a string")
367 (sit-for 1))
369 (let ((new-time-stamp (time-stamp-string ts-format)))
370 (if (and (stringp new-time-stamp)
371 (not (string-equal (buffer-substring start end)
372 new-time-stamp)))
373 (save-excursion
374 (save-restriction
375 (widen)
376 (delete-region start end)
377 (goto-char start)
378 (insert-and-inherit new-time-stamp)
379 (setq end (point))
380 ;; remove any tabs used to format time stamp
381 (if (search-backward "\t" start t)
382 (progn
383 (untabify start end)
384 (setq end (point))))))))))))
385 ;; return the location after this time stamp, if there was one
386 (and end end-length
387 (+ end end-length))))
390 ;;;###autoload
391 (defun time-stamp-toggle-active (&optional arg)
392 "Toggle `time-stamp-active', setting whether \\[time-stamp] updates a buffer.
393 With ARG, turn time stamping on if and only if arg is positive."
394 (interactive "P")
395 (setq time-stamp-active
396 (if (null arg)
397 (not time-stamp-active)
398 (> (prefix-numeric-value arg) 0)))
399 (message "time-stamp is now %s." (if time-stamp-active "active" "off")))
402 (defun time-stamp-string (&optional ts-format)
403 "Generate the new string to be inserted by \\[time-stamp].
404 Optionally use format TS-FORMAT instead of `time-stamp-format' to
405 format the string."
406 (or ts-format
407 (setq ts-format time-stamp-format))
408 (if (stringp ts-format)
409 (if (stringp time-stamp-time-zone)
410 (let ((ts-real-time-zone (getenv "TZ")))
411 (unwind-protect
412 (progn
413 (set-time-zone-rule time-stamp-time-zone)
414 (format-time-string
415 (time-stamp-string-preprocess ts-format)))
416 (set-time-zone-rule ts-real-time-zone)))
417 (format-time-string
418 (time-stamp-string-preprocess ts-format)))
419 ;; handle version 1 compatibility
420 (cond ((or (eq time-stamp-old-format-warn 'error)
421 (and (eq time-stamp-old-format-warn 'ask)
422 (not (y-or-n-p "Use non-string time-stamp-format? "))))
423 (message "Warning: no time-stamp: time-stamp-format not a string")
424 (sit-for 1)
425 nil)
427 (cond ((eq time-stamp-old-format-warn 'warn)
428 (message "Obsolescent time-stamp-format type; should be string")
429 (sit-for 1)))
430 (time-stamp-fconcat ts-format " ")))))
432 (defconst time-stamp-no-file "(no file)"
433 "String to use when the buffer is not associated with a file.")
435 ;;; time-stamp is transitioning to using the new, expanded capabilities
436 ;;; of format-time-string. During the process, this function implements
437 ;;; intermediate, compatible formats and complains about old, soon to
438 ;;; be unsupported, formats. This function will get a lot (a LOT) shorter
439 ;;; when the transition is complete and we can just pass most things
440 ;;; straight through to format-time-string.
441 ;;; At all times, all the formats recommended in the doc string
442 ;;; of time-stamp-format will work not only in the current version of
443 ;;; Emacs, but in all versions that have been released within the past
444 ;;; two years.
445 ;;; The : modifier is a temporary conversion feature used to resolve
446 ;;; ambiguous formats--formats that are changing (over time) incompatibly.
447 (defun time-stamp-string-preprocess (format &optional time)
448 "Use a FORMAT to format date, time, file, and user information.
449 Optional second argument TIME is only for testing.
450 Implements non-time extensions to `format-time-string'
451 and all `time-stamp-format' compatibility."
452 (let ((fmt-len (length format))
453 (ind 0)
454 cur-char
455 (prev-char nil)
456 (result "")
457 field-width
458 field-result
459 alt-form change-case require-padding
460 (paren-level 0))
461 (while (< ind fmt-len)
462 (setq cur-char (aref format ind))
463 (setq
464 result
465 (concat result
466 (cond
467 ((eq cur-char ?%)
468 ;; eat any additional args to allow for future expansion
469 (setq alt-form nil change-case nil require-padding nil field-width "")
470 (while (progn
471 (setq ind (1+ ind))
472 (setq cur-char (if (< ind fmt-len)
473 (aref format ind)
474 ?\0))
475 (or (eq ?. cur-char)
476 (eq ?, cur-char) (eq ?: cur-char) (eq ?@ cur-char)
477 (eq ?- cur-char) (eq ?+ cur-char) (eq ?_ cur-char)
478 (eq ?\ cur-char) (eq ?# cur-char) (eq ?^ cur-char)
479 (and (eq ?\( cur-char)
480 (not (eq prev-char ?\\))
481 (setq paren-level (1+ paren-level)))
482 (if (and (eq ?\) cur-char)
483 (not (eq prev-char ?\\))
484 (> paren-level 0))
485 (setq paren-level (1- paren-level))
486 (and (> paren-level 0)
487 (< ind fmt-len)))
488 (if (and (<= ?0 cur-char) (>= ?9 cur-char))
489 ;; get format width
490 (let ((field-index ind))
491 (while (progn
492 (setq ind (1+ ind))
493 (setq cur-char (if (< ind fmt-len)
494 (aref format ind)
495 ?\0))
496 (and (<= ?0 cur-char) (>= ?9 cur-char))))
497 (setq field-width (substring format field-index ind))
498 (setq ind (1- ind))
499 t))))
500 (setq prev-char cur-char)
501 ;; some characters we actually use
502 (cond ((eq cur-char ?:)
503 (setq alt-form t))
504 ((eq cur-char ?#)
505 (setq change-case t))))
506 (setq field-result
507 (cond
508 ((eq cur-char ?%)
509 "%%")
510 ((eq cur-char ?a) ;day of week
511 (if change-case
512 (format-time-string "%#a" time)
513 (or alt-form (not (string-equal field-width ""))
514 (time-stamp-conv-warn "%a" "%:a"))
515 (if (and alt-form (not (string-equal field-width "")))
516 "" ;discourage "%:3a"
517 (format-time-string "%A" time))))
518 ((eq cur-char ?A)
519 (if alt-form
520 (format-time-string "%A" time)
521 (or change-case (not (string-equal field-width ""))
522 (time-stamp-conv-warn "%A" "%#A"))
523 (format-time-string "%#A" time)))
524 ((eq cur-char ?b) ;month name
525 (if change-case
526 (format-time-string "%#b" time)
527 (or alt-form (not (string-equal field-width ""))
528 (time-stamp-conv-warn "%b" "%:b"))
529 (if (and alt-form (not (string-equal field-width "")))
530 "" ;discourage "%:3b"
531 (format-time-string "%B" time))))
532 ((eq cur-char ?B)
533 (if alt-form
534 (format-time-string "%B" time)
535 (or change-case (not (string-equal field-width ""))
536 (time-stamp-conv-warn "%B" "%#B"))
537 (format-time-string "%#B" time)))
538 ((eq cur-char ?d) ;day of month, 1-31
539 (time-stamp-do-number cur-char alt-form field-width time))
540 ((eq cur-char ?H) ;hour, 0-23
541 (time-stamp-do-number cur-char alt-form field-width time))
542 ((eq cur-char ?I) ;hour, 1-12
543 (time-stamp-do-number cur-char alt-form field-width time))
544 ((eq cur-char ?m) ;month number, 1-12
545 (time-stamp-do-number cur-char alt-form field-width time))
546 ((eq cur-char ?M) ;minute, 0-59
547 (time-stamp-do-number cur-char alt-form field-width time))
548 ((eq cur-char ?p) ;am or pm
549 (or change-case
550 (time-stamp-conv-warn "%p" "%#p"))
551 (format-time-string "%#p" time))
552 ((eq cur-char ?P) ;AM or PM
553 (format-time-string "%p" time))
554 ((eq cur-char ?S) ;seconds, 00-60
555 (time-stamp-do-number cur-char alt-form field-width time))
556 ((eq cur-char ?w) ;weekday number, Sunday is 0
557 (format-time-string "%w" time))
558 ((eq cur-char ?y) ;year
559 (or alt-form (not (string-equal field-width ""))
560 (time-stamp-conv-warn "%y" "%:y"))
561 (string-to-int (format-time-string "%Y" time)))
562 ((eq cur-char ?Y) ;4-digit year, new style
563 (string-to-int (format-time-string "%Y" time)))
564 ((eq cur-char ?z) ;time zone lower case
565 (if change-case
566 "" ;discourage %z variations
567 (format-time-string "%#Z" time)))
568 ((eq cur-char ?Z)
569 (if change-case
570 (format-time-string "%#Z" time)
571 (format-time-string "%Z" time)))
572 ((eq cur-char ?f) ;buffer-file-name, base name only
573 (if buffer-file-name
574 (file-name-nondirectory buffer-file-name)
575 time-stamp-no-file))
576 ((eq cur-char ?F) ;buffer-file-name, full path
577 (or buffer-file-name
578 time-stamp-no-file))
579 ((eq cur-char ?s) ;system name
580 (system-name))
581 ((eq cur-char ?u) ;user name
582 (user-login-name))
583 ((eq cur-char ?U) ;user full name
584 (user-full-name))
585 ((eq cur-char ?l) ;logname (undocumented user name alt)
586 (user-login-name))
587 ((eq cur-char ?L) ;(undocumented alt user full name)
588 (user-full-name))
589 ((eq cur-char ?h) ;mail host name
590 (time-stamp-mail-host-name))
592 (let ((padded-result
593 (format (format "%%%s%c"
594 field-width
595 (if (numberp field-result) ?d ?s))
596 (or field-result ""))))
597 (let* ((initial-length (length padded-result))
598 (desired-length (if (string-equal field-width "")
599 initial-length
600 (string-to-int field-width))))
601 (if (> initial-length desired-length)
602 ;; truncate strings on right, years on left
603 (if (stringp field-result)
604 (substring padded-result 0 desired-length)
605 (if (eq cur-char ?y)
606 (substring padded-result (- desired-length))
607 padded-result)) ;non-year numbers don't truncate
608 padded-result))))
610 (char-to-string cur-char)))))
611 (setq ind (1+ ind)))
612 result))
614 (defun time-stamp-do-number (format-char alt-form field-width time)
615 "Handle compatible FORMAT-CHAR where only default width/padding will change.
616 ALT-FORM is whether `#' specified. FIELD-WIDTH is the string
617 width specification or \"\". TIME is the time to convert."
618 (let ((format-string (concat "%" (char-to-string format-char))))
619 (and (not alt-form) (string-equal field-width "")
620 (time-stamp-conv-warn format-string
621 (format "%%:%c" format-char)))
622 (if (and alt-form (not (string-equal field-width "")))
623 "" ;discourage "%:2d" and the like
624 (string-to-int (format-time-string format-string time)))))
626 (defvar time-stamp-conversion-warn t
627 "Warn about soon-to-be-unsupported forms in `time-stamp-format'.
628 If nil, these warnings are disabled, which would be a bad idea!
629 You really need to update your files instead.
631 The new formats will work with old versions of Emacs.
632 New formats are being recommended now to allow `time-stamp-format'
633 to change in the future to be compatible with `format-time-string'.
634 The new forms being recommended now will continue to work then.")
637 (defun time-stamp-conv-warn (old-form new-form)
638 "Display a warning about a soon-to-be-obsolete format.
639 Suggests replacing OLD-FORM with NEW-FORM."
640 (cond
641 (time-stamp-conversion-warn
642 (save-excursion
643 (set-buffer (get-buffer-create "*Time-stamp-compatibility*"))
644 (goto-char (point-max))
645 (if (bobp)
646 (progn
647 (insert
648 "The formats recognized in time-stamp-format will change in a future release\n"
649 "to be compatible with the new, expanded format-time-string function.\n\n"
650 "The following obsolescent time-stamp-format construct(s) were found:\n\n")))
651 (insert "\"" old-form "\" -- use " new-form "\n"))
652 (display-buffer "*Time-stamp-compatibility*"))))
656 (defun time-stamp-mail-host-name ()
657 "Return the name of the host where the user receives mail.
658 This is the value of `mail-host-address' if bound and a string,
659 otherwise the value of the function `system-name'."
660 (or (and (boundp 'mail-host-address)
661 (stringp mail-host-address)
662 mail-host-address)
663 (system-name)))
665 ;;; the rest of this file is for version 1 compatibility
667 (defun time-stamp-fconcat (list sep)
668 "Similar to (mapconcat 'funcall LIST SEP) but LIST allows literals.
669 If an element of LIST is a symbol, it is funcalled to get the string to use;
670 the separator SEP is used between two strings obtained by funcalling a
671 symbol. Otherwise the element itself is inserted; no separator is used
672 around literals."
673 (let ((return-string "")
674 (insert-sep-p nil))
675 (while list
676 (cond ((symbolp (car list))
677 (if insert-sep-p
678 (setq return-string (concat return-string sep)))
679 (setq return-string (concat return-string (funcall (car list))))
680 (setq insert-sep-p t))
682 (setq return-string (concat return-string (car list)))
683 (setq insert-sep-p nil)))
684 (setq list (cdr list)))
685 return-string))
687 ;;; Some functions used in time-stamp-format
689 ;;; These functions have been obsolete since 1995
690 ;;; and will be removed in Emacs 22.
691 ;;; Meanwhile, discourage other packages from using them.
692 (let ((obsolete-functions '(time-stamp-month-dd-yyyy
693 time-stamp-dd/mm/yyyy
694 time-stamp-mon-dd-yyyy
695 time-stamp-dd-mon-yy
696 time-stamp-yy/mm/dd
697 time-stamp-yyyy/mm/dd
698 time-stamp-yyyy-mm-dd
699 time-stamp-yymmdd
700 time-stamp-hh:mm:ss
701 time-stamp-hhmm)))
702 (while obsolete-functions
703 (make-obsolete (car obsolete-functions)
704 "use time-stamp-string or format-time-string instead."
705 "20.1")
706 (setq obsolete-functions (cdr obsolete-functions))))
708 ;;; pretty form, suitable for a title page
710 (defun time-stamp-month-dd-yyyy ()
711 "Return the current date as a string in \"Month DD, YYYY\" form."
712 (format-time-string "%B %e, %Y"))
714 (defun time-stamp-dd/mm/yyyy ()
715 "Return the current date as a string in \"DD/MM/YYYY\" form."
716 (format-time-string "%d/%m/%Y"))
718 ;;; same as __DATE__ in ANSI C
720 (defun time-stamp-mon-dd-yyyy ()
721 "Return the current date as a string in \"Mon DD YYYY\" form.
722 The first character of DD is space if the value is less than 10."
723 (format-time-string "%b %d %Y"))
725 ;;; RFC 822 date
727 (defun time-stamp-dd-mon-yy ()
728 "Return the current date as a string in \"DD Mon YY\" form."
729 (format-time-string "%d %b %y"))
731 ;;; RCS 3 date
733 (defun time-stamp-yy/mm/dd ()
734 "Return the current date as a string in \"YY/MM/DD\" form."
735 (format-time-string "%y/%m/%d"))
737 ;;; RCS 5 date
739 (defun time-stamp-yyyy/mm/dd ()
740 "Return the current date as a string in \"YYYY/MM/DD\" form."
741 (format-time-string "%Y/%m/%d"))
743 ;;; ISO 8601 date
745 (defun time-stamp-yyyy-mm-dd ()
746 "Return the current date as a string in \"YYYY-MM-DD\" form."
747 (format-time-string "%Y-%m-%d"))
749 (defun time-stamp-yymmdd ()
750 "Return the current date as a string in \"YYMMDD\" form."
751 (format-time-string "%y%m%d"))
753 (defun time-stamp-hh:mm:ss ()
754 "Return the current time as a string in \"HH:MM:SS\" form."
755 (format-time-string "%T"))
757 (defun time-stamp-hhmm ()
758 "Return the current time as a string in \"HHMM\" form."
759 (format-time-string "%H%M"))
761 (provide 'time-stamp)
763 ;;; arch-tag: 8a12c5c3-25d6-4a71-adc5-24b0e025a1e7
764 ;;; time-stamp.el ends here