Blame gl/time.in.h

Packit a4aae4
/* A more-standard <time.h>.
Packit a4aae4
Packit a4aae4
   Copyright (C) 2007-2017 Free Software Foundation, Inc.
Packit a4aae4
Packit a4aae4
   This program is free software; you can redistribute it and/or modify
Packit a4aae4
   it under the terms of the GNU Lesser General Public License as published by
Packit a4aae4
   the Free Software Foundation; either version 2, or (at your option)
Packit a4aae4
   any later version.
Packit a4aae4
Packit a4aae4
   This program is distributed in the hope that it will be useful,
Packit a4aae4
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit a4aae4
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit a4aae4
   GNU Lesser General Public License for more details.
Packit a4aae4
Packit a4aae4
   You should have received a copy of the GNU Lesser General Public License
Packit a4aae4
   along with this program; if not, see <http://www.gnu.org/licenses/>.  */
Packit a4aae4
Packit a4aae4
#if __GNUC__ >= 3
Packit a4aae4
@PRAGMA_SYSTEM_HEADER@
Packit a4aae4
#endif
Packit a4aae4
@PRAGMA_COLUMNS@
Packit a4aae4
Packit a4aae4
/* Don't get in the way of glibc when it includes time.h merely to
Packit a4aae4
   declare a few standard symbols, rather than to declare all the
Packit a4aae4
   symbols.  (However, skip this for MinGW as it treats __need_time_t
Packit a4aae4
   incompatibly.)  Also, Solaris 8 <time.h> eventually includes itself
Packit a4aae4
   recursively; if that is happening, just include the system <time.h>
Packit a4aae4
   without adding our own declarations.  */
Packit a4aae4
#if (((defined __need_time_t || defined __need_clock_t \
Packit a4aae4
       || defined __need_timespec)                     \
Packit a4aae4
      && !defined __MINGW32__)                         \
Packit a4aae4
     || defined _@GUARD_PREFIX@_TIME_H)
Packit a4aae4
Packit a4aae4
# @INCLUDE_NEXT@ @NEXT_TIME_H@
Packit a4aae4
Packit a4aae4
#else
Packit a4aae4
Packit a4aae4
# define _@GUARD_PREFIX@_TIME_H
Packit a4aae4
Packit a4aae4
# @INCLUDE_NEXT@ @NEXT_TIME_H@
Packit a4aae4
Packit a4aae4
/* NetBSD 5.0 mis-defines NULL.  */
Packit a4aae4
# include <stddef.h>
Packit a4aae4
Packit a4aae4
/* The definitions of _GL_FUNCDECL_RPL etc. are copied here.  */
Packit a4aae4
Packit a4aae4
/* The definition of _GL_ARG_NONNULL is copied here.  */
Packit a4aae4
Packit a4aae4
/* The definition of _GL_WARN_ON_USE is copied here.  */
Packit a4aae4
Packit a4aae4
/* Some systems don't define struct timespec (e.g., AIX 4.1, Ultrix 4.3).
Packit a4aae4
   Or they define it with the wrong member names or define it in <sys/time.h>
Packit a4aae4
   (e.g., FreeBSD circa 1997).  Stock Mingw prior to 3.0 does not define it,
Packit a4aae4
   but the pthreads-win32 library defines it in <pthread.h>.  */
Packit a4aae4
# if ! @TIME_H_DEFINES_STRUCT_TIMESPEC@
Packit a4aae4
#  if @SYS_TIME_H_DEFINES_STRUCT_TIMESPEC@
Packit a4aae4
#   include <sys/time.h>
Packit a4aae4
#  elif @PTHREAD_H_DEFINES_STRUCT_TIMESPEC@
Packit a4aae4
#   include <pthread.h>
Packit a4aae4
#  elif @UNISTD_H_DEFINES_STRUCT_TIMESPEC@
Packit a4aae4
#   include <unistd.h>
Packit a4aae4
#  else
Packit a4aae4
Packit a4aae4
#   ifdef __cplusplus
Packit a4aae4
extern "C" {
Packit a4aae4
#   endif
Packit a4aae4
Packit a4aae4
#   if !GNULIB_defined_struct_timespec
Packit a4aae4
#    undef timespec
Packit a4aae4
#    define timespec rpl_timespec
Packit a4aae4
struct timespec
Packit a4aae4
{
Packit a4aae4
  time_t tv_sec;
Packit a4aae4
  long int tv_nsec;
Packit a4aae4
};
Packit a4aae4
#    define GNULIB_defined_struct_timespec 1
Packit a4aae4
#   endif
Packit a4aae4
Packit a4aae4
#   ifdef __cplusplus
Packit a4aae4
}
Packit a4aae4
#   endif
Packit a4aae4
Packit a4aae4
#  endif
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
# if !GNULIB_defined_struct_time_t_must_be_integral
Packit a4aae4
/* Per http://austingroupbugs.net/view.php?id=327, POSIX requires
Packit a4aae4
   time_t to be an integer type, even though C99 permits floating
Packit a4aae4
   point.  We don't know of any implementation that uses floating
Packit a4aae4
   point, and it is much easier to write code that doesn't have to
Packit a4aae4
   worry about that corner case, so we force the issue.  */
Packit a4aae4
struct __time_t_must_be_integral {
Packit a4aae4
  unsigned int __floating_time_t_unsupported : (time_t) 1;
Packit a4aae4
};
Packit a4aae4
#  define GNULIB_defined_struct_time_t_must_be_integral 1
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
/* Sleep for at least RQTP seconds unless interrupted,  If interrupted,
Packit a4aae4
   return -1 and store the remaining time into RMTP.  See
Packit a4aae4
   <http://www.opengroup.org/susv3xsh/nanosleep.html>.  */
Packit a4aae4
# if @GNULIB_NANOSLEEP@
Packit a4aae4
#  if @REPLACE_NANOSLEEP@
Packit a4aae4
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
Packit a4aae4
#    define nanosleep rpl_nanosleep
Packit a4aae4
#   endif
Packit a4aae4
_GL_FUNCDECL_RPL (nanosleep, int,
Packit a4aae4
                  (struct timespec const *__rqtp, struct timespec *__rmtp)
Packit a4aae4
                  _GL_ARG_NONNULL ((1)));
Packit a4aae4
_GL_CXXALIAS_RPL (nanosleep, int,
Packit a4aae4
                  (struct timespec const *__rqtp, struct timespec *__rmtp));
Packit a4aae4
#  else
Packit a4aae4
#   if ! @HAVE_NANOSLEEP@
Packit a4aae4
_GL_FUNCDECL_SYS (nanosleep, int,
Packit a4aae4
                  (struct timespec const *__rqtp, struct timespec *__rmtp)
Packit a4aae4
                  _GL_ARG_NONNULL ((1)));
Packit a4aae4
#   endif
Packit a4aae4
_GL_CXXALIAS_SYS (nanosleep, int,
Packit a4aae4
                  (struct timespec const *__rqtp, struct timespec *__rmtp));
Packit a4aae4
#  endif
Packit a4aae4
_GL_CXXALIASWARN (nanosleep);
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
/* Initialize time conversion information.  */
Packit a4aae4
# if @GNULIB_TZSET@
Packit a4aae4
#  if @REPLACE_TZSET@
Packit a4aae4
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
Packit a4aae4
#    undef tzset
Packit a4aae4
#    define tzset rpl_tzset
Packit a4aae4
#   endif
Packit a4aae4
_GL_FUNCDECL_RPL (tzset, void, (void));
Packit a4aae4
_GL_CXXALIAS_RPL (tzset, void, (void));
Packit a4aae4
#  else
Packit a4aae4
#   if ! @HAVE_TZSET@
Packit a4aae4
_GL_FUNCDECL_SYS (tzset, void, (void));
Packit a4aae4
#   endif
Packit a4aae4
_GL_CXXALIAS_SYS (tzset, void, (void));
Packit a4aae4
#  endif
Packit a4aae4
_GL_CXXALIASWARN (tzset);
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
/* Return the 'time_t' representation of TP and normalize TP.  */
Packit a4aae4
# if @GNULIB_MKTIME@
Packit a4aae4
#  if @REPLACE_MKTIME@
Packit a4aae4
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
Packit a4aae4
#    define mktime rpl_mktime
Packit a4aae4
#   endif
Packit a4aae4
_GL_FUNCDECL_RPL (mktime, time_t, (struct tm *__tp) _GL_ARG_NONNULL ((1)));
Packit a4aae4
_GL_CXXALIAS_RPL (mktime, time_t, (struct tm *__tp));
Packit a4aae4
#  else
Packit a4aae4
_GL_CXXALIAS_SYS (mktime, time_t, (struct tm *__tp));
Packit a4aae4
#  endif
Packit a4aae4
_GL_CXXALIASWARN (mktime);
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
/* Convert TIMER to RESULT, assuming local time and UTC respectively.  See
Packit a4aae4
   <http://www.opengroup.org/susv3xsh/localtime_r.html> and
Packit a4aae4
   <http://www.opengroup.org/susv3xsh/gmtime_r.html>.  */
Packit a4aae4
# if @GNULIB_TIME_R@
Packit a4aae4
#  if @REPLACE_LOCALTIME_R@
Packit a4aae4
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
Packit a4aae4
#    undef localtime_r
Packit a4aae4
#    define localtime_r rpl_localtime_r
Packit a4aae4
#   endif
Packit a4aae4
_GL_FUNCDECL_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
Packit a4aae4
                                             struct tm *restrict __result)
Packit a4aae4
                                            _GL_ARG_NONNULL ((1, 2)));
Packit a4aae4
_GL_CXXALIAS_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
Packit a4aae4
                                             struct tm *restrict __result));
Packit a4aae4
#  else
Packit a4aae4
#   if ! @HAVE_DECL_LOCALTIME_R@
Packit a4aae4
_GL_FUNCDECL_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
Packit a4aae4
                                             struct tm *restrict __result)
Packit a4aae4
                                            _GL_ARG_NONNULL ((1, 2)));
Packit a4aae4
#   endif
Packit a4aae4
_GL_CXXALIAS_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
Packit a4aae4
                                             struct tm *restrict __result));
Packit a4aae4
#  endif
Packit a4aae4
#  if @HAVE_DECL_LOCALTIME_R@
Packit a4aae4
_GL_CXXALIASWARN (localtime_r);
Packit a4aae4
#  endif
Packit a4aae4
#  if @REPLACE_LOCALTIME_R@
Packit a4aae4
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
Packit a4aae4
#    undef gmtime_r
Packit a4aae4
#    define gmtime_r rpl_gmtime_r
Packit a4aae4
#   endif
Packit a4aae4
_GL_FUNCDECL_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
Packit a4aae4
                                          struct tm *restrict __result)
Packit a4aae4
                                         _GL_ARG_NONNULL ((1, 2)));
Packit a4aae4
_GL_CXXALIAS_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
Packit a4aae4
                                          struct tm *restrict __result));
Packit a4aae4
#  else
Packit a4aae4
#   if ! @HAVE_DECL_LOCALTIME_R@
Packit a4aae4
_GL_FUNCDECL_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
Packit a4aae4
                                          struct tm *restrict __result)
Packit a4aae4
                                         _GL_ARG_NONNULL ((1, 2)));
Packit a4aae4
#   endif
Packit a4aae4
_GL_CXXALIAS_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
Packit a4aae4
                                          struct tm *restrict __result));
Packit a4aae4
#  endif
Packit a4aae4
#  if @HAVE_DECL_LOCALTIME_R@
Packit a4aae4
_GL_CXXALIASWARN (gmtime_r);
Packit a4aae4
#  endif
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
/* Convert TIMER to RESULT, assuming local time and UTC respectively.  See
Packit a4aae4
   <http://www.opengroup.org/susv3xsh/localtime.html> and
Packit a4aae4
   <http://www.opengroup.org/susv3xsh/gmtime.html>.  */
Packit a4aae4
# if @GNULIB_LOCALTIME@ || @REPLACE_LOCALTIME@
Packit a4aae4
#  if @REPLACE_LOCALTIME@
Packit a4aae4
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
Packit a4aae4
#    undef localtime
Packit a4aae4
#    define localtime rpl_localtime
Packit a4aae4
#   endif
Packit a4aae4
_GL_FUNCDECL_RPL (localtime, struct tm *, (time_t const *__timer)
Packit a4aae4
		                          _GL_ARG_NONNULL ((1)));
Packit a4aae4
_GL_CXXALIAS_RPL (localtime, struct tm *, (time_t const *__timer));
Packit a4aae4
#  else
Packit a4aae4
_GL_CXXALIAS_SYS (localtime, struct tm *, (time_t const *__timer));
Packit a4aae4
#  endif
Packit a4aae4
_GL_CXXALIASWARN (localtime);
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
# if 0 || @REPLACE_GMTIME@
Packit a4aae4
#  if @REPLACE_GMTIME@
Packit a4aae4
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
Packit a4aae4
#    undef gmtime
Packit a4aae4
#    define gmtime rpl_gmtime
Packit a4aae4
#   endif
Packit a4aae4
_GL_FUNCDECL_RPL (gmtime, struct tm *, (time_t const *__timer)
Packit a4aae4
                                       _GL_ARG_NONNULL ((1)));
Packit a4aae4
_GL_CXXALIAS_RPL (gmtime, struct tm *, (time_t const *__timer));
Packit a4aae4
#  else
Packit a4aae4
_GL_CXXALIAS_SYS (gmtime, struct tm *, (time_t const *__timer));
Packit a4aae4
#  endif
Packit a4aae4
_GL_CXXALIASWARN (gmtime);
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
/* Parse BUF as a timestamp, assuming FORMAT specifies its layout, and store
Packit a4aae4
   the resulting broken-down time into TM.  See
Packit a4aae4
   <http://www.opengroup.org/susv3xsh/strptime.html>.  */
Packit a4aae4
# if @GNULIB_STRPTIME@
Packit a4aae4
#  if ! @HAVE_STRPTIME@
Packit a4aae4
_GL_FUNCDECL_SYS (strptime, char *, (char const *restrict __buf,
Packit a4aae4
                                     char const *restrict __format,
Packit a4aae4
                                     struct tm *restrict __tm)
Packit a4aae4
                                    _GL_ARG_NONNULL ((1, 2, 3)));
Packit a4aae4
#  endif
Packit a4aae4
_GL_CXXALIAS_SYS (strptime, char *, (char const *restrict __buf,
Packit a4aae4
                                     char const *restrict __format,
Packit a4aae4
                                     struct tm *restrict __tm));
Packit a4aae4
_GL_CXXALIASWARN (strptime);
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
/* Convert *TP to a date and time string.  See
Packit a4aae4
   <http://pubs.opengroup.org/onlinepubs/9699919799/functions/ctime.html>.  */
Packit a4aae4
# if @GNULIB_CTIME@
Packit a4aae4
#  if @REPLACE_CTIME@
Packit a4aae4
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
Packit a4aae4
#    define ctime rpl_ctime
Packit a4aae4
#   endif
Packit a4aae4
_GL_FUNCDECL_RPL (ctime, char *, (time_t const *__tp)
Packit a4aae4
                                 _GL_ARG_NONNULL ((1)));
Packit a4aae4
_GL_CXXALIAS_RPL (ctime, char *, (time_t const *__tp));
Packit a4aae4
#  else
Packit a4aae4
_GL_CXXALIAS_SYS (ctime, char *, (time_t const *__tp));
Packit a4aae4
#  endif
Packit a4aae4
_GL_CXXALIASWARN (ctime);
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
/* Convert *TP to a date and time string.  See
Packit a4aae4
   <http://pubs.opengroup.org/onlinepubs/9699919799/functions/strftime.html>.  */
Packit a4aae4
# if @GNULIB_STRFTIME@
Packit a4aae4
#  if @REPLACE_STRFTIME@
Packit a4aae4
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
Packit a4aae4
#    define strftime rpl_strftime
Packit a4aae4
#   endif
Packit a4aae4
_GL_FUNCDECL_RPL (strftime, size_t, (char *__buf, size_t __bufsize,
Packit a4aae4
                                     const char *__fmt, const struct tm *__tp)
Packit a4aae4
                                    _GL_ARG_NONNULL ((1, 3, 4)));
Packit a4aae4
_GL_CXXALIAS_RPL (strftime, size_t, (char *__buf, size_t __bufsize,
Packit a4aae4
                                     const char *__fmt, const struct tm *__tp));
Packit a4aae4
#  else
Packit a4aae4
_GL_CXXALIAS_SYS (strftime, size_t, (char *__buf, size_t __bufsize,
Packit a4aae4
                                     const char *__fmt, const struct tm *__tp));
Packit a4aae4
#  endif
Packit a4aae4
_GL_CXXALIASWARN (strftime);
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
# if defined _GNU_SOURCE && @GNULIB_TIME_RZ@ && ! @HAVE_TIMEZONE_T@
Packit a4aae4
typedef struct tm_zone *timezone_t;
Packit a4aae4
_GL_FUNCDECL_SYS (tzalloc, timezone_t, (char const *__name));
Packit a4aae4
_GL_CXXALIAS_SYS (tzalloc, timezone_t, (char const *__name));
Packit a4aae4
_GL_FUNCDECL_SYS (tzfree, void, (timezone_t __tz));
Packit a4aae4
_GL_CXXALIAS_SYS (tzfree, void, (timezone_t __tz));
Packit a4aae4
_GL_FUNCDECL_SYS (localtime_rz, struct tm *,
Packit a4aae4
                  (timezone_t __tz, time_t const *restrict __timer,
Packit a4aae4
                   struct tm *restrict __result) _GL_ARG_NONNULL ((2, 3)));
Packit a4aae4
_GL_CXXALIAS_SYS (localtime_rz, struct tm *,
Packit a4aae4
                  (timezone_t __tz, time_t const *restrict __timer,
Packit a4aae4
                   struct tm *restrict __result));
Packit a4aae4
_GL_FUNCDECL_SYS (mktime_z, time_t,
Packit a4aae4
                  (timezone_t __tz, struct tm *restrict __result)
Packit a4aae4
                  _GL_ARG_NONNULL ((2)));
Packit a4aae4
_GL_CXXALIAS_SYS (mktime_z, time_t,
Packit a4aae4
                  (timezone_t __tz, struct tm *restrict __result));
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
/* Convert TM to a time_t value, assuming UTC.  */
Packit a4aae4
# if @GNULIB_TIMEGM@
Packit a4aae4
#  if @REPLACE_TIMEGM@
Packit a4aae4
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
Packit a4aae4
#    undef timegm
Packit a4aae4
#    define timegm rpl_timegm
Packit a4aae4
#   endif
Packit a4aae4
_GL_FUNCDECL_RPL (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
Packit a4aae4
_GL_CXXALIAS_RPL (timegm, time_t, (struct tm *__tm));
Packit a4aae4
#  else
Packit a4aae4
#   if ! @HAVE_TIMEGM@
Packit a4aae4
_GL_FUNCDECL_SYS (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
Packit a4aae4
#   endif
Packit a4aae4
_GL_CXXALIAS_SYS (timegm, time_t, (struct tm *__tm));
Packit a4aae4
#  endif
Packit a4aae4
_GL_CXXALIASWARN (timegm);
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
/* Encourage applications to avoid unsafe functions that can overrun
Packit a4aae4
   buffers when given outlandish struct tm values.  Portable
Packit a4aae4
   applications should use strftime (or even sprintf) instead.  */
Packit a4aae4
# if defined GNULIB_POSIXCHECK
Packit a4aae4
#  undef asctime
Packit a4aae4
_GL_WARN_ON_USE (asctime, "asctime can overrun buffers in some cases - "
Packit a4aae4
                 "better use strftime (or even sprintf) instead");
Packit a4aae4
# endif
Packit a4aae4
# if defined GNULIB_POSIXCHECK
Packit a4aae4
#  undef asctime_r
Packit a4aae4
_GL_WARN_ON_USE (asctime, "asctime_r can overrun buffers in some cases - "
Packit a4aae4
                 "better use strftime (or even sprintf) instead");
Packit a4aae4
# endif
Packit a4aae4
# if defined GNULIB_POSIXCHECK
Packit a4aae4
#  undef ctime
Packit a4aae4
_GL_WARN_ON_USE (asctime, "ctime can overrun buffers in some cases - "
Packit a4aae4
                 "better use strftime (or even sprintf) instead");
Packit a4aae4
# endif
Packit a4aae4
# if defined GNULIB_POSIXCHECK
Packit a4aae4
#  undef ctime_r
Packit a4aae4
_GL_WARN_ON_USE (asctime, "ctime_r can overrun buffers in some cases - "
Packit a4aae4
                 "better use strftime (or even sprintf) instead");
Packit a4aae4
# endif
Packit a4aae4
Packit a4aae4
#endif