]> git.ipfire.org Git - thirdparty/glibc.git/blobdiff - time/time.h
Remove pre-ISO C support
[thirdparty/glibc.git] / time / time.h
index f60599d2cbd5d01bb405a37ca31d0d13ae2dc051..ee86f7f9a8777e533846c350bf05e60101f634d5 100644 (file)
@@ -1,23 +1,23 @@
-/* Copyright (C) 1991, 92, 93, 94, 95, 96, 97 Free Software Foundation, Inc.
+/* Copyright (C) 1991-2003,2006,2009,2011,2012 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
-   modify it under the terms of the GNU Library General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
    The GNU C Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Library General Public License for more details.
+   Lesser General Public License for more details.
 
-   You should have received a copy of the GNU Library General Public
-   License along with the GNU C Library; see the file COPYING.LIB.  If not,
-   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, write to the Free
+   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+   02111-1307 USA.  */
 
 /*
- *     ISO C Standard: 4.12 DATE and TIME      <time.h>
+ *     ISO C99 Standard: 7.23 Date and time    <time.h>
  */
 
 #ifndef        _TIME_H
@@ -36,18 +36,13 @@ __BEGIN_DECLS
 # define __need_size_t
 # define __need_NULL
 # include <stddef.h>
-#endif /* <time.h> included.  */
-
-
-
-#ifdef _TIME_H
 
 /* This defines CLOCKS_PER_SEC, which is the number of processor clock
    ticks per second.  */
 # include <bits/time.h>
 
 /* This is the obsolete POSIX.1-1988 name for the same constant.  */
-# ifdef        __USE_POSIX
+# if !defined __STRICT_ANSI__ && !defined __USE_XOPEN2K
 #  ifndef CLK_TCK
 #   define CLK_TCK     CLOCKS_PER_SEC
 #  endif
@@ -55,14 +50,18 @@ __BEGIN_DECLS
 
 #endif /* <time.h> included.  */
 
-
 #if !defined __clock_t_defined && (defined _TIME_H || defined __need_clock_t)
 # define __clock_t_defined     1
 
 # include <bits/types.h>
 
+__BEGIN_NAMESPACE_STD
 /* Returned by `clock'.  */
 typedef __clock_t clock_t;
+__END_NAMESPACE_STD
+#if defined __USE_XOPEN || defined __USE_POSIX || defined __USE_MISC
+__USING_NAMESPACE_STD(clock_t)
+#endif
 
 #endif /* clock_t not defined and <time.h> or need clock_t.  */
 #undef __need_clock_t
@@ -72,22 +71,56 @@ typedef __clock_t clock_t;
 
 # include <bits/types.h>
 
+__BEGIN_NAMESPACE_STD
 /* Returned by `time'.  */
 typedef __time_t time_t;
+__END_NAMESPACE_STD
+#if defined __USE_POSIX || defined __USE_MISC || defined __USE_SVID
+__USING_NAMESPACE_STD(time_t)
+#endif
 
 #endif /* time_t not defined and <time.h> or need time_t.  */
 #undef __need_time_t
 
+#if !defined __clockid_t_defined && \
+   ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_clockid_t)
+# define __clockid_t_defined   1
+
+# include <bits/types.h>
 
-#if !defined __timespec_defined && \
-    ((defined _TIME_H && defined __USE_POSIX) || defined __need_timespec)
+/* Clock ID used in clock and timer functions.  */
+typedef __clockid_t clockid_t;
+
+#endif /* clockid_t not defined and <time.h> or need clockid_t.  */
+#undef __clockid_time_t
+
+#if !defined __timer_t_defined && \
+    ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timer_t)
+# define __timer_t_defined     1
+
+# include <bits/types.h>
+
+/* Timer ID returned by `timer_create'.  */
+typedef __timer_t timer_t;
+
+#endif /* timer_t not defined and <time.h> or need timer_t.  */
+#undef __need_timer_t
+
+
+#if (!defined __timespec_defined                                       \
+     && ((defined _TIME_H                                              \
+         && (defined __USE_POSIX199309 || defined __USE_MISC           \
+             || defined __USE_ISOC11))                                 \
+        || defined __need_timespec))
 # define __timespec_defined    1
 
-/* POSIX.4 structure for a time value.  This is like a `struct timeval' but
+# include <bits/types.h>       /* This defines __time_t for us.  */
+
+/* POSIX.1b structure for a time value.  This is like a `struct timeval' but
    has nanoseconds instead of microseconds.  */
 struct timespec
   {
-    long int tv_sec;           /* Seconds.  */
+    __time_t tv_sec;           /* Seconds.  */
     long int tv_nsec;          /* Nanoseconds.  */
   };
 
@@ -95,15 +128,8 @@ struct timespec
 #undef __need_timespec
 
 
-/* Value used for `tm_' field in `struct tmx' if describing the local
-   time.  */
-#define _LOCALTIME             (0x7fffffff)
-
-/* Value used for `tm_leapsecond' field if the number cannot be computed.  */
-#define _NO_LEAP_SECONDS       (0x7fffffff)
-
-
 #ifdef _TIME_H
+__BEGIN_NAMESPACE_STD
 /* Used by other time functions.  */
 struct tm
 {
@@ -119,135 +145,140 @@ struct tm
 
 # ifdef        __USE_BSD
   long int tm_gmtoff;          /* Seconds east of UTC.  */
-  __const char *tm_zone;       /* Timezone abbreviation.  */
+  const char *tm_zone;         /* Timezone abbreviation.  */
 # else
   long int __tm_gmtoff;                /* Seconds east of UTC.  */
-  __const char *__tm_zone;     /* Timezone abbreviation.  */
+  const char *__tm_zone;       /* Timezone abbreviation.  */
 # endif
 };
+__END_NAMESPACE_STD
+#if defined __USE_XOPEN || defined __USE_POSIX || defined __USE_MISC
+__USING_NAMESPACE_STD(tm)
+#endif
 
-#ifdef __USE_ISOC9X
-/* Extended form of `struct tm' defined in ISO C 9X.  */
-struct tmx
-{
-  int tm_sec;                  /* Seconds.     [0-60] (1 leap second) */
-  int tm_min;                  /* Minutes.     [0-59] */
-  int tm_hour;                 /* Hours.       [0-23] */
-  int tm_mday;                 /* Day.         [1-31] */
-  int tm_mon;                  /* Month.       [0-11] */
-  int tm_year;                 /* Year - 1900.  */
-  int tm_wday;                 /* Day of week. [0-6] */
-  int tm_yday;                 /* Days in year.[0-365] */
-  int tm_isdst;                        /* DST.         [-1/0/1]*/
 
-# ifdef        __USE_BSD
-  long int tm_gmtoff;          /* Seconds east of UTC.  */
-# else
-  long int __tm_gmtoff;                /* Seconds east of UTC.  */
+# ifdef __USE_POSIX199309
+/* 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
-  __const char *__tm_zonestr;  /* Timezone abbreviation.  */
 
-  int tm_version;              /* Version number.  */
-  int tm_zone;                 /* Minutes offset from UTC [-1439-1439] */
-  int tm_leapsecs;             /* Number of leap seconds applied.  */
-  void *tm_ext;                        /* Extension block.  */
-  size_t tm_extlen;            /* Size of the extension block.  */
-};
-#endif
+
+# ifdef __USE_ISOC11
+/* Time base values for timespec_get.  */
+enum
+  {
+    TIME_UTC = 1
+  };
+# endif
 
 
+__BEGIN_NAMESPACE_STD
 /* 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));
-
-#ifdef __USE_ISOC9X
-/* Return the `time_t' representation of TP and normalize TP, taking
-   account for the extra members in `struct tmx'.  */
-extern time_t mkxtime __P ((struct tmx *__tp));
-#endif
+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 *__restrict __s, size_t __maxsize,
-                            __const char *__restrict __format,
-                            __const struct tm *__restrict __tp));
+extern size_t strftime (char *__restrict __s, size_t __maxsize,
+                       const char *__restrict __format,
+                       const struct tm *__restrict __tp) __THROW;
+__END_NAMESPACE_STD
 
 # 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));
+extern char *strptime (const char *__restrict __s,
+                      const char *__restrict __fmt, struct tm *__tp)
+     __THROW;
 # endif
 
+# ifdef __USE_XOPEN2K8
+/* Similar to the two functions above but take the information from
+   the provided locale and not the global locale.  */
+# include <xlocale.h>
 
+extern size_t strftime_l (char *__restrict __s, size_t __maxsize,
+                         const char *__restrict __format,
+                         const struct tm *__restrict __tp,
+                         __locale_t __loc) __THROW;
+# endif
+
+# ifdef __USE_GNU
+extern char *strptime_l (const char *__restrict __s,
+                        const char *__restrict __fmt, struct tm *__tp,
+                        __locale_t __loc) __THROW;
+# endif
+
+
+__BEGIN_NAMESPACE_STD
 /* 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;
+__END_NAMESPACE_STD
 
 # 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));
+extern struct tm *localtime_r (const time_t *__restrict __timer,
+                              struct tm *__restrict __tp) __THROW;
 # endif        /* POSIX or misc */
 
-/* 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));
-
+__BEGIN_NAMESPACE_STD
 /* 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;
+__END_NAMESPACE_STD
 
 # 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));
+extern char *ctime_r (const time_t *__restrict __timer,
+                     char *__restrict __buf) __THROW;
 # endif        /* POSIX or misc */
 
 
@@ -256,19 +287,14 @@ 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
 /* 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));
+/* 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
 
 # if defined __USE_SVID || defined __USE_XOPEN
@@ -279,7 +305,7 @@ extern long int timezone;
 # ifdef __USE_SVID
 /* Set the system time to *WHEN.
    This call is restricted to the superuser.  */
-extern int stime __P ((__const time_t *__when));
+extern int stime (const time_t *__when) __THROW;
 # endif
 
 
@@ -294,22 +320,75 @@ extern int stime __P ((__const time_t *__when));
    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));
+extern int dysize (int __year) __THROW  __attribute__ ((__const__));
 # endif
 
 
 # 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));
+/* Pause execution for a number of nanoseconds.
+
+   This function is a cancellation point and therefore not marked with
+   __THROW.  */
+extern int nanosleep (const struct timespec *__requested_time,
+                     struct timespec *__remaining);
+
+
+/* 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
+/* High-resolution sleep with the specified clock.
+
+   This function is a cancellation point and therefore not marked with
+   __THROW.  */
+extern int clock_nanosleep (clockid_t __clock_id, int __flags,
+                           const struct timespec *__req,
+                           struct timespec *__rem);
+
+/* Return clock ID for CPU-time clock.  */
+extern int clock_getcpuclockid (pid_t __pid, clockid_t *__clock_id) __THROW;
+#  endif
+
+
+# ifdef __USE_ISOC11
+/* Set TS to calendar time based in time base BASE.  */
+extern int timespec_get (struct timespec *__ts, int __base)
+     __THROW __nonnull ((1));
+# endif
+
+
+/* Create new per-process timer using CLOCK_ID.  */
+extern int timer_create (clockid_t __clock_id,
+                        struct sigevent *__restrict __evp,
+                        timer_t *__restrict __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 *__restrict __value,
+                         struct itimerspec *__restrict __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
 
 
@@ -323,15 +402,18 @@ extern int nanosleep __P ((__const struct timespec *__requested_time,
      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
+       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 __P ((__const char *__string));
+   `getdate_err' is set.
+
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+extern struct tm *getdate (const char *__string);
 # endif
 
 # ifdef __USE_GNU
@@ -339,12 +421,16 @@ extern struct tm *getdate __P ((__const char *__string));
    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 __P ((__const char *__string, struct tm *__resbufp));
-extern int getdate_r __P ((__const char *__string, struct tm *__resbufp));
+   value is != 0 with the same values as given above for `getdate_err'.
+
+   This function is not part of POSIX and therefore no official
+   cancellation point.  But due to similarity with an POSIX interface
+   or due to the implementation it is a cancellation point and
+   therefore not marked with __THROW.  */
+extern int getdate_r (const char *__restrict __string,
+                     struct tm *__restrict __resbufp);
 # endif
 
-
 __END_DECLS
 
 #endif /* <time.h> included.  */