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 */
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
129 struct timeb scm_your_base
= {0};
131 timet scm_your_base
= 0;
134 SCM_DEFINE (scm_get_internal_real_time
, "get-internal-real-time", 0, 0, 0,
136 "Returns the number of time units since the interpreter was started.")
137 #define FUNC_NAME s_scm_get_internal_real_time
140 struct timeb time_buffer
;
143 ftime (&time_buffer
);
144 time_buffer
.time
-= scm_your_base
.time
;
145 tmp
= scm_long2num (time_buffer
.millitm
- scm_your_base
.millitm
);
147 scm_product (SCM_MAKINUM (1000),
148 SCM_MAKINUM (time_buffer
.time
)));
149 return scm_quotient (scm_product (tmp
, SCM_MAKINUM (CLKTCK
)),
152 return scm_long2num((time((timet
*)0) - scm_your_base
) * (int)CLKTCK
);
153 #endif /* HAVE_FTIME */
159 SCM_DEFINE (scm_times
, "times", 0, 0, 0,
161 "Returns an object with information about real and processor time.\n"
162 "The following procedures accept such an object as an argument and\n"
163 "return a selected component:\n\n"
166 "The current real time, expressed as time units relative to an\n"
169 "The CPU time units used by the calling process.\n"
171 "The CPU time units used by the system on behalf of the calling process.\n"
173 "The CPU time units used by terminated child processes of the calling\n"
174 "process, whose status has been collected (e.g., using @code{waitpid}).\n"
176 "Similarly, the CPU times units used by the system on behalf of \n"
177 "terminated child processes.\n"
179 #define FUNC_NAME s_scm_times
184 SCM result
= scm_make_vector (SCM_MAKINUM(5), SCM_UNDEFINED
);
188 SCM_VELTS (result
)[0] = scm_long2num (rv
);
189 SCM_VELTS (result
)[1] = scm_long2num (t
.tms_utime
);
190 SCM_VELTS (result
)[2] = scm_long2num (t
.tms_stime
);
191 SCM_VELTS (result
)[3] = scm_long2num (t
.tms_cutime
);
192 SCM_VELTS (result
)[4] = scm_long2num (t
.tms_cstime
);
196 #endif /* HAVE_TIMES */
198 static long scm_my_base
= 0;
200 SCM_DEFINE (scm_get_internal_run_time
, "get-internal-run-time", 0, 0, 0,
202 "Returns the number of time units of processor time used by the interpreter.\n"
203 "Both \"system\" and \"user\" time are included but subprocesses are not.")
204 #define FUNC_NAME s_scm_get_internal_run_time
206 return scm_long2num(mytime()-scm_my_base
);
210 SCM_DEFINE (scm_current_time
, "current-time", 0, 0, 0,
212 "Returns the number of seconds since 1970-01-01 00:00:00 UTC, excludingleap seconds.")
213 #define FUNC_NAME s_scm_current_time
218 if ((timv
= time (0)) == -1)
221 return scm_long2num((long) timv
);
225 SCM_DEFINE (scm_gettimeofday
, "gettimeofday", 0, 0, 0,
227 "Returns a pair containing the number of seconds and microseconds since\n"
228 "1970-01-01 00:00:00 UTC, excluding leap seconds. Note: whether true\n"
229 "microsecond resolution is available depends on the operating system.")
230 #define FUNC_NAME s_scm_gettimeofday
232 #ifdef HAVE_GETTIMEOFDAY
236 if (gettimeofday (&time
, NULL
) == -1)
239 return scm_cons (scm_long2num ((long) time
.tv_sec
),
240 scm_long2num ((long) time
.tv_usec
));
246 return scm_cons (scm_long2num ((long) time
.time
),
247 SCM_MAKINUM (time
.millitm
* 1000));
252 if ((timv
= time (0)) == -1)
255 return scm_cons (scm_long2num (timv
), SCM_MAKINUM (0));
262 filltime (struct tm
*bd_time
, int zoff
, char *zname
)
264 SCM result
= scm_make_vector (SCM_MAKINUM(11), SCM_UNDEFINED
);
266 SCM_VELTS (result
)[0] = SCM_MAKINUM (bd_time
->tm_sec
);
267 SCM_VELTS (result
)[1] = SCM_MAKINUM (bd_time
->tm_min
);
268 SCM_VELTS (result
)[2] = SCM_MAKINUM (bd_time
->tm_hour
);
269 SCM_VELTS (result
)[3] = SCM_MAKINUM (bd_time
->tm_mday
);
270 SCM_VELTS (result
)[4] = SCM_MAKINUM (bd_time
->tm_mon
);
271 SCM_VELTS (result
)[5] = SCM_MAKINUM (bd_time
->tm_year
);
272 SCM_VELTS (result
)[6] = SCM_MAKINUM (bd_time
->tm_wday
);
273 SCM_VELTS (result
)[7] = SCM_MAKINUM (bd_time
->tm_yday
);
274 SCM_VELTS (result
)[8] = SCM_MAKINUM (bd_time
->tm_isdst
);
275 SCM_VELTS (result
)[9] = SCM_MAKINUM (zoff
);
276 SCM_VELTS (result
)[10] = zname
? scm_makfrom0str (zname
) : SCM_BOOL_F
;
280 static char tzvar
[3] = "TZ";
281 extern char ** environ
;
283 /* if zone is set, create a temporary environment with only a TZ
284 string. other threads or interrupt handlers shouldn't be allowed
285 to run until the corresponding restorezone is called. hence the use
286 of a static variable for tmpenv is no big deal. */
288 setzone (SCM zone
, int pos
, const char *subr
)
292 if (!SCM_UNBNDP (zone
))
294 static char *tmpenv
[2];
297 SCM_ASSERT (SCM_ROSTRINGP (zone
), zone
, pos
, subr
);
298 SCM_COERCE_SUBSTR (zone
);
299 buf
= scm_must_malloc (SCM_LENGTH (zone
) + sizeof (tzvar
) + 1,
301 sprintf (buf
, "%s=%s", tzvar
, SCM_ROCHARS (zone
));
311 restorezone (SCM zone
, char **oldenv
, const char *subr
)
313 if (!SCM_UNBNDP (zone
))
315 scm_must_free (environ
[0]);
318 /* for the possible benefit of user code linked with libguile. */
324 SCM_DEFINE (scm_localtime
, "localtime", 1, 1, 0,
325 (SCM time
, SCM zone
),
326 "Returns an object representing the broken down components of @var{time},\n"
327 "an integer like the one returned by @code{current-time}. The time zone\n"
328 "for the calculation is optionally specified by @var{zone} (a string),\n"
329 "otherwise the @code{TZ} environment variable or the system default is\n"
331 #define FUNC_NAME s_scm_localtime
334 struct tm
*ltptr
, lt
, *utc
;
341 itime
= SCM_NUM2LONG (1,time
);
343 /* deferring interupts is essential since a) setzone may install a temporary
344 environment b) localtime uses a static buffer. */
346 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
347 #ifdef LOCALTIME_CACHE
350 ltptr
= localtime (&itime
);
356 /* copy zone name before calling gmtime or restoring zone. */
357 #if defined (HAVE_TM_ZONE)
358 ptr
= ltptr
->tm_zone
;
359 #elif defined (HAVE_TZNAME)
360 ptr
= tzname
[ (ltptr
->tm_isdst
== 1) ? 1 : 0 ];
364 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
367 /* the struct is copied in case localtime and gmtime share a buffer. */
370 utc
= gmtime (&itime
);
373 restorezone (zone
, oldenv
, FUNC_NAME
);
374 /* delayed until zone has been restored. */
376 if (utc
== NULL
|| ltptr
== NULL
)
379 /* calculate timezone offset in seconds west of UTC. */
380 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
381 + utc
->tm_sec
- lt
.tm_sec
;
382 if (utc
->tm_year
< lt
.tm_year
)
383 zoff
-= 24 * 60 * 60;
384 else if (utc
->tm_year
> lt
.tm_year
)
385 zoff
+= 24 * 60 * 60;
386 else if (utc
->tm_yday
< lt
.tm_yday
)
387 zoff
-= 24 * 60 * 60;
388 else if (utc
->tm_yday
> lt
.tm_yday
)
389 zoff
+= 24 * 60 * 60;
391 result
= filltime (<
, zoff
, zname
);
393 scm_must_free (zname
);
398 SCM_DEFINE (scm_gmtime
, "gmtime", 1, 0, 0,
400 "Returns an object representing the broken down components of @var{time},\n"
401 "an integer like the one returned by @code{current-time}. The values\n"
402 "are calculated for UTC.")
403 #define FUNC_NAME s_scm_gmtime
409 itime
= SCM_NUM2LONG (1,time
);
411 bd_time
= gmtime (&itime
);
414 result
= filltime (bd_time
, 0, "GMT");
420 /* copy time components from a Scheme object to a struct tm. */
422 bdtime2c (SCM sbd_time
, struct tm
*lt
, int pos
, const char *subr
)
427 SCM_ASSERT (SCM_VECTORP (sbd_time
)
428 && SCM_LENGTH (sbd_time
) == 11,
429 sbd_time
, pos
, subr
);
430 velts
= SCM_VELTS (sbd_time
);
431 for (i
= 0; i
< 10; i
++)
433 SCM_ASSERT (SCM_INUMP (velts
[i
]), sbd_time
, pos
, subr
);
435 SCM_ASSERT (SCM_FALSEP (velts
[10]) || SCM_STRINGP (velts
[10]),
436 sbd_time
, pos
, subr
);
438 lt
->tm_sec
= SCM_INUM (velts
[0]);
439 lt
->tm_min
= SCM_INUM (velts
[1]);
440 lt
->tm_hour
= SCM_INUM (velts
[2]);
441 lt
->tm_mday
= SCM_INUM (velts
[3]);
442 lt
->tm_mon
= SCM_INUM (velts
[4]);
443 lt
->tm_year
= SCM_INUM (velts
[5]);
444 lt
->tm_wday
= SCM_INUM (velts
[6]);
445 lt
->tm_yday
= SCM_INUM (velts
[7]);
446 lt
->tm_isdst
= SCM_INUM (velts
[8]);
448 lt
->tm_gmtoff
= SCM_INUM (velts
[9]);
449 if (SCM_FALSEP (velts
[10]))
452 lt
->tm_zone
= SCM_CHARS (velts
[10]);
456 SCM_DEFINE (scm_mktime
, "mktime", 1, 1, 0,
457 (SCM sbd_time
, SCM zone
),
458 "@var{bd-time} is an object representing broken down time and @code{zone}\n"
459 "is an optional time zone specifier (otherwise the TZ environment variable\n"
460 "or the system default is used).\n\n"
461 "Returns a pair: the CAR is a corresponding\n"
462 "integer time value like that returned\n"
463 "by @code{current-time}; the CDR is a broken down time object, similar to\n"
464 "as @var{bd-time} but with normalized values.")
465 #define FUNC_NAME s_scm_mktime
475 bdtime2c (sbd_time
, <
, SCM_ARG1
, FUNC_NAME
);
478 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
479 #ifdef LOCALTIME_CACHE
482 itime
= mktime (<
);
489 /* copy zone name before calling gmtime or restoring the zone. */
490 #if defined (HAVE_TM_ZONE)
492 #elif defined (HAVE_TZNAME)
493 ptr
= tzname
[ (lt
.tm_isdst
== 1) ? 1 : 0 ];
497 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
501 /* get timezone offset in seconds west of UTC. */
502 utc
= gmtime (&itime
);
506 restorezone (zone
, oldenv
, FUNC_NAME
);
507 /* delayed until zone has been restored. */
509 if (utc
== NULL
|| itime
== -1)
512 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
513 + utc
->tm_sec
- lt
.tm_sec
;
514 if (utc
->tm_year
< lt
.tm_year
)
515 zoff
-= 24 * 60 * 60;
516 else if (utc
->tm_year
> lt
.tm_year
)
517 zoff
+= 24 * 60 * 60;
518 else if (utc
->tm_yday
< lt
.tm_yday
)
519 zoff
-= 24 * 60 * 60;
520 else if (utc
->tm_yday
> lt
.tm_yday
)
521 zoff
+= 24 * 60 * 60;
523 result
= scm_cons (scm_long2num ((long) itime
),
524 filltime (<
, zoff
, zname
));
526 scm_must_free (zname
);
532 SCM_DEFINE (scm_tzset
, "tzset", 0, 0, 0,
534 "Initialize the timezone from the TZ environment variable\n"
535 "or the system default. It's not usually necessary to call this procedure\n"
536 "since it's done automatically by other procedures that depend on the\n"
538 #define FUNC_NAME s_scm_tzset
541 return SCM_UNSPECIFIED
;
544 #endif /* HAVE_TZSET */
546 SCM_DEFINE (scm_strftime
, "strftime", 2, 0, 0,
547 (SCM format
, SCM stime
),
548 "Formats a time specification @var{time} using @var{template}. @var{time}\n"
549 "is an object with time components in the form returned by @code{localtime}\n"
550 "or @code{gmtime}. @var{template} is a string which can include formatting\n"
551 "specifications introduced by a @code{%} character. The formatting of\n"
552 "month and day names is dependent on the current locale. The value returned\n"
553 "is the formatted string.\n"
554 "@xref{Formatting Date and Time, , , libc, The GNU C Library Reference Manual}.)")
555 #define FUNC_NAME s_scm_strftime
565 SCM_VALIDATE_ROSTRING (1,format
);
566 bdtime2c (stime
, &t
, SCM_ARG2
, FUNC_NAME
);
568 SCM_COERCE_SUBSTR (format
);
569 fmt
= SCM_ROCHARS (format
);
570 len
= SCM_ROLENGTH (format
);
572 tbuf
= SCM_MUST_MALLOC (size
);
573 #ifdef LOCALTIME_CACHE
576 while ((len
= strftime (tbuf
, size
, fmt
, &t
)) == size
)
578 scm_must_free (tbuf
);
580 tbuf
= SCM_MUST_MALLOC (size
);
582 result
= scm_makfromstr (tbuf
, len
, 0);
583 scm_must_free (tbuf
);
589 SCM_DEFINE (scm_strptime
, "strptime", 2, 0, 0,
590 (SCM format
, SCM string
),
591 "Performs the reverse action to @code{strftime}, parsing @var{string}\n"
592 "according to the specification supplied in @var{template}. The\n"
593 "interpretation of month and day names is dependent on the current\n"
595 "value returned is a pair. The CAR has an object with time components \n"
596 "in the form returned by @code{localtime} or @code{gmtime},\n"
597 "but the time zone components\n"
598 "are not usefully set.\n"
599 "The CDR reports the number of characters from @var{string} which\n"
600 "vwere used for the conversion.")
601 #define FUNC_NAME s_scm_strptime
604 char *fmt
, *str
, *rest
;
606 SCM_VALIDATE_ROSTRING (1,format
);
607 SCM_VALIDATE_ROSTRING (2,string
);
609 SCM_COERCE_SUBSTR (format
);
610 SCM_COERCE_SUBSTR (string
);
611 fmt
= SCM_ROCHARS (format
);
612 str
= SCM_ROCHARS (string
);
614 /* initialize the struct tm */
615 #define tm_init(field) t.field = 0
628 if ((rest
= strptime (str
, fmt
, &t
)) == NULL
)
632 return scm_cons (filltime (&t
, 0, NULL
), SCM_MAKINUM (rest
- str
));
635 #endif /* HAVE_STRPTIME */
640 scm_sysintern("internal-time-units-per-second",
641 scm_long2num((long)CLKTCK
));
644 if (!scm_your_base
.time
) ftime(&scm_your_base
);
646 if (!scm_your_base
) time(&scm_your_base
);
649 if (!scm_my_base
) scm_my_base
= mytime();
651 scm_add_feature ("current-time");