]> git.ipfire.org Git - thirdparty/glibc.git/blobdiff - time/time.h
Installed-header hygiene (BZ#20366): time.h types.
[thirdparty/glibc.git] / time / time.h
index c71199aef7905c2a6f5eecc484148447fa880c48..c38fac7ff8ac728682f1fa11f81732c7d0e2ec24 100644 (file)
-/* Copyright (C) 1991-1999, 2000 Free Software Foundation, Inc.
+/* Copyright (C) 1991-2016 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, see
+   <http://www.gnu.org/licenses/>.  */
 
 /*
- *     ISO C Standard: 4.12 DATE and TIME      <time.h>
+ *     ISO C99 Standard: 7.23 Date and time    <time.h>
  */
 
 #ifndef        _TIME_H
+#define _TIME_H        1
 
-#if (! defined __need_time_t && !defined __need_clock_t && \
-     ! defined __need_timespec)
-# define _TIME_H       1
-# include <features.h>
+#include <features.h>
 
-__BEGIN_DECLS
-
-#endif
-
-#ifdef _TIME_H
-/* Get size_t and NULL from <stddef.h>.  */
-# define __need_size_t
-# define __need_NULL
-# include <stddef.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 <bits/time.h>
-
-/* This is the obsolete POSIX.1-1988 name for the same constant.  */
-# 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
-
-# include <bits/types.h>
-
-/* Returned by `clock'.  */
-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
-
-# include <bits/types.h>
-
-/* Returned by `time'.  */
-typedef __time_t time_t;
-
-#endif /* time_t not defined and <time.h> or need time_t.  */
-#undef __need_time_t
-
-
-#if !defined __timespec_defined && \
-    ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timespec)
-# define __timespec_defined    1
+   ticks per second, and possibly a number of other constants.   */
+#include <bits/time.h>
 
-/* 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.  */
-    long int tv_nsec;          /* Nanoseconds.  */
-  };
-
-#endif /* timespec not defined and <time.h> or need timespec.  */
-#undef __need_timespec
-
-
-#ifdef _TIME_H
-/* Used by other time functions.  */
-struct tm
-{
-  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.  */
-  __const char *tm_zone;       /* Timezone abbreviation.  */
-# else
-  long int __tm_gmtoff;                /* Seconds east of UTC.  */
-  __const char *__tm_zone;     /* Timezone abbreviation.  */
-# endif
-};
+/* Many of the typedefs and structs whose official home is this header
+   may also need to be defined by other headers.  */
+#include <bits/types/clock_t.h>
+#include <bits/types/time_t.h>
+#include <bits/types/struct_tm.h>
 
+#if defined __USE_POSIX199309 || defined __USE_ISOC11
+# include <bits/types/struct_timespec.h>
+#endif
 
 #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.  */
+# include <bits/types/clockid_t.h>
+# include <bits/types/timer_t.h>
+# include <bits/types/struct_itimerspec.h>
 struct sigevent;
-
-#endif /* POSIX.1b */
+#endif
 
 #ifdef __USE_XOPEN2K
 # ifndef __pid_t_defined
@@ -140,7 +56,18 @@ typedef __pid_t pid_t;
 # endif
 #endif
 
+#ifdef __USE_XOPEN2K8
+# include <xlocale.h>
+#endif
+
+#ifdef __USE_ISOC11
+/* Time base values for timespec_get.  */
+# define TIME_UTC 1
+#endif
+
+__BEGIN_DECLS
 
+__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 (void) __THROW;
@@ -160,56 +87,78 @@ extern time_t mktime (struct tm *__tp) __THROW;
    Write no more than MAXSIZE characters and return the number
    of characters written, or 0 if it would exceed MAXSIZE.  */
 extern size_t strftime (char *__restrict __s, size_t __maxsize,
-                       __const char *__restrict __format,
-                       __const struct tm *__restrict __tp) __THROW;
+                       const char *__restrict __format,
+                       const struct tm *__restrict __tp) __THROW;
+__END_NAMESPACE_STD
 
-# ifdef __USE_XOPEN
+#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 (__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
+#endif
+
+#ifdef __USE_XOPEN2K8
+/* Similar to the two functions above but take the information from
+   the provided locale and not the global locale.  */
+
+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 (__const time_t *__timer) __THROW;
+extern struct tm *gmtime (const time_t *__timer) __THROW;
 
 /* Return the `struct tm' representation
    of *TIMER in the local timezone.  */
-extern struct tm *localtime (__const time_t *__timer) __THROW;
+extern struct tm *localtime (const time_t *__timer) __THROW;
+__END_NAMESPACE_STD
 
-# if defined __USE_POSIX || defined __USE_MISC
+#ifdef __USE_POSIX
 /* Return the `struct tm' representation of *TIMER in UTC,
    using *TP to store the result.  */
-extern struct tm *gmtime_r (__const time_t *__restrict __timer,
+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 (__const time_t *__restrict __timer,
+extern struct tm *localtime_r (const time_t *__restrict __timer,
                               struct tm *__restrict __tp) __THROW;
-# endif        /* POSIX or misc */
+#endif /* POSIX */
 
+__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 (__const struct tm *__tp) __THROW;
+extern char *asctime (const struct tm *__tp) __THROW;
 
 /* Equivalent to `asctime (localtime (timer))'.  */
-extern char *ctime (__const time_t *__timer) __THROW;
+extern char *ctime (const time_t *__timer) __THROW;
+__END_NAMESPACE_STD
 
-# if defined __USE_POSIX || defined __USE_MISC
+#ifdef __USE_POSIX
 /* 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 (__const struct tm *__restrict __tp,
+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 (__const time_t *__restrict __timer,
+extern char *ctime_r (const time_t *__restrict __timer,
                      char *__restrict __buf) __THROW;
-# endif        /* POSIX or misc */
+#endif /* POSIX */
 
 
 /* Defined in localtime.c.  */
@@ -218,34 +167,34 @@ extern int __daylight;            /* If daylight-saving time is ever in use.  */
 extern long int __timezone;    /* Seconds west of UTC.  */
 
 
-# ifdef        __USE_POSIX
+#ifdef __USE_POSIX
 /* Same as above.  */
 extern char *tzname[2];
 
 /* 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
+#endif
 
-# if defined __USE_SVID || defined __USE_XOPEN
+#if defined __USE_MISC || defined __USE_XOPEN
 extern int daylight;
 extern long int timezone;
-# endif
+#endif
 
-# ifdef __USE_SVID
+#ifdef __USE_MISC
 /* Set the system time to *WHEN.
    This call is restricted to the superuser.  */
-extern int stime (__const time_t *__when) __THROW;
-# 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.  */
 
@@ -256,14 +205,17 @@ extern time_t timegm (struct tm *__tp) __THROW;
 extern time_t timelocal (struct tm *__tp) __THROW;
 
 /* Return the number of days in YEAR.  */
-extern int dysize (int __year) __THROW;
-# endif
+extern int dysize (int __year) __THROW  __attribute__ ((__const__));
+#endif
+
 
+#ifdef __USE_POSIX199309
+/* Pause execution for a number of nanoseconds.
 
-# ifdef __USE_POSIX199309
-/* Pause execution for a number of nanoseconds.  */
-extern int nanosleep (__const struct timespec *__requested_time,
-                     struct timespec *__remaining) __THROW;
+   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.  */
@@ -273,37 +225,53 @@ extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
 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)
+extern int clock_settime (clockid_t __clock_id, const struct timespec *__tp)
      __THROW;
 
-#  ifdef __USE_XOPEN2K
+# 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);
-#  endif
+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;
+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.  */
+/* Set timer TIMERID to VALUE, returning old value in OVALUE.  */
 extern int timer_settime (timer_t __timerid, int __flags,
-                         __const struct itimerspec *__value,
-                         struct itimerspec *__ovalue) __THROW;
+                         const struct itimerspec *__restrict __value,
+                         struct itimerspec *__restrict __ovalue) __THROW;
 
-/* Get current value of timer TIMERID and store it in VLAUE.  */
+/* Get current value of timer TIMERID and store it in VALUE.  */
 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
+#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
 
 
-# ifdef __USE_XOPEN_EXTENDED
+#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,
@@ -313,30 +281,35 @@ extern int timer_getoverrun (timer_t __timerid) __THROW;
      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 (__const char *__string) __THROW;
-# endif
+   `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
+#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
-
+   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.  */
-
-#endif /* <time.h> not already included.  */
+#endif /* time.h.  */