time.in.h 13.3 KB
Newer Older
Paul Eggert's avatar
Paul Eggert committed
1 2
/* A more-standard <time.h>.

Paul Eggert's avatar
Paul Eggert committed
3
   Copyright (C) 2007-2020 Free Software Foundation, Inc.
Paul Eggert's avatar
Paul Eggert committed
4 5 6 7 8 9 10 11 12 13 14 15

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3, or (at your option)
   any later version.

   This program 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 General Public License for more details.

   You should have received a copy of the GNU General Public License
Paul Eggert's avatar
Paul Eggert committed
16
   along with this program; if not, see <https://www.gnu.org/licenses/>.  */
Paul Eggert's avatar
Paul Eggert committed
17 18 19 20 21 22 23 24

#if __GNUC__ >= 3
@PRAGMA_SYSTEM_HEADER@
#endif
@PRAGMA_COLUMNS@

/* Don't get in the way of glibc when it includes time.h merely to
   declare a few standard symbols, rather than to declare all the
Paul Eggert's avatar
Paul Eggert committed
25 26
   symbols.  (However, skip this for MinGW as it treats __need_time_t
   incompatibly.)  Also, Solaris 8 <time.h> eventually includes itself
Paul Eggert's avatar
Paul Eggert committed
27
   recursively; if that is happening, just include the system <time.h>
Paul Eggert's avatar
Paul Eggert committed
28 29 30 31
   without adding our own declarations.  */
#if (((defined __need_time_t || defined __need_clock_t \
       || defined __need_timespec)                     \
      && !defined __MINGW32__)                         \
32
     || defined _@GUARD_PREFIX@_TIME_H)
Paul Eggert's avatar
Paul Eggert committed
33 34 35 36 37

# @INCLUDE_NEXT@ @NEXT_TIME_H@

#else

38
# define _@GUARD_PREFIX@_TIME_H
Paul Eggert's avatar
Paul Eggert committed
39

Paul Eggert's avatar
Paul Eggert committed
40 41 42 43 44 45
/* mingw's <time.h> provides the functions asctime_r, ctime_r, gmtime_r,
   localtime_r only if <unistd.h> or <pthread.h> has been included before.  */
# if defined __MINGW32__
#  include <unistd.h>
# endif

Paul Eggert's avatar
Paul Eggert committed
46 47 48 49 50 51 52 53 54 55 56
# @INCLUDE_NEXT@ @NEXT_TIME_H@

/* NetBSD 5.0 mis-defines NULL.  */
# include <stddef.h>

/* The definitions of _GL_FUNCDECL_RPL etc. are copied here.  */

/* The definition of _GL_ARG_NONNULL is copied here.  */

/* The definition of _GL_WARN_ON_USE is copied here.  */

Paul Eggert's avatar
Paul Eggert committed
57
/* Some systems don't define struct timespec (e.g., AIX 4.1).
Paul Eggert's avatar
Paul Eggert committed
58
   Or they define it with the wrong member names or define it in <sys/time.h>
Paul Eggert's avatar
Paul Eggert committed
59 60
   (e.g., FreeBSD circa 1997).  Stock Mingw prior to 3.0 does not define it,
   but the pthreads-win32 library defines it in <pthread.h>.  */
Paul Eggert's avatar
Paul Eggert committed
61 62 63 64 65
# if ! @TIME_H_DEFINES_STRUCT_TIMESPEC@
#  if @SYS_TIME_H_DEFINES_STRUCT_TIMESPEC@
#   include <sys/time.h>
#  elif @PTHREAD_H_DEFINES_STRUCT_TIMESPEC@
#   include <pthread.h>
66 67
#  elif @UNISTD_H_DEFINES_STRUCT_TIMESPEC@
#   include <unistd.h>
Paul Eggert's avatar
Paul Eggert committed
68 69 70 71 72 73
#  else

#   ifdef __cplusplus
extern "C" {
#   endif

74 75 76
#   if !GNULIB_defined_struct_timespec
#    undef timespec
#    define timespec rpl_timespec
Paul Eggert's avatar
Paul Eggert committed
77 78 79 80 81
struct timespec
{
  time_t tv_sec;
  long int tv_nsec;
};
82 83
#    define GNULIB_defined_struct_timespec 1
#   endif
Paul Eggert's avatar
Paul Eggert committed
84 85 86 87 88 89 90 91

#   ifdef __cplusplus
}
#   endif

#  endif
# endif

92
# if !GNULIB_defined_struct_time_t_must_be_integral
Paul Eggert's avatar
Paul Eggert committed
93 94
/* https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_types.h.html
   requires time_t to be an integer type, even though C99 permits floating
Paul Eggert's avatar
Paul Eggert committed
95 96 97 98 99 100
   point.  We don't know of any implementation that uses floating
   point, and it is much easier to write code that doesn't have to
   worry about that corner case, so we force the issue.  */
struct __time_t_must_be_integral {
  unsigned int __floating_time_t_unsupported : (time_t) 1;
};
101 102
#  define GNULIB_defined_struct_time_t_must_be_integral 1
# endif
Paul Eggert's avatar
Paul Eggert committed
103 104 105

/* Sleep for at least RQTP seconds unless interrupted,  If interrupted,
   return -1 and store the remaining time into RMTP.  See
Paul Eggert's avatar
Paul Eggert committed
106
   <https://pubs.opengroup.org/onlinepubs/9699919799/functions/nanosleep.html>.  */
Paul Eggert's avatar
Paul Eggert committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
# if @GNULIB_NANOSLEEP@
#  if @REPLACE_NANOSLEEP@
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#    define nanosleep rpl_nanosleep
#   endif
_GL_FUNCDECL_RPL (nanosleep, int,
                  (struct timespec const *__rqtp, struct timespec *__rmtp)
                  _GL_ARG_NONNULL ((1)));
_GL_CXXALIAS_RPL (nanosleep, int,
                  (struct timespec const *__rqtp, struct timespec *__rmtp));
#  else
#   if ! @HAVE_NANOSLEEP@
_GL_FUNCDECL_SYS (nanosleep, int,
                  (struct timespec const *__rqtp, struct timespec *__rmtp)
                  _GL_ARG_NONNULL ((1)));
#   endif
_GL_CXXALIAS_SYS (nanosleep, int,
                  (struct timespec const *__rqtp, struct timespec *__rmtp));
#  endif
_GL_CXXALIASWARN (nanosleep);
# endif

Paul Eggert's avatar
Paul Eggert committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
/* Initialize time conversion information.  */
# if @GNULIB_TZSET@
#  if @REPLACE_TZSET@
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#    undef tzset
#    define tzset rpl_tzset
#   endif
_GL_FUNCDECL_RPL (tzset, void, (void));
_GL_CXXALIAS_RPL (tzset, void, (void));
#  else
#   if ! @HAVE_TZSET@
_GL_FUNCDECL_SYS (tzset, void, (void));
#   endif
_GL_CXXALIAS_SYS (tzset, void, (void));
#  endif
_GL_CXXALIASWARN (tzset);
# endif

Paul Eggert's avatar
Paul Eggert committed
147 148 149 150 151 152 153 154 155 156 157
/* Return the 'time_t' representation of TP and normalize TP.  */
# if @GNULIB_MKTIME@
#  if @REPLACE_MKTIME@
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#    define mktime rpl_mktime
#   endif
_GL_FUNCDECL_RPL (mktime, time_t, (struct tm *__tp) _GL_ARG_NONNULL ((1)));
_GL_CXXALIAS_RPL (mktime, time_t, (struct tm *__tp));
#  else
_GL_CXXALIAS_SYS (mktime, time_t, (struct tm *__tp));
#  endif
Paul Eggert's avatar
Paul Eggert committed
158
#  if __GLIBC__ >= 2
Paul Eggert's avatar
Paul Eggert committed
159
_GL_CXXALIASWARN (mktime);
Paul Eggert's avatar
Paul Eggert committed
160
#  endif
Paul Eggert's avatar
Paul Eggert committed
161 162 163
# endif

/* Convert TIMER to RESULT, assuming local time and UTC respectively.  See
Paul Eggert's avatar
Paul Eggert committed
164 165
   <https://pubs.opengroup.org/onlinepubs/9699919799/functions/localtime_r.html> and
   <https://pubs.opengroup.org/onlinepubs/9699919799/functions/gmtime_r.html>.  */
Paul Eggert's avatar
Paul Eggert committed
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
# if @GNULIB_TIME_R@
#  if @REPLACE_LOCALTIME_R@
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#    undef localtime_r
#    define localtime_r rpl_localtime_r
#   endif
_GL_FUNCDECL_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
                                             struct tm *restrict __result)
                                            _GL_ARG_NONNULL ((1, 2)));
_GL_CXXALIAS_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
                                             struct tm *restrict __result));
#  else
#   if ! @HAVE_DECL_LOCALTIME_R@
_GL_FUNCDECL_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
                                             struct tm *restrict __result)
                                            _GL_ARG_NONNULL ((1, 2)));
#   endif
_GL_CXXALIAS_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
                                             struct tm *restrict __result));
#  endif
#  if @HAVE_DECL_LOCALTIME_R@
_GL_CXXALIASWARN (localtime_r);
#  endif
#  if @REPLACE_LOCALTIME_R@
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#    undef gmtime_r
#    define gmtime_r rpl_gmtime_r
#   endif
_GL_FUNCDECL_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
                                          struct tm *restrict __result)
                                         _GL_ARG_NONNULL ((1, 2)));
_GL_CXXALIAS_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
                                          struct tm *restrict __result));
#  else
#   if ! @HAVE_DECL_LOCALTIME_R@
_GL_FUNCDECL_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
                                          struct tm *restrict __result)
                                         _GL_ARG_NONNULL ((1, 2)));
#   endif
_GL_CXXALIAS_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
                                          struct tm *restrict __result));
#  endif
#  if @HAVE_DECL_LOCALTIME_R@
_GL_CXXALIASWARN (gmtime_r);
#  endif
# endif

213
/* Convert TIMER to RESULT, assuming local time and UTC respectively.  See
Paul Eggert's avatar
Paul Eggert committed
214 215
   <https://pubs.opengroup.org/onlinepubs/9699919799/functions/localtime.html> and
   <https://pubs.opengroup.org/onlinepubs/9699919799/functions/gmtime.html>.  */
Paul Eggert's avatar
Paul Eggert committed
216
# if @GNULIB_LOCALTIME@ || @REPLACE_LOCALTIME@
217 218 219 220 221 222
#  if @REPLACE_LOCALTIME@
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#    undef localtime
#    define localtime rpl_localtime
#   endif
_GL_FUNCDECL_RPL (localtime, struct tm *, (time_t const *__timer)
Paul Eggert's avatar
Paul Eggert committed
223
                                          _GL_ARG_NONNULL ((1)));
224 225 226 227
_GL_CXXALIAS_RPL (localtime, struct tm *, (time_t const *__timer));
#  else
_GL_CXXALIAS_SYS (localtime, struct tm *, (time_t const *__timer));
#  endif
Paul Eggert's avatar
Paul Eggert committed
228
#  if __GLIBC__ >= 2
229
_GL_CXXALIASWARN (localtime);
Paul Eggert's avatar
Paul Eggert committed
230
#  endif
231 232
# endif

Paul Eggert's avatar
Paul Eggert committed
233
# if 0 || @REPLACE_GMTIME@
234 235 236 237 238 239 240 241 242 243 244 245 246 247
#  if @REPLACE_GMTIME@
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#    undef gmtime
#    define gmtime rpl_gmtime
#   endif
_GL_FUNCDECL_RPL (gmtime, struct tm *, (time_t const *__timer)
                                       _GL_ARG_NONNULL ((1)));
_GL_CXXALIAS_RPL (gmtime, struct tm *, (time_t const *__timer));
#  else
_GL_CXXALIAS_SYS (gmtime, struct tm *, (time_t const *__timer));
#  endif
_GL_CXXALIASWARN (gmtime);
# endif

Paul Eggert's avatar
Paul Eggert committed
248
/* Parse BUF as a timestamp, assuming FORMAT specifies its layout, and store
Paul Eggert's avatar
Paul Eggert committed
249
   the resulting broken-down time into TM.  See
Paul Eggert's avatar
Paul Eggert committed
250
   <https://pubs.opengroup.org/onlinepubs/9699919799/functions/strptime.html>.  */
Paul Eggert's avatar
Paul Eggert committed
251 252 253 254 255 256 257 258 259 260 261 262 263
# if @GNULIB_STRPTIME@
#  if ! @HAVE_STRPTIME@
_GL_FUNCDECL_SYS (strptime, char *, (char const *restrict __buf,
                                     char const *restrict __format,
                                     struct tm *restrict __tm)
                                    _GL_ARG_NONNULL ((1, 2, 3)));
#  endif
_GL_CXXALIAS_SYS (strptime, char *, (char const *restrict __buf,
                                     char const *restrict __format,
                                     struct tm *restrict __tm));
_GL_CXXALIASWARN (strptime);
# endif

Paul Eggert's avatar
Paul Eggert committed
264
/* Convert *TP to a date and time string.  See
Paul Eggert's avatar
Paul Eggert committed
265
   <https://pubs.opengroup.org/onlinepubs/9699919799/functions/ctime.html>.  */
Paul Eggert's avatar
Paul Eggert committed
266 267 268 269 270 271 272 273 274 275 276
# if @GNULIB_CTIME@
#  if @REPLACE_CTIME@
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#    define ctime rpl_ctime
#   endif
_GL_FUNCDECL_RPL (ctime, char *, (time_t const *__tp)
                                 _GL_ARG_NONNULL ((1)));
_GL_CXXALIAS_RPL (ctime, char *, (time_t const *__tp));
#  else
_GL_CXXALIAS_SYS (ctime, char *, (time_t const *__tp));
#  endif
Paul Eggert's avatar
Paul Eggert committed
277
#  if __GLIBC__ >= 2
Paul Eggert's avatar
Paul Eggert committed
278
_GL_CXXALIASWARN (ctime);
Paul Eggert's avatar
Paul Eggert committed
279
#  endif
Paul Eggert's avatar
Paul Eggert committed
280 281 282
# endif

/* Convert *TP to a date and time string.  See
Paul Eggert's avatar
Paul Eggert committed
283
   <https://pubs.opengroup.org/onlinepubs/9699919799/functions/strftime.html>.  */
Paul Eggert's avatar
Paul Eggert committed
284 285 286 287 288
# if @GNULIB_STRFTIME@
#  if @REPLACE_STRFTIME@
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#    define strftime rpl_strftime
#   endif
Paul Eggert's avatar
Paul Eggert committed
289 290 291 292 293 294 295
_GL_FUNCDECL_RPL (strftime, size_t,
                  (char *restrict __buf, size_t __bufsize,
                   const char *restrict __fmt, const struct tm *restrict __tp)
                  _GL_ARG_NONNULL ((1, 3, 4)));
_GL_CXXALIAS_RPL (strftime, size_t,
                  (char *restrict __buf, size_t __bufsize,
                   const char *restrict __fmt, const struct tm *restrict __tp));
Paul Eggert's avatar
Paul Eggert committed
296
#  else
Paul Eggert's avatar
Paul Eggert committed
297 298 299
_GL_CXXALIAS_SYS (strftime, size_t,
                  (char *restrict __buf, size_t __bufsize,
                   const char *restrict __fmt, const struct tm *restrict __tp));
Paul Eggert's avatar
Paul Eggert committed
300
#  endif
Paul Eggert's avatar
Paul Eggert committed
301
#  if __GLIBC__ >= 2
Paul Eggert's avatar
Paul Eggert committed
302
_GL_CXXALIASWARN (strftime);
Paul Eggert's avatar
Paul Eggert committed
303
#  endif
Paul Eggert's avatar
Paul Eggert committed
304 305
# endif

306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
# if defined _GNU_SOURCE && @GNULIB_TIME_RZ@ && ! @HAVE_TIMEZONE_T@
typedef struct tm_zone *timezone_t;
_GL_FUNCDECL_SYS (tzalloc, timezone_t, (char const *__name));
_GL_CXXALIAS_SYS (tzalloc, timezone_t, (char const *__name));
_GL_FUNCDECL_SYS (tzfree, void, (timezone_t __tz));
_GL_CXXALIAS_SYS (tzfree, void, (timezone_t __tz));
_GL_FUNCDECL_SYS (localtime_rz, struct tm *,
                  (timezone_t __tz, time_t const *restrict __timer,
                   struct tm *restrict __result) _GL_ARG_NONNULL ((2, 3)));
_GL_CXXALIAS_SYS (localtime_rz, struct tm *,
                  (timezone_t __tz, time_t const *restrict __timer,
                   struct tm *restrict __result));
_GL_FUNCDECL_SYS (mktime_z, time_t,
                  (timezone_t __tz, struct tm *restrict __result)
                  _GL_ARG_NONNULL ((2)));
_GL_CXXALIAS_SYS (mktime_z, time_t,
                  (timezone_t __tz, struct tm *restrict __result));
# endif

Paul Eggert's avatar
Paul Eggert committed
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
/* Convert TM to a time_t value, assuming UTC.  */
# if @GNULIB_TIMEGM@
#  if @REPLACE_TIMEGM@
#   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#    undef timegm
#    define timegm rpl_timegm
#   endif
_GL_FUNCDECL_RPL (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
_GL_CXXALIAS_RPL (timegm, time_t, (struct tm *__tm));
#  else
#   if ! @HAVE_TIMEGM@
_GL_FUNCDECL_SYS (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
#   endif
_GL_CXXALIAS_SYS (timegm, time_t, (struct tm *__tm));
#  endif
_GL_CXXALIASWARN (timegm);
# endif

/* Encourage applications to avoid unsafe functions that can overrun
   buffers when given outlandish struct tm values.  Portable
   applications should use strftime (or even sprintf) instead.  */
# if defined GNULIB_POSIXCHECK
#  undef asctime
_GL_WARN_ON_USE (asctime, "asctime can overrun buffers in some cases - "
                 "better use strftime (or even sprintf) instead");
# endif
# if defined GNULIB_POSIXCHECK
#  undef asctime_r
_GL_WARN_ON_USE (asctime, "asctime_r can overrun buffers in some cases - "
                 "better use strftime (or even sprintf) instead");
# endif
# if defined GNULIB_POSIXCHECK
#  undef ctime
_GL_WARN_ON_USE (asctime, "ctime can overrun buffers in some cases - "
                 "better use strftime (or even sprintf) instead");
# endif
# if defined GNULIB_POSIXCHECK
#  undef ctime_r
_GL_WARN_ON_USE (asctime, "ctime_r can overrun buffers in some cases - "
                 "better use strftime (or even sprintf) instead");
# endif

#endif