1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2003 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. */
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 HAVE_SYS_TIMES_H
70 # include <sys/times.h>
73 #ifdef HAVE_SYS_TIMEB_H
74 # include <sys/timeb.h>
77 #ifndef tzname /* For SGI. */
78 extern char *tzname
[]; /* RS6000 and others reject char **tzname. */
80 #if defined (__MINGW32__)
81 # define tzname _tzname
84 #ifdef MISSING_STRPTIME_DECL
85 extern char *strptime ();
98 struct tms time_buffer
;
100 return time_buffer
.tms_utime
+ time_buffer
.tms_stime
;
104 # define mytime() ((time((timet*)0) - scm_your_base) * SCM_TIME_UNITS_PER_SECOND)
106 # define mytime clock
111 struct timeb scm_your_base
= {0};
113 timet scm_your_base
= 0;
116 SCM_DEFINE (scm_get_internal_real_time
, "get-internal-real-time", 0, 0, 0,
118 "Return the number of time units since the interpreter was\n"
120 #define FUNC_NAME s_scm_get_internal_real_time
123 struct timeb time_buffer
;
126 ftime (&time_buffer
);
127 time_buffer
.time
-= scm_your_base
.time
;
128 tmp
= scm_long2num (time_buffer
.millitm
- scm_your_base
.millitm
);
130 scm_product (SCM_MAKINUM (1000),
131 SCM_MAKINUM (time_buffer
.time
)));
132 return scm_quotient (scm_product (tmp
, SCM_MAKINUM (SCM_TIME_UNITS_PER_SECOND
)),
135 return scm_long2num((time((timet
*)0) - scm_your_base
) * (int)SCM_TIME_UNITS_PER_SECOND
);
136 #endif /* HAVE_FTIME */
142 SCM_DEFINE (scm_times
, "times", 0, 0, 0,
144 "Return an object with information about real and processor\n"
145 "time. The following procedures accept such an object as an\n"
146 "argument and return a selected component:\n"
150 "The current real time, expressed as time units relative to an\n"
153 "The CPU time units used by the calling process.\n"
155 "The CPU time units used by the system on behalf of the calling\n"
158 "The CPU time units used by terminated child processes of the\n"
159 "calling process, whose status has been collected (e.g., using\n"
162 "Similarly, the CPU times units used by the system on behalf of\n"
163 "terminated child processes.\n"
165 #define FUNC_NAME s_scm_times
170 SCM result
= scm_c_make_vector (5, SCM_UNDEFINED
);
174 SCM_VECTOR_SET (result
, 0, scm_long2num (rv
));
175 SCM_VECTOR_SET (result
, 1, scm_long2num (t
.tms_utime
));
176 SCM_VECTOR_SET (result
, 2, scm_long2num (t
.tms_stime
));
177 SCM_VECTOR_SET (result
,3, scm_long2num (t
.tms_cutime
));
178 SCM_VECTOR_SET (result
, 4, scm_long2num (t
.tms_cstime
));
182 #endif /* HAVE_TIMES */
184 static long scm_my_base
= 0;
187 scm_c_get_internal_run_time ()
189 return mytime () - scm_my_base
;
192 SCM_DEFINE (scm_get_internal_run_time
, "get-internal-run-time", 0, 0, 0,
194 "Return the number of time units of processor time used by the\n"
195 "interpreter. Both @emph{system} and @emph{user} time are\n"
196 "included but subprocesses are not.")
197 #define FUNC_NAME s_scm_get_internal_run_time
199 return scm_long2num (scm_c_get_internal_run_time ());
203 SCM_DEFINE (scm_current_time
, "current-time", 0, 0, 0,
205 "Return the number of seconds since 1970-01-01 00:00:00 UTC,\n"
206 "excluding leap seconds.")
207 #define FUNC_NAME s_scm_current_time
212 if ((timv
= time (0)) == -1)
215 return scm_long2num((long) timv
);
219 SCM_DEFINE (scm_gettimeofday
, "gettimeofday", 0, 0, 0,
221 "Return a pair containing the number of seconds and microseconds\n"
222 "since 1970-01-01 00:00:00 UTC, excluding leap seconds. Note:\n"
223 "whether true microsecond resolution is available depends on the\n"
225 #define FUNC_NAME s_scm_gettimeofday
227 #ifdef HAVE_GETTIMEOFDAY
231 if (gettimeofday (&time
, NULL
) == -1)
234 return scm_cons (scm_long2num ((long) time
.tv_sec
),
235 scm_long2num ((long) time
.tv_usec
));
241 return scm_cons (scm_long2num ((long) time
.time
),
242 SCM_MAKINUM (time
.millitm
* 1000));
247 if ((timv
= time (0)) == -1)
250 return scm_cons (scm_long2num (timv
), SCM_MAKINUM (0));
257 filltime (struct tm
*bd_time
, int zoff
, char *zname
)
259 SCM result
= scm_c_make_vector (11, SCM_UNDEFINED
);
261 SCM_VECTOR_SET (result
,0, SCM_MAKINUM (bd_time
->tm_sec
));
262 SCM_VECTOR_SET (result
,1, SCM_MAKINUM (bd_time
->tm_min
));
263 SCM_VECTOR_SET (result
,2, SCM_MAKINUM (bd_time
->tm_hour
));
264 SCM_VECTOR_SET (result
,3, SCM_MAKINUM (bd_time
->tm_mday
));
265 SCM_VECTOR_SET (result
,4, SCM_MAKINUM (bd_time
->tm_mon
));
266 SCM_VECTOR_SET (result
,5, SCM_MAKINUM (bd_time
->tm_year
));
267 SCM_VECTOR_SET (result
,6, SCM_MAKINUM (bd_time
->tm_wday
));
268 SCM_VECTOR_SET (result
,7, SCM_MAKINUM (bd_time
->tm_yday
));
269 SCM_VECTOR_SET (result
,8, SCM_MAKINUM (bd_time
->tm_isdst
));
270 SCM_VECTOR_SET (result
,9, SCM_MAKINUM (zoff
));
271 SCM_VECTOR_SET (result
,10, zname
? scm_makfrom0str (zname
) : SCM_BOOL_F
);
275 static char tzvar
[3] = "TZ";
276 extern char ** environ
;
278 /* if zone is set, create a temporary environment with only a TZ
279 string. other threads or interrupt handlers shouldn't be allowed
280 to run until the corresponding restorezone is called. hence the use
281 of a static variable for tmpenv is no big deal. */
283 setzone (SCM zone
, int pos
, const char *subr
)
287 if (!SCM_UNBNDP (zone
))
289 static char *tmpenv
[2];
292 SCM_ASSERT (SCM_STRINGP (zone
), zone
, pos
, subr
);
293 buf
= scm_malloc (SCM_STRING_LENGTH (zone
) + sizeof (tzvar
) + 1);
294 sprintf (buf
, "%s=%s", tzvar
, SCM_STRING_CHARS (zone
));
304 restorezone (SCM zone
, char **oldenv
, const char *subr SCM_UNUSED
)
306 if (!SCM_UNBNDP (zone
))
311 /* for the possible benefit of user code linked with libguile. */
317 SCM_DEFINE (scm_localtime
, "localtime", 1, 1, 0,
318 (SCM time
, SCM zone
),
319 "Return an object representing the broken down components of\n"
320 "@var{time}, an integer like the one returned by\n"
321 "@code{current-time}. The time zone for the calculation is\n"
322 "optionally specified by @var{zone} (a string), otherwise the\n"
323 "@code{TZ} environment variable or the system default is used.")
324 #define FUNC_NAME s_scm_localtime
327 struct tm
*ltptr
, lt
, *utc
;
334 itime
= SCM_NUM2LONG (1, time
);
336 /* deferring interupts is essential since a) setzone may install a temporary
337 environment b) localtime uses a static buffer. */
339 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
340 #ifdef LOCALTIME_CACHE
343 ltptr
= localtime (&itime
);
349 /* copy zone name before calling gmtime or restoring zone. */
350 #if defined (HAVE_TM_ZONE)
351 ptr
= ltptr
->tm_zone
;
352 #elif defined (HAVE_TZNAME)
353 ptr
= tzname
[ (ltptr
->tm_isdst
== 1) ? 1 : 0 ];
357 zname
= scm_malloc (strlen (ptr
) + 1);
360 /* the struct is copied in case localtime and gmtime share a buffer. */
363 utc
= gmtime (&itime
);
366 restorezone (zone
, oldenv
, FUNC_NAME
);
367 /* delayed until zone has been restored. */
369 if (utc
== NULL
|| ltptr
== NULL
)
372 /* calculate timezone offset in seconds west of UTC. */
373 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
374 + utc
->tm_sec
- lt
.tm_sec
;
375 if (utc
->tm_year
< lt
.tm_year
)
376 zoff
-= 24 * 60 * 60;
377 else if (utc
->tm_year
> lt
.tm_year
)
378 zoff
+= 24 * 60 * 60;
379 else if (utc
->tm_yday
< lt
.tm_yday
)
380 zoff
-= 24 * 60 * 60;
381 else if (utc
->tm_yday
> lt
.tm_yday
)
382 zoff
+= 24 * 60 * 60;
384 result
= filltime (<
, zoff
, zname
);
392 SCM_DEFINE (scm_gmtime
, "gmtime", 1, 0, 0,
394 "Return an object representing the broken down components of\n"
395 "@var{time}, an integer like the one returned by\n"
396 "@code{current-time}. The values are calculated for UTC.")
397 #define FUNC_NAME s_scm_gmtime
403 itime
= SCM_NUM2LONG (1, time
);
405 bd_time
= gmtime (&itime
);
408 result
= filltime (bd_time
, 0, "GMT");
414 /* copy time components from a Scheme object to a struct tm. */
416 bdtime2c (SCM sbd_time
, struct tm
*lt
, int pos
, const char *subr
)
421 SCM_ASSERT (SCM_VECTORP (sbd_time
)
422 && SCM_VECTOR_LENGTH (sbd_time
) == 11,
423 sbd_time
, pos
, subr
);
424 velts
= SCM_VELTS (sbd_time
);
425 for (i
= 0; i
< 10; i
++)
427 SCM_ASSERT (SCM_INUMP (velts
[i
]), sbd_time
, pos
, subr
);
429 SCM_ASSERT (SCM_FALSEP (velts
[10]) || SCM_STRINGP (velts
[10]),
430 sbd_time
, pos
, subr
);
432 lt
->tm_sec
= SCM_INUM (velts
[0]);
433 lt
->tm_min
= SCM_INUM (velts
[1]);
434 lt
->tm_hour
= SCM_INUM (velts
[2]);
435 lt
->tm_mday
= SCM_INUM (velts
[3]);
436 lt
->tm_mon
= SCM_INUM (velts
[4]);
437 lt
->tm_year
= SCM_INUM (velts
[5]);
438 lt
->tm_wday
= SCM_INUM (velts
[6]);
439 lt
->tm_yday
= SCM_INUM (velts
[7]);
440 lt
->tm_isdst
= SCM_INUM (velts
[8]);
442 lt
->tm_gmtoff
= SCM_INUM (velts
[9]);
443 if (SCM_FALSEP (velts
[10]))
446 lt
->tm_zone
= SCM_STRING_CHARS (velts
[10]);
450 SCM_DEFINE (scm_mktime
, "mktime", 1, 1, 0,
451 (SCM sbd_time
, SCM zone
),
452 "@var{bd-time} is an object representing broken down time and @code{zone}\n"
453 "is an optional time zone specifier (otherwise the TZ environment variable\n"
454 "or the system default is used).\n\n"
455 "Returns a pair: the car is a corresponding\n"
456 "integer time value like that returned\n"
457 "by @code{current-time}; the cdr is a broken down time object, similar to\n"
458 "as @var{bd-time} but with normalized values.")
459 #define FUNC_NAME s_scm_mktime
469 bdtime2c (sbd_time
, <
, SCM_ARG1
, FUNC_NAME
);
472 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
473 #ifdef LOCALTIME_CACHE
476 itime
= mktime (<
);
483 /* copy zone name before calling gmtime or restoring the zone. */
484 #if defined (HAVE_TM_ZONE)
486 #elif defined (HAVE_TZNAME)
487 ptr
= tzname
[ (lt
.tm_isdst
== 1) ? 1 : 0 ];
491 zname
= scm_malloc (strlen (ptr
) + 1);
495 /* get timezone offset in seconds west of UTC. */
496 utc
= gmtime (&itime
);
500 restorezone (zone
, oldenv
, FUNC_NAME
);
501 /* delayed until zone has been restored. */
503 if (utc
== NULL
|| itime
== -1)
506 zoff
= (utc
->tm_hour
- lt
.tm_hour
) * 3600 + (utc
->tm_min
- lt
.tm_min
) * 60
507 + utc
->tm_sec
- lt
.tm_sec
;
508 if (utc
->tm_year
< lt
.tm_year
)
509 zoff
-= 24 * 60 * 60;
510 else if (utc
->tm_year
> lt
.tm_year
)
511 zoff
+= 24 * 60 * 60;
512 else if (utc
->tm_yday
< lt
.tm_yday
)
513 zoff
-= 24 * 60 * 60;
514 else if (utc
->tm_yday
> lt
.tm_yday
)
515 zoff
+= 24 * 60 * 60;
517 result
= scm_cons (scm_long2num ((long) itime
),
518 filltime (<
, zoff
, zname
));
527 SCM_DEFINE (scm_tzset
, "tzset", 0, 0, 0,
529 "Initialize the timezone from the TZ environment variable\n"
530 "or the system default. It's not usually necessary to call this procedure\n"
531 "since it's done automatically by other procedures that depend on the\n"
533 #define FUNC_NAME s_scm_tzset
536 return SCM_UNSPECIFIED
;
539 #endif /* HAVE_TZSET */
541 SCM_DEFINE (scm_strftime
, "strftime", 2, 0, 0,
542 (SCM format
, SCM stime
),
543 "Formats a time specification @var{time} using @var{template}. @var{time}\n"
544 "is an object with time components in the form returned by @code{localtime}\n"
545 "or @code{gmtime}. @var{template} is a string which can include formatting\n"
546 "specifications introduced by a @code{%} character. The formatting of\n"
547 "month and day names is dependent on the current locale. The value returned\n"
548 "is the formatted string.\n"
549 "@xref{Formatting Date and Time, , , libc, The GNU C Library Reference Manual}.)")
550 #define FUNC_NAME s_scm_strftime
560 SCM_VALIDATE_STRING (1, format
);
561 bdtime2c (stime
, &t
, SCM_ARG2
, FUNC_NAME
);
563 fmt
= SCM_STRING_CHARS (format
);
564 len
= SCM_STRING_LENGTH (format
);
566 /* Ugly hack: strftime can return 0 if its buffer is too small,
567 but some valid time strings (e.g. "%p") can sometimes produce
568 a zero-byte output string! Workaround is to prepend a junk
569 character to the format string, so that valid returns are always
571 myfmt
= scm_malloc (len
+2);
573 strncpy(myfmt
+1, fmt
, len
);
576 tbuf
= scm_malloc (size
);
578 #if !defined (HAVE_TM_ZONE)
579 /* it seems the only way to tell non-GNU versions of strftime what
580 zone to use (for the %Z format) is to set TZ in the
581 environment. interrupts and thread switching must be deferred
582 until TZ is restored. */
583 char **oldenv
= NULL
;
584 SCM
*velts
= SCM_VELTS (stime
);
587 if (!SCM_FALSEP (velts
[10]) && *SCM_STRING_CHARS (velts
[10]) != 0)
589 /* it's not required that the TZ setting be correct, just that
590 it has the right name. so try something like TZ=EST0.
591 using only TZ=EST would be simpler but it doesn't work on
592 some OSs, e.g., Solaris. */
594 scm_string_append (scm_cons (velts
[10],
595 scm_cons (scm_makfrom0str ("0"),
600 oldenv
= setzone (zone
, SCM_ARG2
, FUNC_NAME
);
604 #ifdef LOCALTIME_CACHE
608 /* POSIX says strftime returns 0 on buffer overrun, but old
609 systems (i.e. libc 4 on GNU/Linux) might return `size' in that
611 while ((len
= strftime (tbuf
, size
, myfmt
, &t
)) == 0 || len
== size
)
615 tbuf
= scm_malloc (size
);
618 #if !defined (HAVE_TM_ZONE)
621 restorezone (velts
[10], oldenv
, FUNC_NAME
);
627 result
= scm_mem2string (tbuf
+ 1, len
- 1);
635 SCM_DEFINE (scm_strptime
, "strptime", 2, 0, 0,
636 (SCM format
, SCM string
),
637 "Performs the reverse action to @code{strftime}, parsing\n"
638 "@var{string} according to the specification supplied in\n"
639 "@var{template}. The interpretation of month and day names is\n"
640 "dependent on the current locale. The value returned is a pair.\n"
641 "The car has an object with time components\n"
642 "in the form returned by @code{localtime} or @code{gmtime},\n"
643 "but the time zone components\n"
644 "are not usefully set.\n"
645 "The cdr reports the number of characters from @var{string}\n"
646 "which were used for the conversion.")
647 #define FUNC_NAME s_scm_strptime
650 char *fmt
, *str
, *rest
;
652 SCM_VALIDATE_STRING (1, format
);
653 SCM_VALIDATE_STRING (2, string
);
655 fmt
= SCM_STRING_CHARS (format
);
656 str
= SCM_STRING_CHARS (string
);
658 /* initialize the struct tm */
659 #define tm_init(field) t.field = 0
672 if ((rest
= strptime (str
, fmt
, &t
)) == NULL
)
676 return scm_cons (filltime (&t
, 0, NULL
), SCM_MAKINUM (rest
- str
));
679 #endif /* HAVE_STRPTIME */
684 scm_c_define ("internal-time-units-per-second",
685 scm_long2num((long) SCM_TIME_UNITS_PER_SECOND
));
688 if (!scm_your_base
.time
) ftime(&scm_your_base
);
690 if (!scm_your_base
) time(&scm_your_base
);
693 if (!scm_my_base
) scm_my_base
= mytime();
695 scm_add_feature ("current-time");
696 #include "libguile/stime.x"