Mercurial > octave-nkf

annotate src/DLD-FUNCTIONS/time.cc @ 11005:0de4eff677d6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
use mktime module from gnulib
author John W. Eaton <jwe@octave.org>
date Mon, 20 Sep 2010 21:23:10 -0400
parents 89f4d7e294cc
children f6b7b6e5b8b8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
1 /*
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
2
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 1996, 1997, 1999, 2000, 2002, 2003, 2004, 2005, 2006,
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8810
diff changeset
4 2007, 2008, 2009 John W. Eaton
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
5
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
7
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5823
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5823
diff changeset
11 option) any later version.
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
12
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
16 for more details.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
17
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5823
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5823
diff changeset
20 <http://www.gnu.org/licenses/>.
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
21
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
22 */
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
23
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
24 #ifdef HAVE_CONFIG_H
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
25 #include <config.h>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
26 #endif
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
27
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
28 #include <string>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
29
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
30 #include "defun-dld.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
31 #include "error.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
32 #include "oct-map.h"
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
33 #include "oct-time.h"
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
34 #include "ov.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
35 #include "oct-obj.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
36
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
37 // Date and time functions.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
38
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
39 static Octave_map
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
40 mk_tm_map (const octave_base_tm& t)
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
41 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
42 Octave_map m;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
43
4675
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
44 m.assign ("usec", static_cast<double> (t.usec ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
45 m.assign ("sec", static_cast<double> (t.sec ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
46 m.assign ("min", static_cast<double> (t.min ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
47 m.assign ("hour", static_cast<double> (t.hour ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
48 m.assign ("mday", static_cast<double> (t.mday ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
49 m.assign ("mon", static_cast<double> (t.mon ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
50 m.assign ("year", static_cast<double> (t.year ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
51 m.assign ("wday", static_cast<double> (t.wday ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
52 m.assign ("yday", static_cast<double> (t.yday ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
53 m.assign ("isdst", static_cast<double> (t.isdst ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe]
jwe
parents: 4367
diff changeset
54 m.assign ("zone", t.zone ());
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
55
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
56 return m;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
57 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
58
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
59 static octave_base_tm
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
60 extract_tm (Octave_map &m)
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
61 {
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
62 octave_base_tm tm;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
63
5156
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
64 tm.usec (m.intfield ("usec"));
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
65 tm.sec (m.intfield ("sec"));
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
66 tm.min (m.intfield ("min"));
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
67 tm.hour (m.intfield ("hour"));
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
68 tm.mday (m.intfield ("mday"));
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
69 tm.mon (m.intfield ("mon"));
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
70 tm.year (m.intfield ("year"));
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
71 tm.wday (m.intfield ("wday"));
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
72 tm.yday (m.intfield ("yday"));
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
73 tm.isdst (m.intfield ("isdst"));
7c3b22bafedc [project @ 2005-02-22 17:42:15 by jwe]
jwe
parents: 5020
diff changeset
74 tm.zone (m.stringfield ("zone"));
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
75
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
76 return tm;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
77 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
78
3255
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3254
diff changeset
79 DEFUN_DLD (time, args, ,
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
80 "-*- texinfo -*-\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
81 @deftypefn {Loadable Function} {} time ()\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
82 Return the current time as the number of seconds since the epoch. The\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
83 epoch is referenced to 00:00:00 CUT (Coordinated Universal Time) 1 Jan\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
84 1970. For example, on Monday February 17, 1997 at 07:15:06 CUT, the\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
85 value returned by @code{time} was 856163706.\n\
5688
6274256266d9 [project @ 2006-03-16 20:36:28 by jwe]
jwe
parents: 5675
diff changeset
86 @seealso{strftime, strptime, localtime, gmtime, mktime, now, date, clock, datenum, datestr, datevec, calendar, weekday}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
87 @end deftypefn")
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
88 {
3255
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3254
diff changeset
89 octave_value retval;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
90
3255
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3254
diff changeset
91 if (args.length () == 0)
7065
97db94ae2cf0 [project @ 2007-10-25 05:50:55 by jwe]
jwe
parents: 7017
diff changeset
92 retval = octave_time ();
3255
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3254
diff changeset
93 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5688
diff changeset
94 print_usage ();
3255
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3254
diff changeset
95
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3254
diff changeset
96 return retval;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
97 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
98
7562
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
99 /*
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
100
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
101 %!assert(time () > 0);
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
102
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
103 */
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
104
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
105 DEFUN_DLD (gmtime, args, ,
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
106 "-*- texinfo -*-\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
107 @deftypefn {Loadable Function} {} gmtime (@var{t})\n\
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
108 Given a value returned from time (or any non-negative integer),\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10231
diff changeset
109 return a time structure corresponding to CUT@. For example:\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
110 \n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
111 @example\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
112 @group\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
113 gmtime (time ())\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
114 @result{} @{\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
115 usec = 0\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
116 year = 97\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
117 mon = 1\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
118 mday = 17\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
119 sec = 6\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
120 zone = CST\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
121 min = 15\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
122 wday = 1\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
123 hour = 7\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
124 isdst = 0\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
125 yday = 47\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
126 @}\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
127 @end group\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
128 @end example\n\
5688
6274256266d9 [project @ 2006-03-16 20:36:28 by jwe]
jwe
parents: 5675
diff changeset
129 @seealso{strftime, strptime, localtime, mktime, time, now, date, clock, datenum, datestr, datevec, calendar, weekday}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
130 @end deftypefn")
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
131 {
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
132 octave_value retval;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
133
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
134 if (args.length () == 1)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
135 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
136 double tmp = args(0).double_value ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
137
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
138 if (! error_state)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
139 retval = octave_value (mk_tm_map (octave_gmtime (tmp)));
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
140 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
141 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5688
diff changeset
142 print_usage ();
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
143
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
144 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
145 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
146
7562
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
147 /*
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
148
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
149 %!test
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
150 %! ts = gmtime (time ());
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
151 %! assert((isstruct (ts)
10231
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
152 %! && isfield (ts, "usec")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
153 %! && isfield (ts, "year")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
154 %! && isfield (ts, "mon")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
155 %! && isfield (ts, "mday")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
156 %! && isfield (ts, "sec")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
157 %! && isfield (ts, "min")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
158 %! && isfield (ts, "wday")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
159 %! && isfield (ts, "hour")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
160 %! && isfield (ts, "isdst")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
161 %! && isfield (ts, "yday")));
7562
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
162
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
163 %!error <Invalid call to gmtime.*> gmtime ();
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
164
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
165 %!error <Invalid call to gmtime.*> gmtime (1, 2);
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
166
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
167 */
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
168
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
169 DEFUN_DLD (localtime, args, ,
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
170 "-*- texinfo -*-\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
171 @deftypefn {Loadable Function} {} localtime (@var{t})\n\
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
172 Given a value returned from time (or any non-negative integer),\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
173 return a time structure corresponding to the local time zone.\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
174 \n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
175 @example\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
176 @group\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
177 localtime (time ())\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
178 @result{} @{\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
179 usec = 0\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
180 year = 97\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
181 mon = 1\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
182 mday = 17\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
183 sec = 6\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
184 zone = CST\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
185 min = 15\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
186 wday = 1\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
187 hour = 1\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
188 isdst = 0\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
189 yday = 47\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
190 @}\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
191 @end group\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
192 @end example\n\
5688
6274256266d9 [project @ 2006-03-16 20:36:28 by jwe]
jwe
parents: 5675
diff changeset
193 @seealso{strftime, strptime, gmtime, mktime, time, now, date, clock, datenum, datestr, datevec, calendar, weekday}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
194 @end deftypefn")
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
195 {
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
196 octave_value retval;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
197
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
198 if (args.length () == 1)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
199 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
200 double tmp = args(0).double_value ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
201
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
202 if (! error_state)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
203 retval = octave_value (mk_tm_map (octave_localtime (tmp)));
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
204 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
205 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5688
diff changeset
206 print_usage ();
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
207
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
208 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
209 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
210
7562
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
211 /*
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
212
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
213 %!test
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
214 %! ts = localtime (time ());
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
215 %! assert((isstruct (ts)
10231
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
216 %! && isfield (ts, "usec")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
217 %! && isfield (ts, "year")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
218 %! && isfield (ts, "mon")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
219 %! && isfield (ts, "mday")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
220 %! && isfield (ts, "sec")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
221 %! && isfield (ts, "min")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
222 %! && isfield (ts, "wday")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
223 %! && isfield (ts, "hour")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
224 %! && isfield (ts, "isdst")
f63ee6a20f57 Replace removed functions in tests
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10155
diff changeset
225 %! && isfield (ts, "yday")));
7562
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
226
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
227 %!error <Invalid call to localtime.*> localtime ();
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
228
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
229 %!error <Invalid call to localtime.*> localtime (1, 2);
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
230
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
231 */
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
232
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
233 DEFUN_DLD (mktime, args, ,
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
234 "-*- texinfo -*-\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
235 @deftypefn {Loadable Function} {} mktime (@var{tm_struct})\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
236 Convert a time structure corresponding to the local time to the number\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10231
diff changeset
237 of seconds since the epoch. For example:\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
238 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
239 @example\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
240 @group\n\
7097
e8c94e473c68 [project @ 2007-11-02 17:24:23 by jwe]
jwe
parents: 7065
diff changeset
241 mktime (localtime (time ()))\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
242 @result{} 856163706\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
243 @end group\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
244 @end example\n\
5688
6274256266d9 [project @ 2006-03-16 20:36:28 by jwe]
jwe
parents: 5675
diff changeset
245 @seealso{strftime, strptime, localtime, gmtime, time, now, date, clock, datenum, datestr, datevec, calendar, weekday}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3295
diff changeset
246 @end deftypefn")
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
247 {
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
248 octave_value retval;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
249
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
250 if (args.length () == 1)
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
251 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
252 Octave_map map = args(0).map_value ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
253
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
254 if (! error_state)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
255 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
256 octave_base_tm tm = extract_tm (map);
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
257
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
258 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
259 retval = octave_time (tm);
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
260 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
261 error ("mktime: invalid TMSTRUCT argument");
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
262 }
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
263 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
264 error ("mktime: expecting structure argument");
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
265 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
266 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5688
diff changeset
267 print_usage ();
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
268
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
269 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
270 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
271
7562
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
272 /*
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
273
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
274 %!test
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
275 %! t = time ();
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
276 %! assert(fix (mktime (localtime (t))) == fix (t));
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
277
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
278 %!error <Invalid call to mktime.*> mktime ();
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
279
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
280 %!error <Invalid call to mktime.*> mktime (1, 2, 3);
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
281
11005
0de4eff677d6 use mktime module from gnulib
John W. Eaton <jwe@octave.org>
parents: 10840
diff changeset
282 %% These tests fail on systems with mktime functions of limited
0de4eff677d6 use mktime module from gnulib
John W. Eaton <jwe@octave.org>
parents: 10840
diff changeset
283 %% intelligence:
0de4eff677d6 use mktime module from gnulib
John W. Eaton <jwe@octave.org>
parents: 10840
diff changeset
284 %!assert (datestr (datenum (1969, 1, 1), 0), "01-Jan-1969 00:00:00")
0de4eff677d6 use mktime module from gnulib
John W. Eaton <jwe@octave.org>
parents: 10840
diff changeset
285 %!assert (datestr (datenum (1901, 1, 1), 0), "01-Jan-1901 00:00:00")
0de4eff677d6 use mktime module from gnulib
John W. Eaton <jwe@octave.org>
parents: 10840
diff changeset
286 %!assert (datestr (datenum (1795, 1, 1), 0), "01-Jan-1795 00:00:00")
0de4eff677d6 use mktime module from gnulib
John W. Eaton <jwe@octave.org>
parents: 10840
diff changeset
287
7562
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
288 */
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
289
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
290 DEFUN_DLD (strftime, args, ,
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
291 "-*- texinfo -*-\n\
5675
c5f6623514c4 [project @ 2006-03-16 03:59:09 by jwe]
jwe
parents: 5646
diff changeset
292 @deftypefn {Loadable Function} {} strftime (@var{fmt}, @var{tm_struct})\n\
c5f6623514c4 [project @ 2006-03-16 03:59:09 by jwe]
jwe
parents: 5646
diff changeset
293 Format the time structure @var{tm_struct} in a flexible way using the\n\
c5f6623514c4 [project @ 2006-03-16 03:59:09 by jwe]
jwe
parents: 5646
diff changeset
294 format string @var{fmt} that contains @samp{%} substitutions\n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
295 similar to those in @code{printf}. Except where noted, substituted\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
296 fields have a fixed size; numeric fields are padded if necessary.\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
297 Padding is with zeros by default; for fields that display a single\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
298 number, padding can be changed or inhibited by following the @samp{%}\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
299 with one of the modifiers described below. Unknown field specifiers are\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
300 copied as normal characters. All other characters are copied to the\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10231
diff changeset
301 output without change. For example:\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
302 \n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
303 @example\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
304 @group\n\
5020
a6d935b36b7f [project @ 2004-09-22 12:38:10 by jwe]
jwe
parents: 5016
diff changeset
305 strftime (\"%r (%Z) %A %e %B %Y\", localtime (time ()))\n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
306 @result{} \"01:15:06 AM (CST) Monday 17 February 1997\"\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
307 @end group\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
308 @end example\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
309 \n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
310 Octave's @code{strftime} function supports a superset of the ANSI C\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
311 field specifiers.\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
312 \n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
313 @noindent\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
314 Literal character fields:\n\
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
315 \n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
316 @table @code\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
317 @item %\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
318 % character.\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
319 \n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
320 @item n\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
321 Newline character.\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
322 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
323 @item t\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
324 Tab character.\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
325 @end table\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
326 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
327 @noindent\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
328 Numeric modifiers (a nonstandard extension):\n\
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
329 \n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
330 @table @code\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
331 @item - (dash)\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
332 Do not pad the field.\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
333 \n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
334 @item _ (underscore)\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
335 Pad the field with spaces.\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
336 @end table\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
337 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
338 @noindent\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
339 Time fields:\n\
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
340 \n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
341 @table @code\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
342 @item %H\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
343 Hour (00-23).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
344 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
345 @item %I\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
346 Hour (01-12).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
347 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
348 @item %k\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
349 Hour (0-23).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
350 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
351 @item %l\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
352 Hour (1-12).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
353 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
354 @item %M\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
355 Minute (00-59).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
356 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
357 @item %p\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
358 Locale's AM or PM.\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
359 \n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
360 @item %r\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
361 Time, 12-hour (hh:mm:ss [AP]M).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
362 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
363 @item %R\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
364 Time, 24-hour (hh:mm).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
365 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
366 @item %s\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
367 Time in seconds since 00:00:00, Jan 1, 1970 (a nonstandard extension).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
368 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
369 @item %S\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
370 Second (00-61).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
371 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
372 @item %T\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
373 Time, 24-hour (hh:mm:ss).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
374 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
375 @item %X\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
376 Locale's time representation (%H:%M:%S).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
377 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
378 @item %Z\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
379 Time zone (EDT), or nothing if no time zone is determinable.\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
380 @end table\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
381 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
382 @noindent\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
383 Date fields:\n\
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
384 \n\
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
385 @table @code\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
386 @item %a\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
387 Locale's abbreviated weekday name (Sun-Sat).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
388 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
389 @item %A\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
390 Locale's full weekday name, variable length (Sunday-Saturday).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
391 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
392 @item %b\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
393 Locale's abbreviated month name (Jan-Dec).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
394 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
395 @item %B\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
396 Locale's full month name, variable length (January-December).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
397 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
398 @item %c\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
399 Locale's date and time (Sat Nov 04 12:02:33 EST 1989).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
400 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
401 @item %C\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
402 Century (00-99).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
403 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
404 @item %d\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
405 Day of month (01-31).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
406 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
407 @item %e\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
408 Day of month ( 1-31).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
409 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
410 @item %D\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
411 Date (mm/dd/yy).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
412 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
413 @item %h\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
414 Same as %b.\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
415 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
416 @item %j\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
417 Day of year (001-366).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
418 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
419 @item %m\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
420 Month (01-12).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
421 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
422 @item %U\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
423 Week number of year with Sunday as first day of week (00-53).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
424 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
425 @item %w\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
426 Day of week (0-6).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
427 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
428 @item %W\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
429 Week number of year with Monday as first day of week (00-53).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
430 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
431 @item %x\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
432 Locale's date representation (mm/dd/yy).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
433 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
434 @item %y\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
435 Last two digits of year (00-99).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
436 \n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
437 @item %Y\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
438 Year (1970-).\n\
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3255
diff changeset
439 @end table\n\
5688
6274256266d9 [project @ 2006-03-16 20:36:28 by jwe]
jwe
parents: 5675
diff changeset
440 @seealso{strptime, localtime, gmtime, mktime, time, now, date, clock, datenum, datestr, datevec, calendar, weekday}\n\
5646
2b20d1707f29 [project @ 2006-03-06 22:38:32 by jwe]
jwe
parents: 5307
diff changeset
441 @end deftypefn")
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
442 {
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
443 octave_value retval;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
444
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
445 if (args.length () == 2)
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
446 {
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3465
diff changeset
447 std::string fmt = args(0).string_value ();
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
448
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
449 if (! error_state)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
450 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
451 Octave_map map = args(1).map_value ();
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
452
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
453 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
454 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
455 octave_base_tm tm = extract_tm (map);
3233
98d0ee053ba4 [project @ 1999-01-27 20:23:40 by jwe]
jwe
parents: 3014
diff changeset
456
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
457 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
458 retval = tm.strftime (fmt);
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
459 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
460 error ("strftime: invalid TMSTRUCT argument");
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
461 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
462 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
463 error ("strftime: expecting structure as second argument");
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
464 }
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents: 3233
diff changeset
465 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
466 error ("strftime: expecting format string as first argument");
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
467 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
468 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5688
diff changeset
469 print_usage ();
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
470
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
471 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
472 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
473
7562
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
474 /*
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
475
7768
a2d9f325b65a Use isschar instead of deprecated isstr
Rafael Laboissiere <rafael@debian.org>
parents: 7562
diff changeset
476 %!assert((ischar (strftime ("%%%n%t%H%I%k%l", localtime (time ())))
a2d9f325b65a Use isschar instead of deprecated isstr
Rafael Laboissiere <rafael@debian.org>
parents: 7562
diff changeset
477 %! && ischar (strftime ("%M%p%r%R%s%S%T", localtime (time ())))
a2d9f325b65a Use isschar instead of deprecated isstr
Rafael Laboissiere <rafael@debian.org>
parents: 7562
diff changeset
478 %! && ischar (strftime ("%X%Z%z%a%A%b%B", localtime (time ())))
a2d9f325b65a Use isschar instead of deprecated isstr
Rafael Laboissiere <rafael@debian.org>
parents: 7562
diff changeset
479 %! && ischar (strftime ("%c%C%d%e%D%h%j", localtime (time ())))
a2d9f325b65a Use isschar instead of deprecated isstr
Rafael Laboissiere <rafael@debian.org>
parents: 7562
diff changeset
480 %! && ischar (strftime ("%m%U%w%W%x%y%Y", localtime (time ())))));
7562
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
481
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
482 %!error <Invalid call to strftime.*> strftime ();
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
483
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
484 %!error <Invalid call to strftime.*> strftime ("foo", localtime (time ()), 1);
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
485
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
486 */
c827f5673321 move tests to individual source files
John W. Eaton <jwe@octave.org>
parents: 7097
diff changeset
487
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
488 DEFUN_DLD (strptime, args, ,
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
489 "-*- texinfo -*-\n\
4367
aa04c532d69b [project @ 2003-03-14 01:17:18 by jwe]
jwe
parents: 4233
diff changeset
490 @deftypefn {Loadable Function} {[@var{tm_struct}, @var{nchars}] =} strptime (@var{str}, @var{fmt})\n\
5675
c5f6623514c4 [project @ 2006-03-16 03:59:09 by jwe]
jwe
parents: 5646
diff changeset
491 Convert the string @var{str} to the time structure @var{tm_struct} under\n\
c5f6623514c4 [project @ 2006-03-16 03:59:09 by jwe]
jwe
parents: 5646
diff changeset
492 the control of the format string @var{fmt}.\n\
c5f6623514c4 [project @ 2006-03-16 03:59:09 by jwe]
jwe
parents: 5646
diff changeset
493 \n\
c5f6623514c4 [project @ 2006-03-16 03:59:09 by jwe]
jwe
parents: 5646
diff changeset
494 If @var{fmt} fails to match, @var{nchars} is 0; otherwise it is set to the\n\
c5f6623514c4 [project @ 2006-03-16 03:59:09 by jwe]
jwe
parents: 5646
diff changeset
495 position of last matched character plus 1. Always check for this unless\n\
c5f6623514c4 [project @ 2006-03-16 03:59:09 by jwe]
jwe
parents: 5646
diff changeset
496 you're absolutely sure the date string will be parsed correctly.\n\
5688
6274256266d9 [project @ 2006-03-16 20:36:28 by jwe]
jwe
parents: 5675
diff changeset
497 @seealso{strftime, localtime, gmtime, mktime, time, now, date, clock, datenum, datestr, datevec, calendar, weekday}\n\
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
498 @end deftypefn")
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
499 {
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
500 octave_value_list retval;
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
501
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
502 if (args.length () == 2)
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
503 {
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3465
diff changeset
504 std::string str = args(0).string_value ();
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
505
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
506 if (! error_state)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
507 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
508 std::string fmt = args(1).string_value ();
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
509
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
510 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
511 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
512 octave_strptime t (str, fmt);
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
513
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
514 retval(1) = t.characters_converted ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
515 retval(0) = octave_value (mk_tm_map (t));
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
516 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
517 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
518 error ("strptime: expecting format string as second argument");
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
519 }
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
520 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9209
diff changeset
521 error ("strptime: expecting string as first argument");
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
522 }
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
523 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5688
diff changeset
524 print_usage ();
3465
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
525
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
526 return retval;
996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe]
jwe
parents: 3325
diff changeset
527 }