lib/time.in.h

   1 /* A more-standard <time.h>.
   2
   3    Copyright (C) 2007-2010 Free Software Foundation, Inc.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19 #if __GNUC__ >= 3
  20 @PRAGMA_SYSTEM_HEADER@
  21 #endif
  22
  23 /* Don't get in the way of glibc when it includes time.h merely to
  24    declare a few standard symbols, rather than to declare all the
  25    symbols.  Also, Solaris 8 <time.h> eventually includes itself
  26    recursively; if that is happening, just include the system <time.h>
  27    without adding our own declarations.  */
  28 #if (defined __need_time_t || defined __need_clock_t \
  29      || defined __need_timespec \
  30      || defined _GL_TIME_H)
  31
  32 # @INCLUDE_NEXT@ @NEXT_TIME_H@
  33
  34 #else
  35
  36 # define _GL_TIME_H
  37
  38 # @INCLUDE_NEXT@ @NEXT_TIME_H@
  39
  40 /* NetBSD 5.0 mis-defines NULL.  */
  41 # include <stddef.h>
  42
  43 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here.  */
  44
  45 /* The definition of _GL_ARG_NONNULL is copied here.  */
  46
  47 /* The definition of _GL_WARN_ON_USE is copied here.  */
  48
  49 /* Some systems don't define struct timespec (e.g., AIX 4.1, Ultrix 4.3).
  50    Or they define it with the wrong member names or define it in <sys/time.h>
  51    (e.g., FreeBSD circa 1997).  */
  52 # if ! @TIME_H_DEFINES_STRUCT_TIMESPEC@
  53 #  if @SYS_TIME_H_DEFINES_STRUCT_TIMESPEC@
  54 #   include <sys/time.h>
  55 #  else
  56
  57 #   ifdef __cplusplus
  58 extern "C" {
  59 #   endif
  60
  61 #   undef timespec
  62 #   define timespec rpl_timespec
  63 struct timespec
  64 {
  65   time_t tv_sec;
  66   long int tv_nsec;
  67 };
  68
  69 #   ifdef __cplusplus
  70 }
  71 #   endif
  72
  73 #  endif
  74 # endif
  75
  76 /* Sleep for at least RQTP seconds unless interrupted,  If interrupted,
  77    return -1 and store the remaining time into RMTP.  See
  78    <http://www.opengroup.org/susv3xsh/nanosleep.html>.  */
  79 # if @GNULIB_NANOSLEEP@
  80 #  if @REPLACE_NANOSLEEP@
  81 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
  82 #    define nanosleep rpl_nanosleep
  83 #   endif
  84 _GL_FUNCDECL_RPL (nanosleep, int,
  85                   (struct timespec const *__rqtp, struct timespec *__rmtp)
  86                   _GL_ARG_NONNULL ((1)));
  87 _GL_CXXALIAS_RPL (nanosleep, int,
  88                   (struct timespec const *__rqtp, struct timespec *__rmtp));
  89 #  else
  90 _GL_CXXALIAS_SYS (nanosleep, int,
  91                   (struct timespec const *__rqtp, struct timespec *__rmtp));
  92 #  endif
  93 _GL_CXXALIASWARN (nanosleep);
  94 # endif
  95
  96 /* Return the 'time_t' representation of TP and normalize TP.  */
  97 # if @GNULIB_MKTIME@
  98 #  if @REPLACE_MKTIME@
  99 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 100 #    define mktime rpl_mktime
 101 #   endif
 102 _GL_FUNCDECL_RPL (mktime, time_t, (struct tm *__tp) _GL_ARG_NONNULL ((1)));
 103 _GL_CXXALIAS_RPL (mktime, time_t, (struct tm *__tp));
 104 #  else
 105 _GL_CXXALIAS_SYS (mktime, time_t, (struct tm *__tp));
 106 #  endif
 107 _GL_CXXALIASWARN (mktime);
 108 # endif
 109
 110 /* Convert TIMER to RESULT, assuming local time and UTC respectively.  See
 111    <http://www.opengroup.org/susv3xsh/localtime_r.html> and
 112    <http://www.opengroup.org/susv3xsh/gmtime_r.html>.  */
 113 # if @GNULIB_TIME_R@
 114 #  if @REPLACE_LOCALTIME_R@
 115 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 116 #    undef localtime_r
 117 #    define localtime_r rpl_localtime_r
 118 #   endif
 119 _GL_FUNCDECL_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
 120                                              struct tm *restrict __result)
 121                                             _GL_ARG_NONNULL ((1, 2)));
 122 _GL_CXXALIAS_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
 123                                              struct tm *restrict __result));
 124 #  else
 125 #   if ! @HAVE_LOCALTIME_R@
 126 _GL_FUNCDECL_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
 127                                              struct tm *restrict __result)
 128                                             _GL_ARG_NONNULL ((1, 2)));
 129 #   endif
 130 _GL_CXXALIAS_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
 131                                              struct tm *restrict __result));
 132 #  endif
 133 _GL_CXXALIASWARN (localtime_r);
 134 #  if @REPLACE_LOCALTIME_R@
 135 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 136 #    undef gmtime_r
 137 #    define gmtime_r rpl_gmtime_r
 138 #   endif
 139 _GL_FUNCDECL_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
 140                                           struct tm *restrict __result)
 141                                          _GL_ARG_NONNULL ((1, 2)));
 142 _GL_CXXALIAS_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
 143                                           struct tm *restrict __result));
 144 #  else
 145 #   if ! @HAVE_LOCALTIME_R@
 146 _GL_FUNCDECL_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
 147                                           struct tm *restrict __result)
 148                                          _GL_ARG_NONNULL ((1, 2)));
 149 #   endif
 150 _GL_CXXALIAS_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
 151                                           struct tm *restrict __result));
 152 #  endif
 153 _GL_CXXALIASWARN (gmtime_r);
 154 # endif
 155
 156 /* Parse BUF as a time stamp, assuming FORMAT specifies its layout, and store
 157    the resulting broken-down time into TM.  See
 158    <http://www.opengroup.org/susv3xsh/strptime.html>.  */
 159 # if @GNULIB_STRPTIME@
 160 #  if @REPLACE_STRPTIME@
 161 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 162 #    undef strptime
 163 #    define strptime rpl_strptime
 164 #   endif
 165 _GL_FUNCDECL_RPL (strptime, char *, (char const *restrict __buf,
 166                                      char const *restrict __format,
 167                                      struct tm *restrict __tm)
 168                                     _GL_ARG_NONNULL ((1, 2, 3)));
 169 _GL_CXXALIAS_RPL (strptime, char *, (char const *restrict __buf,
 170                                      char const *restrict __format,
 171                                      struct tm *restrict __tm));
 172 #  else
 173 _GL_CXXALIAS_SYS (strptime, char *, (char const *restrict __buf,
 174                                      char const *restrict __format,
 175                                      struct tm *restrict __tm));
 176 #  endif
 177 _GL_CXXALIASWARN (strptime);
 178 # endif
 179
 180 /* Convert TM to a time_t value, assuming UTC.  */
 181 # if @GNULIB_TIMEGM@
 182 #  if @REPLACE_TIMEGM@
 183 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 184 #    undef timegm
 185 #    define timegm rpl_timegm
 186 #   endif
 187 _GL_FUNCDECL_RPL (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
 188 _GL_CXXALIAS_RPL (timegm, time_t, (struct tm *__tm));
 189 #  else
 190 #   if ! @HAVE_TIMEGM@
 191 _GL_FUNCDECL_SYS (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
 192 #   endif
 193 _GL_CXXALIAS_SYS (timegm, time_t, (struct tm *__tm));
 194 #  endif
 195 _GL_CXXALIASWARN (timegm);
 196 # endif
 197
 198 /* Encourage applications to avoid unsafe functions that can overrun
 199    buffers when given outlandish struct tm values.  Portable
 200    applications should use strftime (or even sprintf) instead.  */
 201 # if defined GNULIB_POSIXCHECK
 202 #  undef asctime
 203 _GL_WARN_ON_USE (asctime, "asctime can overrun buffers in some cases - "
 204                  "better use strftime (or even sprintf) instead");
 205 # endif
 206 # if defined GNULIB_POSIXCHECK
 207 #  undef asctime_r
 208 _GL_WARN_ON_USE (asctime, "asctime_r can overrun buffers in some cases - "
 209                  "better use strftime (or even sprintf) instead");
 210 # endif
 211 # if defined GNULIB_POSIXCHECK
 212 #  undef ctime
 213 _GL_WARN_ON_USE (asctime, "ctime can overrun buffers in some cases - "
 214                  "better use strftime (or even sprintf) instead");
 215 # endif
 216 # if defined GNULIB_POSIXCHECK
 217 #  undef ctime_r
 218 _GL_WARN_ON_USE (asctime, "ctime_r can overrun buffers in some cases - "
 219                  "better use strftime (or even sprintf) instead");
 220 # endif
 221
 222 #endif