octave: libinterp/corefcn/time.cc annotate

annotate libinterp/corefcn/time.cc @ 27923:bd51beb6205e

update formatting of copyright notices * Use <https://octave.org/copyright/> instead of <https://octave.org/COPYRIGHT.html/>. * For consistency with other comments in the Octave sources, use C++-style comments for copyright blocks in C and C++ files. * Use delimiters above and below copyright blocks that are appropriate for the language used in the file. * Eliminate extra spacing inside copyright blocks. * lex.ll (looks_like_copyright): Also allow newlines and carriage returns before the word "Copyright". * scripts/mk-doc.pl (gethelp): Also skip empty comment lines. * bp-table.cc, type.m: Adjust tests.

author	John W. Eaton <jwe@octave.org>
date	Wed, 08 Jan 2020 11:59:41 -0500
parents	1891570abac8
children	09c071328135 0a5b15007766

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	3 // Copyright (C) 1996-2020 The Octave Project Developers
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	25
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21317 diff changeset	26 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	27 # include "config.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	28 #endif
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 <string>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	31
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	32 #include "defun.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	33 #include "error.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	34 #include "oct-map.h"
3254 28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe] jwe parents: 3233 diff changeset	35 #include "oct-time.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	36 #include "ov.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20939 diff changeset	37 #include "ovl.h"
2928 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 // Date and time functions.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	40
11042 f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	41 static octave_scalar_map
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	42 mk_tm_map (const octave::sys::base_tm& t)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	43 {
11042 f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	44 octave_scalar_map m;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	45
4675 f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	46 m.assign ("usec", static_cast<double> (t.usec ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	47 m.assign ("sec", static_cast<double> (t.sec ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	48 m.assign ("min", static_cast<double> (t.min ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	49 m.assign ("hour", static_cast<double> (t.hour ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	50 m.assign ("mday", static_cast<double> (t.mday ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	51 m.assign ("mon", static_cast<double> (t.mon ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	52 m.assign ("year", static_cast<double> (t.year ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	53 m.assign ("wday", static_cast<double> (t.wday ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	54 m.assign ("yday", static_cast<double> (t.yday ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	55 m.assign ("isdst", static_cast<double> (t.isdst ()));
20375 31f89b12aaf7 strftime: Add support for "%z" conversion specifier (bug #45592) Mike Miller <mtmiller@octave.org> parents: 20172 diff changeset	56 m.assign ("gmtoff", static_cast<double> (t.gmtoff ()));
4675 f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4367 diff changeset	57 m.assign ("zone", t.zone ());
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	58
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	59 return m;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	60 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	61
11042 f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	62 static inline int
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	63 intfield (const octave_scalar_map& m, const std::string& k, const char *who)
11042 f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	64 {
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	65 int retval = 0;
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	66
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	67 octave_value v = m.getfield (k);
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	68
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23220 diff changeset	69 if (! v.isempty ())
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	70 retval = v.xint_value ("%s: invalid TM_STRUCT argument", who);
11042 f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	71
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	72 return retval;
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	73 }
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	74
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	75 static inline std::string
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	76 stringfield (const octave_scalar_map& m, const std::string& k, const char *who)
11042 f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	77 {
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	78 std::string retval;
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	79
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	80 octave_value v = m.getfield (k);
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	81
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23220 diff changeset	82 if (! v.isempty ())
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	83 retval = v.xstring_value ("%s: invalid TM_STRUCT argument", who);
11042 f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	84
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	85 return retval;
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	86 }
f6b7b6e5b8b8 time.cc: use octave_scalar_map instead of Octave_map John W. Eaton <jwe@octave.org> parents: 11005 diff changeset	87
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	88 static octave::sys::base_tm
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	89 extract_tm (const octave_scalar_map& m, const char *who)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	90 {
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	91 octave::sys::base_tm tm;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	92
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	93 tm.usec (intfield (m, "usec", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	94 tm.sec (intfield (m, "sec", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	95 tm.min (intfield (m, "min", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	96 tm.hour (intfield (m, "hour", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	97 tm.mday (intfield (m, "mday", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	98 tm.mon (intfield (m, "mon", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	99 tm.year (intfield (m, "year", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	100 tm.wday (intfield (m, "wday", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	101 tm.yday (intfield (m, "yday", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	102 tm.isdst (intfield (m, "isdst", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	103 tm.gmtoff (intfield (m, "gmtoff", who));
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	104 tm.zone (stringfield (m, "zone", who));
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	105
3254 28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe] jwe parents: 3233 diff changeset	106 return tm;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	107 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	108
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	109 DEFUN (time, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	110 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	111 @deftypefn {} {@var{seconds} =} time ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	112 Return the current time as the number of seconds since the epoch.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	113
25387 6cf9d00ad848 Use correct abbreviation UTC for Coordinated Universal Time (bug #53918). Rik <rik@octave.org> parents: 25054 diff changeset	114 The epoch is referenced to 00:00:00 UTC (Coordinated Universal Time) 1 Jan
6cf9d00ad848 Use correct abbreviation UTC for Coordinated Universal Time (bug #53918). Rik <rik@octave.org> parents: 25054 diff changeset	115 1970. For example, on Monday February 17, 1997 at 07:15:06 UTC, the value
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	116 returned by @code{time} was 856163706.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	117 @seealso{strftime, strptime, localtime, gmtime, mktime, now, date, clock, datenum, datestr, datevec, calendar, weekday}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	118 @end deftypefn */)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	119 {
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	120 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5688 diff changeset	121 print_usage ();
3255 4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe] jwe parents: 3254 diff changeset	122
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	123 return ovl (octave::sys::time ());
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	124 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	125
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	126 /*
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	127 %!assert (time () > 0)
19142 b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	128
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	129 %!error time (1)
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	130 */
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	131
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	132 DEFUN (gmtime, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	133 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	134 @deftypefn {} {@var{tm_struct} =} gmtime (@var{t})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	135 Given a value returned from @code{time}, or any non-negative integer,
25387 6cf9d00ad848 Use correct abbreviation UTC for Coordinated Universal Time (bug #53918). Rik <rik@octave.org> parents: 25054 diff changeset	136 return a time structure corresponding to UTC (Coordinated Universal Time).
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	137
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	138 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	139
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	140 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	141 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	142 gmtime (time ())
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	143 @result{} @{
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	144 usec = 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	145 sec = 6
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	146 min = 15
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	147 hour = 7
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	148 mday = 17
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	149 mon = 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	150 year = 97
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	151 wday = 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	152 yday = 47
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	153 isdst = 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	154 gmtoff = 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	155 zone = GMT
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	156 @}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	157 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	158 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	159 @seealso{strftime, strptime, localtime, mktime, time, now, date, clock, datenum, datestr, datevec, calendar, weekday}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	160 @end deftypefn */)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	161 {
27058 f6e59ee37fee Emit an error if localtime or gmtime is called with a non-scalar argument (bug #56190). Rik <rik@octave.org> parents: 26376 diff changeset	162 if (args.length () != 1 \|\| args(0).numel () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5688 diff changeset	163 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	164
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	165 double tmp = args(0).double_value ();
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	166
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	167 return ovl (mk_tm_map (octave::sys::gmtime (tmp)));
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	168 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	169
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	170 /*
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	171 %!test
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	172 %! ts = gmtime (time ());
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	173 %! assert (isstruct (ts));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	174 %! assert (isfield (ts, "usec"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	175 %! assert (isfield (ts, "year"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	176 %! assert (isfield (ts, "mon"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	177 %! assert (isfield (ts, "mday"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	178 %! assert (isfield (ts, "sec"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	179 %! assert (isfield (ts, "min"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	180 %! assert (isfield (ts, "wday"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	181 %! assert (isfield (ts, "hour"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	182 %! assert (isfield (ts, "isdst"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	183 %! assert (isfield (ts, "yday"));
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	184
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	185 %!error gmtime ()
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	186 %!error gmtime (1, 2)
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	187 */
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	188
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	189 DEFUN (localtime, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	190 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	191 @deftypefn {} {@var{tm_struct} =} localtime (@var{t})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	192 Given a value returned from @code{time}, or any non-negative integer,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	193 return a time structure corresponding to the local time zone.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	194
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	195 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	196 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	197 localtime (time ())
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	198 @result{} @{
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	199 usec = 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	200 sec = 6
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	201 min = 15
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	202 hour = 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	203 mday = 17
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	204 mon = 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	205 year = 97
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	206 wday = 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	207 yday = 47
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	208 isdst = 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	209 gmtoff = -21600
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	210 zone = CST
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	211 @}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	212 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	213 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	214 @seealso{strftime, strptime, gmtime, mktime, time, now, date, clock, datenum, datestr, datevec, calendar, weekday}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	215 @end deftypefn */)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	216 {
27058 f6e59ee37fee Emit an error if localtime or gmtime is called with a non-scalar argument (bug #56190). Rik <rik@octave.org> parents: 26376 diff changeset	217 if (args.length () != 1 \|\| args(0).numel () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5688 diff changeset	218 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	219
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	220 double tmp = args(0).double_value ();
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	221
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	222 return ovl (mk_tm_map (octave::sys::localtime (tmp)));
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	223 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	224
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	225 /*
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	226 %!test
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	227 %! ts = localtime (time ());
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	228 %! assert (isstruct (ts));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	229 %! assert (isfield (ts, "usec"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	230 %! assert (isfield (ts, "year"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	231 %! assert (isfield (ts, "mon"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	232 %! assert (isfield (ts, "mday"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	233 %! assert (isfield (ts, "sec"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	234 %! assert (isfield (ts, "min"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	235 %! assert (isfield (ts, "wday"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	236 %! assert (isfield (ts, "hour"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	237 %! assert (isfield (ts, "isdst"));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	238 %! assert (isfield (ts, "yday"));
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	239
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	240 %!error localtime ()
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	241 %!error localtime (1, 2)
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	242 */
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	243
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	244 DEFUN (mktime, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	245 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	246 @deftypefn {} {@var{seconds} =} mktime (@var{tm_struct})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	247 Convert a time structure corresponding to the local time to the number of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	248 seconds since the epoch.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	249
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	250 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	251
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	252 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	253 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	254 mktime (localtime (time ()))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	255 @result{} 856163706
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	256 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	257 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	258 @seealso{strftime, strptime, localtime, gmtime, time, now, date, clock, datenum, datestr, datevec, calendar, weekday}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	259 @end deftypefn */)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	260 {
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	261 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5688 diff changeset	262 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	263
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	264 octave_scalar_map map = args(0).xscalar_map_value ("mktime: TM_STRUCT argument must be a structure");
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	265
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	266 octave::sys::base_tm tm = extract_tm (map, "mktime");
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	267
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	268 return ovl (octave::sys::time (tm));
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	269 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	270
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	271 /*
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	272 %!test
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	273 %! t = time ();
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	274 %! assert (fix (mktime (localtime (t))) == fix (t));
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	275
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	276 ## These tests fail on systems with mktime functions of limited
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	277 ## intelligence:
11005 0de4eff677d6 use mktime module from gnulib John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	278 %!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	279 %!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	280 %!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	281
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	282 %!error mktime ()
19142 b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	283 %!error mktime (1)
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	284 %!error mktime (1, 2, 3)
19142 b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	285 %!error mktime (struct ("year", "foo"))
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	286 */
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	287
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	288 DEFUN (strftime, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	289 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	290 @deftypefn {} {} strftime (@var{fmt}, @var{tm_struct})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	291 Format the time structure @var{tm_struct} in a flexible way using the format
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	292 string @var{fmt} that contains @samp{%} substitutions similar to those in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	293 @code{printf}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	294
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	295 Except where noted, substituted fields have a fixed size; numeric fields are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	296 padded if necessary. Padding is with zeros by default; for fields that
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	297 display a single number, padding can be changed or inhibited by following
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	298 the @samp{%} with one of the modifiers described below. Unknown field
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	299 specifiers are copied as normal characters. All other characters are copied
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	300 to the output without change. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	301
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	302 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	303 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	304 strftime ("%r (%Z) %A %e %B %Y", localtime (time ()))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	305 @result{} "01:15:06 AM (CST) Monday 17 February 1997"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	306 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	307 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	308
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	309 Octave's @code{strftime} function supports a superset of the ANSI C field
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	310 specifiers.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	311
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	312 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	313 Literal character fields:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	314
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	315 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	316 @item %%
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	317 % character.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	318
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	319 @item %n
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	320 Newline character.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	321
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	322 @item %t
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	323 Tab character.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	324 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	325
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	326 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	327 Numeric modifiers (a nonstandard extension):
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	328
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	329 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	330 @item - (dash)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	331 Do not pad the field.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	332
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	333 @item _ (underscore)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	334 Pad the field with spaces.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	335 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	336
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	337 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	338 Time fields:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	339
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	340 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	341 @item %H
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	342 Hour (00-23).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	343
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	344 @item %I
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	345 Hour (01-12).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	346
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	347 @item %k
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	348 Hour (0-23).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	349
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	350 @item %l
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	351 Hour (1-12).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	352
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	353 @item %M
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	354 Minute (00-59).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	355
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	356 @item %p
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	357 Locale's AM or PM.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	358
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	359 @item %r
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	360 Time, 12-hour (hh:mm:ss [AP]M).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	361
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	362 @item %R
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	363 Time, 24-hour (hh:mm).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	364
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	365 @item %s
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	366 Time in seconds since 00:00:00, Jan 1, 1970 (a nonstandard extension).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	367
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	368 @item %S
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	369 Second (00-61).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	370
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	371 @item %T
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	372 Time, 24-hour (hh:mm:ss).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	373
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	374 @item %X
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	375 Locale's time representation (%H:%M:%S).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	376
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	377 @item %z
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	378 Offset from UTC (±@nospell{hhmm}), or nothing if no time zone is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	379 determinable.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	380
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	381 @item %Z
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	382 Time zone (EDT), or nothing if no time zone is determinable.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	383 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	384
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	385 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	386 Date fields:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	387
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	388 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	389 @item %a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	390 Locale's abbreviated weekday name (Sun-Sat).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	391
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	392 @item %A
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	393 Locale's full weekday name, variable length (Sunday-Saturday).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	394
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	395 @item %b
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	396 Locale's abbreviated month name (Jan-Dec).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	397
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	398 @item %B
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	399 Locale's full month name, variable length (January-December).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	400
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	401 @item %c
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	402 Locale's date and time (Sat Nov 04 12:02:33 EST 1989).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	403
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	404 @item %C
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	405 Century (00-99).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	406
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	407 @item %d
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	408 Day of month (01-31).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	409
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	410 @item %e
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	411 Day of month ( 1-31).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	412
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	413 @item %D
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	414 Date (mm/dd/yy).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	415
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	416 @item %h
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	417 Same as %b.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	418
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	419 @item %j
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	420 Day of year (001-366).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	421
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	422 @item %m
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	423 Month (01-12).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	424
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	425 @item %U
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	426 Week number of year with Sunday as first day of week (00-53).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	427
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	428 @item %w
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	429 Day of week (0-6).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	430
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	431 @item %W
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	432 Week number of year with Monday as first day of week (00-53).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	433
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	434 @item %x
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	435 Locale's date representation (mm/dd/yy).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	436
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	437 @item %y
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	438 Last two digits of year (00-99).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	439
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	440 @item %Y
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	441 Year (1970-).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	442 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	443 @seealso{strptime, localtime, gmtime, mktime, time, now, date, clock, datenum, datestr, datevec, calendar, weekday}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	444 @end deftypefn */)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	445 {
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	446 if (args.length () != 2)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5688 diff changeset	447 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	448
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	449 std::string fmt = args(0).xstring_value ("strftime: FMT must be a string");
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	450
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	451 octave_scalar_map map = args(1).xscalar_map_value ("strftime: TM_STRUCT must be a structure");
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	452
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	453 octave::sys::base_tm tm = extract_tm (map, "strftime");
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	454
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20882 diff changeset	455 return ovl (tm.strftime (fmt));
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	456 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	457
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	458 /*
21317 a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	459 %!assert (ischar (strftime ("%%%n%t%H%I%k%l", localtime (time ()))))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	460 %!assert (ischar (strftime ("%M%p%r%R%s%S%T", localtime (time ()))))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	461 %!assert (ischar (strftime ("%X%Z%z%a%A%b%B", localtime (time ()))))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	462 %!assert (ischar (strftime ("%c%C%d%e%D%h%j", localtime (time ()))))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 21301 diff changeset	463 %!assert (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	464
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	465 %!error strftime ()
19142 b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	466 %!error strftime ("foo", 1)
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	467 %!error strftime ("foo", struct ("year", "foo"))
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	468 %!error strftime ("foo", localtime (time ()), 1)
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	469 */
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7097 diff changeset	470
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	471 DEFUN (strptime, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	472 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	473 @deftypefn {} {[@var{tm_struct}, @var{nchars}] =} strptime (@var{str}, @var{fmt})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	474 Convert the string @var{str} to the time structure @var{tm_struct} under
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	475 the control of the format string @var{fmt}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	476
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	477 If @var{fmt} fails to match, @var{nchars} is 0; otherwise, it is set to the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	478 position of last matched character plus 1. Always check for this unless
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	479 you're absolutely sure the date string will be parsed correctly.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	480 @seealso{strftime, localtime, gmtime, mktime, time, now, date, clock, datenum, datestr, datevec, calendar, weekday}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	481 @end deftypefn */)
3465 996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe] jwe parents: 3325 diff changeset	482 {
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	483 if (args.length () != 2)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	484 print_usage ();
3465 996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe] jwe parents: 3325 diff changeset	485
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	486 std::string str = args(0).xstring_value ("strptime: argument STR must be a string");
19403 03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19142 diff changeset	487
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	488 std::string fmt = args(1).xstring_value ("strptime: FMT must be a string");
3465 996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe] jwe parents: 3325 diff changeset	489
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	490 octave::sys::strptime t (str, fmt);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20719 diff changeset	491
20882 776c0b8c1d07 2015 Code Sprint: time.cc: use ovl (). Rik <rik@octave.org> parents: 20880 diff changeset	492 return ovl (mk_tm_map (t), t.characters_converted ());
3465 996bb7ea4507 [project @ 2000-01-21 07:48:25 by jwe] jwe parents: 3325 diff changeset	493 }
19142 b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	494
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	495 /*
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	496 %!test
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	497 %! fmt = "%Y-%m-%d %H:%M:%S";
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	498 %! s = strftime (fmt, localtime (time ()));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	499 %! ts = strptime (s, fmt);
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	500 %! assert (isstruct (ts));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	501 %! assert (isfield (ts, "usec"));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	502 %! assert (isfield (ts, "year"));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	503 %! assert (isfield (ts, "mon"));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	504 %! assert (isfield (ts, "mday"));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	505 %! assert (isfield (ts, "sec"));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	506 %! assert (isfield (ts, "min"));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	507 %! assert (isfield (ts, "wday"));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	508 %! assert (isfield (ts, "hour"));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	509 %! assert (isfield (ts, "isdst"));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	510 %! assert (isfield (ts, "yday"));
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	511
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	512 %!error strptime ()
b8bd0b55af45 codesprint: Add tests to time handling functions Mike Miller <mtmiller@ieee.org> parents: 17787 diff changeset	513 */

Mercurial > octave

annotate libinterp/corefcn/time.cc @ 27923:bd51beb6205e