(distribute): Add datemsk.
[kopensolaris-gnu/glibc.git] / time / time.h
index de7214a..f4a3eb1 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 1991, 92, 93, 94, 95, 96 Free Software Foundation, Inc.
+/* Copyright (C) 1991-1999, 2000 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it and/or
 
 #ifndef        _TIME_H
 
-#if    (! defined (__need_time_t) && !defined (__need_clock_t) && \
-        ! defined (__need_timespec))
-#define        _TIME_H         1
-#include <features.h>
+#if (! defined __need_time_t && !defined __need_clock_t && \
+     ! defined __need_timespec)
+# define _TIME_H       1
+# include <features.h>
 
 __BEGIN_DECLS
 
@@ -33,32 +33,28 @@ __BEGIN_DECLS
 
 #ifdef _TIME_H
 /* Get size_t and NULL from <stddef.h>.  */
-#define        __need_size_t
-#define        __need_NULL
-#include <stddef.h>
-#endif /* <time.h> included.  */
-
-
-
-#ifdef _TIME_H
+# define __need_size_t
+# define __need_NULL
+# include <stddef.h>
 
 /* This defines CLOCKS_PER_SEC, which is the number of processor clock
    ticks per second.  */
-#include <timebits.h>
+# include <bits/time.h>
 
 /* This is the obsolete POSIX.1-1988 name for the same constant.  */
-#ifdef __USE_POSIX
-#define        CLK_TCK         CLOCKS_PER_SEC
-#endif
+# ifdef        __USE_POSIX
+#  ifndef CLK_TCK
+#   define CLK_TCK     CLOCKS_PER_SEC
+#  endif
+# endif
 
 #endif /* <time.h> included.  */
 
 
-#if    !defined (__clock_t_defined) &&                 \
-       (defined (_TIME_H) || defined (__need_clock_t))
-#define        __clock_t_defined       1
+#if !defined __clock_t_defined && (defined _TIME_H || defined __need_clock_t)
+# define __clock_t_defined     1
 
-#include <gnu/types.h>
+# include <bits/types.h>
 
 /* Returned by `clock'.  */
 typedef __clock_t clock_t;
@@ -66,11 +62,10 @@ typedef __clock_t clock_t;
 #endif /* clock_t not defined and <time.h> or need clock_t.  */
 #undef __need_clock_t
 
-#if    !defined (__time_t_defined) &&                  \
-       (defined (_TIME_H) || defined (__need_time_t))
-#define        __time_t_defined        1
+#if !defined __time_t_defined && (defined _TIME_H || defined __need_time_t)
+# define __time_t_defined      1
 
-#include <gnu/types.h>
+# include <bits/types.h>
 
 /* Returned by `time'.  */
 typedef __time_t time_t;
@@ -79,12 +74,11 @@ typedef __time_t time_t;
 #undef __need_time_t
 
 
-#if    ! defined (__timespec_defined) &&                       \
-       ((defined (_TIME_H) && defined (__USE_POSIX)) ||        \
-        defined (__need_timespec))
-#define        __timespec_defined      1
+#if !defined __timespec_defined && \
+    ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timespec)
+# define __timespec_defined    1
 
-/* POSIX.4 structure for a time value.  This is like a `struct timeval' but
+/* POSIX.1b structure for a time value.  This is like a `struct timeval' but
    has nanoseconds instead of microseconds.  */
 struct timespec
   {
@@ -96,7 +90,6 @@ struct timespec
 #undef __need_timespec
 
 
-
 #ifdef _TIME_H
 /* Used by other time functions.  */
 struct tm
@@ -111,105 +104,112 @@ struct tm
   int tm_yday;                 /* Days in year.[0-365] */
   int tm_isdst;                        /* DST.         [-1/0/1]*/
 
-#ifdef __USE_BSD
+# ifdef        __USE_BSD
   long int tm_gmtoff;          /* Seconds east of UTC.  */
   __const char *tm_zone;       /* Timezone abbreviation.  */
-#else
+# else
   long int __tm_gmtoff;                /* Seconds east of UTC.  */
   __const char *__tm_zone;     /* Timezone abbreviation.  */
-#endif
+# endif
 };
 
-#endif /* <time.h> included.  */
+
+#ifdef __USE_POSIX199309
+/* Clock ID used in clock and timer functions.  */
+typedef __clockid_t clockid_t;
+
+/* Timer ID returned by `timer_create'.  */
+typedef __timer_t timer_t;
+
+/* POSIX.1b structure for timer start values and intervals.  */
+struct itimerspec
+  {
+    struct timespec it_interval;
+    struct timespec it_value;
+  };
+
+/* We can use a simple forward declaration.  */
+struct sigevent;
+
+#endif /* POSIX.1b */
+
+#ifdef __USE_XOPEN2K
+# ifndef __pid_t_defined
+typedef __pid_t pid_t;
+#  define __pid_t_defined
+# endif
+#endif
 
 
-#ifdef _TIME_H
 /* Time used by the program so far (user time + system time).
    The result / CLOCKS_PER_SECOND is program time in seconds.  */
-extern clock_t clock __P ((void));
+extern clock_t clock (void) __THROW;
 
 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
-extern time_t time __P ((time_t *__timer));
+extern time_t time (time_t *__timer) __THROW;
 
 /* Return the difference between TIME1 and TIME0.  */
-extern double difftime __P ((time_t __time1, time_t __time0))
-     __attribute__ ((__const__));
+extern double difftime (time_t __time1, time_t __time0)
+     __THROW __attribute__ ((__const__));
 
 /* Return the `time_t' representation of TP and normalize TP.  */
-extern time_t mktime __P ((struct tm *__tp));
-
-/* Subroutine of `mktime'.  Return the `time_t' representation of TP and
-   normalize TP, given that a `struct tm *' maps to a `time_t' as performed
-   by FUNC.  Keep track of next guess for time_t offset in *OFFSET.  */
-extern time_t __mktime_internal __P ((struct tm *__tp,
-                                     struct tm *(*__func) (const time_t *,
-                                                           struct tm *),
-                                     time_t *__offset));
+extern time_t mktime (struct tm *__tp) __THROW;
 
 
 /* Format TP into S according to FORMAT.
    Write no more than MAXSIZE characters and return the number
    of characters written, or 0 if it would exceed MAXSIZE.  */
-extern size_t strftime __P ((char *__s, size_t __maxsize,
-                            __const char *__format, __const struct tm *__tp));
+extern size_t strftime (char *__restrict __s, size_t __maxsize,
+                       __const char *__restrict __format,
+                       __const struct tm *__restrict __tp) __THROW;
 
-#ifdef __USE_MISC
+# ifdef __USE_XOPEN
 /* Parse S according to FORMAT and store binary time information in TP.
    The return value is a pointer to the first unparsed character in S.  */
-extern char *strptime __P ((__const char *__s, __const char *__fmt,
-                           struct tm *__tp));
-#endif
+extern char *strptime (__const char *__s, __const char *__fmt, struct tm *__tp)
+     __THROW;
+# endif
 
 
 /* Return the `struct tm' representation of *TIMER
    in Universal Coordinated Time (aka Greenwich Mean Time).  */
-extern struct tm *gmtime __P ((__const time_t *__timer));
+extern struct tm *gmtime (__const time_t *__timer) __THROW;
 
 /* Return the `struct tm' representation
    of *TIMER in the local timezone.  */
-extern struct tm *localtime __P ((__const time_t *__timer));
+extern struct tm *localtime (__const time_t *__timer) __THROW;
 
-#ifdef __USE_REENTRANT
+# if defined __USE_POSIX || defined __USE_MISC
 /* Return the `struct tm' representation of *TIMER in UTC,
    using *TP to store the result.  */
-extern struct tm *__gmtime_r __P ((__const time_t *__timer,
-                                  struct tm *__tp));
-extern struct tm *gmtime_r __P ((__const time_t *__timer,
-                                struct tm *__tp));
+extern struct tm *gmtime_r (__const time_t *__restrict __timer,
+                           struct tm *__restrict __tp) __THROW;
 
 /* Return the `struct tm' representation of *TIMER in local time,
    using *TP to store the result.  */
-extern struct tm *__localtime_r __P ((__const time_t *__timer,
-                                     struct tm *__tp));
-extern struct tm *localtime_r __P ((__const time_t *__timer,
-                                   struct tm *__tp));
-#endif /* reentrant */
-
-/* Compute the `struct tm' representation of *T,
-   offset OFFSET seconds east of UTC,
-   and store year, yday, mon, mday, wday, hour, min, sec into *TP.  */
-extern void __offtime __P ((__const time_t *__timer,
-                           long int __offset,
-                           struct tm *__TP));
+extern struct tm *localtime_r (__const time_t *__restrict __timer,
+                              struct tm *__restrict __tp) __THROW;
+# endif        /* POSIX or misc */
 
 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
    that is the representation of TP in this format.  */
-extern char *asctime __P ((__const struct tm *__tp));
+extern char *asctime (__const struct tm *__tp) __THROW;
 
 /* Equivalent to `asctime (localtime (timer))'.  */
-extern char *ctime __P ((__const time_t *__timer));
+extern char *ctime (__const time_t *__timer) __THROW;
 
-#ifdef __USE_REENTRANT
+# if defined __USE_POSIX || defined __USE_MISC
 /* Reentrant versions of the above functions.  */
 
 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
    that is the representation of TP in this format.  */
-extern char *__asctime_r __P ((__const struct tm *__tp, char *__buf));
-extern char *asctime_r __P ((__const struct tm *__tp, char *__buf));
+extern char *asctime_r (__const struct tm *__restrict __tp,
+                       char *__restrict __buf) __THROW;
 
 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'.  */
-extern char *ctime_r __P ((__const time_t *__timer, char *__buf));
-#endif /* reentrant */
+extern char *ctime_r (__const time_t *__restrict __timer,
+                     char *__restrict __buf) __THROW;
+# endif        /* POSIX or misc */
 
 
 /* Defined in localtime.c.  */
@@ -217,59 +217,122 @@ extern char *__tzname[2];        /* Current timezone names.  */
 extern int __daylight;         /* If daylight-saving time is ever in use.  */
 extern long int __timezone;    /* Seconds west of UTC.  */
 
-/* Set time conversion information from the TZ environment variable.
-   If TZ is not defined, a locale-dependent default is used.  */
-extern void __tzset __P ((void));
 
-#ifdef __USE_POSIX
+# ifdef        __USE_POSIX
 /* Same as above.  */
 extern char *tzname[2];
 
-/* Return the maximum length of a timezone name.
-   This is what `sysconf (_SC_TZNAME_MAX)' does.  */
-extern long int __tzname_max __P ((void));
-
-extern void tzset __P ((void));
-#endif
+/* Set time conversion information from the TZ environment variable.
+   If TZ is not defined, a locale-dependent default is used.  */
+extern void tzset (void) __THROW;
+# endif
 
-#ifdef __USE_SVID
+# if defined __USE_SVID || defined __USE_XOPEN
 extern int daylight;
 extern long int timezone;
+# endif
 
+# ifdef __USE_SVID
 /* Set the system time to *WHEN.
    This call is restricted to the superuser.  */
-extern int stime __P ((__const time_t *__when));
-#endif
+extern int stime (__const time_t *__when) __THROW;
+# endif
 
 
 /* Nonzero if YEAR is a leap year (every 4 years,
    except every 100th isn't, and every 400th is).  */
-#define        __isleap(year)  \
+# define __isleap(year)        \
   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
 
 
-#ifdef __USE_MISC
+# ifdef __USE_MISC
 /* Miscellaneous functions many Unices inherited from the public domain
    localtime package.  These are included only for compatibility.  */
 
 /* Like `mktime', but for TP represents Universal Time, not local time.  */
-extern time_t timegm __P ((struct tm *__tp));
+extern time_t timegm (struct tm *__tp) __THROW;
 
 /* Another name for `mktime'.  */
-extern time_t timelocal __P ((struct tm *__tp));
+extern time_t timelocal (struct tm *__tp) __THROW;
 
 /* Return the number of days in YEAR.  */
-extern int dysize __P ((int __year));
-#endif
+extern int dysize (int __year) __THROW;
+# endif
 
 
-#ifdef __USE_POSIX
+# ifdef __USE_POSIX199309
 /* Pause execution for a number of nanoseconds.  */
-extern int __nanosleep __P ((__const struct timespec *__requested_time,
-                            struct timespec *__remaining));
-extern int nanosleep __P ((__const struct timespec *__requested_time,
-                          struct timespec *__remaining));
-#endif
+extern int nanosleep (__const struct timespec *__requested_time,
+                     struct timespec *__remaining) __THROW;
+
+
+/* Get resolution of clock CLOCK_ID.  */
+extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
+
+/* Get current value of clock CLOCK_ID and store it in TP.  */
+extern int clock_gettime (clockid_t __clock_id, struct timespec *__tp) __THROW;
+
+/* Set clock CLOCK_ID to value TP.  */
+extern int clock_settime (clockid_t __clock_id, __const struct timespec *__tp)
+     __THROW;
+
+#  ifdef __USE_XOPEN2K
+/* Return clock ID for CPU-time clock.  */
+extern int clock_getcpuclockid (pid_t __pid, clockid_t *__clock_id) __THROW;
+#  endif
+
+
+/* Create new per-process timer using CLOCK_ID.  */
+extern int timer_create (clockid_t __clock_id, struct sigevent *__evp,
+                        timer_t *__timerid) __THROW;
+
+/* Delete timer TIMERID.  */
+extern int timer_delete (timer_t __timerid) __THROW;
+
+/* Set timer TIMERID to VALUE, returning old value in OVLAUE.  */
+extern int timer_settime (timer_t __timerid, int __flags,
+                         __const struct itimerspec *__value,
+                         struct itimerspec *__ovalue) __THROW;
+
+/* Get current value of timer TIMERID and store it in VLAUE.  */
+extern int timer_gettime (timer_t __timerid, struct itimerspec *__value)
+     __THROW;
+
+/* Get expiration overrun for timer TIMERID.  */
+extern int timer_getoverrun (timer_t __timerid) __THROW;
+# endif
+
+
+# ifdef __USE_XOPEN_EXTENDED
+/* Set to one of the following values to indicate an error.
+     1  the DATEMSK environment variable is null or undefined,
+     2  the template file cannot be opened for reading,
+     3  failed to get file status information,
+     4  the template file is not a regular file,
+     5  an error is encountered while reading the template file,
+     6  memory allication failed (not enough memory available),
+     7  there is no line in the template that matches the input,
+     8  invalid input specification Example: February 31 or a time is
+        specified that can not be represented in a time_t (representing
+       the time in seconds since 00:00:00 UTC, January 1, 1970) */
+extern int getdate_err;
+
+/* Parse the given string as a date specification and return a value
+   representing the value.  The templates from the file identified by
+   the environment variable DATEMSK are used.  In case of an error
+   `getdate_err' is set.  */
+extern struct tm *getdate (__const char *__string) __THROW;
+# endif
+
+# ifdef __USE_GNU
+/* Since `getdate' is not reentrant because of the use of `getdate_err'
+   and the static buffer to return the result in, we provide a thread-safe
+   variant.  The functionality is the same.  The result is returned in
+   the buffer pointed to by RESBUFP and in case of an error the return
+   value is != 0 with the same values as given above for `getdate_err'.  */
+extern int getdate_r (__const char *__restrict __string,
+                     struct tm *__restrict __resbufp) __THROW;
+# endif
 
 
 __END_DECLS