1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001 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 */
50 #include "libguile/_scm.h"
51 #include "libguile/feature.h"
52 #include "libguile/strings.h"
53 #include "libguile/vectors.h"
55 #include "libguile/validate.h"
56 #include "libguile/stime.h"
63 # ifdef HAVE_SYS_TYPES_H
64 # include <sys/types.h>
71 # ifdef TIME_WITH_SYS_TIME
72 # include <sys/time.h>
75 # ifdef HAVE_SYS_TIME_H
76 # include <sys/time.h>
84 #ifdef HAVE_SYS_TIMES_H
85 # include <sys/times.h>
88 #ifdef HAVE_SYS_TIMEB_H
89 # include <sys/timeb.h>
92 #ifndef tzname /* For SGI. */
93 extern char *tzname
[]; /* RS6000 and others reject char **tzname. */
96 #ifdef MISSING_STRPTIME_DECL
97 extern char *strptime ();
100 /* This should be figured out by autoconf. */
101 #if ! defined(CLKTCK) && defined(CLK_TCK)
102 # define CLKTCK ((int) CLK_TCK)
104 #if ! defined(CLKTCK) && defined(CLOCKS_PER_SEC)
105 # define CLKTCK ((int) CLOCKS_PER_SEC)
107 #if ! defined(CLKTCK)
112 # define timet time_t
121 struct tms time_buffer
;
123 return time_buffer
.tms_utime
+ time_buffer
.tms_stime
;
127 # define mytime() ((time((timet*)0) - scm_your_base) * CLKTCK)
129 # define mytime clock
134 struct timeb scm_your_base
= {0};
136 timet scm_your_base
= 0;
139 SCM_DEFINE (scm_get_internal_real_time
, "get-internal-real-time", 0, 0, 0,
141 "Return the number of time units since the interpreter was\n"
143 #define FUNC_NAME s_scm_get_internal_real_time
146 struct timeb time_buffer
;
149 ftime (&time_buffer
);
150 time_buffer
.time
-= scm_your_base
.time
;
151 tmp
= scm_long2num (time_buffer
.millitm
- scm_your_base
.millitm
);
153 scm_product (SCM_MAKINUM (1000),
154 SCM_MAKINUM (time_buffer
.time
)));
155 return scm_quotient (scm_product (tmp
, SCM_MAKINUM (CLKTCK
)),
158 return scm_long2num((time((timet
*)0) - scm_your_base
) * (int)CLKTCK
);
159 #endif /* HAVE_FTIME */
165 SCM_DEFINE (scm_times
, "times", 0, 0, 0,
167 "Return an object with information about real and processor\n"
168 "time. The following procedures accept such an object as an\n"
169 "argument and return a selected component:\n"
173 "The current real time, expressed as time units relative to an\n"
176 "The CPU time units used by the calling process.\n"
178 "The CPU time units used by the system on behalf of the calling\n"
181 "The CPU time units used by terminated child processes of the\n"
182 "calling process, whose status has been collected (e.g., using\n"
185 "Similarly, the CPU times units used by the system on behalf of\n"
186 "terminated child processes.\n"
188 #define FUNC_NAME s_scm_times
193 SCM result
= scm_c_make_vector (5, SCM_UNDEFINED
);
197 SCM_VELTS (result
)[0] = scm_long2num (rv
);
198 SCM_VELTS (result
)[1] = scm_long2num (t
.tms_utime
);
199 SCM_VELTS (result
)[2] = scm_long2num (t
.tms_stime
);
200 SCM_VELTS (result
)[3] = scm_long2num (t
.tms_cutime
);
201 SCM_VELTS (result
)[4] = scm_long2num (t
.tms_cstime
);
205 #endif /* HAVE_TIMES */
207 static long scm_my_base
= 0;
210 scm_c_get_internal_run_time ()
212 return mytime () - scm_my_base
;
215 SCM_DEFINE (scm_get_internal_run_time
, "get-internal-run-time", 0, 0, 0,
217 "Return the number of time units of processor time used by the\n"
218 "interpreter. Both @emph{system} and @emph{user} time are\n"
219 "included but subprocesses are not.")
220 #define FUNC_NAME s_scm_get_internal_run_time
222 return scm_long2num (scm_c_get_internal_run_time ());
226 SCM_DEFINE (scm_current_time
, "current-time", 0, 0, 0,
228 "Return the number of seconds since 1970-01-01 00:00:00 UTC,\n"
229 "excluding leap seconds.")
230 #define FUNC_NAME s_scm_current_time
235 if ((timv
= time (0)) == -1)
238 return scm_long2num((long) timv
);
242 SCM_DEFINE (scm_gettimeofday
, "gettimeofday", 0, 0, 0,
244 "Return a pair containing the number of seconds and microseconds\n"
245 "since 1970-01-01 00:00:00 UTC, excluding leap seconds. Note:\n"
246 "whether true microsecond resolution is available depends on the\n"
248 #define FUNC_NAME s_scm_gettimeofday
250 #ifdef HAVE_GETTIMEOFDAY
254 if (gettimeofday (&time
, NULL
) == -1)
257 return scm_cons (scm_long2num ((long) time
.tv_sec
),
258 scm_long2num ((long) time
.tv_usec
));
264 return scm_cons (scm_long2num ((long) time
.time
),
265 SCM_MAKINUM (time
.millitm
* 1000));
270 if ((timv
= time (0)) == -1)
273 return scm_cons (scm_long2num (timv
), SCM_MAKINUM (0));
280 filltime (struct tm
*bd_time
, int zoff
, char *zname
)
282 SCM result
= scm_c_make_vector (11, SCM_UNDEFINED
);
284 SCM_VELTS (result
)[0] = SCM_MAKINUM (bd_time
->tm_sec
);
285 SCM_VELTS (result
)[1] = SCM_MAKINUM (bd_time
->tm_min
);
286 SCM_VELTS (result
)[2] = SCM_MAKINUM (bd_time
->tm_hour
);
287 SCM_VELTS (result
)[3] = SCM_MAKINUM (bd_time
->tm_mday
);
288 SCM_VELTS (result
)[4] = SCM_MAKINUM (bd_time
->tm_mon
);
289 SCM_VELTS (result
)[5] = SCM_MAKINUM (bd_time
->tm_year
);
290 SCM_VELTS (result
)[6] = SCM_MAKINUM (bd_time
->tm_wday
);
291 SCM_VELTS (result
)[7] = SCM_MAKINUM (bd_time
->tm_yday
);
292 SCM_VELTS (result
)[8] = SCM_MAKINUM (bd_time
->tm_isdst
);
293 SCM_VELTS (result
)[9] = SCM_MAKINUM (zoff
);
294 SCM_VELTS (result
)[10] = zname
? scm_makfrom0str (zname
) : SCM_BOOL_F
;
298 static char tzvar
[3] = "TZ";
299 extern char ** environ
;
301 /* if zone is set, create a temporary environment with only a TZ
302 string. other threads or interrupt handlers shouldn't be allowed
303 to run until the corresponding restorezone is called. hence the use
304 of a static variable for tmpenv is no big deal. */
306 setzone (SCM zone
, int pos
, const char *subr
)
310 if (!SCM_UNBNDP (zone
))
312 static char *tmpenv
[2];
315 SCM_ASSERT (SCM_STRINGP (zone
), zone
, pos
, subr
);
316 SCM_STRING_COERCE_0TERMINATION_X (zone
);
317 buf
= scm_must_malloc (SCM_STRING_LENGTH (zone
) + sizeof (tzvar
) + 1, subr
);
318 sprintf (buf
, "%s=%s", tzvar
, SCM_STRING_CHARS (zone
));
328 restorezone (SCM zone
, char **oldenv
, const char *subr SCM_UNUSED
)
330 if (!SCM_UNBNDP (zone
))
332 scm_must_free (environ
[0]);
335 /* for the possible benefit of user code linked with libguile. */
341 SCM_DEFINE (scm_localtime
, "localtime", 1, 1, 0,
342 (SCM time
, SCM zone
),
343 "Return an object representing the broken down components of\n"
344 "@var{time}, an integer like the one returned by\n"
345 "@code{current-time}. The time zone for the calculation is\n"
346 "optionally specified by @var{zone} (a string), otherwise the\n"
347 "@code{TZ} environment variable or the system default is used.")
348 #define FUNC_NAME s_scm_localtime
351 struct tm
*ltptr
, lt
, *utc
;
358 itime
= SCM_NUM2LONG (1, time
);
360 /* deferring interupts is essential since a) setzone may install a temporary
361 environment b) localtime uses a static buffer. */
363 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
364 #ifdef LOCALTIME_CACHE
367 ltptr
= localtime (&itime
);
373 /* copy zone name before calling gmtime or restoring zone. */
374 #if defined (HAVE_TM_ZONE)
375 ptr
= ltptr
->tm_zone
;
376 #elif defined (HAVE_TZNAME)
377 ptr
= tzname
[ (ltptr
->tm_isdst
== 1) ? 1 : 0 ];
381 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
384 /* the struct is copied in case localtime and gmtime share a buffer. */
387 utc
= gmtime (&itime
);
390 restorezone (zone
, oldenv
, FUNC_NAME
);
391 /* delayed until zone has been restored. */
393 if (utc
== NULL
|| ltptr
== NULL
)
396 /* calculate timezone offset in seconds west of UTC. */
397 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
398 + utc
->tm_sec
- lt
.tm_sec
;
399 if (utc
->tm_year
< lt
.tm_year
)
400 zoff
-= 24 * 60 * 60;
401 else if (utc
->tm_year
> lt
.tm_year
)
402 zoff
+= 24 * 60 * 60;
403 else if (utc
->tm_yday
< lt
.tm_yday
)
404 zoff
-= 24 * 60 * 60;
405 else if (utc
->tm_yday
> lt
.tm_yday
)
406 zoff
+= 24 * 60 * 60;
408 result
= filltime (<
, zoff
, zname
);
410 scm_must_free (zname
);
415 SCM_DEFINE (scm_gmtime
, "gmtime", 1, 0, 0,
417 "Return an object representing the broken down components of\n"
418 "@var{time}, an integer like the one returned by\n"
419 "@code{current-time}. The values are calculated for UTC.")
420 #define FUNC_NAME s_scm_gmtime
426 itime
= SCM_NUM2LONG (1, time
);
428 bd_time
= gmtime (&itime
);
431 result
= filltime (bd_time
, 0, "GMT");
437 /* copy time components from a Scheme object to a struct tm. */
439 bdtime2c (SCM sbd_time
, struct tm
*lt
, int pos
, const char *subr
)
444 SCM_ASSERT (SCM_VECTORP (sbd_time
)
445 && SCM_VECTOR_LENGTH (sbd_time
) == 11,
446 sbd_time
, pos
, subr
);
447 velts
= SCM_VELTS (sbd_time
);
448 for (i
= 0; i
< 10; i
++)
450 SCM_ASSERT (SCM_INUMP (velts
[i
]), sbd_time
, pos
, subr
);
452 SCM_ASSERT (SCM_FALSEP (velts
[10]) || SCM_STRINGP (velts
[10]),
453 sbd_time
, pos
, subr
);
455 lt
->tm_sec
= SCM_INUM (velts
[0]);
456 lt
->tm_min
= SCM_INUM (velts
[1]);
457 lt
->tm_hour
= SCM_INUM (velts
[2]);
458 lt
->tm_mday
= SCM_INUM (velts
[3]);
459 lt
->tm_mon
= SCM_INUM (velts
[4]);
460 lt
->tm_year
= SCM_INUM (velts
[5]);
461 lt
->tm_wday
= SCM_INUM (velts
[6]);
462 lt
->tm_yday
= SCM_INUM (velts
[7]);
463 lt
->tm_isdst
= SCM_INUM (velts
[8]);
465 lt
->tm_gmtoff
= SCM_INUM (velts
[9]);
466 if (SCM_FALSEP (velts
[10]))
469 lt
->tm_zone
= SCM_STRING_CHARS (velts
[10]);
473 SCM_DEFINE (scm_mktime
, "mktime", 1, 1, 0,
474 (SCM sbd_time
, SCM zone
),
475 "@var{bd-time} is an object representing broken down time and @code{zone}\n"
476 "is an optional time zone specifier (otherwise the TZ environment variable\n"
477 "or the system default is used).\n\n"
478 "Returns a pair: the car is a corresponding\n"
479 "integer time value like that returned\n"
480 "by @code{current-time}; the cdr is a broken down time object, similar to\n"
481 "as @var{bd-time} but with normalized values.")
482 #define FUNC_NAME s_scm_mktime
492 bdtime2c (sbd_time
, <
, SCM_ARG1
, FUNC_NAME
);
495 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
496 #ifdef LOCALTIME_CACHE
499 itime
= mktime (<
);
506 /* copy zone name before calling gmtime or restoring the zone. */
507 #if defined (HAVE_TM_ZONE)
509 #elif defined (HAVE_TZNAME)
510 ptr
= tzname
[ (lt
.tm_isdst
== 1) ? 1 : 0 ];
514 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
518 /* get timezone offset in seconds west of UTC. */
519 utc
= gmtime (&itime
);
523 restorezone (zone
, oldenv
, FUNC_NAME
);
524 /* delayed until zone has been restored. */
526 if (utc
== NULL
|| itime
== -1)
529 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
530 + utc
->tm_sec
- lt
.tm_sec
;
531 if (utc
->tm_year
< lt
.tm_year
)
532 zoff
-= 24 * 60 * 60;
533 else if (utc
->tm_year
> lt
.tm_year
)
534 zoff
+= 24 * 60 * 60;
535 else if (utc
->tm_yday
< lt
.tm_yday
)
536 zoff
-= 24 * 60 * 60;
537 else if (utc
->tm_yday
> lt
.tm_yday
)
538 zoff
+= 24 * 60 * 60;
540 result
= scm_cons (scm_long2num ((long) itime
),
541 filltime (<
, zoff
, zname
));
543 scm_must_free (zname
);
549 SCM_DEFINE (scm_tzset
, "tzset", 0, 0, 0,
551 "Initialize the timezone from the TZ environment variable\n"
552 "or the system default. It's not usually necessary to call this procedure\n"
553 "since it's done automatically by other procedures that depend on the\n"
555 #define FUNC_NAME s_scm_tzset
558 return SCM_UNSPECIFIED
;
561 #endif /* HAVE_TZSET */
563 SCM_DEFINE (scm_strftime
, "strftime", 2, 0, 0,
564 (SCM format
, SCM stime
),
565 "Formats a time specification @var{time} using @var{template}. @var{time}\n"
566 "is an object with time components in the form returned by @code{localtime}\n"
567 "or @code{gmtime}. @var{template} is a string which can include formatting\n"
568 "specifications introduced by a @code{%} character. The formatting of\n"
569 "month and day names is dependent on the current locale. The value returned\n"
570 "is the formatted string.\n"
571 "@xref{Formatting Date and Time, , , libc, The GNU C Library Reference Manual}.)")
572 #define FUNC_NAME s_scm_strftime
582 SCM_VALIDATE_STRING (1, format
);
583 bdtime2c (stime
, &t
, SCM_ARG2
, FUNC_NAME
);
585 SCM_STRING_COERCE_0TERMINATION_X (format
);
586 fmt
= SCM_STRING_CHARS (format
);
587 len
= SCM_STRING_LENGTH (format
);
589 /* Ugly hack: strftime can return 0 if its buffer is too small,
590 but some valid time strings (e.g. "%p") can sometimes produce
591 a zero-byte output string! Workaround is to prepend a junk
592 character to the format string, so that valid returns are always
594 myfmt
= SCM_MUST_MALLOC (len
+2);
596 strncpy(myfmt
+1, fmt
, len
);
599 tbuf
= SCM_MUST_MALLOC (size
);
601 #if !defined (HAVE_TM_ZONE)
602 /* it seems the only way to tell non-GNU versions of strftime what
603 zone to use (for the %Z format) is to set TZ in the
604 environment. interrupts and thread switching must be deferred
605 until TZ is restored. */
606 char **oldenv
= NULL
;
607 SCM
*velts
= SCM_VELTS (stime
);
610 if (!SCM_FALSEP (velts
[10]) && *SCM_STRING_CHARS (velts
[10]) != 0)
612 /* it's not required that the TZ setting be correct, just that
613 it has the right name. so try something like TZ=EST0.
614 using only TZ=EST would be simpler but it doesn't work on
615 some OSs, e.g., Solaris. */
617 scm_string_append (scm_cons (velts
[10],
618 scm_cons (scm_makfrom0str ("0"),
623 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
627 #ifdef LOCALTIME_CACHE
631 /* POSIX says strftime returns 0 on buffer overrun, but old
632 systems (i.e. libc 4 on GNU/Linux) might return `size' in that
634 while ((len
= strftime (tbuf
, size
, myfmt
, &t
)) == 0 || len
== size
)
636 scm_must_free (tbuf
);
638 tbuf
= SCM_MUST_MALLOC (size
);
641 #if !defined (HAVE_TM_ZONE)
644 restorezone (velts
[10], oldenv
, FUNC_NAME
);
650 result
= scm_mem2string (tbuf
+ 1, len
- 1);
651 scm_must_free (tbuf
);
652 scm_must_free(myfmt
);
658 SCM_DEFINE (scm_strptime
, "strptime", 2, 0, 0,
659 (SCM format
, SCM string
),
660 "Performs the reverse action to @code{strftime}, parsing\n"
661 "@var{string} according to the specification supplied in\n"
662 "@var{template}. The interpretation of month and day names is\n"
663 "dependent on the current locale. The value returned is a pair.\n"
664 "The car has an object with time components\n"
665 "in the form returned by @code{localtime} or @code{gmtime},\n"
666 "but the time zone components\n"
667 "are not usefully set.\n"
668 "The cdr reports the number of characters from @var{string}\n"
669 "which were used for the conversion.")
670 #define FUNC_NAME s_scm_strptime
673 char *fmt
, *str
, *rest
;
675 SCM_VALIDATE_STRING (1, format
);
676 SCM_VALIDATE_STRING (2, string
);
678 SCM_STRING_COERCE_0TERMINATION_X (format
);
679 SCM_STRING_COERCE_0TERMINATION_X (string
);
680 fmt
= SCM_STRING_CHARS (format
);
681 str
= SCM_STRING_CHARS (string
);
683 /* initialize the struct tm */
684 #define tm_init(field) t.field = 0
697 if ((rest
= strptime (str
, fmt
, &t
)) == NULL
)
701 return scm_cons (filltime (&t
, 0, NULL
), SCM_MAKINUM (rest
- str
));
704 #endif /* HAVE_STRPTIME */
709 scm_c_define ("internal-time-units-per-second",
710 scm_long2num((long)CLKTCK
));
713 if (!scm_your_base
.time
) ftime(&scm_your_base
);
715 if (!scm_your_base
) time(&scm_your_base
);
718 if (!scm_my_base
) scm_my_base
= mytime();
720 scm_add_feature ("current-time");
721 #ifndef SCM_MAGIC_SNARFER
722 #include "libguile/stime.x"