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 SCM_DEFINE (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 SCM_DEFINE (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
);
168 SCM_DEFINE (scm_times
, "times", 0, 0, 0,
170 "Returns an object with information about real and processor time.\n"
171 "The following procedures accept such an object as an argument and\n"
172 "return a selected component:\n\n"
175 "The current real time, expressed as time units relative to an\n"
178 "The CPU time units used by the calling process.\n"
180 "The CPU time units used by the system on behalf of the calling process.\n"
182 "The CPU time units used by terminated child processes of the calling\n"
183 "process, whose status has been collected (e.g., using @code{waitpid}).\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_make_vector (SCM_MAKINUM(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;
209 SCM_DEFINE (scm_get_internal_run_time
, "get-internal-run-time", 0, 0, 0,
211 "Returns the number of time units of processor time used by the interpreter.\n"
212 "Both "system
" and "user
" time
213 are included but subprocesses are not.")
214 #define FUNC_NAME s_scm_get_internal_run_time
216 return scm_long2num(mytime()-scm_my_base
);
220 SCM_DEFINE (scm_current_time
, "current-time", 0, 0, 0,
222 "Returns the number of seconds since 1970-01-01 00:00:00 UTC, excludingleap seconds.")
223 #define FUNC_NAME s_scm_current_time
228 if ((timv
= time (0)) == -1)
231 return scm_long2num((long) timv
);
235 SCM_DEFINE (scm_gettimeofday
, "gettimeofday", 0, 0, 0,
237 "Returns a pair containing the number of seconds and microseconds since
238 1970-01-01 00:00:00 UTC, excluding leap seconds. Note: whether true
239 microsecond resolution is available depends on the operating system.")
240 #define FUNC_NAME s_scm_gettimeofday
242 #ifdef HAVE_GETTIMEOFDAY
246 if (gettimeofday (&time
, NULL
) == -1)
249 return scm_cons (scm_long2num ((long) time
.tv_sec
),
250 scm_long2num ((long) time
.tv_usec
));
256 return scm_cons (scm_long2num ((long) time
.time
),
257 SCM_MAKINUM (time
.millitm
* 1000));
262 if ((timv
= time (0)) == -1)
265 return scm_cons (scm_long2num (timv
), SCM_MAKINUM (0));
272 filltime (struct tm
*bd_time
, int zoff
, char *zname
)
274 SCM result
= scm_make_vector (SCM_MAKINUM(11), SCM_UNDEFINED
);
276 SCM_VELTS (result
)[0] = SCM_MAKINUM (bd_time
->tm_sec
);
277 SCM_VELTS (result
)[1] = SCM_MAKINUM (bd_time
->tm_min
);
278 SCM_VELTS (result
)[2] = SCM_MAKINUM (bd_time
->tm_hour
);
279 SCM_VELTS (result
)[3] = SCM_MAKINUM (bd_time
->tm_mday
);
280 SCM_VELTS (result
)[4] = SCM_MAKINUM (bd_time
->tm_mon
);
281 SCM_VELTS (result
)[5] = SCM_MAKINUM (bd_time
->tm_year
);
282 SCM_VELTS (result
)[6] = SCM_MAKINUM (bd_time
->tm_wday
);
283 SCM_VELTS (result
)[7] = SCM_MAKINUM (bd_time
->tm_yday
);
284 SCM_VELTS (result
)[8] = SCM_MAKINUM (bd_time
->tm_isdst
);
285 SCM_VELTS (result
)[9] = SCM_MAKINUM (zoff
);
286 SCM_VELTS (result
)[10] = zname
? scm_makfrom0str (zname
) : SCM_BOOL_F
;
290 static char tzvar
[3] = "TZ";
291 extern char ** environ
;
293 /* if zone is set, create a temporary environment with only a TZ
294 string. other threads or interrupt handlers shouldn't be allowed
295 to run until the corresponding restorezone is called. hence the use
296 of a static variable for tmpenv is no big deal. */
298 setzone (SCM zone
, int pos
, const char *subr
)
302 if (!SCM_UNBNDP (zone
))
304 static char *tmpenv
[2];
307 SCM_ASSERT (SCM_ROSTRINGP (zone
), zone
, pos
, subr
);
308 SCM_COERCE_SUBSTR (zone
);
309 buf
= scm_must_malloc (SCM_LENGTH (zone
) + sizeof (tzvar
) + 1,
311 sprintf (buf
, "%s=%s", tzvar
, SCM_ROCHARS (zone
));
321 restorezone (SCM zone
, char **oldenv
, const char *subr
)
323 if (!SCM_UNBNDP (zone
))
325 scm_must_free (environ
[0]);
328 /* 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},
338 an integer like the one returned by @code{current-time}. The time zone
339 for the calculation is optionally specified by @var{zone} (a string),
340 otherwise the @code{TZ} environment variable or the system default is
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 tzset. */
369 ptr
= ltptr
->tm_zone
;
372 ptr
= tzname
[ (ltptr
->tm_isdst
== 1) ? 1 : 0 ];
374 SCM_MISC_ERROR ("Not fully implemented on this platform",_EOL
);
377 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
380 /* the struct is copied in case localtime and gmtime share a buffer. */
383 utc
= gmtime (&itime
);
386 restorezone (zone
, oldenv
, FUNC_NAME
);
387 /* delayed until zone has been restored. */
389 if (utc
== NULL
|| ltptr
== NULL
)
392 /* calculate timezone offset in seconds west of UTC. */
393 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
394 + utc
->tm_sec
- lt
.tm_sec
;
395 if (utc
->tm_year
< lt
.tm_year
)
396 zoff
-= 24 * 60 * 60;
397 else if (utc
->tm_year
> lt
.tm_year
)
398 zoff
+= 24 * 60 * 60;
399 else if (utc
->tm_yday
< lt
.tm_yday
)
400 zoff
-= 24 * 60 * 60;
401 else if (utc
->tm_yday
> lt
.tm_yday
)
402 zoff
+= 24 * 60 * 60;
404 result
= filltime (<
, zoff
, zname
);
406 scm_must_free (zname
);
411 SCM_DEFINE (scm_gmtime
, "gmtime", 1, 0, 0,
413 "Returns an object representing the broken down components of @var{time},
414 an integer like the one returned by @code{current-time}. The values
415 are calculated for UTC.")
416 #define FUNC_NAME s_scm_gmtime
422 itime
= SCM_NUM2LONG (1,time
);
424 bd_time
= gmtime (&itime
);
427 result
= filltime (bd_time
, 0, "GMT");
433 /* copy time components from a Scheme object to a struct tm. */
435 bdtime2c (SCM sbd_time
, struct tm
*lt
, int pos
, const char *subr
)
440 SCM_ASSERT (SCM_VECTORP (sbd_time
)
441 && SCM_LENGTH (sbd_time
) == 11,
442 sbd_time
, pos
, subr
);
443 velts
= SCM_VELTS (sbd_time
);
444 for (i
= 0; i
< 10; i
++)
446 SCM_ASSERT (SCM_INUMP (velts
[i
]), sbd_time
, pos
, subr
);
448 SCM_ASSERT (SCM_FALSEP (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 SCM_DEFINE (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 #ifdef LOCALTIME_CACHE
496 itime
= mktime (<
);
503 /* copy zone name before calling gmtime or tzset. */
508 ptr
= tzname
[ (lt
.tm_isdst
== 1) ? 1 : 0 ];
510 scm_misc_error (s_mktime
, "Not fully implemented on this platform",
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
552 or the system default. It's not usually necessary to call this procedure
553 since it's done automatically by other procedures that depend on the
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}
566 is an object with time components in the form returned by @code{localtime}
567 or @code{gmtime}. @var{template} is a string which can include formatting
568 specifications introduced by a @code{%} character. The formatting of
569 month and day names is dependent on the current locale. The value returned
570 is the formatted string.
571 @xref{Formatting Date and Time, , , libc, The GNU C Library Reference Manual}.)")
572 #define FUNC_NAME s_scm_strftime
582 SCM_VALIDATE_ROSTRING (1,format
);
583 bdtime2c (stime
, &t
, SCM_ARG2
, FUNC_NAME
);
585 SCM_COERCE_SUBSTR (format
);
586 fmt
= SCM_ROCHARS (format
);
587 len
= SCM_ROLENGTH (format
);
589 tbuf
= SCM_MUST_MALLOC (size
);
590 #ifdef LOCALTIME_CACHE
593 while ((len
= strftime (tbuf
, size
, fmt
, &t
)) == size
)
595 scm_must_free (tbuf
);
597 tbuf
= SCM_MUST_MALLOC (size
);
599 result
= scm_makfromstr (tbuf
, len
, 0);
600 scm_must_free (tbuf
);
606 SCM_DEFINE (scm_strptime
, "strptime", 2, 0, 0,
607 (SCM format
, SCM string
),
608 "Performs the reverse action to @code{strftime}, parsing @var{string}
609 according to the specification supplied in @var{template}. The
610 interpretation of month and day names is dependent on the current
612 value returned is a pair. The CAR has an object with time components
613 in the form returned by @code{localtime} or @code{gmtime},
614 but the time zone components
615 are not usefully set.
616 The CDR reports the number of characters from @var{string} which
617 vwere used for the conversion.")
618 #define FUNC_NAME s_scm_strptime
621 char *fmt
, *str
, *rest
;
623 SCM_VALIDATE_ROSTRING (1,format
);
624 SCM_VALIDATE_ROSTRING (2,string
);
626 SCM_COERCE_SUBSTR (format
);
627 SCM_COERCE_SUBSTR (string
);
628 fmt
= SCM_ROCHARS (format
);
629 str
= SCM_ROCHARS (string
);
631 /* initialize the struct tm */
632 #define tm_init(field) t.field = 0
645 if ((rest
= strptime (str
, fmt
, &t
)) == NULL
)
649 return scm_cons (filltime (&t
, 0, NULL
), SCM_MAKINUM (rest
- str
));
652 #endif /* HAVE_STRPTIME */
657 scm_sysintern("internal-time-units-per-second",
658 scm_long2num((long)CLKTCK
));
661 if (!scm_your_base
.time
) ftime(&scm_your_base
);
663 if (!scm_your_base
) time(&scm_your_base
);
666 if (!scm_my_base
) scm_my_base
= mytime();
668 scm_add_feature ("current-time");