|
5687
|
1 ## Copyright (C) 2000, 2001, 2002, 2003, 2005 Paul Kienzle |
|
|
2 ## |
|
|
3 ## This file is part of Octave. |
|
|
4 ## |
|
|
5 ## Octave is free software; you can redistribute it and/or modify it |
|
|
6 ## under the terms of the GNU General Public License as published by |
|
|
7 ## the Free Software Foundation; either version 2, or (at your option) |
|
|
8 ## any later version. |
|
|
9 ## |
|
|
10 ## Octave is distributed in the hope that it will be useful, but |
|
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
|
13 ## General Public License for more details. |
|
|
14 ## |
|
|
15 ## You should have received a copy of the GNU General Public License |
|
|
16 ## along with Octave; see the file COPYING. If not, write to the Free |
|
|
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
|
|
18 ## 02110-1301, USA. |
|
|
19 |
|
|
20 ## -*- texinfo -*- |
|
|
21 ## @deftypefn {Function File} {@var{str} =} datestr (@var{date}, [@var{f}, [@var{p}]]) |
|
|
22 ## Format the given date/time according to the format @code{f} and return |
|
|
23 ## the result in @var{str}. @var{date} is a serial date number (see |
|
|
24 ## @code{datenum}) or a date vector (see @code{datevec}). For compatibility |
|
|
25 ## with Matlab, @var{date} may also be a string or cell array of strings. |
|
|
26 ## |
|
|
27 ## @var{f} can be an integer which corresponds to one of the codes in |
|
|
28 ## the table below, or a date format string. |
|
|
29 ## |
|
|
30 ## @var{p} is the year at the start of the century in which two-digit years |
|
|
31 ## are to be interpreted in. If not specified, it defaults to the current |
|
|
32 ## year minus 50. |
|
|
33 ## |
|
|
34 ## For example, the date 730736.65149 (2000-09-07 15:38:09.0934) would be |
|
|
35 ## formatted as follows: |
|
|
36 ## |
|
|
37 ## @multitable @columnfractions 0.1 0.45 0.35 |
|
|
38 ## @headitem Code @tab Format @tab Example |
|
|
39 ## @item 0 @tab dd-mmm-yyyy HH:MM:SS @tab 07-Sep-2000 15:38:09 |
|
|
40 ## @item 1 @tab dd-mmm-yyyy @tab 07-Sep-2000 |
|
|
41 ## @item 2 @tab mm/dd/yy @tab 09/07/00 |
|
|
42 ## @item 3 @tab mmm @tab Sep |
|
|
43 ## @item 4 @tab m @tab S |
|
|
44 ## @item 5 @tab mm @tab 09 |
|
|
45 ## @item 6 @tab mm/dd @tab 09/07 |
|
|
46 ## @item 7 @tab dd @tab 07 |
|
|
47 ## @item 8 @tab ddd @tab Thu |
|
|
48 ## @item 9 @tab d @tab T |
|
|
49 ## @item 10 @tab yyyy @tab 2000 |
|
|
50 ## @item 11 @tab yy @tab 00 |
|
|
51 ## @item 12 @tab mmmyy @tab Sep00 |
|
|
52 ## @item 13 @tab HH:MM:SS @tab 15:38:09 |
|
|
53 ## @item 14 @tab HH:MM:SS PM @tab 03:38:09 PM |
|
|
54 ## @item 15 @tab HH:MM @tab 15:38 |
|
|
55 ## @item 16 @tab HH:MM PM @tab 03:38 PM |
|
|
56 ## @item 17 @tab QQ-YY @tab Q3-00 |
|
|
57 ## @item 18 @tab QQ @tab Q3 |
|
|
58 ## @item 19 @tab dd/mm @tab 13/03 |
|
|
59 ## @item 20 @tab dd/mm/yy @tab 13/03/95 |
|
|
60 ## @item 21 @tab mmm.dd.yyyy HH:MM:SS @tab Mar.03.1962 13:53:06 |
|
|
61 ## @item 22 @tab mmm.dd.yyyy @tab Mar.03.1962 |
|
|
62 ## @item 23 @tab mm/dd/yyyy @tab 03/13/1962 |
|
|
63 ## @item 24 @tab dd/mm/yyyy @tab 12/03/1962 |
|
|
64 ## @item 25 @tab yy/mm/dd @tab 95/03/13 |
|
|
65 ## @item 26 @tab yyyy/mm/dd @tab 1995/03/13 |
|
|
66 ## @item 27 @tab QQ-YYYY @tab Q4-2132 |
|
|
67 ## @item 28 @tab mmmyyyy @tab Mar2047 |
|
|
68 ## @item 29 @tab yyyymmdd @tab 20470313 |
|
|
69 ## @item 30 @tab yyyymmddTHHMMSS @tab 20470313T132603 |
|
|
70 ## @item 31 @tab yyyy-mm-dd HH:MM:SS @tab 1047-03-13 13:26:03 |
|
|
71 ## @end multitable |
|
|
72 ## |
|
|
73 ## If @var{f} is a format string, the following symbols are recognised: |
|
|
74 ## |
|
|
75 ## @multitable @columnfractions 0.1 0.7 0.2 |
|
|
76 ## @headitem Symbol @tab Meaning @tab Example |
|
|
77 ## @item yyyy @tab Full year @tab 2005 |
|
|
78 ## @item yy @tab Two-digit year @tab 2005 |
|
|
79 ## @item mmmm @tab Full month name @tab December |
|
|
80 ## @item mmm @tab Abbreviated month name @tab Dec |
|
|
81 ## @item mm @tab Numeric month number (padded with zeros) @tab 01, 08, 12 |
|
|
82 ## @item m @tab First letter of month name (capitalized) @tab D |
|
|
83 ## @item dddd @tab Full weekday name @tab Sunday |
|
|
84 ## @item ddd @tab Abbreviated weekday name @tab Sun |
|
|
85 ## @item dd @tab Numeric day of month (padded with zeros) @tab 11 |
|
|
86 ## @item d @tab First letter of weekday name (capitalized) @tab S |
|
|
87 ## @item HH @tab Hour of day, padded with zeros if PM is set @tab 09:00 |
|
|
88 ## @item @tab and not padded with zeros otherwise @tab 9:00 AM |
|
|
89 ## @item MM @tab Minute of hour (padded with zeros) @tab 10:05 |
|
|
90 ## @item SS @tab Second of minute (padded with zeros) @tab 10:05:03 |
|
|
91 ## @item PM @tab Use 12-hour time format @tab 11:30 PM |
|
|
92 ## @end multitable |
|
|
93 ## |
|
|
94 ## If @var{f} is not specified or is @code{-1}, then use 0, 1 or 16, |
|
|
95 ## depending on whether the date portion or the time portion of |
|
|
96 ## @var{date} is empty. |
|
|
97 ## |
|
|
98 ## If @var{p} is nor specified, it defaults to the current year minus 50. |
|
|
99 ## |
|
|
100 ## If a matrix or cell array of dates is given, a vector of date strings is |
|
|
101 ## returned. |
|
|
102 ## |
|
|
103 ## @seealso{datenum, datevec, date, clock, now, datetick} |
|
|
104 ## @end deftypefn |
|
|
105 |
|
|
106 ## TODO: parse arbitrary code strings. |
|
|
107 ## TODO: e.g., for Wednesday 2001-03-05 09:04:06 AM, use |
|
|
108 ## TODO: yy 01 |
|
|
109 ## TODO: yyyy 2001 |
|
|
110 ## TODO: m M |
|
|
111 ## TODO: mm 03 |
|
|
112 ## TODO: mmm Mar |
|
|
113 ## TODO: d W |
|
|
114 ## TODO: dd 05 |
|
|
115 ## TODO: ddd Wed |
|
|
116 ## TODO: HH 09 |
|
|
117 ## TODO: MM 04 |
|
|
118 ## TODO: SS 06 |
|
|
119 ## TODO: PM AM |
|
|
120 ## TODO: Vectorize. It is particularly easy since all the codes are |
|
|
121 ## TODO: fixed width. Just generate the parts in separate arrays and |
|
|
122 ## TODO: concatenate. |
|
|
123 |
|
|
124 ## Author: pkienzle <pkienzle@users.sf.net> |
|
|
125 ## Created: 10 October 2001 (CVS) |
|
|
126 ## Adapted-By: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com> |
|
|
127 |
|
|
128 function retval = datestr (date, f, p) |
|
|
129 |
|
|
130 persistent dateform names_mmmm names_mmm names_m names_dddd names_ddd names_d; |
|
|
131 |
|
|
132 if (isempty (dateform)) |
|
|
133 |
|
|
134 dateform = cell (32, 1); |
|
|
135 dateform{1} = "dd-mmm-yyyy HH:MM:SS"; |
|
|
136 dateform{2} = "dd-mmm-yyyy"; |
|
|
137 dateform{3} = "mm/dd/yy"; |
|
|
138 dateform{4} = "mmm"; |
|
|
139 dateform{5} = "m"; |
|
|
140 dateform{6} = "mm"; |
|
|
141 dateform{7} = "mm/dd"; |
|
|
142 dateform{8} = "dd"; |
|
|
143 dateform{9} = "ddd"; |
|
|
144 dateform{10} = "d"; |
|
|
145 dateform{11} = "yyyy"; |
|
|
146 dateform{12} = "yy"; |
|
|
147 dateform{13} = "mmmyy"; |
|
|
148 dateform{14} = "HH:MM:SS"; |
|
|
149 dateform{15} = "HH:MM:SS PM"; |
|
|
150 dateform{16} = "HH:MM"; |
|
|
151 dateform{17} = "HH:MM PM"; |
|
|
152 dateform{18} = "QQ-YY"; |
|
|
153 dateform{19} = "QQ"; |
|
|
154 dateform{20} = "dd/mm"; |
|
|
155 dateform{21} = "dd/mm/yy"; |
|
|
156 dateform{22} = "mmm.dd.yyyy HH:MM:SS"; |
|
|
157 dateform{23} = "mmm.dd.yyyy"; |
|
|
158 dateform{24} = "mm/dd/yyyy"; |
|
|
159 dateform{25} = "dd/mm/yyyy"; |
|
|
160 dateform{26} = "yy/mm/dd"; |
|
|
161 dateform{27} = "yyyy/mm/dd"; |
|
|
162 dateform{28} = "QQ-YYYY"; |
|
|
163 dateform{29} = "mmmyyyy"; |
|
|
164 dateform{30} = "yyyymmdd"; |
|
|
165 dateform{31} = "yyyymmddTHHMMSS"; |
|
|
166 dateform{32} = "yyyy-mm-dd HH:MM:SS"; |
|
|
167 |
|
|
168 names_mmmm = {"January"; "February"; "March"; "April"; |
|
|
169 "May"; "June"; "July"; "August"; |
|
|
170 "September"; "October"; "November"; "December"}; |
|
|
171 |
|
|
172 names_mmm = {"Jan"; "Feb"; "Mar"; "Apr"; "May"; "Jun"; |
|
|
173 "Jul"; "Aug"; "Sep"; "Oct"; "Nov"; "Dec"}; |
|
|
174 |
|
|
175 names_m = {"J"; "F"; "M"; "A"; "M"; "J"; "J"; "A"; "S"; "O"; "N"; "D"}; |
|
|
176 |
|
|
177 names_dddd = {"Sunday"; "Monday"; "Tuesday"; "Wednesday"; |
|
|
178 "Thursday"; "Friday"; "Saturday"}; |
|
|
179 |
|
|
180 names_ddd = {"Sun"; "Mon"; "Tue"; "Wed"; "Thu"; "Fri"; "Sat"}; |
|
|
181 |
|
|
182 names_d = {"S"; "M"; "T"; "W"; "T"; "F"; "S"}; |
|
|
183 |
|
|
184 endif |
|
|
185 |
|
|
186 if (nargin < 1 || nargin > 3) |
|
|
187 usage("str = datestr (date, [f, [p]])"); |
|
|
188 endif |
|
|
189 |
|
|
190 if (nargin < 2) |
|
|
191 f = []; |
|
|
192 endif |
|
|
193 if (nargin < 3) |
|
|
194 p = []; |
|
|
195 endif |
|
|
196 |
|
|
197 if (ischar (date)) |
|
|
198 t = date; |
|
|
199 date = cell (1); |
|
|
200 date{1} = t; |
|
|
201 endif |
|
|
202 |
|
|
203 # guess, so we might be wrong |
|
|
204 if (iscell (date) || columns (date) != 6) |
|
|
205 v = datevec (date, p); |
|
|
206 else |
|
|
207 v = date; |
|
|
208 endif |
|
|
209 |
|
|
210 for i = 1:(rows (v)) |
|
|
211 |
|
|
212 if (isempty (f) || f == -1) |
|
|
213 if (v(i,4:6) == 0) |
|
|
214 f = 1; |
|
|
215 #elseif (v(i,1:3) == [0, 1, 1]) |
|
|
216 elseif (v(i,1:3) == [-1, 12, 31]) |
|
|
217 f = 16; |
|
|
218 else |
|
|
219 f = 0; |
|
|
220 endif |
|
|
221 endif |
|
|
222 |
|
|
223 if (isnumeric (f)) |
|
|
224 df = dateform{f + 1}; |
|
|
225 else |
|
|
226 df = f; |
|
|
227 endif |
|
|
228 |
|
|
229 ## dates to lowercase (note: we cannot convert MM to mm) |
|
|
230 df = strrep (df, "YYYY", "yyyy"); |
|
|
231 df = strrep (df, "YY", "yy"); |
|
|
232 df = strrep (df, "QQ", "qq"); |
|
|
233 df = strrep (df, "MMMM", "mmmm"); |
|
|
234 df = strrep (df, "MMM", "mmm"); |
|
|
235 #### BEGIN NOT-SO-UGLY HACK #### |
|
|
236 idx_MM = strfind (df, "MM"); |
|
|
237 idx_AM = strfind (df, "AM"); |
|
|
238 idx_PM = strfind (df, "PM"); |
|
|
239 df = strrep (df, "M", "m"); |
|
|
240 df([idx_MM, idx_MM + 1, idx_AM + 1, idx_PM + 1]) = "M"; |
|
|
241 df(idx_AM) = "A"; |
|
|
242 df(idx_PM) = "P"; |
|
|
243 #### END NOT-SO-UGLY HACK #### |
|
|
244 df = strrep (df, "DDDD", "dddd"); |
|
|
245 df = strrep (df, "DDD", "ddd"); |
|
|
246 df = strrep (df, "DD", "dd"); |
|
|
247 df = strrep (df, "D", "d"); |
|
|
248 ## times to uppercase (also cannot convert mm to MM) |
|
|
249 df = strrep (df, "hh", "HH"); |
|
|
250 df = strrep (df, "ss", "SS"); |
|
|
251 df = strrep (df, "am", "AM"); |
|
|
252 df = strrep (df, "pm", "PM"); |
|
|
253 |
|
|
254 str = df; |
|
|
255 ## replace date symbols with actual values |
|
|
256 str = strrep (str, "yyyy", sprintf ("%04d", v(i,1))); |
|
|
257 str = strrep (str, "yy", sprintf ("%02d", rem (v(i,1), 100))); |
|
|
258 str = strrep (str, "qq", sprintf ("Q%d", fix ((v(i,2) + 2) / 3))); |
|
|
259 str = strrep (str, "mmmm", names_mmmm{v(i,2)}); |
|
|
260 str = strrep (str, "mmm", names_mmm{v(i,2)}); |
|
|
261 str = strrep (str, "mm", sprintf ("%02d", v(i,2))); |
|
|
262 str = strrep (str, "m", names_m{v(i,2)}); |
|
|
263 str = strrep (str, "dddd", names_dddd{weekday (datenum (v(i,1), v(i,2), v(i,3)))}); |
|
|
264 str = strrep (str, "ddd", names_ddd{weekday (datenum (v(i,1), v(i,2), v(i,3)))}); |
|
|
265 str = strrep (str, "dd", sprintf ("%02d", v(i,3))); |
|
|
266 str = strrep (str, "d", names_d{weekday (datenum (v(i,1), v(i,2), v(i,3)))}); |
|
|
267 ## replace time symbols with actual values |
|
|
268 if ((any (strfind (str, "AM")) || any (strfind (str, "PM")))) |
|
|
269 if (v(i,4) > 12) |
|
|
270 str = strrep (str, "HH", sprintf ("%d", v(i,4) - 12)); |
|
|
271 else |
|
|
272 str = strrep (str, "HH", sprintf ("%d", v(i,4))); |
|
|
273 endif |
|
|
274 if (v(i,4) < 12) |
|
|
275 str = strrep (str, "AM", "AM"); |
|
|
276 str = strrep (str, "PM", "AM"); |
|
|
277 else |
|
|
278 str = strrep (str, "AM", "PM"); |
|
|
279 str = strrep (str, "PM", "PM"); |
|
|
280 endif |
|
|
281 else |
|
|
282 str = strrep (str, "HH", sprintf ("%02d", v(i,4))); |
|
|
283 endif |
|
|
284 str = strrep (str, "MM", sprintf ("%02d", v(i,5))); |
|
|
285 str = strrep (str, "SS", sprintf ("%02d", v(i,6))); |
|
|
286 |
|
|
287 if (i == 1) |
|
|
288 retval = str; |
|
|
289 else |
|
|
290 retval = [retval; str]; |
|
|
291 endif |
|
|
292 |
|
|
293 endfor |
|
|
294 |
|
|
295 endfunction |
|
|
296 |
|
|
297 # simple tests |
|
|
298 %!shared testtime |
|
|
299 %! testtime = [2005.0000, 12.0000, 18.0000, 2.0000, 33.0000, 17.3822]; |
|
|
300 %!assert(datestr(testtime,0),"18-Dec-2005 02:33:17"); |
|
|
301 %!assert(datestr(testtime,1),"18-Dec-2005"); |
|
|
302 %!assert(datestr(testtime,2),"12/18/05"); |
|
|
303 %!assert(datestr(testtime,3),"Dec"); |
|
|
304 %!assert(datestr(testtime,4),"D"); |
|
|
305 %!assert(datestr(testtime,5),"12"); |
|
|
306 %!assert(datestr(testtime,6),"12/18"); |
|
|
307 %!assert(datestr(testtime,7),"18"); |
|
|
308 %!assert(datestr(testtime,8),"Sun"); |
|
|
309 %!assert(datestr(testtime,9),"S"); |
|
|
310 %!assert(datestr(testtime,10),"2005"); |
|
|
311 %!assert(datestr(testtime,11),"05"); |
|
|
312 %!assert(datestr(testtime,12),"Dec05"); |
|
|
313 %!assert(datestr(testtime,13),"02:33:17"); |
|
|
314 %!assert(datestr(testtime,14),"2:33:17 AM"); |
|
|
315 %!assert(datestr(testtime,15),"02:33"); |
|
|
316 %!assert(datestr(testtime,16),"2:33 AM"); |
|
|
317 %!assert(datestr(testtime,17),"Q4-05"); |
|
|
318 %!assert(datestr(testtime,18),"Q4"); |
|
|
319 %!assert(datestr(testtime,19),"18/12"); |
|
|
320 %!assert(datestr(testtime,20),"18/12/05"); |
|
|
321 %!assert(datestr(testtime,21),"Dec.18.2005 02:33:17"); |
|
|
322 %!assert(datestr(testtime,22),"Dec.18.2005"); |
|
|
323 %!assert(datestr(testtime,23),"12/18/2005"); |
|
|
324 %!assert(datestr(testtime,24),"18/12/2005"); |
|
|
325 %!assert(datestr(testtime,25),"05/12/18"); |
|
|
326 %!assert(datestr(testtime,26),"2005/12/18"); |
|
|
327 %!assert(datestr(testtime,27),"Q4-2005"); |
|
|
328 %!assert(datestr(testtime,28),"Dec2005"); |
|
|
329 %!assert(datestr(testtime,29),"20051218"); |
|
|
330 %!assert(datestr(testtime,30),"20051218T023317"); |
|
|
331 %!assert(datestr(testtime,31),"2005-12-18 02:33:17"); |
|
|
332 # demos |
|
|
333 %!demo |
|
|
334 %! datestr (now ()) |
|
|
335 %!demo |
|
|
336 %! datestr (rem (now (), 1)) |
|
|
337 %!demo |
|
|
338 %! datestr (floor (now ())) |
