lib/gl/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 Lesser General Public License as published by
   7    the Free Software Foundation; either version 2.1, 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 Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser 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 #   if ! @HAVE_NANOSLEEP@
  91 _GL_FUNCDECL_SYS (nanosleep, int,
  92                   (struct timespec const *__rqtp, struct timespec *__rmtp)
  93                   _GL_ARG_NONNULL ((1)));
  94 #   endif
  95 _GL_CXXALIAS_SYS (nanosleep, int,
  96                   (struct timespec const *__rqtp, struct timespec *__rmtp));
  97 #  endif
  98 _GL_CXXALIASWARN (nanosleep);
  99 # endif
 100
 101 /* Return the 'time_t' representation of TP and normalize TP.  */
 102 # if @GNULIB_MKTIME@
 103 #  if @REPLACE_MKTIME@
 104 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 105 #    define mktime rpl_mktime
 106 #   endif
 107 _GL_FUNCDECL_RPL (mktime, time_t, (struct tm *__tp) _GL_ARG_NONNULL ((1)));
 108 _GL_CXXALIAS_RPL (mktime, time_t, (struct tm *__tp));
 109 #  else
 110 _GL_CXXALIAS_SYS (mktime, time_t, (struct tm *__tp));
 111 #  endif
 112 _GL_CXXALIASWARN (mktime);
 113 # endif
 114
 115 /* Convert TIMER to RESULT, assuming local time and UTC respectively.  See
 116    <http://www.opengroup.org/susv3xsh/localtime_r.html> and
 117    <http://www.opengroup.org/susv3xsh/gmtime_r.html>.  */
 118 # if @GNULIB_TIME_R@
 119 #  if @REPLACE_LOCALTIME_R@
 120 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 121 #    undef localtime_r
 122 #    define localtime_r rpl_localtime_r
 123 #   endif
 124 _GL_FUNCDECL_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
 125                                              struct tm *restrict __result)
 126                                             _GL_ARG_NONNULL ((1, 2)));
 127 _GL_CXXALIAS_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
 128                                              struct tm *restrict __result));
 129 #  else
 130 #   if ! @HAVE_LOCALTIME_R@
 131 _GL_FUNCDECL_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
 132                                              struct tm *restrict __result)
 133                                             _GL_ARG_NONNULL ((1, 2)));
 134 #   endif
 135 _GL_CXXALIAS_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
 136                                              struct tm *restrict __result));
 137 #  endif
 138 _GL_CXXALIASWARN (localtime_r);
 139 #  if @REPLACE_LOCALTIME_R@
 140 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 141 #    undef gmtime_r
 142 #    define gmtime_r rpl_gmtime_r
 143 #   endif
 144 _GL_FUNCDECL_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
 145                                           struct tm *restrict __result)
 146                                          _GL_ARG_NONNULL ((1, 2)));
 147 _GL_CXXALIAS_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
 148                                           struct tm *restrict __result));
 149 #  else
 150 #   if ! @HAVE_LOCALTIME_R@
 151 _GL_FUNCDECL_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
 152                                           struct tm *restrict __result)
 153                                          _GL_ARG_NONNULL ((1, 2)));
 154 #   endif
 155 _GL_CXXALIAS_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
 156                                           struct tm *restrict __result));
 157 #  endif
 158 _GL_CXXALIASWARN (gmtime_r);
 159 # endif
 160
 161 /* Parse BUF as a time stamp, assuming FORMAT specifies its layout, and store
 162    the resulting broken-down time into TM.  See
 163    <http://www.opengroup.org/susv3xsh/strptime.html>.  */
 164 # if @GNULIB_STRPTIME@
 165 #  if ! @HAVE_STRPTIME@
 166 _GL_FUNCDECL_SYS (strptime, char *, (char const *restrict __buf,
 167                                      char const *restrict __format,
 168                                      struct tm *restrict __tm)
 169                                     _GL_ARG_NONNULL ((1, 2, 3)));
 170 #  endif
 171 _GL_CXXALIAS_SYS (strptime, char *, (char const *restrict __buf,
 172                                      char const *restrict __format,
 173                                      struct tm *restrict __tm));
 174 _GL_CXXALIASWARN (strptime);
 175 # endif
 176
 177 /* Convert TM to a time_t value, assuming UTC.  */
 178 # if @GNULIB_TIMEGM@
 179 #  if @REPLACE_TIMEGM@
 180 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 181 #    undef timegm
 182 #    define timegm rpl_timegm
 183 #   endif
 184 _GL_FUNCDECL_RPL (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
 185 _GL_CXXALIAS_RPL (timegm, time_t, (struct tm *__tm));
 186 #  else
 187 #   if ! @HAVE_TIMEGM@
 188 _GL_FUNCDECL_SYS (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
 189 #   endif
 190 _GL_CXXALIAS_SYS (timegm, time_t, (struct tm *__tm));
 191 #  endif
 192 _GL_CXXALIASWARN (timegm);
 193 # endif
 194
 195 /* Encourage applications to avoid unsafe functions that can overrun
 196    buffers when given outlandish struct tm values.  Portable
 197    applications should use strftime (or even sprintf) instead.  */
 198 # if defined GNULIB_POSIXCHECK
 199 #  undef asctime
 200 _GL_WARN_ON_USE (asctime, "asctime can overrun buffers in some cases - "
 201                  "better use strftime (or even sprintf) instead");
 202 # endif
 203 # if defined GNULIB_POSIXCHECK
 204 #  undef asctime_r
 205 _GL_WARN_ON_USE (asctime, "asctime_r can overrun buffers in some cases - "
 206                  "better use strftime (or even sprintf) instead");
 207 # endif
 208 # if defined GNULIB_POSIXCHECK
 209 #  undef ctime
 210 _GL_WARN_ON_USE (asctime, "ctime can overrun buffers in some cases - "
 211                  "better use strftime (or even sprintf) instead");
 212 # endif
 213 # if defined GNULIB_POSIXCHECK
 214 #  undef ctime_r
 215 _GL_WARN_ON_USE (asctime, "ctime_r can overrun buffers in some cases - "
 216                  "better use strftime (or even sprintf) instead");
 217 # endif
 218
 219 #endif