annotate lisp/time-stamp.el @ 25180:1a84afcdb8f9

(auto-show-mode): Fix :set.
author Dave Love <fx@gnu.org>
date Thu, 05 Aug 1999 19:12:08 +0000
parents 894911d2c01d
children 456e2e2bc4d3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 ;;; time-stamp.el --- Maintain last change time stamps in files edited by Emacs
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
3 ;; Copyright 1989, 1993, 1994, 1995, 1997 Free Software Foundation, Inc.
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14042
diff changeset
4
24266
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
5 ;; Maintainer's Time-stamp: <1999-01-06 11:06:03 gildea>
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
6 ;; Maintainer: Stephen Gildea <gildea@alum.mit.edu>
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 ;; Keywords: tools
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; This file is free software; you can redistribute it and/or modify
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 ;; it under the terms of the GNU General Public License as published by
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; the Free Software Foundation; either version 2, or (at your option)
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; any later version.
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; This file is distributed in the hope that it will be useful,
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; GNU General Public License for more details.
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; You should have received a copy of the GNU General Public License
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14042
diff changeset
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14042
diff changeset
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14042
diff changeset
22 ;; Boston, MA 02111-1307, USA.
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 ;;; Commentary:
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
26 ;; A template in a file can be updated with a new time stamp when
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
27 ;; you save the file. For example:
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
28 ;; static char *ts = "sdmain.c Time-stamp: <1996-08-13 10:20:51 gildea>";
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
29 ;; See the top of `time-stamp.el' for another example.
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
31 ;; To use time-stamping, add this line to your .emacs file:
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
32 ;; (add-hook 'write-file-hooks 'time-stamp)
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
33 ;; Now any time-stamp templates in your files will be updated automatically.
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
35 ;; See the documentation for the functions `time-stamp'
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
36 ;; and `time-stamp-toggle-active' for details.
11404
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
37
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 ;;; Code:
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39
17438
368547942e03 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 16714
diff changeset
40 (defgroup time-stamp nil
368547942e03 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 16714
diff changeset
41 "Maintain last change time stamps in files edited by Emacs."
368547942e03 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 16714
diff changeset
42 :group 'data
368547942e03 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 16714
diff changeset
43 :group 'extensions)
368547942e03 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 16714
diff changeset
44
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
45 (defcustom time-stamp-format "%:y-%02m-%02d %02H:%02M:%02S %u"
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
46 "*Format of the string inserted by \\[time-stamp].
16674
91590d8f74c3 (time-stamp-am-pm): Variable deleted.
Richard M. Stallman <rms@gnu.org>
parents: 16517
diff changeset
47 The value may be a string or a list. Lists are supported only for
91590d8f74c3 (time-stamp-am-pm): Variable deleted.
Richard M. Stallman <rms@gnu.org>
parents: 16517
diff changeset
48 backward compatibility; see variable `time-stamp-old-format-warn'.
13356
a2a68cba7996 update some doc strings.
Karl Heuer <kwzh@gnu.org>
parents: 12044
diff changeset
49
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
50 A string is used verbatim except for character sequences beginning with %:
16705
db8a501954f6 (time-stamp-no-file): Reintroduced.
Richard M. Stallman <rms@gnu.org>
parents: 16674
diff changeset
51
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
52 %:a weekday name: `Monday'. %#A gives uppercase: `MONDAY'
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
53 %3a abbreviated weekday: `Mon'. %3A gives uppercase: `MON'
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
54 %:b month name: `January'. %#B gives uppercase: `JANUARY'
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
55 %3b abbreviated month: `Jan'. %3B gives uppercase: `JAN'
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
56 %02d day of month
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
57 %02H 24-hour clock hour
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
58 %02I 12-hour clock hour
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
59 %02m month number
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
60 %02M minute
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
61 %#p `am' or `pm'. %P gives uppercase: `AM' or `PM'
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
62 %02S seconds
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
63 %w day number of week, Sunday is 0
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
64 %02y 2-digit year: `97' %:y 4-digit year: `1997'
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
65 %z time zone name: `est'. %Z gives uppercase: `EST'
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
66
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
67 Non-date items:
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
68 %% a literal percent character: `%'
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
69 %f file name without directory %F gives absolute pathname
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
70 %s system name
24266
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
71 %u user's login name %U user's full name
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
72 %h mail host name
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
73
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
74 Decimal digits between the % and the type character specify the
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
75 field width. Strings are truncated on the right; years on the left.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
76 A leading zero causes numbers to be zero-filled.
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
77
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
78 For example, to get the format used by the `date' command,
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
79 use \"%3a %3b %2d %02H:%02M:%02S %Z %:y\".
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
80
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
81 In the future these formats will be aligned more with format-time-string.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
82 Because of this transition, the default padding for numeric formats will
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
83 change in a future version. Therefore either a padding width should be
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
84 specified, or the : modifier should be used to explicitly request the
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
85 historical default."
17438
368547942e03 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 16714
diff changeset
86 :type 'string
368547942e03 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 16714
diff changeset
87 :group 'time-stamp)
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
88
19504
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
89 (defcustom time-stamp-active t
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
90 "*Non-nil to enable time-stamping of buffers by \\[time-stamp].
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
91 Can be toggled by \\[time-stamp-toggle-active].
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
92 See also the variable `time-stamp-warn-inactive'."
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
93 :type 'boolean
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
94 :group 'time-stamp)
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
95
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
96 (defcustom time-stamp-warn-inactive t
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
97 "Non-nil to have \\[time-stamp] warn if a buffer did not get time-stamped.
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
98 A warning is printed if `time-stamp-active' is nil and the buffer contains
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
99 a time stamp template that would otherwise have been updated."
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
100 :type 'boolean
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
101 :group 'time-stamp)
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
102
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
103 (defcustom time-stamp-old-format-warn 'ask
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
104 "Action to take if `time-stamp-format' is an old-style list.
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
105 If `error', the format is not used. If `ask', the user is queried about
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
106 using the time-stamp-format. If `warn', a warning is displayed.
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
107 If nil, no notification is given."
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
108 :type '(choice (const :tag "No notification" nil)
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
109 (const :tag "Don't use the format" error)
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
110 (const ask) (const warn))
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
111 :group 'time-stamp)
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
112
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
113 (defcustom time-stamp-time-zone nil
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
114 "If non-nil, a string naming the timezone to be used by \\[time-stamp].
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
115 Format is the same as that used by the environment variable TZ on your system."
19791
1366d82c1d3f (time-stamp-time-zone): Allow nil as alternative.
Richard M. Stallman <rms@gnu.org>
parents: 19504
diff changeset
116 :type '(choice (const nil) string)
19504
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
117 :group 'time-stamp)
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
118
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
119
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
120 ;;; Do not change time-stamp-line-limit, time-stamp-start,
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
121 ;;; time-stamp-end, or time-stamp-pattern in your .emacs
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
122 ;;; or you will be incompatible with other people's files!
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
123 ;;; If you must change them, do so only in the local variables
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
124 ;;; section of the file itself.
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
126
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
127 (defvar time-stamp-line-limit 8 ;Do not change!
14042
161d50568707 (time-stamp-line-limit): negative value counts
Karl Heuer <kwzh@gnu.org>
parents: 13356
diff changeset
128 "Lines of a file searched; positive counts from start, negative from end.
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
129 The patterns `time-stamp-start' and `time-stamp-end' must be found on one
14042
161d50568707 (time-stamp-line-limit): negative value counts
Karl Heuer <kwzh@gnu.org>
parents: 13356
diff changeset
130 of the first (last) `time-stamp-line-limit' lines of the file for the
24266
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
131 file to be time-stamped by \\[time-stamp]. A value of 0 searches the
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
132 entire buffer (use with care).
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
133
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
134 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
135 `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
136 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
137 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
138
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139
5971
f97f4938fffa (time-stamp-start): Allow more white space
Richard M. Stallman <rms@gnu.org>
parents: 5632
diff changeset
140 (defvar time-stamp-start "Time-stamp:[ \t]+\\\\?[\"<]+" ;Do not change!
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 "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
142 See also the variables `time-stamp-end' and `time-stamp-line-limit'.
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
144 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
145 `time-stamp-end' for yourself or you will be incompatible
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146 with other people's files! If you must change them for some application,
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147 do so in the local variables section of the time-stamped file itself.")
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
148
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
149
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
150 (defvar time-stamp-end "\\\\?[\">]" ;Do not change!
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
151 "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
152 \\[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
153 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
154 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
155
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
156 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
157 `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
158 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
159 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
160
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
161
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
162 (defvar time-stamp-pattern "%%" ;Do not change!
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
163 "Convenience variable setting all time-stamp location and format variables.
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
164 This string has four parts, each of which is optional.
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
165 These four parts set time-stamp-line-limit, time-stamp-start,
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
166 time-stamp-format, and time-stamp-end. See the documentation
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
167 for each of these variables for details.
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
168
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
169 The first part is a number followed by a slash; the number sets the number
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
170 of lines at the beginning (negative counts from end) of the file searched
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
171 for the time-stamp. The number and the slash may be omitted to use the
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
172 normal value.
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
173
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
174 The second part is a regexp identifying the pattern preceding the time stamp.
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
175 This part may be omitted to use the normal pattern.
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
176
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
177 The third part specifies the format of the time-stamp inserted. See
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
178 the documentation for time-stamp-format for details. Specify this
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
179 part as \"%%\" to use the normal format.
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
180
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
181 The fourth part is a regexp identifying the pattern following the time stamp.
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
182 This part may be omitted to use the normal pattern.
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
183
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
184 As an example, the default behavior can be specified something like this:
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
185 \"8/Time-stamp: [\\\"<]%:y-%02m-%02d %02H:%02M:%02S %u[\\\">]\"
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
186
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
187 Do not change `time-stamp-pattern' for yourself or you will be incompatible
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
188 with other people's files! Set it only in the local variables section
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
189 of the time-stamped file itself.")
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
190
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
191
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
192
4327
771786f5d8c2 (time-stamp): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 4325
diff changeset
193 ;;;###autoload
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194 (defun time-stamp ()
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195 "Update the time stamp string in the buffer.
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
196 A template in a file can be automatically updated with a new time stamp
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
197 every time you save the file. Add this line to your .emacs file:
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
198 (add-hook 'write-file-hooks 'time-stamp)
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
199 Normally the template must appear in the first 8 lines of a file and
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
200 look like one of the following:
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
201 Time-stamp: <>
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
202 Time-stamp: \" \"
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
203 The time stamp is written between the brackets or quotes:
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
204 Time-stamp: <1998-02-18 10:20:51 gildea>
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
205 The time stamp is updated only if the variable `time-stamp-active' is non-nil.
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
206 The format of the time stamp is set by the variable `time-stamp-format'.
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
207 The variables `time-stamp-line-limit', `time-stamp-start',
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
208 and `time-stamp-end' control finding the template."
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
209 (interactive)
12023
1a3e7aef5f8a (time-stamp): only warn about time-stamping
Karl Heuer <kwzh@gnu.org>
parents: 11429
diff changeset
210 (let ((case-fold-search nil)
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
211 (start nil)
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
212 (end nil)
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
213 search-limit
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
214 (line-limit time-stamp-line-limit)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
215 (ts-start time-stamp-start)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
216 (ts-format time-stamp-format)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
217 (ts-end time-stamp-end))
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
218 (if (stringp time-stamp-pattern)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
219 (progn
22508
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
220 (string-match "\\`\\(\\(-?[0-9]+\\)/\\)?\\([^%]+\\)?\\(\\(.\\|\n\\)*%[-.,:@+_ #^()0-9]*[A-Za-z%]\\)?\\([^%]+\\)?\\'" time-stamp-pattern)
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
221 (and (match-beginning 2)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
222 (setq line-limit
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
223 (string-to-int (match-string 2 time-stamp-pattern))))
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
224 (and (match-beginning 3)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
225 (setq ts-start (match-string 3 time-stamp-pattern)))
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
226 (and (match-beginning 4)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
227 (not (string-equal (match-string 4 time-stamp-pattern) "%%"))
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
228 (setq ts-format (match-string 4 time-stamp-pattern)))
22508
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
229 (and (match-beginning 6)
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
230 (setq ts-end (match-string 6 time-stamp-pattern)))))
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
231 (cond ((not (integerp line-limit))
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
232 (setq line-limit 8)
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
233 (message "time-stamp-line-limit is not an integer")
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
234 (sit-for 1)))
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
235 (save-excursion
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
236 (save-restriction
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
237 (widen)
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
238 (cond ((> line-limit 0)
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
239 (goto-char (setq start (point-min)))
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
240 (forward-line line-limit)
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
241 (setq search-limit (point)))
24266
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
242 ((< line-limit 0)
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
243 (goto-char (setq search-limit (point-max)))
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
244 (forward-line line-limit)
24266
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
245 (setq start (point)))
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
246 (t ;0 => no limit (use with care!)
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
247 (setq start (point-min))
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
248 (setq search-limit (point-max))))
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
249 (goto-char start)
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
250 (while (and (< (point) search-limit)
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
251 (not end)
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
252 (re-search-forward ts-start search-limit 'move))
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
253 (setq start (point))
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
254 (end-of-line)
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
255 (let ((line-end (point)))
14042
161d50568707 (time-stamp-line-limit): negative value counts
Karl Heuer <kwzh@gnu.org>
parents: 13356
diff changeset
256 (goto-char start)
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
257 (if (re-search-forward ts-end line-end 'move)
17600
0dc8180c2e7a (time-stamp-old-format-warn): Fix a tag string.
Richard M. Stallman <rms@gnu.org>
parents: 17438
diff changeset
258 (setq end (match-beginning 0)))))))
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
259 (if end
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
260 (progn
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
261 ;; do all warnings outside save-excursion
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
262 (cond
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
263 ((not time-stamp-active)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
264 (if time-stamp-warn-inactive
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
265 ;; don't signal an error in a write-file-hook
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
266 (progn
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
267 (message "Warning: time-stamp-active is off; did not time-stamp buffer.")
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
268 (sit-for 1))))
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
269 ((not (and (stringp ts-start)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
270 (stringp ts-end)))
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
271 (message "time-stamp-start or time-stamp-end is not a string")
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
272 (sit-for 1))
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
273 (t
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
274 (let ((new-time-stamp (time-stamp-string ts-format)))
24266
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
275 (if (and (stringp new-time-stamp)
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
276 (not (string-equal (buffer-substring start end)
894911d2c01d (time-stamp-format): Format doc tighter.
Richard M. Stallman <rms@gnu.org>
parents: 22993
diff changeset
277 new-time-stamp)))
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
278 (save-excursion
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
279 (save-restriction
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
280 (widen)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
281 (delete-region start end)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
282 (goto-char start)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
283 (insert-and-inherit new-time-stamp)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
284 (setq end (point))
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
285 ;; remove any tabs used to format time stamp
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
286 (goto-char start)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
287 (if (search-forward "\t" end t)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
288 (untabify start end)))))))))))
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
289 ;; be sure to return nil so can be used on write-file-hooks
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
290 nil)
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
291
11404
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
292 ;;;###autoload
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
293 (defun time-stamp-toggle-active (&optional arg)
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
294 "Toggle `time-stamp-active', setting whether \\[time-stamp] updates a buffer.
11404
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
295 With arg, turn time stamping on if and only if arg is positive."
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
296 (interactive "P")
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
297 (setq time-stamp-active
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
298 (if (null arg)
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
299 (not time-stamp-active)
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
300 (> (prefix-numeric-value arg) 0)))
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
301 (message "time-stamp is now %s." (if time-stamp-active "active" "off")))
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
302
16705
db8a501954f6 (time-stamp-no-file): Reintroduced.
Richard M. Stallman <rms@gnu.org>
parents: 16674
diff changeset
303 (defconst time-stamp-no-file "(no file)"
db8a501954f6 (time-stamp-no-file): Reintroduced.
Richard M. Stallman <rms@gnu.org>
parents: 16674
diff changeset
304 "String to use when the buffer is not associated with a file.")
db8a501954f6 (time-stamp-no-file): Reintroduced.
Richard M. Stallman <rms@gnu.org>
parents: 16674
diff changeset
305
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
306 ;;; time-stamp is transitioning to using the new, expanded capabilities
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
307 ;;; of format-time-string. During the process, this function implements
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
308 ;;; intermediate, compatible formats and complains about old, soon to
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
309 ;;; be unsupported, formats. This function will get a lot (a LOT) shorter
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
310 ;;; when the transition is complete and we can just pass most things
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
311 ;;; straight through to format-time-string.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
312 ;;; At all times, all the formats recommended in the doc string
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
313 ;;; of time-stamp-format will work not only in the current version of
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
314 ;;; Emacs, but in all versions that have been released within the past
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
315 ;;; two years.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
316 ;;; The : modifier is a temporary conversion feature used to resolve
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
317 ;;; ambiguous formats--formats that are changing (over time) incompatibly.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
318 (defun time-stamp-string-preprocess (format &optional time)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
319 ;; Uses a FORMAT to format date, time, file, and user information.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
320 ;; Optional second argument TIME is only for testing.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
321 ;; Implements non-time extensions to format-time-string
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
322 ;; and all time-stamp-format compatibility.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
323 (let ((fmt-len (length format))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
324 (ind 0)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
325 cur-char
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
326 (prev-char nil)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
327 (result "")
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
328 field-width
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
329 field-result
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
330 alt-form change-case require-padding
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
331 (paren-level 0))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
332 (while (< ind fmt-len)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
333 (setq cur-char (aref format ind))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
334 (setq
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
335 result
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
336 (concat result
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
337 (cond
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
338 ((eq cur-char ?%)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
339 ;; eat any additional args to allow for future expansion
22508
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
340 (setq alt-form nil change-case nil require-padding nil field-width "")
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
341 (while (progn
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
342 (setq ind (1+ ind))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
343 (setq cur-char (if (< ind fmt-len)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
344 (aref format ind)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
345 ?\0))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
346 (or (eq ?. cur-char)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
347 (eq ?, cur-char) (eq ?: cur-char) (eq ?@ cur-char)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
348 (eq ?- cur-char) (eq ?+ cur-char) (eq ?_ cur-char)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
349 (eq ?\ cur-char) (eq ?# cur-char) (eq ?^ cur-char)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
350 (and (eq ?\( cur-char)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
351 (not (eq prev-char ?\\))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
352 (setq paren-level (1+ paren-level)))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
353 (if (and (eq ?\) cur-char)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
354 (not (eq prev-char ?\\))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
355 (> paren-level 0))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
356 (setq paren-level (1- paren-level))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
357 (and (> paren-level 0)
22508
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
358 (< ind fmt-len)))
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
359 (if (and (<= ?0 cur-char) (>= ?9 cur-char))
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
360 ;; get format width
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
361 (let ((field-index ind))
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
362 (while (progn
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
363 (setq ind (1+ ind))
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
364 (setq cur-char (if (< ind fmt-len)
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
365 (aref format ind)
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
366 ?\0))
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
367 (and (<= ?0 cur-char) (>= ?9 cur-char))))
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
368 (setq field-width (substring format field-index ind))
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
369 (setq ind (1- ind))
c9307c229265 (time-stamp): Handle newlines in time-stamp-pattern.
Karl Heuer <kwzh@gnu.org>
parents: 21073
diff changeset
370 t))))
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
371 (setq prev-char cur-char)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
372 ;; some characters we actually use
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
373 (cond ((eq cur-char ?:)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
374 (setq alt-form t))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
375 ((eq cur-char ?#)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
376 (setq change-case t))))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
377 (setq field-result
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
378 (cond
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
379 ((eq cur-char ?%)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
380 "%")
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
381 ((eq cur-char ?a) ;day of week
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
382 (if change-case
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
383 (format-time-string "%#A" time)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
384 (or alt-form (not (string-equal field-width ""))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
385 (time-stamp-conv-warn "%a" "%:a"))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
386 (if (and alt-form (not (string-equal field-width "")))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
387 "" ;discourage "%:3a"
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
388 (format-time-string "%A" time))))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
389 ((eq cur-char ?A)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
390 (if alt-form
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
391 (format-time-string "%A" time)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
392 (or change-case (not (string-equal field-width ""))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
393 (time-stamp-conv-warn "%A" "%#A"))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
394 (format-time-string "%#A" time)))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
395 ((eq cur-char ?b) ;month name
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
396 (if change-case
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
397 (format-time-string "%#B" time)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
398 (or alt-form (not (string-equal field-width ""))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
399 (time-stamp-conv-warn "%b" "%:b"))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
400 (if (and alt-form (not (string-equal field-width "")))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
401 "" ;discourage "%:3b"
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
402 (format-time-string "%B" time))))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
403 ((eq cur-char ?B)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
404 (if alt-form
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
405 (format-time-string "%B" time)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
406 (or change-case (not (string-equal field-width ""))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
407 (time-stamp-conv-warn "%B" "%#B"))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
408 (format-time-string "%#B" time)))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
409 ((eq cur-char ?d) ;day of month, 1-31
18171
566b6cf773ed (time-stamp-string-preprocess, time-stamp-do-number):
Richard M. Stallman <rms@gnu.org>
parents: 18170
diff changeset
410 (time-stamp-do-number cur-char alt-form field-width time))
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
411 ((eq cur-char ?H) ;hour, 0-23
18171
566b6cf773ed (time-stamp-string-preprocess, time-stamp-do-number):
Richard M. Stallman <rms@gnu.org>
parents: 18170
diff changeset
412 (time-stamp-do-number cur-char alt-form field-width time))
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
413 ((eq cur-char ?I) ;hour, 1-12
18171
566b6cf773ed (time-stamp-string-preprocess, time-stamp-do-number):
Richard M. Stallman <rms@gnu.org>
parents: 18170
diff changeset
414 (time-stamp-do-number cur-char alt-form field-width time))
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
415 ((eq cur-char ?m) ;month number, 1-12
18171
566b6cf773ed (time-stamp-string-preprocess, time-stamp-do-number):
Richard M. Stallman <rms@gnu.org>
parents: 18170
diff changeset
416 (time-stamp-do-number cur-char alt-form field-width time))
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
417 ((eq cur-char ?M) ;minute, 0-59
18171
566b6cf773ed (time-stamp-string-preprocess, time-stamp-do-number):
Richard M. Stallman <rms@gnu.org>
parents: 18170
diff changeset
418 (time-stamp-do-number cur-char alt-form field-width time))
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
419 ((eq cur-char ?p) ;am or pm
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
420 (or change-case
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
421 (time-stamp-conv-warn "%p" "%#p"))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
422 (format-time-string "%#p" time))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
423 ((eq cur-char ?P) ;AM or PM
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
424 (format-time-string "%p" time))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
425 ((eq cur-char ?S) ;seconds, 00-60
18171
566b6cf773ed (time-stamp-string-preprocess, time-stamp-do-number):
Richard M. Stallman <rms@gnu.org>
parents: 18170
diff changeset
426 (time-stamp-do-number cur-char alt-form field-width time))
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
427 ((eq cur-char ?w) ;weekday number, Sunday is 0
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
428 (format-time-string "%w" time))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
429 ((eq cur-char ?y) ;year
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
430 (or alt-form (not (string-equal field-width ""))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
431 (time-stamp-conv-warn "%y" "%:y"))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
432 (string-to-int (format-time-string "%Y" time)))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
433 ((eq cur-char ?Y) ;4-digit year, new style
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
434 (string-to-int (format-time-string "%Y" time)))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
435 ((eq cur-char ?z) ;time zone lower case
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
436 (if change-case
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
437 "" ;discourage %z variations
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
438 (format-time-string "%#Z" time)))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
439 ((eq cur-char ?Z)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
440 (if change-case
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
441 (format-time-string "%#Z" time)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
442 (format-time-string "%Z" time)))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
443 ((eq cur-char ?f) ;buffer-file-name, base name only
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
444 (if buffer-file-name
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
445 (file-name-nondirectory buffer-file-name)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
446 time-stamp-no-file))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
447 ((eq cur-char ?F) ;buffer-file-name, full path
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
448 (or buffer-file-name
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
449 time-stamp-no-file))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
450 ((eq cur-char ?s) ;system name
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
451 (system-name))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
452 ((eq cur-char ?u) ;user name
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
453 (user-login-name))
22993
f580b9694876 (time-stamp-string-preprocess): Add %U code.
Richard M. Stallman <rms@gnu.org>
parents: 22508
diff changeset
454 ((eq cur-char ?U) ;user full name
f580b9694876 (time-stamp-string-preprocess): Add %U code.
Richard M. Stallman <rms@gnu.org>
parents: 22508
diff changeset
455 (user-full-name))
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
456 ((eq cur-char ?h) ;mail host name
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
457 (time-stamp-mail-host-name))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
458 ))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
459 (if (string-equal field-width "")
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
460 field-result
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
461 (let ((padded-result
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
462 (format (format "%%%s%c"
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
463 field-width
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
464 (if (numberp field-result) ?d ?s))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
465 (or field-result ""))))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
466 (let ((initial-length (length padded-result))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
467 (desired-length (string-to-int field-width)))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
468 (if (> initial-length desired-length)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
469 ;; truncate strings on right, years on left
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
470 (if (stringp field-result)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
471 (substring padded-result 0 desired-length)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
472 (if (eq cur-char ?y)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
473 (substring padded-result (- desired-length))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
474 padded-result)) ;non-year numbers don't truncate
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
475 padded-result)))))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
476 (t
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
477 (char-to-string cur-char)))))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
478 (setq ind (1+ ind)))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
479 result))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
480
18171
566b6cf773ed (time-stamp-string-preprocess, time-stamp-do-number):
Richard M. Stallman <rms@gnu.org>
parents: 18170
diff changeset
481 (defun time-stamp-do-number (format-char alt-form field-width time)
566b6cf773ed (time-stamp-string-preprocess, time-stamp-do-number):
Richard M. Stallman <rms@gnu.org>
parents: 18170
diff changeset
482 ;; Handle a compatible FORMAT-CHAR where only
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
483 ;; the default width/padding will change.
18171
566b6cf773ed (time-stamp-string-preprocess, time-stamp-do-number):
Richard M. Stallman <rms@gnu.org>
parents: 18170
diff changeset
484 ;; ALT-FORM is whether `#' specified. FIELD-WIDTH is the string
566b6cf773ed (time-stamp-string-preprocess, time-stamp-do-number):
Richard M. Stallman <rms@gnu.org>
parents: 18170
diff changeset
485 ;; width specification or "". TIME is the time to convert.
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
486 (let ((format-string (concat "%" (char-to-string format-char))))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
487 (and (not alt-form) (string-equal field-width "")
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
488 (time-stamp-conv-warn format-string
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
489 (format "%%:%c" format-char)))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
490 (if (and alt-form (not (string-equal field-width "")))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
491 "" ;discourage "%:2d" and the like
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
492 (string-to-int (format-time-string format-string time)))))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
493
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
494 (defvar time-stamp-conversion-warn t
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
495 "Non-nil to warn about soon-to-be-unsupported forms in time-stamp-format.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
496 In would be a bad idea to disable these warnings!
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
497 You really need to update your files instead.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
498
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
499 The new formats will work with old versions of Emacs.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
500 New formats are being recommended now to allow time-stamp-format
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
501 to change in the future to be compatible with format-time-string.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
502 The new forms being recommended now will continue to work then.")
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
503
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
504
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
505 (defun time-stamp-conv-warn (old-form new-form)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
506 ;; Display a warning about a soon-to-be-obsolete format.
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
507 (cond
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
508 (time-stamp-conversion-warn
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
509 (save-excursion
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
510 (set-buffer (get-buffer-create "*Time-stamp-compatibility*"))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
511 (goto-char (point-max))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
512 (if (bobp)
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
513 (progn
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
514 (insert
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
515 "The formats recognized in time-stamp-format will change in a future release\n"
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
516 "to be compatible with the new, expanded format-time-string function.\n\n"
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
517 "The following obsolescent time-stamp-format construct(s) were found:\n\n")))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
518 (insert "\"" old-form "\" -- use " new-form "\n"))
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
519 (display-buffer "*Time-stamp-compatibility*"))))
19504
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
520
18170
7776ee6215de (time-stamp-format): Doc fix. Use %;y.
Richard M. Stallman <rms@gnu.org>
parents: 17600
diff changeset
521
11404
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
522
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
523 (defun time-stamp-string (&optional ts-format)
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
524 "Generate the new string to be inserted by \\[time-stamp].
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
525 Optionally use FORMAT."
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
526 (or ts-format
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
527 (setq ts-format time-stamp-format))
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
528 (if (stringp ts-format)
19504
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
529 (if (stringp time-stamp-time-zone)
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
530 (let ((real-time-zone (getenv "TZ")))
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
531 (unwind-protect
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
532 (progn
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
533 (setenv "TZ" time-stamp-time-zone)
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
534 (format-time-string
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
535 (time-stamp-string-preprocess ts-format)))
19504
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
536 (setenv "TZ" real-time-zone)))
fd1ee3c25839 (time-stamp-time-zone): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19154
diff changeset
537 (format-time-string
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
538 (time-stamp-string-preprocess ts-format)))
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
539 ;; handle version 1 compatibility
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
540 (cond ((or (eq time-stamp-old-format-warn 'error)
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
541 (and (eq time-stamp-old-format-warn 'ask)
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
542 (not (y-or-n-p "Use non-string time-stamp-format? "))))
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
543 (message "Warning: no time-stamp: time-stamp-format not a string")
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
544 (sit-for 1)
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
545 nil)
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
546 (t
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
547 (cond ((eq time-stamp-old-format-warn 'warn)
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
548 (message "Obsolescent time-stamp-format type; should be string")
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
549 (sit-for 1)))
21073
82e7d581bad1 (time-stamp-pattern): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 19791
diff changeset
550 (time-stamp-fconcat ts-format " ")))))
11404
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
551
14042
161d50568707 (time-stamp-line-limit): negative value counts
Karl Heuer <kwzh@gnu.org>
parents: 13356
diff changeset
552 (defconst time-stamp-no-file "(no file)"
161d50568707 (time-stamp-line-limit): negative value counts
Karl Heuer <kwzh@gnu.org>
parents: 13356
diff changeset
553 "String to use when the buffer is not associated with a file.")
161d50568707 (time-stamp-line-limit): negative value counts
Karl Heuer <kwzh@gnu.org>
parents: 13356
diff changeset
554
11404
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
555 (defun time-stamp-mail-host-name ()
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
556 "Return the name of the host where the user receives mail.
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
557 This is the value of `mail-host-address' if bound and a string,
16714
634b34517d56 (time-stamp-mail-host-name): Get rid of time-stamp-mail-host.
Richard M. Stallman <rms@gnu.org>
parents: 16706
diff changeset
558 otherwise the value of the function system-name."
11404
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
559 (or (and (boundp 'mail-host-address)
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
560 (stringp mail-host-address)
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
561 mail-host-address)
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
562 (system-name)))
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
563
b12a8765508b (time-stamp-format): Replace list of Lisp
Richard M. Stallman <rms@gnu.org>
parents: 9016
diff changeset
564 ;;; the rest of this file is for version 1 compatibility
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 (defun time-stamp-fconcat (list sep)
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
567 "Similar to (mapconcat 'funcall LIST SEP) but LIST allows literals.
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568 If an element of LIST is a symbol, it is funcalled to get the string to use;
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
569 the separator SEP is used between two strings obtained by funcalling a
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 symbol. Otherwise the element itself is inserted; no separator is used
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
571 around literals."
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
572 (let ((return-string "")
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
573 (insert-sep-p nil))
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
574 (while list
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575 (cond ((symbolp (car list))
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576 (if insert-sep-p
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
577 (setq return-string (concat return-string sep)))
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
578 (setq return-string (concat return-string (funcall (car list))))
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
579 (setq insert-sep-p t))
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580 (t
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581 (setq return-string (concat return-string (car list)))
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
582 (setq insert-sep-p nil)))
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
583 (setq list (cdr list)))
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
584 return-string))
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
585
16287
24fd930446f6 (time-stamp-old-format-warn): new variable.
Karl Heuer <kwzh@gnu.org>
parents: 14231
diff changeset
586 ;;; Some functions used in time-stamp-format
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 ;;; 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
589 ;;; '(time-stamp-yymmdd "" time-stamp-hhmm "@" time-stamp-mail-host-name)
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
590
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
591 ;;; pretty form, suitable for a title page
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593 (defun time-stamp-month-dd-yyyy ()
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
594 "Return the current date as a string in \"Month DD, YYYY\" form."
16706
450cb7cbf895 (time-stamp-month-dd-yyyy): Use format-time-string.
Richard M. Stallman <rms@gnu.org>
parents: 16705
diff changeset
595 (format-time-string "%B %e, %Y"))
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596
16517
1fa5a347e70f (time-stamp-dd/mm/yyyy): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16287
diff changeset
597 (defun time-stamp-dd/mm/yyyy ()
1fa5a347e70f (time-stamp-dd/mm/yyyy): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16287
diff changeset
598 "Return the current date as a string in \"DD/MM/YYYY\" form."
16706
450cb7cbf895 (time-stamp-month-dd-yyyy): Use format-time-string.
Richard M. Stallman <rms@gnu.org>
parents: 16705
diff changeset
599 (format-time-string "%d/%m/%Y"))
16517
1fa5a347e70f (time-stamp-dd/mm/yyyy): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16287
diff changeset
600
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
601 ;;; same as __DATE__ in ANSI C
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603 (defun time-stamp-mon-dd-yyyy ()
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
604 "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
605 The first character of DD is space if the value is less than 10."
16706
450cb7cbf895 (time-stamp-month-dd-yyyy): Use format-time-string.
Richard M. Stallman <rms@gnu.org>
parents: 16705
diff changeset
606 (format-time-string "%b %d %Y"))
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 ;;; RFC 822 date
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610 (defun time-stamp-dd-mon-yy ()
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
611 "Return the current date as a string in \"DD Mon YY\" form."
16706
450cb7cbf895 (time-stamp-month-dd-yyyy): Use format-time-string.
Richard M. Stallman <rms@gnu.org>
parents: 16705
diff changeset
612 (format-time-string "%d %b %y"))
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614 ;;; RCS 3 date
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
615
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616 (defun time-stamp-yy/mm/dd ()
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
617 "Return the current date as a string in \"YY/MM/DD\" form."
16706
450cb7cbf895 (time-stamp-month-dd-yyyy): Use format-time-string.
Richard M. Stallman <rms@gnu.org>
parents: 16705
diff changeset
618 (format-time-string "%y/%m/%d"))
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620 ;;; RCS 5 date
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
621
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
622 (defun time-stamp-yyyy/mm/dd ()
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
623 "Return the current date as a string in \"YYYY/MM/DD\" form."
16706
450cb7cbf895 (time-stamp-month-dd-yyyy): Use format-time-string.
Richard M. Stallman <rms@gnu.org>
parents: 16705
diff changeset
624 (format-time-string "%Y/%m/%d"))
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
625
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
626 ;;; ISO 8601 date
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
627
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
628 (defun time-stamp-yyyy-mm-dd ()
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
629 "Return the current date as a string in \"YYYY-MM-DD\" form."
16706
450cb7cbf895 (time-stamp-month-dd-yyyy): Use format-time-string.
Richard M. Stallman <rms@gnu.org>
parents: 16705
diff changeset
630 (format-time-string "%Y-%m-%d"))
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
631
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
632 (defun time-stamp-yymmdd ()
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
633 "Return the current date as a string in \"YYMMDD\" form."
16706
450cb7cbf895 (time-stamp-month-dd-yyyy): Use format-time-string.
Richard M. Stallman <rms@gnu.org>
parents: 16705
diff changeset
634 (format-time-string "%y%m%d"))
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
636 (defun time-stamp-hh:mm:ss ()
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
637 "Return the current time as a string in \"HH:MM:SS\" form."
16706
450cb7cbf895 (time-stamp-month-dd-yyyy): Use format-time-string.
Richard M. Stallman <rms@gnu.org>
parents: 16705
diff changeset
638 (format-time-string "%T"))
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 (defun time-stamp-hhmm ()
5632
63d80d94e0d7 Better, more user-oriented doc strings.
Richard M. Stallman <rms@gnu.org>
parents: 5287
diff changeset
641 "Return the current time as a string in \"HHMM\" form."
16706
450cb7cbf895 (time-stamp-month-dd-yyyy): Use format-time-string.
Richard M. Stallman <rms@gnu.org>
parents: 16705
diff changeset
642 (format-time-string "%H%M"))
3854
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
644 (provide 'time-stamp)
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
645
ae1022bb1578 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
646 ;;; time-stamp.el ends here