1 /* Copyright (C) 1995,1996,1997,1998, 1999, 2000 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 */
48 #include "libguile/_scm.h"
49 #include "libguile/feature.h"
50 #include "libguile/strings.h"
51 #include "libguile/vectors.h"
53 #include "libguile/validate.h"
54 #include "libguile/stime.h"
61 # ifdef HAVE_SYS_TYPES_H
62 # include <sys/types.h>
69 # ifdef TIME_WITH_SYS_TIME
70 # include <sys/time.h>
73 # ifdef HAVE_SYS_TIME_H
74 # include <sys/time.h>
82 #ifdef HAVE_SYS_TIMES_H
83 # include <sys/times.h>
86 #ifdef HAVE_SYS_TIMEB_H
87 # include <sys/timeb.h>
90 #ifndef tzname /* For SGI. */
91 extern char *tzname
[]; /* RS6000 and others reject char **tzname. */
94 #ifdef MISSING_STRPTIME_DECL
95 extern char *strptime ();
98 /* This should be figured out by autoconf. */
99 #if ! defined(CLKTCK) && defined(CLK_TCK)
100 # define CLKTCK CLK_TCK
102 #if ! defined(CLKTCK) && defined(CLOCKS_PER_SEC)
103 # define CLKTCK CLOCKS_PER_SEC
105 #if ! defined(CLKTCK)
110 # define timet time_t
119 struct tms time_buffer
;
121 return time_buffer
.tms_utime
+ time_buffer
.tms_stime
;
125 # define mytime() ((time((timet*)0) - scm_your_base) * CLKTCK)
127 # 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 "Returns the number of time units since the interpreter was started.")
142 #define FUNC_NAME s_scm_get_internal_real_time
145 struct timeb time_buffer
;
148 ftime (&time_buffer
);
149 time_buffer
.time
-= scm_your_base
.time
;
150 tmp
= scm_long2num (time_buffer
.millitm
- scm_your_base
.millitm
);
152 scm_product (SCM_MAKINUM (1000),
153 SCM_MAKINUM (time_buffer
.time
)));
154 return scm_quotient (scm_product (tmp
, SCM_MAKINUM (CLKTCK
)),
157 return scm_long2num((time((timet
*)0) - scm_your_base
) * (int)CLKTCK
);
158 #endif /* HAVE_FTIME */
164 SCM_DEFINE (scm_times
, "times", 0, 0, 0,
166 "Returns an object with information about real and processor time.\n"
167 "The following procedures accept such an object as an argument and\n"
168 "return a selected component:\n\n"
171 "The current real time, expressed as time units relative to an\n"
174 "The CPU time units used by the calling process.\n"
176 "The CPU time units used by the system on behalf of the calling process.\n"
178 "The CPU time units used by terminated child processes of the calling\n"
179 "process, whose status has been collected (e.g., using @code{waitpid}).\n"
181 "Similarly, the CPU times units used by the system on behalf of \n"
182 "terminated child processes.\n"
184 #define FUNC_NAME s_scm_times
189 SCM result
= scm_make_vector (SCM_MAKINUM(5), SCM_UNDEFINED
);
193 SCM_VELTS (result
)[0] = scm_long2num (rv
);
194 SCM_VELTS (result
)[1] = scm_long2num (t
.tms_utime
);
195 SCM_VELTS (result
)[2] = scm_long2num (t
.tms_stime
);
196 SCM_VELTS (result
)[3] = scm_long2num (t
.tms_cutime
);
197 SCM_VELTS (result
)[4] = scm_long2num (t
.tms_cstime
);
201 #endif /* HAVE_TIMES */
203 static long scm_my_base
= 0;
206 scm_c_get_internal_run_time ()
208 return mytime () - scm_my_base
;
211 SCM_DEFINE (scm_get_internal_run_time
, "get-internal-run-time", 0, 0, 0,
213 "Returns the number of time units of processor time used by the interpreter.\n"
214 "Both \"system\" and \"user\" time are included but subprocesses are not.")
215 #define FUNC_NAME s_scm_get_internal_run_time
217 return scm_long2num (scm_c_get_internal_run_time ());
221 SCM_DEFINE (scm_current_time
, "current-time", 0, 0, 0,
223 "Returns the number of seconds since 1970-01-01 00:00:00 UTC, excluding\n"
225 #define FUNC_NAME s_scm_current_time
230 if ((timv
= time (0)) == -1)
233 return scm_long2num((long) timv
);
237 SCM_DEFINE (scm_gettimeofday
, "gettimeofday", 0, 0, 0,
239 "Returns a pair containing the number of seconds and microseconds since\n"
240 "1970-01-01 00:00:00 UTC, excluding leap seconds. Note: whether true\n"
241 "microsecond resolution is available depends on the operating system.")
242 #define FUNC_NAME s_scm_gettimeofday
244 #ifdef HAVE_GETTIMEOFDAY
248 if (gettimeofday (&time
, NULL
) == -1)
251 return scm_cons (scm_long2num ((long) time
.tv_sec
),
252 scm_long2num ((long) time
.tv_usec
));
258 return scm_cons (scm_long2num ((long) time
.time
),
259 SCM_MAKINUM (time
.millitm
* 1000));
264 if ((timv
= time (0)) == -1)
267 return scm_cons (scm_long2num (timv
), SCM_MAKINUM (0));
274 filltime (struct tm
*bd_time
, int zoff
, char *zname
)
276 SCM result
= scm_make_vector (SCM_MAKINUM(11), SCM_UNDEFINED
);
278 SCM_VELTS (result
)[0] = SCM_MAKINUM (bd_time
->tm_sec
);
279 SCM_VELTS (result
)[1] = SCM_MAKINUM (bd_time
->tm_min
);
280 SCM_VELTS (result
)[2] = SCM_MAKINUM (bd_time
->tm_hour
);
281 SCM_VELTS (result
)[3] = SCM_MAKINUM (bd_time
->tm_mday
);
282 SCM_VELTS (result
)[4] = SCM_MAKINUM (bd_time
->tm_mon
);
283 SCM_VELTS (result
)[5] = SCM_MAKINUM (bd_time
->tm_year
);
284 SCM_VELTS (result
)[6] = SCM_MAKINUM (bd_time
->tm_wday
);
285 SCM_VELTS (result
)[7] = SCM_MAKINUM (bd_time
->tm_yday
);
286 SCM_VELTS (result
)[8] = SCM_MAKINUM (bd_time
->tm_isdst
);
287 SCM_VELTS (result
)[9] = SCM_MAKINUM (zoff
);
288 SCM_VELTS (result
)[10] = zname
? scm_makfrom0str (zname
) : SCM_BOOL_F
;
292 static char tzvar
[3] = "TZ";
293 extern char ** environ
;
295 /* if zone is set, create a temporary environment with only a TZ
296 string. other threads or interrupt handlers shouldn't be allowed
297 to run until the corresponding restorezone is called. hence the use
298 of a static variable for tmpenv is no big deal. */
300 setzone (SCM zone
, int pos
, const char *subr
)
304 if (!SCM_UNBNDP (zone
))
306 static char *tmpenv
[2];
309 SCM_ASSERT (SCM_STRINGP (zone
), zone
, pos
, subr
);
310 SCM_STRING_COERCE_0TERMINATION_X (zone
);
311 buf
= scm_must_malloc (SCM_STRING_LENGTH (zone
) + sizeof (tzvar
) + 1, subr
);
312 sprintf (buf
, "%s=%s", tzvar
, SCM_STRING_CHARS (zone
));
322 restorezone (SCM zone
, char **oldenv
, const char *subr
)
324 if (!SCM_UNBNDP (zone
))
326 scm_must_free (environ
[0]);
329 /* for the possible benefit of user code linked with libguile. */
335 SCM_DEFINE (scm_localtime
, "localtime", 1, 1, 0,
336 (SCM time
, SCM zone
),
337 "Returns an object representing the broken down components of @var{time},\n"
338 "an integer like the one returned by @code{current-time}. The time zone\n"
339 "for the calculation is optionally specified by @var{zone} (a string),\n"
340 "otherwise the @code{TZ} environment variable or the system default is\n"
342 #define FUNC_NAME s_scm_localtime
345 struct tm
*ltptr
, lt
, *utc
;
352 itime
= SCM_NUM2LONG (1,time
);
354 /* deferring interupts is essential since a) setzone may install a temporary
355 environment b) localtime uses a static buffer. */
357 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
358 #ifdef LOCALTIME_CACHE
361 ltptr
= localtime (&itime
);
367 /* copy zone name before calling gmtime or restoring zone. */
368 #if defined (HAVE_TM_ZONE)
369 ptr
= ltptr
->tm_zone
;
370 #elif defined (HAVE_TZNAME)
371 ptr
= tzname
[ (ltptr
->tm_isdst
== 1) ? 1 : 0 ];
375 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
378 /* the struct is copied in case localtime and gmtime share a buffer. */
381 utc
= gmtime (&itime
);
384 restorezone (zone
, oldenv
, FUNC_NAME
);
385 /* delayed until zone has been restored. */
387 if (utc
== NULL
|| ltptr
== NULL
)
390 /* calculate timezone offset in seconds west of UTC. */
391 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
392 + utc
->tm_sec
- lt
.tm_sec
;
393 if (utc
->tm_year
< lt
.tm_year
)
394 zoff
-= 24 * 60 * 60;
395 else if (utc
->tm_year
> lt
.tm_year
)
396 zoff
+= 24 * 60 * 60;
397 else if (utc
->tm_yday
< lt
.tm_yday
)
398 zoff
-= 24 * 60 * 60;
399 else if (utc
->tm_yday
> lt
.tm_yday
)
400 zoff
+= 24 * 60 * 60;
402 result
= filltime (<
, zoff
, zname
);
404 scm_must_free (zname
);
409 SCM_DEFINE (scm_gmtime
, "gmtime", 1, 0, 0,
411 "Returns an object representing the broken down components of @var{time},\n"
412 "an integer like the one returned by @code{current-time}. The values\n"
413 "are calculated for UTC.")
414 #define FUNC_NAME s_scm_gmtime
420 itime
= SCM_NUM2LONG (1,time
);
422 bd_time
= gmtime (&itime
);
425 result
= filltime (bd_time
, 0, "GMT");
431 /* copy time components from a Scheme object to a struct tm. */
433 bdtime2c (SCM sbd_time
, struct tm
*lt
, int pos
, const char *subr
)
438 SCM_ASSERT (SCM_VECTORP (sbd_time
)
439 && SCM_VECTOR_LENGTH (sbd_time
) == 11,
440 sbd_time
, pos
, subr
);
441 velts
= SCM_VELTS (sbd_time
);
442 for (i
= 0; i
< 10; i
++)
444 SCM_ASSERT (SCM_INUMP (velts
[i
]), sbd_time
, pos
, subr
);
446 SCM_ASSERT (SCM_FALSEP (velts
[10]) || SCM_STRINGP (velts
[10]),
447 sbd_time
, pos
, subr
);
449 lt
->tm_sec
= SCM_INUM (velts
[0]);
450 lt
->tm_min
= SCM_INUM (velts
[1]);
451 lt
->tm_hour
= SCM_INUM (velts
[2]);
452 lt
->tm_mday
= SCM_INUM (velts
[3]);
453 lt
->tm_mon
= SCM_INUM (velts
[4]);
454 lt
->tm_year
= SCM_INUM (velts
[5]);
455 lt
->tm_wday
= SCM_INUM (velts
[6]);
456 lt
->tm_yday
= SCM_INUM (velts
[7]);
457 lt
->tm_isdst
= SCM_INUM (velts
[8]);
459 lt
->tm_gmtoff
= SCM_INUM (velts
[9]);
460 if (SCM_FALSEP (velts
[10]))
463 lt
->tm_zone
= SCM_STRING_CHARS (velts
[10]);
467 SCM_DEFINE (scm_mktime
, "mktime", 1, 1, 0,
468 (SCM sbd_time
, SCM zone
),
469 "@var{bd-time} is an object representing broken down time and @code{zone}\n"
470 "is an optional time zone specifier (otherwise the TZ environment variable\n"
471 "or the system default is used).\n\n"
472 "Returns a pair: the CAR is a corresponding\n"
473 "integer time value like that returned\n"
474 "by @code{current-time}; the CDR is a broken down time object, similar to\n"
475 "as @var{bd-time} but with normalized values.")
476 #define FUNC_NAME s_scm_mktime
486 bdtime2c (sbd_time
, <
, SCM_ARG1
, FUNC_NAME
);
489 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
490 #ifdef LOCALTIME_CACHE
493 itime
= mktime (<
);
500 /* copy zone name before calling gmtime or restoring the zone. */
501 #if defined (HAVE_TM_ZONE)
503 #elif defined (HAVE_TZNAME)
504 ptr
= tzname
[ (lt
.tm_isdst
== 1) ? 1 : 0 ];
508 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
512 /* get timezone offset in seconds west of UTC. */
513 utc
= gmtime (&itime
);
517 restorezone (zone
, oldenv
, FUNC_NAME
);
518 /* delayed until zone has been restored. */
520 if (utc
== NULL
|| itime
== -1)
523 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
524 + utc
->tm_sec
- lt
.tm_sec
;
525 if (utc
->tm_year
< lt
.tm_year
)
526 zoff
-= 24 * 60 * 60;
527 else if (utc
->tm_year
> lt
.tm_year
)
528 zoff
+= 24 * 60 * 60;
529 else if (utc
->tm_yday
< lt
.tm_yday
)
530 zoff
-= 24 * 60 * 60;
531 else if (utc
->tm_yday
> lt
.tm_yday
)
532 zoff
+= 24 * 60 * 60;
534 result
= scm_cons (scm_long2num ((long) itime
),
535 filltime (<
, zoff
, zname
));
537 scm_must_free (zname
);
543 SCM_DEFINE (scm_tzset
, "tzset", 0, 0, 0,
545 "Initialize the timezone from the TZ environment variable\n"
546 "or the system default. It's not usually necessary to call this procedure\n"
547 "since it's done automatically by other procedures that depend on the\n"
549 #define FUNC_NAME s_scm_tzset
552 return SCM_UNSPECIFIED
;
555 #endif /* HAVE_TZSET */
557 SCM_DEFINE (scm_strftime
, "strftime", 2, 0, 0,
558 (SCM format
, SCM stime
),
559 "Formats a time specification @var{time} using @var{template}. @var{time}\n"
560 "is an object with time components in the form returned by @code{localtime}\n"
561 "or @code{gmtime}. @var{template} is a string which can include formatting\n"
562 "specifications introduced by a @code{%} character. The formatting of\n"
563 "month and day names is dependent on the current locale. The value returned\n"
564 "is the formatted string.\n"
565 "@xref{Formatting Date and Time, , , libc, The GNU C Library Reference Manual}.)")
566 #define FUNC_NAME s_scm_strftime
576 SCM_VALIDATE_STRING (1, format
);
577 bdtime2c (stime
, &t
, SCM_ARG2
, FUNC_NAME
);
579 SCM_STRING_COERCE_0TERMINATION_X (format
);
580 fmt
= SCM_STRING_CHARS (format
);
581 len
= SCM_STRING_LENGTH (format
);
583 /* Ugly hack: strftime can return 0 if its buffer is too small,
584 but some valid time strings (e.g. "%p") can sometimes produce
585 a zero-byte output string! Workaround is to prepend a junk
586 character to the format string, so that valid returns are always
588 myfmt
= SCM_MUST_MALLOC (len
+2);
590 strncpy(myfmt
+1, fmt
, len
);
593 tbuf
= SCM_MUST_MALLOC (size
);
595 #if !defined (HAVE_TM_ZONE)
596 /* it seems the only way to tell non-GNU versions of strftime what
597 zone to use (for the %Z format) is to set TZ in the
598 environment. interrupts and thread switching must be deferred
599 until TZ is restored. */
600 char **oldenv
= NULL
;
601 SCM
*velts
= SCM_VELTS (stime
);
604 if (SCM_NFALSEP (velts
[10]) && *SCM_STRING_CHARS (velts
[10]) != 0)
606 /* it's not required that the TZ setting be correct, just that
607 it has the right name. so try something like TZ=EST0.
608 using only TZ=EST would be simpler but it doesn't work on
609 some OSs, e.g., Solaris. */
611 scm_string_append (scm_cons (velts
[10],
612 scm_cons (scm_makfrom0str ("0"),
617 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
621 #ifdef LOCALTIME_CACHE
625 /* POSIX says strftime returns 0 on buffer overrun, but old
626 systems (i.e. libc 4 on GNU/Linux) might return `size' in that
628 while ((len
= strftime (tbuf
, size
, myfmt
, &t
)) == 0 || len
== size
)
630 scm_must_free (tbuf
);
632 tbuf
= SCM_MUST_MALLOC (size
);
635 #if !defined (HAVE_TM_ZONE)
638 restorezone (velts
[10], oldenv
, FUNC_NAME
);
644 result
= scm_makfromstr (tbuf
+1, len
-1, 0);
645 scm_must_free (tbuf
);
646 scm_must_free(myfmt
);
652 SCM_DEFINE (scm_strptime
, "strptime", 2, 0, 0,
653 (SCM format
, SCM string
),
654 "Performs the reverse action to @code{strftime}, parsing @var{string}\n"
655 "according to the specification supplied in @var{template}. The\n"
656 "interpretation of month and day names is dependent on the current\n"
658 "value returned is a pair. The CAR has an object with time components \n"
659 "in the form returned by @code{localtime} or @code{gmtime},\n"
660 "but the time zone components\n"
661 "are not usefully set.\n"
662 "The CDR reports the number of characters from @var{string} which\n"
663 "were used for the conversion.")
664 #define FUNC_NAME s_scm_strptime
667 char *fmt
, *str
, *rest
;
669 SCM_VALIDATE_STRING (1, format
);
670 SCM_VALIDATE_STRING (2, string
);
672 SCM_STRING_COERCE_0TERMINATION_X (format
);
673 SCM_STRING_COERCE_0TERMINATION_X (string
);
674 fmt
= SCM_STRING_CHARS (format
);
675 str
= SCM_STRING_CHARS (string
);
677 /* initialize the struct tm */
678 #define tm_init(field) t.field = 0
691 if ((rest
= strptime (str
, fmt
, &t
)) == NULL
)
695 return scm_cons (filltime (&t
, 0, NULL
), SCM_MAKINUM (rest
- str
));
698 #endif /* HAVE_STRPTIME */
703 scm_sysintern("internal-time-units-per-second",
704 scm_long2num((long)CLKTCK
));
707 if (!scm_your_base
.time
) ftime(&scm_your_base
);
709 if (!scm_your_base
) time(&scm_your_base
);
712 if (!scm_my_base
) scm_my_base
= mytime();
714 scm_add_feature ("current-time");
715 #ifndef SCM_MAGIC_SNARFER
716 #include "libguile/stime.x"