1 /* Copyright (C) 1995,1996,1997,1998, 1999 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
43 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
51 #include "scm_validate.h"
59 # ifdef HAVE_SYS_TYPES_H
60 # include <sys/types.h>
63 # ifdef TIME_WITH_SYS_TIME
64 # include <sys/time.h>
67 # ifdef HAVE_SYS_TIME_H
68 # include <sys/time.h>
76 #ifdef HAVE_SYS_TIMES_H
77 # include <sys/times.h>
80 #ifdef HAVE_SYS_TIMEB_H
81 # include <sys/timeb.h>
84 #ifndef tzname /* For SGI. */
85 extern char *tzname
[]; /* RS6000 and others reject char **tzname. */
88 #ifdef MISSING_STRPTIME_DECL
89 extern char *strptime ();
92 /* This should be figured out by autoconf. */
93 #if ! defined(CLKTCK) && defined(CLK_TCK)
94 # define CLKTCK CLK_TCK
96 #if ! defined(CLKTCK) && defined(CLOCKS_PER_SEC)
97 # define CLKTCK CLOCKS_PER_SEC
105 # define timet time_t
114 struct tms time_buffer
;
116 return time_buffer
.tms_utime
+ time_buffer
.tms_stime
;
120 # define mytime() ((time((timet*)0) - scm_your_base) * CLKTCK)
122 # define mytime clock
130 struct timeb scm_your_base
= {0};
132 GUILE_PROC(scm_get_internal_real_time
, "get-internal-real-time", 0, 0, 0,
134 "Returns the number of time units since the interpreter was started.")
135 #define FUNC_NAME s_scm_get_internal_real_time
137 struct timeb time_buffer
;
140 ftime (&time_buffer
);
141 time_buffer
.time
-= scm_your_base
.time
;
142 tmp
= scm_long2num (time_buffer
.millitm
- scm_your_base
.millitm
);
144 scm_product (SCM_MAKINUM (1000),
145 SCM_MAKINUM (time_buffer
.time
)));
146 return scm_quotient (scm_product (tmp
, SCM_MAKINUM (CLKTCK
)),
154 timet scm_your_base
= 0;
156 GUILE_PROC(scm_get_internal_real_time
, "get-internal-real-time", 0, 0, 0,
159 #define FUNC_NAME s_scm_get_internal_real_time
161 return scm_long2num((time((timet
*)0) - scm_your_base
) * (int)CLKTCK
);
167 GUILE_PROC (scm_times
, "times", 0, 0, 0,
169 "Returns an object with information about real and processor time.
170 The following procedures accept such an object as an argument and
171 return a selected component:
175 The current real time, expressed as time units relative to an
178 The CPU time units used by the calling process.
180 The CPU time units used by the system on behalf of the calling process.
182 The CPU time units used by terminated child processes of the calling
183 process, whose status has been collected (e.g., using @code{waitpid}).
185 Similarly, the CPU times units used by the system on behalf of
186 terminated child processes.
188 #define FUNC_NAME s_scm_times
194 SCM result
= scm_make_vector (SCM_MAKINUM(5), SCM_UNDEFINED
);
198 SCM_VELTS (result
)[0] = scm_long2num (rv
);
199 SCM_VELTS (result
)[1] = scm_long2num (t
.tms_utime
);
200 SCM_VELTS (result
)[2] = scm_long2num (t
.tms_stime
);
201 SCM_VELTS (result
)[3] = scm_long2num (t
.tms_cutime
);
202 SCM_VELTS (result
)[4] = scm_long2num (t
.tms_cstime
);
211 /* GNU-WIN32's cygwin.dll doesn't have this. */
216 static long scm_my_base
= 0;
218 GUILE_PROC(scm_get_internal_run_time
, "get-internal-run-time", 0, 0, 0,
220 "Returns the number of time units of processor time used by the interpreter.
221 Both "system
" and "user
" time
222 are included but subprocesses are not.")
223 #define FUNC_NAME s_scm_get_internal_run_time
225 return scm_long2num(mytime()-scm_my_base
);
229 GUILE_PROC(scm_current_time
, "current-time", 0, 0, 0,
231 "Returns the number of seconds since 1970-01-01 00:00:00 UTC, excluding
233 #define FUNC_NAME s_scm_current_time
238 if ((timv
= time (0)) == -1)
241 return scm_long2num((long) timv
);
245 GUILE_PROC (scm_gettimeofday
, "gettimeofday", 0, 0, 0,
247 "Returns a pair containing the number of seconds and microseconds since
248 1970-01-01 00:00:00 UTC, excluding leap seconds. Note: whether true
249 microsecond resolution is available depends on the operating system.")
250 #define FUNC_NAME s_scm_gettimeofday
252 #ifdef HAVE_GETTIMEOFDAY
256 if (gettimeofday (&time
, NULL
) == -1)
259 return scm_cons (scm_long2num ((long) time
.tv_sec
),
260 scm_long2num ((long) time
.tv_usec
));
266 return scm_cons (scm_long2num ((long) time
.time
),
267 SCM_MAKINUM (time
.millitm
* 1000));
272 if ((timv
= time (0)) == -1)
275 return scm_cons (scm_long2num (timv
), SCM_MAKINUM (0));
282 filltime (struct tm
*bd_time
, int zoff
, char *zname
)
284 SCM result
= scm_make_vector (SCM_MAKINUM(11), SCM_UNDEFINED
);
286 SCM_VELTS (result
)[0] = SCM_MAKINUM (bd_time
->tm_sec
);
287 SCM_VELTS (result
)[1] = SCM_MAKINUM (bd_time
->tm_min
);
288 SCM_VELTS (result
)[2] = SCM_MAKINUM (bd_time
->tm_hour
);
289 SCM_VELTS (result
)[3] = SCM_MAKINUM (bd_time
->tm_mday
);
290 SCM_VELTS (result
)[4] = SCM_MAKINUM (bd_time
->tm_mon
);
291 SCM_VELTS (result
)[5] = SCM_MAKINUM (bd_time
->tm_year
);
292 SCM_VELTS (result
)[6] = SCM_MAKINUM (bd_time
->tm_wday
);
293 SCM_VELTS (result
)[7] = SCM_MAKINUM (bd_time
->tm_yday
);
294 SCM_VELTS (result
)[8] = SCM_MAKINUM (bd_time
->tm_isdst
);
295 SCM_VELTS (result
)[9] = SCM_MAKINUM (zoff
);
296 SCM_VELTS (result
)[10] = zname
? scm_makfrom0str (zname
) : SCM_BOOL_F
;
300 static char tzvar
[3] = "TZ";
301 extern char ** environ
;
304 setzone (SCM zone
, int pos
, const char *subr
)
308 if (!SCM_UNBNDP (zone
))
310 static char *tmpenv
[2];
313 /* if zone was supplied, set the environment temporarily. */
314 SCM_ASSERT (SCM_NIMP (zone
) && SCM_ROSTRINGP (zone
), zone
, pos
, subr
);
315 SCM_COERCE_SUBSTR (zone
);
316 buf
= scm_must_malloc (SCM_LENGTH (zone
) + sizeof (tzvar
) + 1,
318 sprintf (buf
, "%s=%s", tzvar
, SCM_ROCHARS (zone
));
329 restorezone (SCM zone
, char **oldenv
, const char *subr
)
331 if (!SCM_UNBNDP (zone
))
333 scm_must_free (environ
[0]);
340 GUILE_PROC (scm_localtime
, "localtime", 1, 1, 0,
341 (SCM time
, SCM zone
),
342 "Returns an object representing the broken down components of @var{time},
343 an integer like the one returned by @code{current-time}. The time zone
344 for the calculation is optionally specified by @var{zone} (a string),
345 otherwise the @code{TZ} environment variable or the system default is
347 #define FUNC_NAME s_scm_localtime
350 struct tm
*ltptr
, lt
, *utc
;
357 itime
= SCM_NUM2LONG (1,time
);
359 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
360 ltptr
= localtime (&itime
);
366 /* copy zone name before calling gmtime or tzset. */
368 ptr
= ltptr
->tm_zone
;
371 ptr
= tzname
[ (ltptr
->tm_isdst
== 1) ? 1 : 0 ];
373 SCM_MISC_ERROR ("Not fully implemented on this platform",_EOL
);
376 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
379 /* the struct is copied in case localtime and gmtime share a buffer. */
382 utc
= gmtime (&itime
);
385 restorezone (zone
, oldenv
, FUNC_NAME
);
386 /* delayed until zone has been restored. */
388 if (utc
== NULL
|| ltptr
== NULL
)
391 /* calculate timezone offset in seconds west of UTC. */
392 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
393 + utc
->tm_sec
- lt
.tm_sec
;
394 if (utc
->tm_year
< lt
.tm_year
)
395 zoff
-= 24 * 60 * 60;
396 else if (utc
->tm_year
> lt
.tm_year
)
397 zoff
+= 24 * 60 * 60;
398 else if (utc
->tm_yday
< lt
.tm_yday
)
399 zoff
-= 24 * 60 * 60;
400 else if (utc
->tm_yday
> lt
.tm_yday
)
401 zoff
+= 24 * 60 * 60;
403 result
= filltime (<
, zoff
, zname
);
405 scm_must_free (zname
);
410 GUILE_PROC (scm_gmtime
, "gmtime", 1, 0, 0,
412 "Returns an object representing the broken down components of @var{time},
413 an integer like the one returned by @code{current-time}. The values
414 are calculated for UTC.")
415 #define FUNC_NAME s_scm_gmtime
421 itime
= SCM_NUM2LONG (1,time
);
423 bd_time
= gmtime (&itime
);
426 result
= filltime (bd_time
, 0, "GMT");
432 /* copy time components from a Scheme object to a struct tm. */
434 bdtime2c (SCM sbd_time
, struct tm
*lt
, int pos
, const char *subr
)
439 SCM_ASSERT (SCM_NIMP (sbd_time
) && SCM_VECTORP (sbd_time
)
440 && SCM_LENGTH (sbd_time
) == 11,
441 sbd_time
, pos
, subr
);
442 velts
= SCM_VELTS (sbd_time
);
443 for (i
= 0; i
< 10; i
++)
445 SCM_ASSERT (SCM_INUMP (velts
[i
]), sbd_time
, pos
, subr
);
447 SCM_ASSERT (SCM_FALSEP (velts
[10])
448 || (SCM_NIMP (velts
[10]) && SCM_STRINGP (velts
[10])),
449 sbd_time
, pos
, subr
);
451 lt
->tm_sec
= SCM_INUM (velts
[0]);
452 lt
->tm_min
= SCM_INUM (velts
[1]);
453 lt
->tm_hour
= SCM_INUM (velts
[2]);
454 lt
->tm_mday
= SCM_INUM (velts
[3]);
455 lt
->tm_mon
= SCM_INUM (velts
[4]);
456 lt
->tm_year
= SCM_INUM (velts
[5]);
457 lt
->tm_wday
= SCM_INUM (velts
[6]);
458 lt
->tm_yday
= SCM_INUM (velts
[7]);
459 lt
->tm_isdst
= SCM_INUM (velts
[8]);
461 lt
->tm_gmtoff
= SCM_INUM (velts
[9]);
462 if (SCM_FALSEP (velts
[10]))
465 lt
->tm_zone
= SCM_CHARS (velts
[10]);
469 GUILE_PROC (scm_mktime
, "mktime", 1, 1, 0,
470 (SCM sbd_time
, SCM zone
),
471 "@var{bd-time} is an object representing broken down time and @code{zone}
472 is an optional time zone specifier (otherwise the TZ environment variable
473 or the system default is used).
475 Returns a pair: the CAR is a corresponding
476 integer time value like that returned
477 by @code{current-time}; the CDR is a broken down time object, similar to
478 as @var{bd-time} but with normalized values.")
479 #define FUNC_NAME s_scm_mktime
489 bdtime2c (sbd_time
, <
, SCM_ARG1
, FUNC_NAME
);
492 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
493 itime
= mktime (<
);
500 /* copy zone name before calling gmtime or tzset. */
505 ptr
= tzname
[ (lt
.tm_isdst
== 1) ? 1 : 0 ];
507 scm_misc_error (s_mktime
, "Not fully implemented on this platform",
511 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
515 /* get timezone offset in seconds west of UTC. */
516 utc
= gmtime (&itime
);
520 restorezone (zone
, oldenv
, FUNC_NAME
);
521 /* delayed until zone has been restored. */
523 if (utc
== NULL
|| itime
== -1)
526 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
527 + utc
->tm_sec
- lt
.tm_sec
;
528 if (utc
->tm_year
< lt
.tm_year
)
529 zoff
-= 24 * 60 * 60;
530 else if (utc
->tm_year
> lt
.tm_year
)
531 zoff
+= 24 * 60 * 60;
532 else if (utc
->tm_yday
< lt
.tm_yday
)
533 zoff
-= 24 * 60 * 60;
534 else if (utc
->tm_yday
> lt
.tm_yday
)
535 zoff
+= 24 * 60 * 60;
537 result
= scm_cons (scm_long2num ((long) itime
),
538 filltime (<
, zoff
, zname
));
540 scm_must_free (zname
);
545 GUILE_PROC (scm_tzset
, "tzset", 0, 0, 0,
547 "Initialize the timezone from the TZ environment variable or the system
548 default. Usually this is done automatically by other procedures which
549 use the time zone, but this procedure may need to be used if TZ
551 #define FUNC_NAME s_scm_tzset
554 return SCM_UNSPECIFIED
;
558 GUILE_PROC (scm_strftime
, "strftime", 2, 0, 0,
559 (SCM format
, SCM stime
),
560 "Formats a time specification @var{time} using @var{template}. @var{time}
561 is an object with time components in the form returned by @code{localtime}
562 or @code{gmtime}. @var{template} is a string which can include formatting
563 specifications introduced by a @code{%} character. The formatting of
564 month and day names is dependent on the current locale. The value returned
565 is the formatted string.
566 @xref{Formatting Date and Time, , , libc, The GNU C Library Reference Manual}.)")
567 #define FUNC_NAME s_scm_strftime
577 SCM_VALIDATE_ROSTRING(1,format
);
578 bdtime2c (stime
, &t
, SCM_ARG2
, FUNC_NAME
);
580 SCM_COERCE_SUBSTR (format
);
581 fmt
= SCM_ROCHARS (format
);
582 len
= SCM_ROLENGTH (format
);
584 tbuf
= SCM_MUST_MALLOC (size
);
585 while ((len
= strftime (tbuf
, size
, fmt
, &t
)) == size
)
587 scm_must_free (tbuf
);
589 tbuf
= SCM_MUST_MALLOC (size
);
591 result
= scm_makfromstr (tbuf
, len
, 0);
592 scm_must_free (tbuf
);
597 GUILE_PROC (scm_strptime
, "strptime", 2, 0, 0,
598 (SCM format
, SCM string
),
599 "Performs the reverse action to @code{strftime}, parsing @var{string}
600 according to the specification supplied in @var{template}. The
601 interpretation of month and day names is dependent on the current
603 value returned is a pair. The CAR has an object with time components
604 in the form returned by @code{localtime} or @code{gmtime},
605 but the time zone components
606 are not usefully set.
607 The CDR reports the number of characters from @var{string} which
608 were used for the conversion.")
609 #define FUNC_NAME s_scm_strptime
613 char *fmt
, *str
, *rest
;
615 SCM_VALIDATE_ROSTRING(1,format
);
616 SCM_VALIDATE_ROSTRING(2,string
);
618 SCM_COERCE_SUBSTR (format
);
619 SCM_COERCE_SUBSTR (string
);
620 fmt
= SCM_ROCHARS (format
);
621 str
= SCM_ROCHARS (string
);
623 /* initialize the struct tm */
624 #define tm_init(field) t.field = 0
637 if ((rest
= strptime (str
, fmt
, &t
)) == NULL
)
641 return scm_cons (filltime (&t
, 0, NULL
), SCM_MAKINUM (rest
- str
));
652 scm_sysintern("internal-time-units-per-second",
653 scm_long2num((long)CLKTCK
));
656 if (!scm_your_base
.time
) ftime(&scm_your_base
);
658 if (!scm_your_base
) time(&scm_your_base
);
661 if (!scm_my_base
) scm_my_base
= mytime();
663 scm_add_feature ("current-time");