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 */
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>
65 # ifdef TIME_WITH_SYS_TIME
66 # include <sys/time.h>
69 # ifdef HAVE_SYS_TIME_H
70 # include <sys/time.h>
78 #ifdef HAVE_SYS_TIMES_H
79 # include <sys/times.h>
82 #ifdef HAVE_SYS_TIMEB_H
83 # include <sys/timeb.h>
86 #ifndef tzname /* For SGI. */
87 extern char *tzname
[]; /* RS6000 and others reject char **tzname. */
90 #ifdef MISSING_STRPTIME_DECL
91 extern char *strptime ();
94 /* This should be figured out by autoconf. */
95 #if ! defined(CLKTCK) && defined(CLK_TCK)
96 # define CLKTCK CLK_TCK
98 #if ! defined(CLKTCK) && defined(CLOCKS_PER_SEC)
99 # define CLKTCK CLOCKS_PER_SEC
101 #if ! defined(CLKTCK)
107 # define timet time_t
116 struct tms time_buffer
;
118 return time_buffer
.tms_utime
+ time_buffer
.tms_stime
;
122 # define mytime() ((time((timet*)0) - scm_your_base) * CLKTCK)
124 # define mytime clock
131 struct timeb scm_your_base
= {0};
133 timet scm_your_base
= 0;
136 SCM_DEFINE (scm_get_internal_real_time
, "get-internal-real-time", 0, 0, 0,
138 "Returns the number of time units since the interpreter was started.")
139 #define FUNC_NAME s_scm_get_internal_real_time
142 struct timeb time_buffer
;
145 ftime (&time_buffer
);
146 time_buffer
.time
-= scm_your_base
.time
;
147 tmp
= scm_long2num (time_buffer
.millitm
- scm_your_base
.millitm
);
149 scm_product (SCM_MAKINUM (1000),
150 SCM_MAKINUM (time_buffer
.time
)));
151 return scm_quotient (scm_product (tmp
, SCM_MAKINUM (CLKTCK
)),
154 return scm_long2num((time((timet
*)0) - scm_your_base
) * (int)CLKTCK
);
155 #endif /* HAVE_FTIME */
161 SCM_DEFINE (scm_times
, "times", 0, 0, 0,
163 "Returns an object with information about real and processor time.\n"
164 "The following procedures accept such an object as an argument and\n"
165 "return a selected component:\n\n"
168 "The current real time, expressed as time units relative to an\n"
171 "The CPU time units used by the calling process.\n"
173 "The CPU time units used by the system on behalf of the calling process.\n"
175 "The CPU time units used by terminated child processes of the calling\n"
176 "process, whose status has been collected (e.g., using @code{waitpid}).\n"
178 "Similarly, the CPU times units used by the system on behalf of \n"
179 "terminated child processes.\n"
181 #define FUNC_NAME s_scm_times
186 SCM result
= scm_make_vector (SCM_MAKINUM(5), SCM_UNDEFINED
);
190 SCM_VELTS (result
)[0] = scm_long2num (rv
);
191 SCM_VELTS (result
)[1] = scm_long2num (t
.tms_utime
);
192 SCM_VELTS (result
)[2] = scm_long2num (t
.tms_stime
);
193 SCM_VELTS (result
)[3] = scm_long2num (t
.tms_cutime
);
194 SCM_VELTS (result
)[4] = scm_long2num (t
.tms_cstime
);
198 #endif /* HAVE_TIMES */
200 static long scm_my_base
= 0;
202 SCM_DEFINE (scm_get_internal_run_time
, "get-internal-run-time", 0, 0, 0,
204 "Returns the number of time units of processor time used by the interpreter.\n"
205 "Both \"system\" and \"user\" time are included but subprocesses are not.")
206 #define FUNC_NAME s_scm_get_internal_run_time
208 return scm_long2num(mytime()-scm_my_base
);
212 SCM_DEFINE (scm_current_time
, "current-time", 0, 0, 0,
214 "Returns the number of seconds since 1970-01-01 00:00:00 UTC, excludingleap seconds.")
215 #define FUNC_NAME s_scm_current_time
220 if ((timv
= time (0)) == -1)
223 return scm_long2num((long) timv
);
227 SCM_DEFINE (scm_gettimeofday
, "gettimeofday", 0, 0, 0,
229 "Returns a pair containing the number of seconds and microseconds since\n"
230 "1970-01-01 00:00:00 UTC, excluding leap seconds. Note: whether true\n"
231 "microsecond resolution is available depends on the operating system.")
232 #define FUNC_NAME s_scm_gettimeofday
234 #ifdef HAVE_GETTIMEOFDAY
238 if (gettimeofday (&time
, NULL
) == -1)
241 return scm_cons (scm_long2num ((long) time
.tv_sec
),
242 scm_long2num ((long) time
.tv_usec
));
248 return scm_cons (scm_long2num ((long) time
.time
),
249 SCM_MAKINUM (time
.millitm
* 1000));
254 if ((timv
= time (0)) == -1)
257 return scm_cons (scm_long2num (timv
), SCM_MAKINUM (0));
264 filltime (struct tm
*bd_time
, int zoff
, char *zname
)
266 SCM result
= scm_make_vector (SCM_MAKINUM(11), SCM_UNDEFINED
);
268 SCM_VELTS (result
)[0] = SCM_MAKINUM (bd_time
->tm_sec
);
269 SCM_VELTS (result
)[1] = SCM_MAKINUM (bd_time
->tm_min
);
270 SCM_VELTS (result
)[2] = SCM_MAKINUM (bd_time
->tm_hour
);
271 SCM_VELTS (result
)[3] = SCM_MAKINUM (bd_time
->tm_mday
);
272 SCM_VELTS (result
)[4] = SCM_MAKINUM (bd_time
->tm_mon
);
273 SCM_VELTS (result
)[5] = SCM_MAKINUM (bd_time
->tm_year
);
274 SCM_VELTS (result
)[6] = SCM_MAKINUM (bd_time
->tm_wday
);
275 SCM_VELTS (result
)[7] = SCM_MAKINUM (bd_time
->tm_yday
);
276 SCM_VELTS (result
)[8] = SCM_MAKINUM (bd_time
->tm_isdst
);
277 SCM_VELTS (result
)[9] = SCM_MAKINUM (zoff
);
278 SCM_VELTS (result
)[10] = zname
? scm_makfrom0str (zname
) : SCM_BOOL_F
;
282 static char tzvar
[3] = "TZ";
283 extern char ** environ
;
285 /* if zone is set, create a temporary environment with only a TZ
286 string. other threads or interrupt handlers shouldn't be allowed
287 to run until the corresponding restorezone is called. hence the use
288 of a static variable for tmpenv is no big deal. */
290 setzone (SCM zone
, int pos
, const char *subr
)
294 if (!SCM_UNBNDP (zone
))
296 static char *tmpenv
[2];
299 SCM_ASSERT (SCM_ROSTRINGP (zone
), zone
, pos
, subr
);
300 SCM_COERCE_SUBSTR (zone
);
301 buf
= scm_must_malloc (SCM_LENGTH (zone
) + sizeof (tzvar
) + 1,
303 sprintf (buf
, "%s=%s", tzvar
, SCM_ROCHARS (zone
));
313 restorezone (SCM zone
, char **oldenv
, const char *subr
)
315 if (!SCM_UNBNDP (zone
))
317 scm_must_free (environ
[0]);
320 /* for the possible benefit of user code linked with libguile. */
326 SCM_DEFINE (scm_localtime
, "localtime", 1, 1, 0,
327 (SCM time
, SCM zone
),
328 "Returns an object representing the broken down components of @var{time},\n"
329 "an integer like the one returned by @code{current-time}. The time zone\n"
330 "for the calculation is optionally specified by @var{zone} (a string),\n"
331 "otherwise the @code{TZ} environment variable or the system default is\n"
333 #define FUNC_NAME s_scm_localtime
336 struct tm
*ltptr
, lt
, *utc
;
343 itime
= SCM_NUM2LONG (1,time
);
345 /* deferring interupts is essential since a) setzone may install a temporary
346 environment b) localtime uses a static buffer. */
348 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
349 #ifdef LOCALTIME_CACHE
352 ltptr
= localtime (&itime
);
358 /* copy zone name before calling gmtime or restoring zone. */
359 #if defined (HAVE_TM_ZONE)
360 ptr
= ltptr
->tm_zone
;
361 #elif defined (HAVE_TZNAME)
362 ptr
= tzname
[ (ltptr
->tm_isdst
== 1) ? 1 : 0 ];
366 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
369 /* the struct is copied in case localtime and gmtime share a buffer. */
372 utc
= gmtime (&itime
);
375 restorezone (zone
, oldenv
, FUNC_NAME
);
376 /* delayed until zone has been restored. */
378 if (utc
== NULL
|| ltptr
== NULL
)
381 /* calculate timezone offset in seconds west of UTC. */
382 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
383 + utc
->tm_sec
- lt
.tm_sec
;
384 if (utc
->tm_year
< lt
.tm_year
)
385 zoff
-= 24 * 60 * 60;
386 else if (utc
->tm_year
> lt
.tm_year
)
387 zoff
+= 24 * 60 * 60;
388 else if (utc
->tm_yday
< lt
.tm_yday
)
389 zoff
-= 24 * 60 * 60;
390 else if (utc
->tm_yday
> lt
.tm_yday
)
391 zoff
+= 24 * 60 * 60;
393 result
= filltime (<
, zoff
, zname
);
395 scm_must_free (zname
);
400 SCM_DEFINE (scm_gmtime
, "gmtime", 1, 0, 0,
402 "Returns an object representing the broken down components of @var{time},\n"
403 "an integer like the one returned by @code{current-time}. The values\n"
404 "are calculated for UTC.")
405 #define FUNC_NAME s_scm_gmtime
411 itime
= SCM_NUM2LONG (1,time
);
413 bd_time
= gmtime (&itime
);
416 result
= filltime (bd_time
, 0, "GMT");
422 /* copy time components from a Scheme object to a struct tm. */
424 bdtime2c (SCM sbd_time
, struct tm
*lt
, int pos
, const char *subr
)
429 SCM_ASSERT (SCM_VECTORP (sbd_time
)
430 && SCM_LENGTH (sbd_time
) == 11,
431 sbd_time
, pos
, subr
);
432 velts
= SCM_VELTS (sbd_time
);
433 for (i
= 0; i
< 10; i
++)
435 SCM_ASSERT (SCM_INUMP (velts
[i
]), sbd_time
, pos
, subr
);
437 SCM_ASSERT (SCM_FALSEP (velts
[10]) || SCM_STRINGP (velts
[10]),
438 sbd_time
, pos
, subr
);
440 lt
->tm_sec
= SCM_INUM (velts
[0]);
441 lt
->tm_min
= SCM_INUM (velts
[1]);
442 lt
->tm_hour
= SCM_INUM (velts
[2]);
443 lt
->tm_mday
= SCM_INUM (velts
[3]);
444 lt
->tm_mon
= SCM_INUM (velts
[4]);
445 lt
->tm_year
= SCM_INUM (velts
[5]);
446 lt
->tm_wday
= SCM_INUM (velts
[6]);
447 lt
->tm_yday
= SCM_INUM (velts
[7]);
448 lt
->tm_isdst
= SCM_INUM (velts
[8]);
450 lt
->tm_gmtoff
= SCM_INUM (velts
[9]);
451 if (SCM_FALSEP (velts
[10]))
454 lt
->tm_zone
= SCM_CHARS (velts
[10]);
458 SCM_DEFINE (scm_mktime
, "mktime", 1, 1, 0,
459 (SCM sbd_time
, SCM zone
),
460 "@var{bd-time} is an object representing broken down time and @code{zone}\n"
461 "is an optional time zone specifier (otherwise the TZ environment variable\n"
462 "or the system default is used).\n\n"
463 "Returns a pair: the CAR is a corresponding\n"
464 "integer time value like that returned\n"
465 "by @code{current-time}; the CDR is a broken down time object, similar to\n"
466 "as @var{bd-time} but with normalized values.")
467 #define FUNC_NAME s_scm_mktime
477 bdtime2c (sbd_time
, <
, SCM_ARG1
, FUNC_NAME
);
480 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
481 #ifdef LOCALTIME_CACHE
484 itime
= mktime (<
);
491 /* copy zone name before calling gmtime or restoring the zone. */
492 #if defined (HAVE_TM_ZONE)
494 #elif defined (HAVE_TZNAME)
495 ptr
= tzname
[ (lt
.tm_isdst
== 1) ? 1 : 0 ];
499 zname
= SCM_MUST_MALLOC (strlen (ptr
) + 1);
503 /* get timezone offset in seconds west of UTC. */
504 utc
= gmtime (&itime
);
508 restorezone (zone
, oldenv
, FUNC_NAME
);
509 /* delayed until zone has been restored. */
511 if (utc
== NULL
|| itime
== -1)
514 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
515 + utc
->tm_sec
- lt
.tm_sec
;
516 if (utc
->tm_year
< lt
.tm_year
)
517 zoff
-= 24 * 60 * 60;
518 else if (utc
->tm_year
> lt
.tm_year
)
519 zoff
+= 24 * 60 * 60;
520 else if (utc
->tm_yday
< lt
.tm_yday
)
521 zoff
-= 24 * 60 * 60;
522 else if (utc
->tm_yday
> lt
.tm_yday
)
523 zoff
+= 24 * 60 * 60;
525 result
= scm_cons (scm_long2num ((long) itime
),
526 filltime (<
, zoff
, zname
));
528 scm_must_free (zname
);
534 SCM_DEFINE (scm_tzset
, "tzset", 0, 0, 0,
536 "Initialize the timezone from the TZ environment variable\n"
537 "or the system default. It's not usually necessary to call this procedure\n"
538 "since it's done automatically by other procedures that depend on the\n"
540 #define FUNC_NAME s_scm_tzset
543 return SCM_UNSPECIFIED
;
546 #endif /* HAVE_TZSET */
548 SCM_DEFINE (scm_strftime
, "strftime", 2, 0, 0,
549 (SCM format
, SCM stime
),
550 "Formats a time specification @var{time} using @var{template}. @var{time}\n"
551 "is an object with time components in the form returned by @code{localtime}\n"
552 "or @code{gmtime}. @var{template} is a string which can include formatting\n"
553 "specifications introduced by a @code{%} character. The formatting of\n"
554 "month and day names is dependent on the current locale. The value returned\n"
555 "is the formatted string.\n"
556 "@xref{Formatting Date and Time, , , libc, The GNU C Library Reference Manual}.)")
557 #define FUNC_NAME s_scm_strftime
567 SCM_VALIDATE_ROSTRING (1,format
);
568 bdtime2c (stime
, &t
, SCM_ARG2
, FUNC_NAME
);
570 SCM_COERCE_SUBSTR (format
);
571 fmt
= SCM_ROCHARS (format
);
572 len
= SCM_ROLENGTH (format
);
574 tbuf
= SCM_MUST_MALLOC (size
);
575 #ifdef LOCALTIME_CACHE
578 while ((len
= strftime (tbuf
, size
, fmt
, &t
)) == size
)
580 scm_must_free (tbuf
);
582 tbuf
= SCM_MUST_MALLOC (size
);
584 result
= scm_makfromstr (tbuf
, len
, 0);
585 scm_must_free (tbuf
);
591 SCM_DEFINE (scm_strptime
, "strptime", 2, 0, 0,
592 (SCM format
, SCM string
),
593 "Performs the reverse action to @code{strftime}, parsing @var{string}\n"
594 "according to the specification supplied in @var{template}. The\n"
595 "interpretation of month and day names is dependent on the current\n"
597 "value returned is a pair. The CAR has an object with time components \n"
598 "in the form returned by @code{localtime} or @code{gmtime},\n"
599 "but the time zone components\n"
600 "are not usefully set.\n"
601 "The CDR reports the number of characters from @var{string} which\n"
602 "vwere used for the conversion.")
603 #define FUNC_NAME s_scm_strptime
606 char *fmt
, *str
, *rest
;
608 SCM_VALIDATE_ROSTRING (1,format
);
609 SCM_VALIDATE_ROSTRING (2,string
);
611 SCM_COERCE_SUBSTR (format
);
612 SCM_COERCE_SUBSTR (string
);
613 fmt
= SCM_ROCHARS (format
);
614 str
= SCM_ROCHARS (string
);
616 /* initialize the struct tm */
617 #define tm_init(field) t.field = 0
630 if ((rest
= strptime (str
, fmt
, &t
)) == NULL
)
634 return scm_cons (filltime (&t
, 0, NULL
), SCM_MAKINUM (rest
- str
));
637 #endif /* HAVE_STRPTIME */
642 scm_sysintern("internal-time-units-per-second",
643 scm_long2num((long)CLKTCK
));
646 if (!scm_your_base
.time
) ftime(&scm_your_base
);
648 if (!scm_your_base
) time(&scm_your_base
);
651 if (!scm_my_base
) scm_my_base
= mytime();
653 scm_add_feature ("current-time");
654 #include "libguile/stime.x"